Cryptol.ModuleSystem.Renamer.Monad

Documentation

data NameType

Indicates if a name is in a binding poisition or a use site

Constructors

NameBind

NameUse

data RenamerInfo

Information needed to do some renaming.

Constructors

RenamerInfo

Fields

• renSupply :: Supply

  Use to make new names

• renContext :: ModPath

  We are renaming things in here

• renEnv :: NamingEnv

  This is what's in scope

• renIfaces :: ModName -> Iface

newtype RenameM a

Constructors

RenameM

Fields

• unRenameM :: ReaderT RO (StateT RW Lift) a

Instances

Monad RenameM

Defined in Cryptol.ModuleSystem.Renamer.Monad

Methods

(>>=) :: RenameM a -> (a -> RenameM b) -> RenameM b

(>>) :: RenameM a -> RenameM b -> RenameM b

return :: a -> RenameM a

Functor RenameM

Defined in Cryptol.ModuleSystem.Renamer.Monad

Methods

fmap :: (a -> b) -> RenameM a -> RenameM b

(<$) :: a -> RenameM b -> RenameM a

Applicative RenameM

Defined in Cryptol.ModuleSystem.Renamer.Monad

Methods

pure :: a -> RenameM a

(<*>) :: RenameM (a -> b) -> RenameM a -> RenameM b

liftA2 :: (a -> b -> c) -> RenameM a -> RenameM b -> RenameM c

(*>) :: RenameM a -> RenameM b -> RenameM b

(<*) :: RenameM a -> RenameM b -> RenameM a

FreshM RenameM

Defined in Cryptol.ModuleSystem.Renamer.Monad

Methods

liftSupply :: (Supply -> (a, Supply)) -> RenameM a

Semigroup a => Semigroup (RenameM a)

Defined in Cryptol.ModuleSystem.Renamer.Monad

Methods

(<>) :: RenameM a -> RenameM a -> RenameM a

sconcat :: NonEmpty (RenameM a) -> RenameM a

stimes :: Integral b => b -> RenameM a -> RenameM a

(Semigroup a, Monoid a) => Monoid (RenameM a)

Defined in Cryptol.ModuleSystem.Renamer.Monad

Methods

mempty :: RenameM a

mappend :: RenameM a -> RenameM a -> RenameM a

mconcat :: [RenameM a] -> RenameM a

data RO

Constructors

RO

Fields

• roLoc :: Range
• roNames :: NamingEnv
• roIfaces :: ModName -> Iface
• roCurMod :: ModPath

  Current module we are working on

• roNestedMods :: Map ModPath Name

data RW

Constructors

RW

Fields

• rwWarnings :: ![RenamerWarning]
• rwErrors :: !(Seq RenamerError)
• rwSupply :: !Supply
• rwNameUseCount :: !(Map Name Int)

  How many times did we refer to each name. Used to generate warnings for unused definitions.

• rwCurrentDeps :: Set Name

  keeps track of names *used* by something. see depsOf

• rwDepGraph :: Map DepName (Set Name)

  keeps track of the dependencies for things. see depsOf

• rwExternalDeps :: !IfaceDecls

  Info about imported things

runRenamer :: RenamerInfo -> RenameM a -> (Either [RenamerError] (a, Supply), [RenamerWarning])

setCurMod :: ModPath -> RenameM a -> RenameM a

getCurMod :: RenameM ModPath

getNamingEnv :: RenameM NamingEnv

setNestedModule :: Map ModPath Name -> RenameM a -> RenameM a

nestedModuleOrig :: ModPath -> RenameM (Maybe Name)

record :: RenamerError -> RenameM ()

Record an error. XXX: use a better name

collectIfaceDeps :: RenameM a -> RenameM (IfaceDecls, a)

depsOf :: DepName -> RenameM a -> RenameM a

Rename something. All name uses in the sub-computation are assumed to be dependenices of the thing.

depGroup :: RenameM a -> RenameM (a, Map DepName (Set Name))

This is used when renaming a group of things. The result contains dependencies between names defines and the group, and is intended to be used to order the group members in dependency order.

curLoc :: RenameM Range

Get the source range for wahtever we are currently renaming.

located :: a -> RenameM (Located a)

Annotate something with the current range.

withLoc :: HasLoc loc => loc -> RenameM a -> RenameM a

Do the given computation using the source code range from loc if any.

shadowNames :: BindsNames env => env -> RenameM a -> RenameM a

Shadow the current naming environment with some more names.

data EnvCheck

Constructors

CheckAll

Check for overlap and shadowing

CheckOverlap

Only check for overlap

CheckNone

Don't check the environment

Instances

Eq EnvCheck

Defined in Cryptol.ModuleSystem.Renamer.Monad

Methods

(==) :: EnvCheck -> EnvCheck -> Bool

(/=) :: EnvCheck -> EnvCheck -> Bool

Show EnvCheck

Defined in Cryptol.ModuleSystem.Renamer.Monad

Methods

showsPrec :: Int -> EnvCheck -> ShowS

show :: EnvCheck -> String

showList :: [EnvCheck] -> ShowS

shadowNames' :: BindsNames env => EnvCheck -> env -> RenameM a -> RenameM a

Shadow the current naming environment with some more names.

checkEnv :: EnvCheck -> NamingEnv -> NamingEnv -> RW -> (NamingEnv, RW)

Generate warnings when the left environment shadows things defined in the right. Additionally, generate errors when two names overlap in the left environment.

containsOverlap :: [Name] -> Seq RenamerError

Check the RHS of a single name rewrite for conflicting sources.

recordUse :: Name -> RenameM ()

addDep :: Name -> RenameM ()

Mark something as a dependency. This is similar but different from recordUse, in particular: * We only record use sites, not bindings * We record all namespaces, not just types * We only keep track of actual uses mentioned in the code. Otoh, recordUse also considers exported entities to be used. * If we depend on a name from a sibling submodule we add a dependency on the module in our common ancestor. Examples: - A::B::x depends on A::B::C::D::y, x depends on A::B::C - A::B::x depends on A::P::Q::y, x depends on A::P@

warnUnused :: ModPath -> NamingEnv -> RW -> [RenamerWarning]

lookupImport :: Import -> RenameM IfaceDecls

Get the exported declarations in a module