Moduleghc-10.0.0.20260917GHC2024

GHC.Driver.Env

2 types
1 class
37 values

Packageghc-10.0.0.20260917
Exports40
LanguageGHC2024
LicenceBSD-3-Clause
SourceTypes.hs

newtypenewtype Hsc a

The Hsc monad: Passing an environment and diagnostic state

Constructors

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

Instances10Monad, Functor, Applicative, MonadIO, MonadCatch, MonadMask, …

Monad HscDefined in ghc-10.0.0.20260917 · GHC.Driver.Env.Types
Functor HscDefined in ghc-10.0.0.20260917 · GHC.Driver.Env.Types
Applicative HscDefined in ghc-10.0.0.20260917 · GHC.Driver.Env.Types
MonadIO HscDefined in ghc-10.0.0.20260917 · GHC.Driver.Env.Types
MonadCatch HscDefined in ghc-10.0.0.20260917 · GHC.Driver.Env.Types
MonadMask HscDefined in ghc-10.0.0.20260917 · GHC.Driver.Env.Types
MonadThrow HscDefined in ghc-10.0.0.20260917 · GHC.Driver.Env.Types
HasLogger HscDefined in ghc-10.0.0.20260917 · GHC.Driver.Env.Types
HasDynFlags HscDefined in ghc-10.0.0.20260917 · GHC.Driver.Env.Types
HasHscEnv HscDefined in ghc-10.0.0.20260917 · 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_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.

Instances2ContainsDynFlags, HasHscEnv

ContainsDynFlags HscEnvDefined in ghc-10.0.0.20260917 · GHC.Driver.Env.Types
HasHscEnv ((->) HscEnv)Defined in ghc-10.0.0.20260917 · GHC.Driver.Env.Types

classclass HasHscEnv (m :: Type -> Type) where

Methods

getHscEnv :: m HscEnv

Instances4HasHscEnv

HasHscEnv CoreMDefined in ghc-10.0.0.20260917 · GHC.Core.Opt.Monad
HasHscEnv HscDefined in ghc-10.0.0.20260917 · GHC.Driver.Env.Types
HasHscEnv BcMDefined in ghc-10.0.0.20260917 · GHC.StgToByteCode
HasHscEnv ((->) HscEnv)Defined in ghc-10.0.0.20260917 · GHC.Driver.Env.Types

valuehsc_mod_graph :: HscEnv -> ModuleGraph

valuesetModuleGraph :: ModuleGraph -> HscEnv -> HscEnv

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

valuehscUnitIndex :: HscEnv -> IO UnitIndex

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

valuehscInsertHPT :: HomeModInfo -> HscEnv -> IO ()

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.

valuehscEUD :: HscEnv -> IO (ExternalUnitDatabases UnitId)

valuehscUIC :: HscEnv -> UnitIndexCache

valuehscInterp :: HscEnv -> Interp

Retrieve the target code interpreter

Fails if no target code interpreter is available

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

valuelookupIfaceByModuleHsc :: HscEnv -> Module -> IO (Maybe ModIface)

valuemainModIs :: HomeUnitEnv -> Module

valuehugRulesBelow :: HscEnv -> UnitId -> ModuleNameWithIsBoot -> IO RuleBase

Find all rules in modules that are in the transitive closure of the given module.

valuehugInstancesBelow

Find instances visible from the given set of imports

valuehugAnnsBelow :: HscEnv -> UnitId -> ModuleNameWithIsBoot -> IO AnnEnv

Get annotations from all modules "below" this one (in the dependency sense) within the home units. If the module is Nothing, returns all annotations in the home units.

valuehugCompleteSigsBelow

Find all COMPLETE pragmas in modules that are in the transitive closure of the given module.

Legacy API

1 declaration

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

Deprecated. Updating the HPT directly is no longer a supported operation. Instead, the HPT is an insert-only data structure. If you want to overwrite an existing entry, just use hscInsertHPT to insert it again (it will override the existing entry if there is one). See GHC.Unit.Home.PackageTable for more details.