Module

The ModuleName type

data ModuleName

A ModuleName is essentially a simple string, e.g. Data.List.

Instances

Eq ModuleName

Defined in Module

Methods

(==) :: ModuleName -> ModuleName -> Bool

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

Data ModuleName

Defined in Module

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModuleName -> c ModuleName

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModuleName

toConstr :: ModuleName -> Constr

dataTypeOf :: ModuleName -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModuleName)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModuleName)

gmapT :: (forall b. Data b => b -> b) -> ModuleName -> ModuleName

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModuleName -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModuleName -> r

gmapQ :: (forall d. Data d => d -> u) -> ModuleName -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModuleName -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName

Ord ModuleName

Defined in Module

Methods

compare :: ModuleName -> ModuleName -> Ordering

(<) :: ModuleName -> ModuleName -> Bool

(<=) :: ModuleName -> ModuleName -> Bool

(>) :: ModuleName -> ModuleName -> Bool

(>=) :: ModuleName -> ModuleName -> Bool

max :: ModuleName -> ModuleName -> ModuleName

min :: ModuleName -> ModuleName -> ModuleName

NFData ModuleName

Defined in Module

Methods

rnf :: ModuleName -> ()

BinaryStringRep ModuleName

Defined in Module

Methods

fromStringRep :: ByteString -> ModuleName

toStringRep :: ModuleName -> ByteString

Outputable ModuleName

Defined in Module

Methods

ppr :: ModuleName -> SDoc

pprPrec :: Rational -> ModuleName -> SDoc

Uniquable ModuleName

Defined in Module

Methods

getUnique :: ModuleName -> Unique

Binary ModuleName

Defined in Module

Methods

put_ :: BinHandle -> ModuleName -> IO ()

put :: BinHandle -> ModuleName -> IO (Bin ModuleName)

get :: BinHandle -> IO ModuleName

DbUnitIdModuleRep InstalledUnitId ComponentId UnitId ModuleName Module

Defined in Module

Methods

fromDbModule :: DbModule InstalledUnitId ComponentId UnitId ModuleName Module -> Module

toDbModule :: Module -> DbModule InstalledUnitId ComponentId UnitId ModuleName Module

fromDbUnitId :: DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module -> UnitId

toDbUnitId :: UnitId -> DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module

pprModuleName :: ModuleName -> SDoc

moduleNameFS :: ModuleName -> FastString

moduleNameString :: ModuleName -> String

moduleNameSlashes :: ModuleName -> String

Returns the string version of the module name, with dots replaced by slashes.

moduleNameColons :: ModuleName -> String

Returns the string version of the module name, with dots replaced by colons.

moduleStableString :: Module -> String

Get a string representation of a Module that's unique and stable across recompilations. eg. "$aeson_70dylHtv1FFGeai1IoxcQr$Data.Aeson.Types.Internal"

moduleFreeHoles :: Module -> UniqDSet ModuleName

Calculate the free holes of a Module. If this set is non-empty, this module was defined in an indefinite library that had required signatures.

If a module has free holes, that means that substitutions can operate on it; if it has no free holes, substituting over a module has no effect.

moduleIsDefinite :: Module -> Bool

A Module is definite if it has no free holes.

mkModuleName :: String -> ModuleName

mkModuleNameFS :: FastString -> ModuleName

stableModuleNameCmp :: ModuleName -> ModuleName -> Ordering

Compares module names lexically, rather than by their Uniques

The UnitId type

newtype ComponentId

A ComponentId consists of the package name, package version, component ID, the transitive dependencies of the component, and other information to uniquely identify the source code and build configuration of a component.

This used to be known as an InstalledPackageId, but a package can contain multiple components and a ComponentId uniquely identifies a component within a package. When a package only has one component, the ComponentId coincides with the InstalledPackageId

Constructors

ComponentId FastString

Instances

Eq ComponentId

Defined in Module

Methods

(==) :: ComponentId -> ComponentId -> Bool

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

Ord ComponentId

Defined in Module

Methods

compare :: ComponentId -> ComponentId -> Ordering

(<) :: ComponentId -> ComponentId -> Bool

(<=) :: ComponentId -> ComponentId -> Bool

(>) :: ComponentId -> ComponentId -> Bool

