Cryptol.ModuleSystem

Module System

data ModuleEnv

Constructors

ModuleEnv

Fields

meLoadedModules :: LoadedModules

meNameSeeds :: NameSeeds

meEvalEnv :: EvalEnv

meFocusedModule :: Maybe ModName

meSearchPath :: [FilePath]

meDynEnv :: DynamicEnv

meMonoBinds :: !Bool

initialModuleEnv :: IO ModuleEnv

data DynamicEnv

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.

Constructors

DEnv

Fields

deNames :: NamingEnv

deDecls :: [DeclGroup]

deEnv :: EvalEnv

Instances

Monoid DynamicEnv

data ModuleError

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

Show ModuleError

PP ModuleError

data ModuleWarning

Constructors

TypeCheckWarnings [(Range, Warning)]

RenamerWarnings [RenamerWarning]

Instances

Show ModuleWarning

PP ModuleWarning

type ModuleCmd a = ModuleEnv -> IO (ModuleRes a)

type ModuleRes a = (Either ModuleError (a, ModuleEnv), [ModuleWarning])

findModule :: ModName -> ModuleCmd FilePath

Find the file associated with a module name in the module search path.

loadModuleByPath :: FilePath -> ModuleCmd Module

Load the module contained in the given file.

loadModule :: FilePath -> Module -> ModuleCmd Module

Load the given parsed module.

checkExpr :: Expr -> ModuleCmd (Expr, Schema)

Check the type of an expression.

evalExpr :: Expr -> ModuleCmd Value

Evaluate an expression.

checkDecls :: (HasLoc d, Rename d, FromDecl d) => [d] -> ModuleCmd [DeclGroup]

Typecheck declarations.

evalDecls :: [DeclGroup] -> ModuleCmd ()

Evaluate declarations and add them to the extended environment.

noPat :: RemovePatterns a => a -> ModuleCmd a

focusedEnv :: ModuleEnv -> IfaceDecls

Produce an ifaceDecls that represents the focused environment of the module system.

This could really do with some better error handling, just returning mempty when one of the imports fails isn't really desirable.

Interfaces

data Iface

The resulting interface generated by a module that has been typechecked.

Constructors

Iface

Fields

ifModName :: ModName

ifPublic :: IfaceDecls

ifPrivate :: IfaceDecls

Instances

Show Iface

BindsNames Iface

Produce a naming environment from an interface file, that contains a mapping only from unqualified names to qualified ones.

data IfaceDecls

Constructors

IfaceDecls

Fields

ifTySyns :: Map QName [IfaceTySyn]

ifNewtypes :: Map QName [IfaceNewtype]

ifDecls :: Map QName [IfaceDecl]

Instances

Show IfaceDecls

Monoid IfaceDecls

BindsNames IfaceDecls

Translate a set of declarations from an interface into a naming environment.

genIface :: Module -> Iface

Generate an Iface from a typechecked module.

type IfaceTySyn = TySyn

data IfaceDecl

Constructors

IfaceDecl

Fields

ifDeclName :: QName

ifDeclSig :: Schema

ifDeclPragmas :: [Pragma]

Instances

Show IfaceDecl