| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Development.IDE.Core.Compile
Description
Based on https://ghc.haskell.org/trac/ghc/wiki/Commentary/Compiler/API.
Given a list of paths to find libraries, and a file to compile, produce a list of CoreModule values.
Synopsis
- data TcModuleResult = TcModuleResult {}
- newtype RunSimplifier = RunSimplifier Bool
- compileModule :: RunSimplifier -> HscEnv -> ModSummary -> TcGblEnv -> IO (IdeResult ModGuts)
- parseModule :: IdeOptions -> HscEnv -> FilePath -> ModSummary -> IO (IdeResult ParsedModule)
- typecheckModule :: IdeDefer -> HscEnv -> [Linkable] -> ParsedModule -> IO (IdeResult TcModuleResult)
- computePackageDeps :: HscEnv -> InstalledUnitId -> IO (Either [FileDiagnostic] [InstalledUnitId])
- addRelativeImport :: NormalizedFilePath -> ModuleName -> DynFlags -> DynFlags
- mkHiFileResultCompile :: HscEnv -> TcModuleResult -> ModGuts -> LinkableType -> IO (IdeResult HiFileResult)
- mkHiFileResultNoCompile :: HscEnv -> TcModuleResult -> IO HiFileResult
- generateObjectCode :: HscEnv -> ModSummary -> CgGuts -> IO (IdeResult Linkable)
- generateByteCode :: HscEnv -> ModSummary -> CgGuts -> IO (IdeResult Linkable)
- generateHieAsts :: HscEnv -> TcModuleResult -> IO ([FileDiagnostic], Maybe (HieASTs Type))
- writeAndIndexHieFile :: HscEnv -> ShakeExtras -> ModSummary -> NormalizedFilePath -> [AvailInfo] -> HieASTs Type -> ByteString -> IO [FileDiagnostic]
- indexHieFile :: ShakeExtras -> ModSummary -> NormalizedFilePath -> Fingerprint -> HieFile -> IO ()
- writeHiFile :: HscEnv -> HiFileResult -> IO [FileDiagnostic]
- getModSummaryFromImports :: HscEnv -> FilePath -> UTCTime -> Maybe StringBuffer -> ExceptT [FileDiagnostic] IO (ModSummary, [LImportDecl GhcPs])
- loadHieFile :: NameCacheUpdater -> FilePath -> IO HieFile
- loadInterface :: MonadIO m => HscEnv -> ModSummary -> SourceModified -> Maybe LinkableType -> (Maybe LinkableType -> m ([FileDiagnostic], Maybe HiFileResult)) -> m ([FileDiagnostic], Maybe HiFileResult)
- loadModulesHome :: [HomeModInfo] -> HscEnv -> HscEnv
- setupFinderCache :: [ModSummary] -> HscEnv -> IO HscEnv
- getDocsBatch :: HscEnv -> Module -> [Name] -> IO [Either String (Maybe HsDocString, Map Int HsDocString)]
- lookupName :: HscEnv -> Module -> Name -> IO (Maybe TyThing)
Documentation
data TcModuleResult Source #
Contains the typechecked module and the OrigNameCache entry for that module.
Constructors
| TcModuleResult | |
Fields
| |
Instances
| Show TcModuleResult Source # | |
Defined in Development.IDE.Core.RuleTypes Methods showsPrec :: Int -> TcModuleResult -> ShowS # show :: TcModuleResult -> String # showList :: [TcModuleResult] -> ShowS # | |
| NFData TcModuleResult Source # | |
Defined in Development.IDE.Core.RuleTypes Methods rnf :: TcModuleResult -> () # | |
newtype RunSimplifier Source #
Whether we should run the -O0 simplifier when generating core.
This is required for template Haskell to work but we disable this in DAML. See #256
Constructors
| RunSimplifier Bool |
compileModule :: RunSimplifier -> HscEnv -> ModSummary -> TcGblEnv -> IO (IdeResult ModGuts) Source #
Compile a single type-checked module to a CoreModule value, or
provide errors.
parseModule :: IdeOptions -> HscEnv -> FilePath -> ModSummary -> IO (IdeResult ParsedModule) Source #
Given a string buffer, return the string (after preprocessing) and the ParsedModule.
Arguments
| :: IdeDefer | |
| -> HscEnv | |
| -> [Linkable] | linkables not to unload |
| -> ParsedModule | |
| -> IO (IdeResult TcModuleResult) |
computePackageDeps :: HscEnv -> InstalledUnitId -> IO (Either [FileDiagnostic] [InstalledUnitId]) Source #
Given a package identifier, what packages does it depend on
addRelativeImport :: NormalizedFilePath -> ModuleName -> DynFlags -> DynFlags Source #
mkHiFileResultCompile Source #
Arguments
| :: HscEnv | |
| -> TcModuleResult | |
| -> ModGuts | |
| -> LinkableType | use object code or byte code? |
| -> IO (IdeResult HiFileResult) |
generateObjectCode :: HscEnv -> ModSummary -> CgGuts -> IO (IdeResult Linkable) Source #
generateByteCode :: HscEnv -> ModSummary -> CgGuts -> IO (IdeResult Linkable) Source #
generateHieAsts :: HscEnv -> TcModuleResult -> IO ([FileDiagnostic], Maybe (HieASTs Type)) Source #
writeAndIndexHieFile :: HscEnv -> ShakeExtras -> ModSummary -> NormalizedFilePath -> [AvailInfo] -> HieASTs Type -> ByteString -> IO [FileDiagnostic] Source #
indexHieFile :: ShakeExtras -> ModSummary -> NormalizedFilePath -> Fingerprint -> HieFile -> IO () Source #
In addition to indexing the `.hie` file, this function is responsible for
maintaining the IndexQueue state and notfiying the user about indexing
progress.
We maintain a record of all pending index operations in the indexPending
TVar.
When indexHieFile is called, it must check to ensure that the file hasn't
already be queued up for indexing. If it has, then we can just skip it
Otherwise, we record the current file as pending and write an indexing operation to the queue
When the indexing operation is picked up and executed by the worker thread,
the first thing it does is ensure that a newer index for the same file hasn't
been scheduled by looking at indexPending. If a newer index has been
scheduled, we can safely skip this one
Otherwise, we start or continue a progress reporting session, telling it about progress so far and the current file we are attempting to index. Then we can go ahead and call in to hiedb to actually do the indexing operation
Once this completes, we have to update the IndexQueue state. First, we
must remove the just indexed file from indexPending Then we check if
indexPending is now empty. In that case, we end the progress session and
report the total number of file indexed. We also set the indexCompleted
TVar to 0 in order to set it up for a fresh indexing session. Otherwise, we
can just increment the indexCompleted TVar and exit.
writeHiFile :: HscEnv -> HiFileResult -> IO [FileDiagnostic] Source #
getModSummaryFromImports :: HscEnv -> FilePath -> UTCTime -> Maybe StringBuffer -> ExceptT [FileDiagnostic] IO (ModSummary, [LImportDecl GhcPs]) Source #
Given a buffer, env and filepath, produce a module summary by parsing only the imports. Runs preprocessors as needed.
loadHieFile :: NameCacheUpdater -> FilePath -> IO HieFile Source #
Arguments
| :: MonadIO m | |
| => HscEnv | |
| -> ModSummary | |
| -> SourceModified | |
| -> Maybe LinkableType | |
| -> (Maybe LinkableType -> m ([FileDiagnostic], Maybe HiFileResult)) | Action to regenerate an interface |
| -> m ([FileDiagnostic], Maybe HiFileResult) |
Retuns an up-to-date module interface, regenerating if needed.
Assumes file exists.
Requires the HscEnv to be set up with dependencies
loadModulesHome :: [HomeModInfo] -> HscEnv -> HscEnv Source #
Load modules, quickly. Input doesn't need to be desugared. A module must be loaded before dependent modules can be typechecked. This variant of loadModuleHome will *never* cause recompilation, it just modifies the session. The order modules are loaded is important when there are hs-boot files. In particular you should make sure to load the .hs version of a file after the .hs-boot version.
setupFinderCache :: [ModSummary] -> HscEnv -> IO HscEnv Source #
Initialise the finder cache, dependencies should be topologically sorted.
Arguments
| :: HscEnv | |
| -> Module | a moudle where the names are in scope |
| -> [Name] | |
| -> IO [Either String (Maybe HsDocString, Map Int HsDocString)] |
Non-interactive, batch version of getDocs.
The interactive paths create problems in ghc-lib builds
Non-interactive, batch version of lookupNames.
The interactive paths create problems in ghc-lib builds