Language.Haskell.GHC.Simple

Simplified interface to the GHC API.

Entry points

compile

Arguments

:: (Intermediate a, Binary b)

=> (ModMetadata -> a -> IO b)

Compilation function from some intermediate language to the desired output. The output type needs to be an instance of Binary, as it will be cached after compilation to speed up future recompilation. This function is called once per module. Due to caching of modules which don't need to be recompiled, it will not necessarily be called once per module included in the return value of compile.

-> [String]

List of compilation targets. A target can be either a module or a file name.

-> IO (CompResult [CompiledModule b])

Compile a list of targets and their dependencies into intermediate code. Uses settings from the the default CompConfig.

compileWith

Arguments

:: (Intermediate a, Binary b)

=> CompConfig

GHC pipeline configuration.

-> (ModMetadata -> a -> IO b)

Compilation function.

-> [String]

List of compilation targets. A target can be either a module or a file name. Targets may also be read from the specified CompConfig, if cfgUseTargetsFromFlags is set.

-> IO (CompResult [CompiledModule b])

Compile a list of targets and their dependencies using a custom configuration.

compileFold

Arguments

:: (Intermediate a, Binary b)

=> CompConfig

GHC pipeline configuration.

-> (ModMetadata -> a -> IO b)

Per module compilation function.

-> (acc -> CompiledModule b -> IO acc)

Folding function.

-> acc

Initial accumulator.

-> [String]

List of compilation targets. A target can be either a module or a file name. Targets may also be read from the specified CompConfig, if cfgUseTargetsFromFlags is set.

-> IO (CompResult acc)

Left fold over a list of compilation targets and their dependencies.

Sometimes you don't just want a huge pile of intermediate code lying around; chances are you either want to dump it to file or combine it with some other intermediate code, without having to keep it all in memory at the same time.

Configuration, input and output types

getDynFlagsForConfig :: CompConfig -> IO (DynFlags, [String])

Obtain the dynamic flags and extra targets that would be used to compile anything with the given config.

GHC re-exports for processing STG and Core

module CoreSyn

module StgSyn

module Module

module Id

module IdInfo

module Var

module Literal

module DataCon

module OccName

module Name

module Type

module TysPrim

module TyCon

module ForeignCall

module PrimOp

module DynFlags

module SrcLoc

module DriverPhases

data ModSummary :: *

A single node in a ModuleGraph. The nodes of the module graph are one of:

• A regular Haskell source module
• A hi-boot source module

Constructors

ModSummary

Fields

• ms_mod :: Module

  Identity of the module

• ms_hsc_src :: HscSource

  The module source either plain Haskell or hs-boot

• ms_location :: ModLocation

  Location of the various files belonging to the module

• ms_hs_date :: UTCTime

  Timestamp of source file

• ms_obj_date :: Maybe UTCTime

  Timestamp of object, if we have one

• ms_iface_date :: Maybe UTCTime

  Timestamp of hi file, if we *only* are typechecking (it is Nothing otherwise. See Note [Recompilation checking when typechecking only] and #9243

• ms_srcimps :: [(Maybe FastString, Located ModuleName)]

  Source imports of the module

• ms_textual_imps :: [(Maybe FastString, Located ModuleName)]

  Non-source imports of the module from the module *text*

• ms_hspp_file :: FilePath

  Filename of preprocessed source file

• ms_hspp_opts :: DynFlags

  Cached flags from OPTIONS, INCLUDE and LANGUAGE pragmas in the modules source code

• ms_hspp_buf :: Maybe StringBuffer

  The actual preprocessed source, if we have it

Instances

Outputable ModSummary

Methods

ppr :: ModSummary -> SDoc

pprPrec :: Rational -> ModSummary -> SDoc

data ModGuts :: *

A ModGuts is carried through the compiler, accumulating stuff as it goes There is only one ModGuts at any time, the one for the module being compiled right now. Once it is compiled, a ModIface and ModDetails are extracted and the ModGuts is discarded.

Constructors

ModGuts

Fields

• mg_module :: ~Module

  Module being compiled

• mg_hsc_src :: HscSource

  Whether it's an hs-boot module

• mg_loc :: SrcSpan

  For error messages from inner passes

• mg_exports :: ~[AvailInfo]

  What it exports

• mg_deps :: ~Dependencies

  What it depends on, directly or otherwise

• mg_usages :: ~[Usage]

  What was used? Used for interfaces.

• mg_used_th :: ~Bool

  Did we run a TH splice?

• mg_rdr_env :: ~GlobalRdrEnv

  Top-level lexical environment

• mg_fix_env :: ~FixityEnv

  Fixities declared in this module. Used for creating interface files.

• mg_tcs :: ~[TyCon]

  TyCons declared in this module (includes TyCons for classes)

• mg_insts :: ~[ClsInst]

  Class instances declared in this module

• mg_fam_insts :: ~[FamInst]

  Family instances declared in this module

• mg_patsyns :: ~[PatSyn]

  Pattern synonyms declared in this module

• mg_rules :: ~[CoreRule]

  Before the core pipeline starts, contains See Note [Overall plumbing for rules] in Rules.hs

• mg_binds :: ~CoreProgram

  Bindings for this module

• mg_foreign :: ~ForeignStubs

  Foreign exports declared in this module

• mg_warns :: ~Warnings

  Warnings declared in the module

• mg_anns :: [Annotation]

  Annotations declared in this module

• mg_hpc_info :: ~HpcInfo

  Coverage tick boxes in the module

• mg_modBreaks :: ~(Maybe ModBreaks)

  Breakpoints for the module

• mg_vect_decls :: ~[CoreVect]

  Vectorisation declarations in this module (produced by desugarer & consumed by vectoriser)

• mg_vect_info :: ~VectInfo

  Pool of vectorised declarations in the module

• mg_inst_env :: InstEnv

  Class instance environment for home-package modules (including this one); c.f. tcg_inst_env

• mg_fam_inst_env :: FamInstEnv

  Type-family instance environment for home-package modules (including this one); c.f. tcg_fam_inst_env

• mg_safe_haskell :: SafeHaskellMode

  Safe Haskell mode

• mg_trust_pkg :: Bool

  Do we need to trust our own package for Safe Haskell? See Note [RnNames . Trust Own Package]

type PkgKey = UnitId

Synonym for UnitId, to bridge a slight incompatibility between GHC 7.87.108.0.

pkgKeyString :: PkgKey -> String

String representation of a package ID/key.

modulePkgKey :: Module -> PkgKey

Package ID/key of a module.