(>=) :: ComponentId -> ComponentId -> Bool

max :: ComponentId -> ComponentId -> ComponentId

min :: ComponentId -> ComponentId -> ComponentId

BinaryStringRep ComponentId

Defined in Module

Methods

fromStringRep :: ByteString -> ComponentId

toStringRep :: ComponentId -> ByteString

Outputable ComponentId

Defined in Module

Methods

ppr :: ComponentId -> SDoc

pprPrec :: Rational -> ComponentId -> SDoc

Uniquable ComponentId

Defined in Module

Methods

getUnique :: ComponentId -> Unique

Binary ComponentId

Defined in Module

Methods

put_ :: BinHandle -> ComponentId -> IO ()

put :: BinHandle -> ComponentId -> IO (Bin ComponentId)

get :: BinHandle -> IO ComponentId

DbUnitIdModuleRep InstalledUnitId ComponentId UnitId ModuleName Module

Defined in Module

Methods

fromDbModule :: DbModule InstalledUnitId ComponentId UnitId ModuleName Module -> Module

toDbModule :: Module -> DbModule InstalledUnitId ComponentId UnitId ModuleName Module

fromDbUnitId :: DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module -> UnitId

toDbUnitId :: UnitId -> DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module

data UnitId

A unit identifier identifies a (possibly partially) instantiated library. It is primarily used as part of Module, which in turn is used in Name, which is used to give names to entities when typechecking.

There are two possible forms for a UnitId. It can be a DefiniteUnitId, in which case we just have a string that uniquely identifies some fully compiled, installed library we have on disk. However, when we are typechecking a library with missing holes, we may need to instantiate a library on the fly (in which case we don't have any on-disk representation.) In that case, you have an IndefiniteUnitId, which explicitly records the instantiation, so that we can substitute over it.

Constructors

IndefiniteUnitId !IndefUnitId

DefiniteUnitId !DefUnitId

Instances

Eq UnitId

Defined in Module

Methods

(==) :: UnitId -> UnitId -> Bool

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

Data UnitId

Defined in Module

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UnitId -> c UnitId

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UnitId

toConstr :: UnitId -> Constr

dataTypeOf :: UnitId -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UnitId)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UnitId)

gmapT :: (forall b. Data b => b -> b) -> UnitId -> UnitId

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UnitId -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UnitId -> r

gmapQ :: (forall d. Data d => d -> u) -> UnitId -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UnitId -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UnitId -> m UnitId

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UnitId -> m UnitId

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UnitId -> m UnitId

Ord UnitId

Defined in Module

Methods

compare :: UnitId -> UnitId -> Ordering

(<) :: UnitId -> UnitId -> Bool

(<=) :: UnitId -> UnitId -> Bool

(>) :: UnitId -> UnitId -> Bool

(>=) :: UnitId -> UnitId -> Bool

max :: UnitId -> UnitId -> UnitId

min :: UnitId -> UnitId -> UnitId

Show UnitId

Defined in Module

Methods

showsPrec :: Int -> UnitId -> ShowS

show :: UnitId -> String

showList :: [UnitId] -> ShowS

NFData UnitId

Defined in Module

Methods

rnf :: UnitId -> ()

Outputable UnitId

Defined in Module

Methods

ppr :: UnitId -> SDoc

pprPrec :: Rational -> UnitId -> SDoc

Uniquable UnitId

Defined in Module

Methods

getUnique :: UnitId -> Unique

Binary UnitId

Defined in Module

Methods

put_ :: BinHandle -> UnitId -> IO ()

put :: BinHandle -> UnitId -> IO (Bin UnitId)

get :: BinHandle -> IO UnitId

DbUnitIdModuleRep InstalledUnitId ComponentId UnitId ModuleName Module

Defined in Module

Methods

fromDbModule :: DbModule InstalledUnitId ComponentId UnitId ModuleName Module -> Module

toDbModule :: Module -> DbModule InstalledUnitId ComponentId UnitId ModuleName Module

fromDbUnitId :: DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module -> UnitId

toDbUnitId :: UnitId -> DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module

unitIdFS :: UnitId -> FastString

unitIdKey :: UnitId -> Unique

data IndefUnitId

