GHC.Driver.Make

Documentation

depanal

Arguments

:: GhcMonad m

=> [ModuleName]

excluded modules

-> Bool

allow duplicate roots

-> m ModuleGraph

Perform a dependency analysis starting from the current targets and update the session with the new module graph.

Dependency analysis entails parsing the import directives and may therefore require running certain preprocessors.

Note that each ModSummary in the module graph caches its DynFlags. These DynFlags are determined by the current session DynFlags and the OPTIONS and LANGUAGE pragmas of the parsed module. Thus if you want changes to the DynFlags to take effect you need to call this function again. In case of errors, just throw them.

depanalE

Arguments

:: GhcMonad m

=> [ModuleName]

excluded modules

-> Bool

allow duplicate roots

-> m (DriverMessages, ModuleGraph)

Perform dependency analysis like in depanal. In case of errors, the errors and an empty module graph are returned.

depanalPartial

Arguments

:: GhcMonad m

=> [ModuleName]

excluded modules

-> Bool

allow duplicate roots

-> m (DriverMessages, ModuleGraph)

possibly empty Bag of errors and a module graph.

Perform dependency analysis like depanal but return a partial module graph even in the face of problems with some modules.

Modules which have parse errors in the module header, failing preprocessors or other issues preventing them from being summarised will simply be absent from the returned module graph.

Unlike depanal this function will not update hsc_mod_graph with the new module graph.

checkHomeUnitsClosed :: UnitEnv -> [DriverMessages]

This function checks then important property that if both p and q are home units then any dependency of p, which transitively depends on q is also a home unit.

See Note [Multiple Home Units], section 'Closure Property'.

load :: GhcMonad f => LoadHowMuch -> f SuccessFlag

Try to load the program. See LoadHowMuch for the different modes.

This function implements the core of GHC's --make mode. It preprocesses, compiles and loads the specified modules, avoiding re-compilation wherever possible. Depending on the backend (see backend field) compiling and loading may result in files being created on disk.

Calls the defaultWarnErrLogger after each compiling each module, whether successful or not.

If errors are encountered during dependency analysis, the module depanalE returns together with the errors an empty ModuleGraph. After processing this empty ModuleGraph, the errors of depanalE are thrown. All other errors are reported using the defaultWarnErrLogger.

loadWithCache

Arguments

:: GhcMonad m

=> Maybe ModIfaceCache

Instructions about how to cache interfaces as we create them.

-> (GhcMessage -> AnyGhcDiagnostic)

How to wrap error messages before they are displayed to a user. If you are using the GHC API you can use this to override how messages created during loadWithCache are displayed to the user.

-> LoadHowMuch

How much loadWithCache should load

-> m SuccessFlag

load' :: GhcMonad m => Maybe ModIfaceCache -> LoadHowMuch -> (GhcMessage -> AnyGhcDiagnostic) -> Maybe Messager -> ModuleGraph -> m SuccessFlag

