Safe Haskell | None |
---|---|
Language | Haskell98 |
This module deals with finding imported modules and loading their interface files.
- data MainInterface
- mergeInterface :: Interface -> TCM ()
- addImportedThings :: Signature -> BuiltinThings PrimFun -> Set String -> PatternSynDefns -> TCM ()
- scopeCheckImport :: ModuleName -> TCM (ModuleName, Map ModuleName Scope)
- data MaybeWarnings
- hasWarnings :: MaybeWarnings -> Bool
- alreadyVisited :: TopLevelModuleName -> TCM (Interface, MaybeWarnings) -> TCM (Interface, MaybeWarnings)
- typeCheckMain :: AbsolutePath -> TCM (Interface, MaybeWarnings)
- getInterface :: ModuleName -> TCM Interface
- getInterface_ :: TopLevelModuleName -> TCM Interface
- getInterface' :: TopLevelModuleName -> MainInterface -> TCM (Interface, MaybeWarnings)
- highlightFromInterface :: Interface -> AbsolutePath -> TCM ()
- readInterface :: FilePath -> TCM (Maybe Interface)
- writeInterface :: FilePath -> Interface -> TCM ()
- createInterface :: AbsolutePath -> TopLevelModuleName -> TCM (Interface, MaybeWarnings)
- buildInterface :: AbsolutePath -> TopLevelInfo -> HighlightingInfo -> Set String -> [OptionsPragma] -> TCM Interface
- getInterfaceFileHashes :: FilePath -> TCM (Maybe (Hash, Hash))
- safeReadInterface :: FilePath -> TCM (Maybe Interface)
- moduleHash :: ModuleName -> TCM Hash
- isNewerThan :: FilePath -> FilePath -> IO Bool
Documentation
data MainInterface Source
Are we loading the interface for the user-loaded file or for an import?
MainInterface | Interface for main file. |
NotMainInterface | Interface for imported file. |
mergeInterface :: Interface -> TCM () Source
Merge an interface into the current proof state.
addImportedThings :: Signature -> BuiltinThings PrimFun -> Set String -> PatternSynDefns -> TCM () Source
scopeCheckImport :: ModuleName -> TCM (ModuleName, Map ModuleName Scope) Source
Scope checks the given module. A proper version of the module name (with correct definition sites) is returned.
hasWarnings :: MaybeWarnings -> Bool Source
alreadyVisited :: TopLevelModuleName -> TCM (Interface, MaybeWarnings) -> TCM (Interface, MaybeWarnings) Source
If the module has already been visited (without warnings), then its interface is returned directly. Otherwise the computation is used to find the interface and the computed interface is stored for potential later use.
typeCheckMain :: AbsolutePath -> TCM (Interface, MaybeWarnings) Source
Type checks the main file of the interaction. This could be the file loaded in the interacting editor (emacs), or the file passed on the command line.
First, the primitive modules are imported.
Then, getInterface'
is called to do the main work.
getInterface :: ModuleName -> TCM Interface Source
Tries to return the interface associated to the given (imported) module. The time stamp of the relevant interface file is also returned. Calls itself recursively for the imports of the given module. May type check the module. An error is raised if a warning is encountered.
Do not use this for the main file, use typeCheckMain
instead.
:: TopLevelModuleName | |
-> MainInterface | If type checking is necessary,
should all state changes inflicted by |
-> TCM (Interface, MaybeWarnings) |
A more precise variant of getInterface
. If warnings are
encountered then they are returned instead of being turned into
errors.
:: Interface | |
-> AbsolutePath | The corresponding file. |
-> TCM () |
Print the highlighting information contained in the given interface.
writeInterface :: FilePath -> Interface -> TCM () Source
Writes the given interface to the given file. Returns the file's
new modification time stamp, or Nothing
if the write failed.
:: AbsolutePath | The file to type check. |
-> TopLevelModuleName | The expected module name. |
-> TCM (Interface, MaybeWarnings) |
Tries to type check a module and write out its interface. The function only writes out an interface file if it does not encounter any warnings.
If appropriate this function writes out syntax highlighting information.
:: AbsolutePath | |
-> TopLevelInfo |
|
-> HighlightingInfo | Syntax highlighting info for the module. |
-> Set String | Haskell modules imported in imported modules (transitively). |
-> [OptionsPragma] | Options set in |
-> TCM Interface |
Builds an interface for the current module, which should already have been successfully type checked.
getInterfaceFileHashes :: FilePath -> TCM (Maybe (Hash, Hash)) Source
Returns (iSourceHash, iFullHash)
moduleHash :: ModuleName -> TCM Hash Source