Copyright	(c) 2013-2016 Galois, Inc.
License	BSD3
Maintainer	cryptol@galois.com
Stability	provisional
Portability	portable
Safe Haskell	None
Language	Haskell98

Cryptol.ModuleSystem

Contents

Module System
Interfaces

Description

Synopsis

Module System

data ModuleEnv Source

Constructors

ModuleEnv
Fields meLoadedModules :: LoadedModules meNameSeeds :: NameSeeds meEvalEnv :: EvalEnv meFocusedModule :: Maybe ModName meSearchPath :: [FilePath] meDynEnv :: DynamicEnv meMonoBinds :: !Bool meSolverConfig :: SolverConfig meCoreLint :: CoreLint meSupply :: !Supply

Instances

Generic ModuleEnv Source
NFData ModuleEnv Source
type Rep ModuleEnv Source

initialModuleEnv :: IO ModuleEnv Source

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.

Constructors

DEnv
Fields deNames :: NamingEnv deDecls :: [DeclGroup] deEnv :: EvalEnv

Instances

Generic DynamicEnv Source
Monoid DynamicEnv Source
NFData DynamicEnv Source
type Rep DynamicEnv Source

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

Show ModuleError Source
NFData ModuleError Source
PP ModuleError Source

data ModuleWarning Source

Constructors

TypeCheckWarnings [(Range, Warning)]
RenamerWarnings [RenamerWarning]

Instances

Show ModuleWarning Source
Generic ModuleWarning Source
NFData ModuleWarning Source
PP ModuleWarning Source
type Rep ModuleWarning Source

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

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.

loadModule :: FilePath -> Module PName -> ModuleCmd Module Source

Load the given parsed module.

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.

evalExpr :: Expr -> ModuleCmd Value Source

Evaluate an expression.

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.

getPrimMap :: ModuleCmd PrimMap Source

renameVar :: NamingEnv -> PName -> ModuleCmd Name Source

renameType :: NamingEnv -> PName -> ModuleCmd Name Source

Interfaces

data Iface Source

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

Constructors

Iface
Fields ifModName :: !ModName ifPublic :: IfaceDecls ifPrivate :: IfaceDecls

Instances

Show Iface Source
Generic Iface Source
NFData Iface Source
type Rep Iface Source

data IfaceDecls Source

Constructors

IfaceDecls
Fields ifTySyns :: Map Name IfaceTySyn ifNewtypes :: Map Name IfaceNewtype ifDecls :: Map Name IfaceDecl

Instances

Show IfaceDecls Source
Generic IfaceDecls Source
Monoid IfaceDecls Source
NFData IfaceDecls Source
type Rep IfaceDecls Source

genIface :: Module -> Iface Source

Generate an Iface from a typechecked module.

type IfaceTySyn = TySyn Source

data IfaceDecl Source

Constructors

IfaceDecl
Fields ifDeclName :: !Name ifDeclSig :: Schema ifDeclPragmas :: [Pragma] ifDeclInfix :: Bool ifDeclFixity :: Maybe Fixity ifDeclDoc :: Maybe String

Instances

Show IfaceDecl Source
Generic IfaceDecl Source
NFData IfaceDecl Source
type Rep IfaceDecl Source