| Copyright | (c) 2013-2016 Galois, Inc. |
|---|---|
| License | BSD3 |
| Maintainer | cryptol@galois.com |
| Stability | provisional |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell98 |
Cryptol.ModuleSystem
Contents
Description
- data ModuleEnv = ModuleEnv {}
- initialModuleEnv :: IO ModuleEnv
- data DynamicEnv = DEnv {}
- data ModuleError
- = ModuleNotFound ModName [FilePath]
- | CantFindFile FilePath
- | OtherIOError FilePath IOException
- | ModuleParseError FilePath ParseError
- | RecursiveModules [ImportSource]
- | RenamerErrors ImportSource [RenamerError]
- | NoPatErrors ImportSource [Error]
- | NoIncludeErrors ImportSource [IncludeError]
- | TypeCheckingFailed ImportSource [(Range, Error)]
- | OtherFailure String
- | ModuleNameMismatch ModName (Located ModName)
- | DuplicateModuleName ModName FilePath FilePath
- data ModuleWarning
- type ModuleCmd a = ModuleEnv -> IO (ModuleRes a)
- type ModuleRes a = (Either ModuleError (a, ModuleEnv), [ModuleWarning])
- findModule :: ModName -> ModuleCmd FilePath
- loadModuleByPath :: FilePath -> ModuleCmd Module
- loadModule :: FilePath -> Module PName -> ModuleCmd Module
- checkExpr :: Expr PName -> ModuleCmd (Expr Name, Expr, Schema)
- evalExpr :: Expr -> ModuleCmd Value
- checkDecls :: [TopDecl PName] -> ModuleCmd (NamingEnv, [DeclGroup])
- evalDecls :: [DeclGroup] -> ModuleCmd ()
- noPat :: RemovePatterns a => a -> ModuleCmd a
- focusedEnv :: ModuleEnv -> (IfaceDecls, NamingEnv, NameDisp)
- getPrimMap :: ModuleCmd PrimMap
- renameVar :: NamingEnv -> PName -> ModuleCmd Name
- renameType :: NamingEnv -> PName -> ModuleCmd Name
- data Iface = Iface {}
- data IfaceDecls = IfaceDecls {}
- genIface :: Module -> Iface
- type IfaceTySyn = TySyn
- data IfaceDecl = IfaceDecl {
- ifDeclName :: !Name
- ifDeclSig :: Schema
- ifDeclPragmas :: [Pragma]
- ifDeclInfix :: Bool
- ifDeclFixity :: Maybe Fixity
- ifDeclDoc :: Maybe String
Module System
Constructors
| ModuleEnv | |
Fields
| |
data DynamicEnv Source #
Extra information we need to carry around to dynamically extend
an environment outside the context of a single module. Particularly
useful when dealing with interactive declarations as in :let or
it.
Instances
data ModuleError Source #
Constructors
| ModuleNotFound ModName [FilePath] | Unable to find the module given, tried looking in these paths |
| CantFindFile FilePath | Unable to open a file |
| OtherIOError FilePath IOException | Some other IO error occurred while reading this file |
| ModuleParseError FilePath ParseError | Generated this parse error when parsing the file for module m |
| RecursiveModules [ImportSource] | Recursive module group discovered |
| RenamerErrors ImportSource [RenamerError] | Problems during the renaming phase |
| NoPatErrors ImportSource [Error] | Problems during the NoPat phase |
| NoIncludeErrors ImportSource [IncludeError] | Problems during the NoInclude phase |
| TypeCheckingFailed ImportSource [(Range, Error)] | Problems during type checking |
| OtherFailure String | Problems after type checking, eg. specialization |
| ModuleNameMismatch ModName (Located ModName) | Module loaded by 'import' statement has the wrong module name |
| DuplicateModuleName ModName FilePath FilePath | Two modules loaded from different files have the same module name |
Instances
data ModuleWarning Source #
Constructors
| TypeCheckWarnings [(Range, Warning)] | |
| RenamerWarnings [RenamerWarning] |
Instances
type ModuleRes a = (Either ModuleError (a, ModuleEnv), [ModuleWarning]) Source #
findModule :: ModName -> ModuleCmd FilePath Source #
Find the file associated with a module name in the module search path.
loadModuleByPath :: FilePath -> ModuleCmd Module Source #
Load the module contained in the given file.
checkExpr :: Expr PName -> ModuleCmd (Expr Name, Expr, Schema) Source #
Check the type of an expression. Give back the renamed expression, the core expression, and its type schema.
checkDecls :: [TopDecl PName] -> ModuleCmd (NamingEnv, [DeclGroup]) Source #
Typecheck top-level declarations.
evalDecls :: [DeclGroup] -> ModuleCmd () Source #
Evaluate declarations and add them to the extended environment.
noPat :: RemovePatterns a => a -> ModuleCmd a Source #
focusedEnv :: ModuleEnv -> (IfaceDecls, NamingEnv, NameDisp) Source #
Produce an ifaceDecls that represents the focused environment of the module
system, as well as a NameDisp for pretty-printing names according to the
imports.
XXX This could really do with some better error handling, just returning mempty when one of the imports fails isn't really desirable.
Interfaces
The resulting interface generated by a module that has been typechecked.
Constructors
| Iface | |
Fields
| |
data IfaceDecls Source #
Constructors
| IfaceDecls | |
Fields
| |
Instances
type IfaceTySyn = TySyn Source #
Constructors
| IfaceDecl | |
Fields
| |