A unit identifier which identifies an indefinite library (with holes) that has been *on-the-fly* instantiated with a substitution indefUnitIdInsts. In fact, an indefinite unit identifier could have no holes, but we haven't gotten around to compiling the actual library yet.

An indefinite unit identifier pretty-prints to something like p[H=H,A=aimpl:A>] (p is the ComponentId, and the brackets enclose the module substitution).

Constructors

IndefUnitId

Fields

• indefUnitIdFS :: FastString

  A private, uniquely identifying representation of a UnitId. This string is completely private to GHC and is just used to get a unique; in particular, we don't use it for symbols (indefinite libraries are not compiled).

• indefUnitIdKey :: Unique

  Cached unique of unitIdFS.

• indefUnitIdComponentId :: !ComponentId

  The component identity of the indefinite library that is being instantiated.

• indefUnitIdInsts :: ![(ModuleName, Module)]

  The sorted (by ModuleName) instantiations of this library.

• indefUnitIdFreeHoles :: UniqDSet ModuleName

  A cache of the free module variables of unitIdInsts. This lets us efficiently tell if a UnitId has been fully instantiated (free module variables are empty) and whether or not a substitution can have any effect.

Instances

Eq IndefUnitId

Defined in Module

Methods

(==) :: IndefUnitId -> IndefUnitId -> Bool

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

Ord IndefUnitId

Defined in Module

Methods

compare :: IndefUnitId -> IndefUnitId -> Ordering

(<) :: IndefUnitId -> IndefUnitId -> Bool

(<=) :: IndefUnitId -> IndefUnitId -> Bool

(>) :: IndefUnitId -> IndefUnitId -> Bool

(>=) :: IndefUnitId -> IndefUnitId -> Bool

max :: IndefUnitId -> IndefUnitId -> IndefUnitId

min :: IndefUnitId -> IndefUnitId -> IndefUnitId

Outputable IndefUnitId

Defined in Module

Methods

ppr :: IndefUnitId -> SDoc

pprPrec :: Rational -> IndefUnitId -> SDoc

Binary IndefUnitId

Defined in Module

Methods

put_ :: BinHandle -> IndefUnitId -> IO ()

put :: BinHandle -> IndefUnitId -> IO (Bin IndefUnitId)

get :: BinHandle -> IO IndefUnitId

data IndefModule

Constructors

IndefModule

Fields

• indefModuleUnitId :: IndefUnitId
• indefModuleName :: ModuleName

Instances

Eq IndefModule

Defined in Module

Methods

(==) :: IndefModule -> IndefModule -> Bool

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

Ord IndefModule

Defined in Module

Methods

compare :: IndefModule -> IndefModule -> Ordering

(<) :: IndefModule -> IndefModule -> Bool

(<=) :: IndefModule -> IndefModule -> Bool

(>) :: IndefModule -> IndefModule -> Bool

(>=) :: IndefModule -> IndefModule -> Bool

max :: IndefModule -> IndefModule -> IndefModule

min :: IndefModule -> IndefModule -> IndefModule

Outputable IndefModule

Defined in Module

Methods

ppr :: IndefModule -> SDoc

pprPrec :: Rational -> IndefModule -> SDoc

indefUnitIdToUnitId :: DynFlags -> IndefUnitId -> UnitId

Injects an IndefUnitId (indefinite library which was on-the-fly instantiated) to a UnitId (either an indefinite or definite library).

indefModuleToModule :: DynFlags -> IndefModule -> Module

