GHC.Driver.Env · ghc-9.10.3 · horizon-platform

newtypenewtype Hsc a

#

The Hsc monad: Passing an environment and diagnostic state

Constructors

Hsc (HscEnv -> Messages GhcMessage -> IO (a, Messages GhcMessage))

Instances6Monad, Functor, Applicative, MonadIO, HasLogger, HasDynFlags

Monad HscDefined in ghc-9.10.3 · GHC.Driver.Env.Types
Functor HscDefined in ghc-9.10.3 · GHC.Driver.Env.Types
Applicative HscDefined in ghc-9.10.3 · GHC.Driver.Env.Types
MonadIO HscDefined in ghc-9.10.3 · GHC.Driver.Env.Types
HasLogger HscDefined in ghc-9.10.3 · GHC.Driver.Env.Types
HasDynFlags HscDefined in ghc-9.10.3 · GHC.Driver.Env.Types

datadata HscEnv

#

HscEnv is like Session, except that some of the fields are immutable. An HscEnv is used to compile a single module from plain Haskell source code (after preprocessing) to either C, assembly or C--. It's also used to store the dynamic linker state to allow for multiple linkers in the same address space. Things like the module graph don't change during a single compilation.

Historical note: "hsc" used to be the name of the compiler binary, when there was a separate driver and compiler. To compile a single module, the driver would invoke hsc on the source code... so nowadays we think of hsc as the layer of the compiler that deals with compiling a single module.

Constructors

HscEnv
- hsc_dflags :: DynFlags
  The dynamic flag settings
- hsc_targets :: [Target]
  The targets (or roots) of the current session
- hsc_mod_graph :: ModuleGraph
  The module graph of the current session
- hsc_IC :: InteractiveContext
  The context for evaluating interactive statements
- hsc_NC :: !NameCache
  Global Name cache so that each Name gets a single Unique. Also track the origin of the Names.
- hsc_FC :: !FinderCache
  The cached result of performing finding in the file system
- hsc_type_env_vars :: KnotVars (IORef TypeEnv)
  Used for one-shot compilation only, to initialise the IfGblEnv. See GHC.Tc.Utils.tcg_type_env_var for GHC.Tc.Utils.TcGblEnv. See also Note [hsc_type_env_var hack]
- hsc_interp :: Maybe Interp
  target code interpreter (if any) to use for TH and GHCi. See Note [Target code interpreter]
- hsc_plugins :: !Plugins
  Plugins
- hsc_unit_env :: UnitEnv
  Unit environment (unit state, home unit, etc.).
  Initialized from the databases cached in hsc_unit_dbs and from the DynFlags.
- hsc_logger :: !Logger
  Logger with its flags.
  Don't forget to update the logger flags if the logging related DynFlags change. Or better, use hscSetFlags setter which does it.
- hsc_hooks :: !Hooks
  Hooks
- hsc_tmpfs :: !TmpFs
  Temporary files
- hsc_llvm_config :: !LlvmConfigCache
  LLVM configuration cache.

Instances1ContainsDynFlags

ContainsDynFlags HscEnvDefined in ghc-9.10.3 · GHC.Driver.Env.Types

valuehscUpdateFlags :: (DynFlags -> DynFlags) -> HscEnv -> HscEnv

#

Update Flags

valuehscSetFlags :: HasDebugCallStack => DynFlags -> HscEnv -> HscEnv

#

Set Flags

valuehsc_home_unit :: HscEnv -> HomeUnit

#

valuehsc_home_unit_maybe :: HscEnv -> Maybe HomeUnit

#

valuehsc_units :: HasDebugCallStack => HscEnv -> UnitState

#

valuehsc_HPT :: HscEnv -> HomePackageTable

#

valuehsc_HUE :: HscEnv -> HomeUnitEnv

#

valuehsc_HUG :: HscEnv -> HomeUnitGraph

#

valuehsc_all_home_unit_ids :: HscEnv -> Set UnitId

#

valuehscUpdateLoggerFlags :: HscEnv -> HscEnv

#

Update the LogFlags of the Log in hsc_logger from the DynFlags in hsc_dflags. You need to call this when DynFlags are modified.

valuehscUpdateHUG :: (HomeUnitGraph -> HomeUnitGraph) -> HscEnv -> HscEnv

#

valuehscUpdateHPT_lazy

:: HomePackageTable -> HomePackageTable
-> HscEnv
-> HscEnv

#

valuehscUpdateHPT :: (HomePackageTable -> HomePackageTable) -> HscEnv -> HscEnv

#

valuehscSetActiveHomeUnit :: HasDebugCallStack => HomeUnit -> HscEnv -> HscEnv

#

valuehscSetActiveUnitId :: HasDebugCallStack => UnitId -> HscEnv -> HscEnv

#

valuehscActiveUnitId :: HscEnv -> UnitId

#

valuerunHsc :: HscEnv -> Hsc a -> IO a

#

valuerunHsc' :: HscEnv -> Hsc a -> IO (a, Messages GhcMessage)

#

valuemkInteractiveHscEnv :: HscEnv -> HscEnv

#

Switches in the DynFlags and Plugins from the InteractiveContext

valuerunInteractiveHsc :: HscEnv -> Hsc a -> IO a

#

A variant of runHsc that switches in the DynFlags and Plugins from the InteractiveContext before running the Hsc computation.

valuehscEPS :: HscEnv -> IO ExternalPackageState

#

Retrieve the ExternalPackageState cache.

valuehscInterp :: HscEnv -> Interp

#

Retrieve the target code interpreter

Fails if no target code interpreter is available

valuehptCompleteSigs :: HscEnv -> [CompleteMatch]

#

valuehptAllInstances :: HscEnv -> (InstEnv, [FamInst])

#

Find all the instance declarations (of classes and families) from the Home Package Table filtered by the provided predicate function. Used in tcRnImports, to select the instances that are in the transitive closure of imports from the currently compiled module.

valuehptInstancesBelow

#

Find instances visible from the given set of imports

valuehptAnns :: HscEnv -> Maybe (UnitId, ModuleNameWithIsBoot) -> [Annotation]

#

Get annotations from modules "below" this one (in the dependency sense)

valuehptAllThings :: (HomeModInfo -> [a]) -> HscEnv -> [a]

#

valuehptSomeThingsBelowUs

:: HomeModInfo -> [a]
-> Bool
-> HscEnv
-> UnitId
-> ModuleNameWithIsBoot
-> [a]

#

Get things from modules "below" this one (in the dependency sense) C.f Inst.hptInstances

valuehptRules :: HscEnv -> UnitId -> ModuleNameWithIsBoot -> [CoreRule]

#

Get rules from modules "below" this one (in the dependency sense)

valueprepareAnnotations :: HscEnv -> Maybe ModGuts -> IO AnnEnv

#

Deal with gathering annotations in from all possible places and combining them into a single AnnEnv

valuediscardIC :: HscEnv -> HscEnv

#

Discard the contents of the InteractiveContext, but keep the DynFlags and the loaded plugins. It will also keep ic_int_print and ic_monad if their names are from external packages.

valuelookupType :: HscEnv -> Name -> IO (Maybe TyThing)

#

Find the TyThing for the given Name by using all the resources at our disposal: the compiled modules in the HomePackageTable and the compiled modules in other packages that live in PackageTypeEnv. Note that this does NOT look up the TyThing in the module being compiled: you have to do that yourself, if desired

valuelookupIfaceByModule

#

Find the ModIface for a Module, searching in both the loaded home and external package module information

valuemainModIs :: HomeUnitEnv -> Module

#