ghc-7.8.0.20140228: The GHC API

Safe HaskellNone
LanguageHaskell98

Module

Contents

Synopsis

The ModuleName type

data ModuleName Source

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

Instances

pprModuleName :: ModuleName -> SDoc Source

moduleNameFS :: ModuleName -> FastString Source

moduleNameString :: ModuleName -> String Source

moduleNameSlashes :: ModuleName -> String Source

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

moduleNameColons :: ModuleName -> String Source

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

mkModuleName :: String -> ModuleName Source

mkModuleNameFS :: FastString -> ModuleName Source

stableModuleNameCmp :: ModuleName -> ModuleName -> Ordering Source

Compares module names lexically, rather than by their Uniques

The PackageId type

data PackageId Source

Essentially just a string identifying a package, including the version: e.g. parsec-1.0

Instances

fsToPackageId :: FastString -> PackageId Source

packageIdFS :: PackageId -> FastString Source

stringToPackageId :: String -> PackageId Source

packageIdString :: PackageId -> String Source

stablePackageIdCmp :: PackageId -> PackageId -> Ordering Source

Compares package ids lexically, rather than by their Uniques

Wired-in PackageIds

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 PackageId 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).

primPackageId :: PackageId Source

integerPackageId :: PackageId Source

basePackageId :: PackageId Source

rtsPackageId :: PackageId Source

thPackageId :: PackageId Source

dphSeqPackageId :: PackageId Source

dphParPackageId :: PackageId Source

mainPackageId :: PackageId 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.

thisGhcPackageId :: PackageId Source

interactivePackageId :: PackageId Source

isInteractiveModule :: Module -> Bool Source

The Module type

data Module Source

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

Instances

modulePackageId :: Module -> PackageId Source

moduleName :: Module -> ModuleName Source

pprModule :: Module -> SDoc Source

mkModule :: PackageId -> ModuleName -> Module Source

stableModuleCmp :: Module -> Module -> Ordering Source

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 Source

Methods

getModule :: m Module Source

Instances

class ContainsModule t where Source

Methods

extractModule :: t -> Module Source

Instances

The ModuleLocation type

data ModLocation Source

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

addBootSuffix :: FilePath -> FilePath Source

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

addBootSuffix_maybe :: Bool -> FilePath -> FilePath Source

Add the -boot suffix if the Bool argument is True

addBootSuffixLocn :: ModLocation -> ModLocation Source

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

Module mappings

data ModuleEnv elt Source

A map keyed off of Modules

elemModuleEnv :: Module -> ModuleEnv a -> Bool Source

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

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

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

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

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

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

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

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

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

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

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

emptyModuleEnv :: ModuleEnv a Source

moduleEnvKeys :: ModuleEnv a -> [Module] Source

moduleEnvElts :: ModuleEnv a -> [a] Source

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

unitModuleEnv :: Module -> a -> ModuleEnv a Source

isEmptyModuleEnv :: ModuleEnv a -> Bool Source

foldModuleEnv :: (a -> b -> b) -> b -> ModuleEnv a -> b Source

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

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

ModuleName mappings

type ModuleNameEnv elt = UniqFM elt Source

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

Sets of Modules

type ModuleSet = Map Module () Source

A set of Modules

emptyModuleSet :: ModuleSet Source

mkModuleSet :: [Module] -> ModuleSet Source

moduleSetElts :: ModuleSet -> [Module] Source

extendModuleSet :: ModuleSet -> Module -> ModuleSet Source

elemModuleSet :: Module -> ModuleSet -> Bool Source