Injects an IndefModule to Module (see also indefUnitIdToUnitId.

newtype InstalledUnitId

An installed unit identifier identifies a library which has been installed to the package database. These strings are provided to us via the -this-unit-id flag. The library in question may be definite or indefinite; if it is indefinite, none of the holes have been filled (we never install partially instantiated libraries.) Put another way, an installed unit id is either fully instantiated, or not instantiated at all.

Installed unit identifiers look something like p+af23SAj2dZ219, or maybe just p if they don't use Backpack.

Constructors

InstalledUnitId

Fields

• installedUnitIdFS :: FastString

  The full hashed unit identifier, including the component id and the hash.

Instances

Eq InstalledUnitId

Defined in Module

Methods

(==) :: InstalledUnitId -> InstalledUnitId -> Bool

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

Ord InstalledUnitId

Defined in Module

Methods

compare :: InstalledUnitId -> InstalledUnitId -> Ordering

(<) :: InstalledUnitId -> InstalledUnitId -> Bool

(<=) :: InstalledUnitId -> InstalledUnitId -> Bool

(>) :: InstalledUnitId -> InstalledUnitId -> Bool

(>=) :: InstalledUnitId -> InstalledUnitId -> Bool

max :: InstalledUnitId -> InstalledUnitId -> InstalledUnitId

min :: InstalledUnitId -> InstalledUnitId -> InstalledUnitId

BinaryStringRep InstalledUnitId

Defined in Module

Methods

fromStringRep :: ByteString -> InstalledUnitId

toStringRep :: InstalledUnitId -> ByteString

Outputable InstalledUnitId

Defined in Module

Methods

ppr :: InstalledUnitId -> SDoc

pprPrec :: Rational -> InstalledUnitId -> SDoc

Uniquable InstalledUnitId

Defined in Module

Methods

getUnique :: InstalledUnitId -> Unique

Binary InstalledUnitId

Defined in Module

Methods

put_ :: BinHandle -> InstalledUnitId -> IO ()

put :: BinHandle -> InstalledUnitId -> IO (Bin InstalledUnitId)

get :: BinHandle -> IO InstalledUnitId

DbUnitIdModuleRep InstalledUnitId ComponentId UnitId ModuleName Module

Defined in Module

Methods

fromDbModule :: DbModule InstalledUnitId ComponentId UnitId ModuleName Module -> Module

toDbModule :: Module -> DbModule InstalledUnitId ComponentId UnitId ModuleName Module

fromDbUnitId :: DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module -> UnitId

toDbUnitId :: UnitId -> DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module

toInstalledUnitId :: UnitId -> InstalledUnitId

Lossy conversion to the on-disk InstalledUnitId for a component.

type ShHoleSubst = ModuleNameEnv Module

Substitution on module variables, mapping module names to module identifiers.

unitIdIsDefinite :: UnitId -> Bool

A UnitId is definite if it has no free holes.

unitIdString :: UnitId -> String

unitIdFreeHoles :: UnitId -> UniqDSet ModuleName

Retrieve the set of free holes of a UnitId.

newUnitId :: ComponentId -> [(ModuleName, Module)] -> UnitId

Create a new, un-hashed unit identifier.

newIndefUnitId :: ComponentId -> [(ModuleName, Module)] -> IndefUnitId

Create a new IndefUnitId given an explicit module substitution.

newSimpleUnitId :: ComponentId -> UnitId

Create a new simple unit identifier (no holes) from a ComponentId.

hashUnitId :: ComponentId -> [(ModuleName, Module)] -> FastString

Generate a uniquely identifying FastString for a unit identifier. This is a one-way function. You can rely on one special property: if a unit identifier is in most general form, its FastString coincides with its ComponentId. This hash is completely internal to GHC and is not used for symbol names or file paths.

fsToUnitId :: FastString -> UnitId

Create a new simple unit identifier from a FastString. Internally, this is primarily used to specify wired-in unit identifiers.

stringToUnitId :: String -> UnitId

stableUnitIdCmp :: UnitId -> UnitId -> Ordering

Compares package ids lexically, rather than by their Uniques

HOLE renaming

renameHoleUnitId :: DynFlags -> ShHoleSubst -> UnitId -> UnitId

Substitutes holes in a UnitId, suitable for renaming when an include occurs; see Note [Representation of module/name variable].

p[A=A] maps to p[A=B] with A=B.

renameHoleModule :: DynFlags -> ShHoleSubst -> Module -> Module

Substitutes holes in a Module. NOT suitable for being called directly on a nameModule, see Note [Representation of module/name variable]. p[A=A]:B maps to p[A=q():A]:B with A=q():A; similarly, A maps to q():A.

renameHoleUnitId' :: PackageConfigMap -> ShHoleSubst -> UnitId -> UnitId

Like 'renameHoleUnitId, but requires only PackageConfigMap so it can be used by Packages.

renameHoleModule' :: PackageConfigMap -> ShHoleSubst -> Module -> Module

Like renameHoleModule, but requires only PackageConfigMap so it can be used by Packages.

Generalization

splitModuleInsts :: Module -> (InstalledModule, Maybe IndefModule)

Given a possibly on-the-fly instantiated module, split it into a Module that we definitely can find on-disk, as well as an instantiation if we need to instantiate it on the fly. If the instantiation is Nothing no on-the-fly renaming is needed.

splitUnitIdInsts :: UnitId -> (InstalledUnitId, Maybe IndefUnitId)

See splitModuleInsts.

generalizeIndefUnitId :: IndefUnitId -> IndefUnitId

generalizeIndefModule :: IndefModule -> IndefModule

Parsers

parseModuleName :: ReadP ModuleName

parseUnitId :: ReadP UnitId

parseComponentId :: ReadP ComponentId

parseModuleId :: ReadP Module

parseModSubst :: ReadP [(ModuleName, Module)]

Wired-in UnitIds

Certain packages are known to the compiler, in that we know about certain entities that reside in these packages, and the compiler needs to declare static Modules and Names that refer to these packages. Hence the wired-in packages can't include version numbers, since we don't want to bake the version numbers of these packages into GHC.

So here's the plan. Wired-in packages are still versioned as normal in the packages database, and you can still have multiple versions of them installed. However, for each invocation of GHC, only a single instance of each wired-in package will be recognised (the desired one is selected via -package/-hide-package), and GHC will use the unversioned UnitId below when referring to it, including in .hi files and object file symbols. Unselected versions of wired-in packages will be ignored, as will any other package that depends directly or indirectly on it (much as if you had used -ignore-package).

primUnitId :: UnitId

integerUnitId :: UnitId

baseUnitId :: UnitId

rtsUnitId :: UnitId

thUnitId :: UnitId

mainUnitId :: UnitId

This is the package Id for the current program. It is the default package Id if you don't specify a package name. We don't add this prefix to symbol names, since there can be only one main package per program.

thisGhcUnitId :: UnitId

isHoleModule :: Module -> Bool

interactiveUnitId :: UnitId

isInteractiveModule :: Module -> Bool

wiredInUnitIds :: [UnitId]

The Module type

data Module

A Module is a pair of a UnitId and a ModuleName.

Module variables (i.e. H) which can be instantiated to a specific module at some later point in time are represented with moduleUnitId set to holeUnitId (this allows us to avoid having to make moduleUnitId a partial operation.)

Constructors

Module !UnitId !ModuleName

Instances

Eq Module

Defined in Module

Methods

(==) :: Module -> Module -> Bool

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

Data Module

Defined in Module

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Module -> c Module

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Module

toConstr :: Module -> Constr

dataTypeOf :: Module -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Module)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Module)