Generalized version of load which also supports a custom Messager (for reporting progress) and ModuleGraph (generally produced by calling depanal.

type AnyGhcDiagnostic = UnknownDiagnostic (DiagnosticOpts GhcMessage)

data LoadHowMuch

Describes which modules of the module graph need to be loaded.

Constructors

LoadAllTargets

Load all targets and its dependencies.

LoadUpTo HomeUnitModule

Load only the given module and its dependencies.

LoadDependenciesOf HomeUnitModule

Load only the dependencies of the given module, but not the module itself.

data ModIfaceCache

Constructors

ModIfaceCache

Fields

• iface_clearCache :: IO [CachedIface]
• iface_addToCache :: CachedIface -> IO ()

noIfaceCache :: Maybe ModIfaceCache

newIfaceCache :: IO ModIfaceCache

instantiationNodes :: UnitId -> UnitState -> [ModuleGraphNode]

Collect the instantiations of dependencies to create InstantiationNode work graph nodes. These are used to represent the type checking that is done after all the free holes (sigs in current package) relevant to that instantiation are compiled. This is necessary to catch some instantiation errors.

In the future, perhaps more of the work of instantiation could be moved here, instead of shoved in with the module compilation nodes. That could simplify backpack, and maybe hs-boot too.

downsweep

Arguments

:: HscEnv

-> [ModSummary]

Old summaries

-> [ModuleName]

-> Bool

-> IO ([DriverMessages], [ModuleGraphNode])

Downsweep (dependency analysis)

Chase downwards from the specified root set, returning summaries for all home modules encountered. Only follow source-import links.

We pass in the previous collection of summaries, which is used as a cache to avoid recalculating a module summary if the source is unchanged.

The returned list of [ModSummary] nodes has one node for each home-package module, plus one for any hs-boot files. The imports of these nodes are all there, including the imports of non-home-package modules.

topSortModuleGraph

Arguments

:: Bool

Drop hi-boot nodes? (see below)

-> ModuleGraph

-> Maybe HomeUnitModule

Root module name. If Nothing, use the full graph.

-> [SCC ModuleGraphNode]

Topological sort of the module graph

Calculate SCCs of the module graph, possibly dropping the hi-boot nodes The resulting list of strongly-connected-components is in topologically sorted order, starting with the module(s) at the bottom of the dependency graph (ie compile them first) and ending with the ones at the top.

Drop hi-boot nodes (first boolean arg)?

• False: treat the hi-boot summaries as nodes of the graph, so the graph must be acyclic
• True: eliminate the hi-boot nodes, and instead pretend the a source-import of Foo is an import of Foo The resulting graph has no hi-boot nodes, but can be cyclic

ms_home_srcimps :: ModSummary -> [Located ModuleName]

Like ms_home_imps, but for SOURCE imports.

ms_home_imps :: ModSummary -> [(PkgQual, Located ModuleName)]

All of the (possibly) home module imports from a ModSummary; that is to say, each of these module names could be a home import if an appropriately named file existed. (This is in contrast to package qualified imports, which are guaranteed not to be home imports.)

summariseModule

Arguments

:: HscEnv

-> HomeUnit

-> Map (UnitId, FilePath) ModSummary

Map of old summaries

-> IsBootInterface

-> Located ModuleName

-> PkgQual

-> Maybe (StringBuffer, UTCTime)

-> [ModuleName]

-> IO SummariseResult

data SummariseResult

Constructors

FoundInstantiation InstantiatedUnit

FoundHomeWithError (UnitId, DriverMessages)

FoundHome ModSummary

External UnitId

NotThere

summariseFile :: HscEnv -> HomeUnit -> Map (UnitId, FilePath) ModSummary -> FilePath -> Maybe Phase -> Maybe (StringBuffer, UTCTime) -> IO (Either DriverMessages ModSummary)

hscSourceToIsBoot :: HscSource -> IsBootInterface

Tests if an HscSource is a boot file, primarily for constructing elements of BuildModule. We conflate signatures and modules because they are bound in the same namespace; only boot interfaces can be disambiguated with `import {-# SOURCE #-}`.

findExtraSigImports :: HscEnv -> HscSource -> ModuleName -> IO [ModuleName]

For a module modname of type HscSource, determine the list of extra "imports" of other requirements which should be considered part of the import of the requirement, because it transitively depends on those requirements by imports of modules from other packages. The situation is something like this:

unit p where signature X signature Y import X

unit q where dependency p[X=<A>,Y=<B>] signature A signature B

Although q's B does not directly import A, we still have to make sure we process A first, because the merging process will cause B to indirectly import A. This function finds the TRANSITIVE closure of all such imports we need to make.

implicitRequirementsShallow :: HscEnv -> [(PkgQual, Located ModuleName)] -> IO ([ModuleName], [InstantiatedUnit])

Like implicitRequirements', but returns either the module name, if it is a free hole, or the instantiated unit the imported module is from, so that that instantiated unit can be processed and via the batch mod graph (rather than a transitive closure done here) all the free holes are still reachable.

noModError :: HscEnv -> SrcSpan -> ModuleName -> FindResult -> MsgEnvelope GhcMessage

cyclicModuleErr :: [ModuleGraphNode] -> SDoc

type SummaryNode = Node Int ModuleGraphNode

data IsBootInterface

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.

Constructors

NotBoot

IsBoot

Instances

Data IsBootInterface

Defined in Language.Haskell.Syntax.ImpExp

Methods

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

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

toConstr :: IsBootInterface -> Constr

dataTypeOf :: IsBootInterface -> DataType

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

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

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

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

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

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

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

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

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

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

Show IsBootInterface

Defined in Language.Haskell.Syntax.ImpExp

Methods

showsPrec :: Int -> IsBootInterface -> ShowS

show :: IsBootInterface -> String

showList :: [IsBootInterface] -> ShowS

Eq IsBootInterface

Defined in Language.Haskell.Syntax.ImpExp

Methods

(==) :: IsBootInterface -> IsBootInterface -> Bool

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

Ord IsBootInterface

Defined in Language.Haskell.Syntax.ImpExp

Methods

compare :: IsBootInterface -> IsBootInterface -> Ordering

(<) :: IsBootInterface -> IsBootInterface -> Bool

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

(>) :: IsBootInterface -> IsBootInterface -> Bool

(>=) :: IsBootInterface -> IsBootInterface -> Bool

max :: IsBootInterface -> IsBootInterface -> IsBootInterface

min :: IsBootInterface -> IsBootInterface -> IsBootInterface

mkNodeKey :: ModuleGraphNode -> NodeKey

type ModNodeKey = ModuleNameWithIsBoot

data ModNodeKeyWithUid

Constructors

ModNodeKeyWithUid

Fields

• mnkModuleName :: !ModuleNameWithIsBoot
• mnkUnitId :: !UnitId

Instances

Outputable ModNodeKeyWithUid

Defined in GHC.Unit.Module.Graph

Methods

ppr :: ModNodeKeyWithUid -> SDoc

Eq ModNodeKeyWithUid

Defined in GHC.Unit.Module.Graph

Methods

(==) :: ModNodeKeyWithUid -> ModNodeKeyWithUid -> Bool

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

Ord ModNodeKeyWithUid

Defined in GHC.Unit.Module.Graph

Methods

compare :: ModNodeKeyWithUid -> ModNodeKeyWithUid -> Ordering

(<) :: ModNodeKeyWithUid -> ModNodeKeyWithUid -> Bool

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

(>) :: ModNodeKeyWithUid -> ModNodeKeyWithUid -> Bool

(>=) :: ModNodeKeyWithUid -> ModNodeKeyWithUid -> Bool

max :: ModNodeKeyWithUid -> ModNodeKeyWithUid -> ModNodeKeyWithUid

min :: ModNodeKeyWithUid -> ModNodeKeyWithUid -> ModNodeKeyWithUid

newtype ModNodeMap a

Constructors

ModNodeMap

Fields

• unModNodeMap :: Map ModNodeKey a

Instances

Foldable ModNodeMap

Defined in GHC.Driver.Make

Methods

fold :: Monoid m => ModNodeMap m -> m

foldMap :: Monoid m => (a -> m) -> ModNodeMap a -> m

foldMap' :: Monoid m => (a -> m) -> ModNodeMap a -> m

foldr :: (a -> b -> b) -> b -> ModNodeMap a -> b

foldr' :: (a -> b -> b) -> b -> ModNodeMap a -> b

foldl :: (b -> a -> b) -> b -> ModNodeMap a -> b

foldl' :: (b -> a -> b) -> b -> ModNodeMap a -> b

foldr1 :: (a -> a -> a) -> ModNodeMap a -> a

foldl1 :: (a -> a -> a) -> ModNodeMap a -> a

toList :: ModNodeMap a -> [a]

null :: ModNodeMap a -> Bool

length :: ModNodeMap a -> Int

elem :: Eq a => a -> ModNodeMap a -> Bool

maximum :: Ord a => ModNodeMap a -> a

minimum :: Ord a => ModNodeMap a -> a

sum :: Num a => ModNodeMap a -> a

product :: Num a => ModNodeMap a -> a

Traversable ModNodeMap

Defined in GHC.Driver.Make

Methods

traverse :: Applicative f => (a -> f b) -> ModNodeMap a -> f (ModNodeMap b)

sequenceA :: Applicative f => ModNodeMap (f a) -> f (ModNodeMap a)

mapM :: Monad m => (a -> m b) -> ModNodeMap a -> m (ModNodeMap b)

sequence :: Monad m => ModNodeMap (m a) -> m (ModNodeMap a)

Functor ModNodeMap

Defined in GHC.Driver.Make

Methods

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

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

emptyModNodeMap :: ModNodeMap a

modNodeMapElems :: ModNodeMap a -> [a]

modNodeMapLookup :: ModNodeKey -> ModNodeMap a -> Maybe a

modNodeMapInsert :: ModNodeKey -> a -> ModNodeMap a -> ModNodeMap a

modNodeMapSingleton :: ModNodeKey -> a -> ModNodeMap a

modNodeMapUnionWith :: (a -> a -> a) -> ModNodeMap a -> ModNodeMap a -> ModNodeMap a