| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
GHC.Unit.Types
Description
Unit & Module types
This module is used to resolve the loops between Unit and Module types (Module references a Unit and vice-versa).
Synopsis
- data GenModule unit = Module {
- moduleUnit :: !unit
- moduleName :: !ModuleName
- type Module = GenModule Unit
- type InstalledModule = GenModule UnitId
- type InstantiatedModule = GenModule InstantiatedUnit
- mkModule :: u -> ModuleName -> GenModule u
- pprModule :: Module -> SDoc
- pprInstantiatedModule :: InstantiatedModule -> SDoc
- moduleFreeHoles :: GenModule (GenUnit u) -> UniqDSet ModuleName
- class IsUnitId u
- data GenUnit uid
- = RealUnit !(Definite uid)
- | VirtUnit !(GenInstantiatedUnit uid)
- | HoleUnit
- type Unit = GenUnit UnitId
- newtype UnitId = UnitId {}
- newtype UnitKey = UnitKey FastString
- data GenInstantiatedUnit unit = InstantiatedUnit {
- instUnitFS :: !FastString
- instUnitKey :: !Unique
- instUnitInstanceOf :: !(Indefinite unit)
- instUnitInsts :: !(GenInstantiations unit)
- instUnitHoles :: UniqDSet ModuleName
- type InstantiatedUnit = GenInstantiatedUnit UnitId
- type IndefUnitId = Indefinite UnitId
- type DefUnitId = Definite UnitId
- type Instantiations = GenInstantiations UnitId
- type GenInstantiations unit = [(ModuleName, GenModule (GenUnit unit))]
- mkInstantiatedUnit :: IsUnitId u => Indefinite u -> GenInstantiations u -> GenInstantiatedUnit u
- mkInstantiatedUnitHash :: IsUnitId u => Indefinite u -> [(ModuleName, GenModule (GenUnit u))] -> FastString
- mkVirtUnit :: IsUnitId u => Indefinite u -> [(ModuleName, GenModule (GenUnit u))] -> GenUnit u
- mapGenUnit :: IsUnitId v => (u -> v) -> GenUnit u -> GenUnit v
- mapInstantiations :: IsUnitId v => (u -> v) -> GenInstantiations u -> GenInstantiations v
- unitFreeModuleHoles :: GenUnit u -> UniqDSet ModuleName
- fsToUnit :: FastString -> Unit
- unitFS :: IsUnitId u => u -> FastString
- unitString :: IsUnitId u => u -> String
- toUnitId :: Unit -> UnitId
- virtualUnitId :: InstantiatedUnit -> UnitId
- stringToUnit :: String -> Unit
- stableUnitCmp :: Unit -> Unit -> Ordering
- unitIsDefinite :: Unit -> Bool
- isHoleUnit :: GenUnit u -> Bool
- unitIdString :: UnitId -> String
- stringToUnitId :: String -> UnitId
- newtype Definite unit = Definite {
- unDefinite :: unit
- newtype Indefinite unit = Indefinite {
- indefUnit :: unit
- primUnitId :: UnitId
- bignumUnitId :: UnitId
- baseUnitId :: UnitId
- rtsUnitId :: UnitId
- thUnitId :: UnitId
- mainUnitId :: UnitId
- thisGhcUnitId :: UnitId
- interactiveUnitId :: UnitId
- primUnit :: Unit
- bignumUnit :: Unit
- baseUnit :: Unit
- rtsUnit :: Unit
- thUnit :: Unit
- mainUnit :: Unit
- thisGhcUnit :: Unit
- interactiveUnit :: Unit
- isInteractiveModule :: Module -> Bool
- wiredInUnitIds :: [UnitId]
- data IsBootInterface
- data GenWithIsBoot mod = GWIB {
- gwib_mod :: mod
- gwib_isBoot :: IsBootInterface
- type ModuleNameWithIsBoot = GenWithIsBoot ModuleName
- type ModuleWithIsBoot = GenWithIsBoot Module
Modules
A generic module is a pair of a unit identifier and a ModuleName.
Constructors
| Module | |
Fields
| |
Instances
| Functor GenModule Source # | |
| Uniquable Module Source # | |
| Outputable InstalledModule Source # | |
Defined in GHC.Unit.Types Methods ppr :: InstalledModule -> SDoc Source # | |
| Outputable InstantiatedModule Source # | |
Defined in GHC.Unit.Types Methods ppr :: InstantiatedModule -> SDoc Source # | |
| Outputable Module Source # | |
| Data unit => Data (GenModule unit) Source # | |
Defined in GHC.Unit.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GenModule unit -> c (GenModule unit) Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (GenModule unit) Source # toConstr :: GenModule unit -> Constr Source # dataTypeOf :: GenModule unit -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (GenModule unit)) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (GenModule unit)) Source # gmapT :: (forall b. Data b => b -> b) -> GenModule unit -> GenModule unit Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GenModule unit -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GenModule unit -> r Source # gmapQ :: (forall d. Data d => d -> u) -> GenModule unit -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> GenModule unit -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GenModule unit -> m (GenModule unit) Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GenModule unit -> m (GenModule unit) Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GenModule unit -> m (GenModule unit) Source # | |
| NFData (GenModule a) Source # | |
Defined in GHC.Unit.Types | |
| Binary a => Binary (GenModule a) Source # | |
| Eq unit => Eq (GenModule unit) Source # | |
| Ord unit => Ord (GenModule unit) Source # | |
Defined in GHC.Unit.Types Methods compare :: GenModule unit -> GenModule unit -> Ordering # (<) :: GenModule unit -> GenModule unit -> Bool # (<=) :: GenModule unit -> GenModule unit -> Bool # (>) :: GenModule unit -> GenModule unit -> Bool # (>=) :: GenModule unit -> GenModule unit -> Bool # | |
type InstalledModule = GenModule UnitId Source #
A InstalledModule is a Module whose unit is identified with an
UnitId.
type InstantiatedModule = GenModule InstantiatedUnit Source #
An InstantiatedModule is a Module whose unit is identified with an InstantiatedUnit.
mkModule :: u -> ModuleName -> GenModule u Source #
moduleFreeHoles :: GenModule (GenUnit u) -> UniqDSet ModuleName Source #
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.
Units
Class for types that are used as unit identifiers (UnitKey, UnitId, Unit)
We need this class because we create new unit ids for virtual units (see VirtUnit) and they have to to be made from units with different kinds of identifiers.
Minimal complete definition
Instances
| IsUnitId UnitId Source # | |
Defined in GHC.Unit.Types Methods unitFS :: UnitId -> FastString Source # | |
| IsUnitId UnitKey Source # | |
Defined in GHC.Unit.Types Methods unitFS :: UnitKey -> FastString Source # | |
| IsUnitId unit => IsUnitId (Definite unit) Source # | |
Defined in GHC.Unit.Types Methods unitFS :: Definite unit -> FastString Source # | |
| IsUnitId u => IsUnitId (GenUnit u) Source # | |
Defined in GHC.Unit.Types Methods unitFS :: GenUnit u -> FastString Source # | |
| IsUnitId unit => IsUnitId (Indefinite unit) Source # | |
Defined in GHC.Unit.Types Methods unitFS :: Indefinite unit -> FastString Source # | |
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 Unit:
1) It can be a RealUnit, in which case we just have a DefUnitId that
uniquely identifies some fully compiled, installed library we have on disk.
2) It can be an VirtUnit. 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
InstantiatedUnit, which explicitly records the instantiation, so that we
can substitute over it.
Constructors
| RealUnit !(Definite uid) | Installed definite unit (either a fully instantiated unit or a closed unit) |
| VirtUnit !(GenInstantiatedUnit uid) | Virtual unit instantiated on-the-fly. It may be definite if all the holes are instantiated but we don't have code objects for it. |
| HoleUnit | Fake hole unit |
Instances
| Data Unit Source # | |
Defined in GHC.Unit.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Unit -> c Unit Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Unit Source # toConstr :: Unit -> Constr Source # dataTypeOf :: Unit -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Unit) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Unit) Source # gmapT :: (forall b. Data b => b -> b) -> Unit -> Unit Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Unit -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Unit -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Unit -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Unit -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Unit -> m Unit Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Unit -> m Unit Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Unit -> m Unit Source # | |
| Show Unit Source # | |
| NFData Unit Source # | |
Defined in GHC.Unit.Types | |
| Uniquable Module Source # | |
| Binary Unit Source # | |
| Outputable Module Source # | |
| Outputable Unit Source # | |
| Ord Unit Source # | |
| IsUnitId u => Uniquable (GenUnit u) Source # | |
| IsUnitId u => IsUnitId (GenUnit u) Source # | |
Defined in GHC.Unit.Types Methods unitFS :: GenUnit u -> FastString Source # | |
| IsUnitId u => Eq (GenUnit u) Source # | |
A UnitId identifies a built library in a database and is used to generate unique symbols, etc. It's usually of the form:
pkgname-1.2:libname+hash
These UnitId 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 as we can cheaply instantiate them on-the-fly, cf VirtUnit). Put another way, an installed unit id is either fully instantiated, or not instantiated at all.
Constructors
| UnitId | |
Fields
| |
Instances
A unit key in the database
Constructors
| UnitKey FastString |
Instances
| IsUnitId UnitKey Source # | |
Defined in GHC.Unit.Types Methods unitFS :: UnitKey -> FastString Source # | |
data GenInstantiatedUnit unit Source #
An instantiated unit.
It identifies an indefinite library (with holes) that has been instantiated.
This unit may be indefinite or not (i.e. with remaining holes or not). If it is definite, we don't know if it has already been compiled and installed in a database. Nevertheless, we have a mechanism called "improvement" to try to match a fully instantiated unit with existing compiled and installed units: see Note [VirtUnit to RealUnit improvement].
An indefinite unit identifier pretty-prints to something like
p[H=H,A=aimpl:A>] (p is the IndefUnitId, and the
brackets enclose the module substitution).
Constructors
| InstantiatedUnit | |
Fields
| |
Instances
type IndefUnitId = Indefinite UnitId Source #
An IndefUnitId is an UnitId with the invariant that it only
refers to an indefinite library; i.e., one that can be instantiated.
type Instantiations = GenInstantiations UnitId Source #
type GenInstantiations unit = [(ModuleName, GenModule (GenUnit unit))] Source #
mkInstantiatedUnit :: IsUnitId u => Indefinite u -> GenInstantiations u -> GenInstantiatedUnit u Source #
Create a new GenInstantiatedUnit given an explicit module substitution.
mkInstantiatedUnitHash :: IsUnitId u => Indefinite u -> [(ModuleName, GenModule (GenUnit u))] -> FastString Source #
Generate a uniquely identifying hash (internal unit-id) for an instantiated unit.
This is a one-way function. If the indefinite unit has not been instantiated at all, we return its unit-id.
This hash is completely internal to GHC and is not used for symbol names or file paths. It is different from the hash Cabal would produce for the same instantiated unit.
mkVirtUnit :: IsUnitId u => Indefinite u -> [(ModuleName, GenModule (GenUnit u))] -> GenUnit u Source #
Smart constructor for instantiated GenUnit
mapGenUnit :: IsUnitId v => (u -> v) -> GenUnit u -> GenUnit v Source #
Map over the unit type of a GenUnit
mapInstantiations :: IsUnitId v => (u -> v) -> GenInstantiations u -> GenInstantiations v Source #
Map over the unit identifier of unit instantiations.
unitFreeModuleHoles :: GenUnit u -> UniqDSet ModuleName Source #
Retrieve the set of free module holes of a Unit.
fsToUnit :: FastString -> Unit Source #
Create a new simple unit identifier from a FastString. Internally,
this is primarily used to specify wired-in unit identifiers.
unitFS :: IsUnitId u => u -> FastString Source #
unitString :: IsUnitId u => u -> String Source #
toUnitId :: Unit -> UnitId Source #
Return the UnitId of the Unit. For on-the-fly instantiated units, return the UnitId of the indefinite unit this unit is an instance of.
virtualUnitId :: InstantiatedUnit -> UnitId Source #
Return the virtual UnitId of an on-the-fly instantiated unit.
stringToUnit :: String -> Unit Source #
stableUnitCmp :: Unit -> Unit -> Ordering Source #
Compares unit ids lexically, rather than by their Uniques
isHoleUnit :: GenUnit u -> Bool Source #
Unit Ids
unitIdString :: UnitId -> String Source #
stringToUnitId :: String -> UnitId Source #
Utils
newtype Definite unit Source #
A definite unit (i.e. without any free module hole)
Constructors
| Definite | |
Fields
| |
Instances
| Functor Definite Source # | |
| Uniquable unit => Uniquable (Definite unit) Source # | |
| IsUnitId unit => IsUnitId (Definite unit) Source # | |
Defined in GHC.Unit.Types Methods unitFS :: Definite unit -> FastString Source # | |
| Binary unit => Binary (Definite unit) Source # | |
| Outputable unit => Outputable (Definite unit) Source # | |
| Eq unit => Eq (Definite unit) Source # | |
| Ord unit => Ord (Definite unit) Source # | |
Defined in GHC.Unit.Types Methods compare :: Definite unit -> Definite unit -> Ordering # (<) :: Definite unit -> Definite unit -> Bool # (<=) :: Definite unit -> Definite unit -> Bool # (>) :: Definite unit -> Definite unit -> Bool # (>=) :: Definite unit -> Definite unit -> Bool # | |
newtype Indefinite unit Source #
Constructors
| Indefinite | |
Fields
| |
Instances
Wired-in units
primUnitId :: UnitId Source #
baseUnitId :: UnitId Source #
mainUnitId :: UnitId Source #
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.
bignumUnit :: Unit Source #
thisGhcUnit :: Unit Source #
isInteractiveModule :: Module -> Bool Source #
wiredInUnitIds :: [UnitId] Source #
Boot modules
data IsBootInterface Source #
Indicates whether a module name is referring to a boot interface (hs-boot file) or regular module (hs file). We need to treat boot modules specially when building compilation graphs, since they break cycles. Regular source files and signature files are treated equivalently.
Instances
data GenWithIsBoot mod Source #
This data type just pairs a value mod with an IsBootInterface flag. In
practice, mod is usually a Module or ModuleName'.
Constructors
| GWIB | |
Fields
| |
Instances
type ModuleWithIsBoot = GenWithIsBoot Module Source #