gmapT :: (forall b. Data b => b -> b) -> Module -> Module

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Module -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Module -> r

gmapQ :: (forall d. Data d => d -> u) -> Module -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Module -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Module -> m Module

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Module -> m Module

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Module -> m Module

Ord Module

Defined in Module

Methods

compare :: Module -> Module -> Ordering

(<) :: Module -> Module -> Bool

(<=) :: Module -> Module -> Bool

(>) :: Module -> Module -> Bool

(>=) :: Module -> Module -> Bool

max :: Module -> Module -> Module

min :: Module -> Module -> Module

NFData Module

Defined in Module

Methods

rnf :: Module -> ()

Outputable Module

Defined in Module

Methods

ppr :: Module -> SDoc

pprPrec :: Rational -> Module -> SDoc

Uniquable Module

Defined in Module

Methods

getUnique :: Module -> Unique

Binary Module

Defined in Module

Methods

put_ :: BinHandle -> Module -> IO ()

put :: BinHandle -> Module -> IO (Bin Module)

get :: BinHandle -> IO Module

DbUnitIdModuleRep InstalledUnitId ComponentId UnitId ModuleName Module

Defined in Module

Methods

fromDbModule :: DbModule InstalledUnitId ComponentId UnitId ModuleName Module -> Module

toDbModule :: Module -> DbModule InstalledUnitId ComponentId UnitId ModuleName Module

fromDbUnitId :: DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module -> UnitId

toDbUnitId :: UnitId -> DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module

moduleUnitId :: Module -> UnitId

moduleName :: Module -> ModuleName

pprModule :: Module -> SDoc

mkModule :: UnitId -> ModuleName -> Module

mkHoleModule :: ModuleName -> Module

