GHC.Driver.Env.Types · ghc-10.0.0.20260917

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