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

Cryptol.ModuleSystem.Name

Contents

Names

Description

Synopsis

Names

data Name Source

Instances

Eq Name Source
Ord Name Source
Show Name Source
Generic Name Source
NFData Name Source
PPName Name Source
PP Name Source
FromDecl (Decl Name) Source
FromDecl (TopDecl Name) Source
type Rep Name Source

data NameInfo Source

Information about the binding site of the name.

Constructors

Declared !ModName	This name refers to a declaration from this module
Parameter	This name is a parameter (function or type)

Instances

Eq NameInfo Source
Show NameInfo Source
Generic NameInfo Source
NFData NameInfo Source
type Rep NameInfo Source

nameUnique :: Name -> Int Source

nameIdent :: Name -> Ident Source

nameInfo :: Name -> NameInfo Source

nameLoc :: Name -> Range Source

asPrim :: Name -> Maybe Ident Source

cmpNameLexical :: Name -> Name -> Ordering Source

Compare two names lexically.

cmpNameDisplay :: NameDisp -> Name -> Name -> Ordering Source

Compare two names by the way they would be displayed.

ppLocName :: Name -> Doc Source

Pretty-print a name with its source location information.

Creation

mkDeclared :: ModName -> Ident -> Range -> Supply -> (Name, Supply) Source

Make a new name for a declaration.

mkParameter :: Ident -> Range -> Supply -> (Name, Supply) Source

Make a new parameter name.

Unique Supply

class Monad m => FreshM m where Source

Methods

liftSupply :: (Supply -> (a, Supply)) -> m a Source

Instances

FreshM SupplyM Source
FreshM InferM Source
FreshM REPL Source
Monad m => FreshM (SupplyT m) Source
Monad m => FreshM (ModuleT m) Source
FreshM m => FreshM (ReaderT i m) Source
(Monoid i, FreshM m) => FreshM (WriterT i m) Source
FreshM m => FreshM (StateT i m) Source
FreshM m => FreshM (ExceptionT i m) Source

nextUniqueM :: FreshM m => m Int Source

Retrieve the next unique from the supply.

data SupplyT m a Source

A monad for easing the use of the supply.

Instances

MonadT SupplyT Source
Monad m => Monad (SupplyT m) Source
Monad m => Functor (SupplyT m) Source
MonadFix m => MonadFix (SupplyT m) Source
Monad m => Applicative (SupplyT m) Source
Monad m => FreshM (SupplyT m) Source
BaseM m n => BaseM (SupplyT m) n Source
RunM m (a, Supply) r => RunM (SupplyT m) a (Supply -> r) Source

runSupplyT :: Monad m => Supply -> SupplyT m a -> m (a, Supply) Source

data SupplyM a Source

Instances

Monad SupplyM Source
Functor SupplyM Source
MonadFix SupplyM Source
Applicative SupplyM Source
FreshM SupplyM Source
BaseM SupplyM SupplyM Source
RunM SupplyM a (Supply -> (a, Supply)) Source
Monoid a => Monoid (SupplyM a) Source

runSupplyM :: Supply -> SupplyM a -> (a, Supply) Source

data Supply Source

Instances

Show Supply Source
Generic Supply Source
NFData Supply Source
RunM SupplyM a (Supply -> (a, Supply)) Source
RunM m (a, Supply) r => RunM (SupplyT m) a (Supply -> r) Source
type Rep Supply Source

emptySupply :: Supply Source

This should only be used once at library initialization, and threaded through the rest of the session. The supply is started at 0x1000 to leave us plenty of room for names that the compiler needs to know about (wired-in constants).

nextUnique :: Supply -> (Int, Supply) Source

PrimMap

data PrimMap Source

A mapping from an identifier defined in some module to its real name.

Constructors

PrimMap
Fields primDecls :: Map Ident Name primTypes :: Map Ident Name

Instances

Show PrimMap Source
Generic PrimMap Source
NFData PrimMap Source
type Rep PrimMap Source

lookupPrimDecl :: Ident -> PrimMap -> Name Source

It's assumed that we're looking things up that we know already exist, so this will panic if it doesn't find the name.

lookupPrimType :: Ident -> PrimMap -> Name Source

It's assumed that we're looking things up that we know already exist, so this will panic if it doesn't find the name.