Create a module variable at some ModuleName. See Note [Representation of module/name variables]

stableModuleCmp :: Module -> Module -> Ordering

This gives a stable ordering, as opposed to the Ord instance which gives an ordering based on the Uniques of the components, which may not be stable from run to run of the compiler.

class HasModule m where

Methods

getModule :: m Module

Instances

HasModule CoreM

Defined in CoreMonad

Methods

getModule :: CoreM Module

HasModule TcS

Defined in TcSMonad

Methods

getModule :: TcS Module

ContainsModule env => HasModule (IOEnv env)

Defined in IOEnv

Methods

getModule :: IOEnv env Module

class ContainsModule t where

Methods

extractModule :: t -> Module

Instances

ContainsModule TcGblEnv

Defined in TcRnTypes

Methods

extractModule :: TcGblEnv -> Module

ContainsModule DsGblEnv

Defined in TcRnTypes

Methods

extractModule :: DsGblEnv -> Module

ContainsModule gbl => ContainsModule (Env gbl lcl)

Defined in TcRnTypes

Methods

extractModule :: Env gbl lcl -> Module

Installed unit ids and modules

data InstalledModule

A InstalledModule is a Module which contains a InstalledUnitId.

Constructors

InstalledModule

Fields

• installedModuleUnitId :: !InstalledUnitId
• installedModuleName :: !ModuleName

Instances

Eq InstalledModule

Defined in Module

Methods

(==) :: InstalledModule -> InstalledModule -> Bool

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

Ord InstalledModule

Defined in Module

Methods

compare :: InstalledModule -> InstalledModule -> Ordering

(<) :: InstalledModule -> InstalledModule -> Bool

(<=) :: InstalledModule -> InstalledModule -> Bool

(>) :: InstalledModule -> InstalledModule -> Bool

(>=) :: InstalledModule -> InstalledModule -> Bool

max :: InstalledModule -> InstalledModule -> InstalledModule

min :: InstalledModule -> InstalledModule -> InstalledModule

Outputable InstalledModule

Defined in Module

Methods

ppr :: InstalledModule -> SDoc

pprPrec :: Rational -> InstalledModule -> SDoc

data InstalledModuleEnv elt

A map keyed off of InstalledModule

installedModuleEq :: InstalledModule -> Module -> Bool

Test if a Module corresponds to a given InstalledModule, modulo instantiation.

installedUnitIdEq :: InstalledUnitId -> UnitId -> Bool

Test if a UnitId corresponds to a given InstalledUnitId, modulo instantiation.

installedUnitIdString :: InstalledUnitId -> String

fsToInstalledUnitId :: FastString -> InstalledUnitId

componentIdToInstalledUnitId :: ComponentId -> InstalledUnitId

stringToInstalledUnitId :: String -> InstalledUnitId

emptyInstalledModuleEnv :: InstalledModuleEnv a

lookupInstalledModuleEnv :: InstalledModuleEnv a -> InstalledModule -> Maybe a

extendInstalledModuleEnv :: InstalledModuleEnv a -> InstalledModule -> a -> InstalledModuleEnv a

filterInstalledModuleEnv :: (InstalledModule -> a -> Bool) -> InstalledModuleEnv a -> InstalledModuleEnv a

delInstalledModuleEnv :: InstalledModuleEnv a -> InstalledModule -> InstalledModuleEnv a

newtype DefUnitId

A DefUnitId is an InstalledUnitId with the invariant that it only refers to a definite library; i.e., one we have generated code for.

Constructors

DefUnitId

Fields

• unDefUnitId :: InstalledUnitId

Instances

Eq DefUnitId

Defined in Module

Methods

(==) :: DefUnitId -> DefUnitId -> Bool

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

Ord DefUnitId

Defined in Module

Methods

compare :: DefUnitId -> DefUnitId -> Ordering

(<) :: DefUnitId -> DefUnitId -> Bool

(<=) :: DefUnitId -> DefUnitId -> Bool

(>) :: DefUnitId -> DefUnitId -> Bool

(>=) :: DefUnitId -> DefUnitId -> Bool

max :: DefUnitId -> DefUnitId -> DefUnitId

min :: DefUnitId -> DefUnitId -> DefUnitId

Outputable DefUnitId

Defined in Module

Methods

ppr :: DefUnitId -> SDoc

pprPrec :: Rational -> DefUnitId -> SDoc

Binary DefUnitId

Defined in Module

Methods

put_ :: BinHandle -> DefUnitId -> IO ()

put :: BinHandle -> DefUnitId -> IO (Bin DefUnitId)

get :: BinHandle -> IO DefUnitId

The ModuleLocation type

data ModLocation

Module Location

Where a module lives on the file system: the actual locations of the .hs, .hi and .o files, if we have them

Constructors

ModLocation

Fields

• ml_hs_file :: Maybe FilePath
• ml_hi_file :: FilePath
• ml_obj_file :: FilePath

Instances

Show ModLocation

Defined in Module

Methods

showsPrec :: Int -> ModLocation -> ShowS

show :: ModLocation -> String

showList :: [ModLocation] -> ShowS

Outputable ModLocation

Defined in Module

Methods

ppr :: ModLocation -> SDoc

pprPrec :: Rational -> ModLocation -> SDoc

addBootSuffix :: FilePath -> FilePath

Add the -boot suffix to .hs, .hi and .o files

addBootSuffix_maybe :: Bool -> FilePath -> FilePath

Add the -boot suffix if the Bool argument is True

addBootSuffixLocn :: ModLocation -> ModLocation

Add the -boot suffix to all file paths associated with the module

Module mappings

data ModuleEnv elt

A map keyed off of Modules

elemModuleEnv :: Module -> ModuleEnv a -> Bool

extendModuleEnv :: ModuleEnv a -> Module -> a -> ModuleEnv a

extendModuleEnvList :: ModuleEnv a -> [(Module, a)] -> ModuleEnv a

extendModuleEnvList_C :: (a -> a -> a) -> ModuleEnv a -> [(Module, a)] -> ModuleEnv a

plusModuleEnv_C :: (a -> a -> a) -> ModuleEnv a -> ModuleEnv a -> ModuleEnv a

delModuleEnvList :: ModuleEnv a -> [Module] -> ModuleEnv a

delModuleEnv :: ModuleEnv a -> Module -> ModuleEnv a

plusModuleEnv :: ModuleEnv a -> ModuleEnv a -> ModuleEnv a

lookupModuleEnv :: ModuleEnv a -> Module -> Maybe a

lookupWithDefaultModuleEnv :: ModuleEnv a -> a -> Module -> a

mapModuleEnv :: (a -> b) -> ModuleEnv a -> ModuleEnv b

mkModuleEnv :: [(Module, a)] -> ModuleEnv a

emptyModuleEnv :: ModuleEnv a

moduleEnvKeys :: ModuleEnv a -> [Module]

moduleEnvElts :: ModuleEnv a -> [a]

moduleEnvToList :: ModuleEnv a -> [(Module, a)]

unitModuleEnv :: Module -> a -> ModuleEnv a

isEmptyModuleEnv :: ModuleEnv a -> Bool

extendModuleEnvWith :: (a -> a -> a) -> ModuleEnv a -> Module -> a -> ModuleEnv a

filterModuleEnv :: (Module -> a -> Bool) -> ModuleEnv a -> ModuleEnv a

ModuleName mappings

type ModuleNameEnv elt = UniqFM elt

A map keyed off of ModuleNames (actually, their Uniques)

type DModuleNameEnv elt = UniqDFM elt

A map keyed off of ModuleNames (actually, their Uniques) Has deterministic folds and can be deterministically converted to a list

Sets of Modules

type ModuleSet = Set NDModule

A set of Modules

emptyModuleSet :: ModuleSet

mkModuleSet :: [Module] -> ModuleSet

moduleSetElts :: ModuleSet -> [Module]

extendModuleSet :: ModuleSet -> Module -> ModuleSet

extendModuleSetList :: ModuleSet -> [Module] -> ModuleSet

delModuleSet :: ModuleSet -> Module -> ModuleSet

elemModuleSet :: Module -> ModuleSet -> Bool

intersectModuleSet :: ModuleSet -> ModuleSet -> ModuleSet

minusModuleSet :: ModuleSet -> ModuleSet -> ModuleSet

unionModuleSet :: ModuleSet -> ModuleSet -> ModuleSet

unitModuleSet :: Module -> ModuleSet