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

datadata UnitEnv

#

Constructors

UnitEnv
- ue_eps :: !ExternalUnitCache
  Information about the currently loaded external packages. This is mutable because packages will be demand-loaded during a compilation run as required.
- ue_current_unit :: UnitId
- ue_home_unit_graph :: !HomeUnitGraph
- ue_platform :: !Platform
  Platform
- ue_namever :: !GhcNameVersion
  GHC name/version (used for dynamic library suffix)

valueinitUnitEnv

#

valueueEPS :: UnitEnv -> IO ExternalPackageState

#

valueunsafeGetHomeUnit :: UnitEnv -> HomeUnit

#

Get home-unit

Unsafe because the home-unit may not be set

valueupdateHug :: (HomeUnitGraph -> HomeUnitGraph) -> UnitEnv -> UnitEnv

#

valueupdateHpt_lazy

:: HomePackageTable -> HomePackageTable
-> UnitEnv
-> UnitEnv

#

valueupdateHpt :: (HomePackageTable -> HomePackageTable) -> UnitEnv -> UnitEnv

#

Unit Env helper functions

19 declarations

valueue_units :: HasDebugCallStack => UnitEnv -> UnitState

#

valueue_currentHomeUnitEnv :: HasDebugCallStack => UnitEnv -> HomeUnitEnv

#

valueue_setUnits :: UnitState -> UnitEnv -> UnitEnv

#

valueue_setUnitFlags

#

valueue_unit_dbs :: UnitEnv -> Maybe [UnitDatabase UnitId]

#

valueue_all_home_unit_ids :: UnitEnv -> Set UnitId

#

valueue_setUnitDbs :: Maybe [UnitDatabase UnitId] -> UnitEnv -> UnitEnv

#

valueue_hpt :: HasDebugCallStack => UnitEnv -> HomePackageTable

#

valueue_homeUnit :: UnitEnv -> Maybe HomeUnit

#

valueue_unsafeHomeUnit :: UnitEnv -> HomeUnit

#

valueue_setFlags :: HasDebugCallStack => DynFlags -> UnitEnv -> UnitEnv

#

valueue_setActiveUnit :: UnitId -> UnitEnv -> UnitEnv

#

valueue_currentUnit :: UnitEnv -> UnitId

#

valueue_findHomeUnitEnv :: HasDebugCallStack => UnitId -> UnitEnv -> HomeUnitEnv

#

valueue_updateHomeUnitEnv

:: HomeUnitEnv -> HomeUnitEnv
-> UnitId
-> UnitEnv
-> UnitEnv

#

valueue_unitHomeUnit :: UnitId -> UnitEnv -> HomeUnit

#

valueue_unitFlags :: HasDebugCallStack => UnitId -> UnitEnv -> DynFlags

#

valueue_renameUnitId

:: HasDebugCallStack
=> UnitId
-> UnitId
-> UnitEnv
-> UnitEnv

#

Rename a unit id in the internal unit env.

ue_renameUnitId oldUnit newUnit UnitEnv, it is assumed that the oldUnit exists in the map, otherwise we panic. The DynFlags associated with the home unit will have its field homeUnitId set to newUnit.

valueue_transitiveHomeDeps :: UnitId -> UnitEnv -> [UnitId]

#

HomeUnitEnv

7 declarations

typetype HomeUnitGraph = UnitEnvGraph HomeUnitEnv

#

datadata HomeUnitEnv

#

Constructors

HomeUnitEnv
- homeUnitEnv_units :: !UnitState
  External units
- homeUnitEnv_unit_dbs :: !Maybe [UnitDatabase UnitId]
  Stack of unit databases for the target platform.
  This field is populated with the result of initUnits.
  Nothing means the databases have never been read from disk.
  Usually we don't reload the databases from disk if they are cached, even if the database flags changed!
- homeUnitEnv_dflags :: DynFlags
  The dynamic flag settings
- homeUnitEnv_hpt :: HomePackageTable
  The home package table describes already-compiled home-package modules, excluding the module we are compiling right now. (In one-shot mode the current module is the only home-package module, so homeUnitEnv_hpt is empty. All other modules count as "external-package" modules. However, even in GHCi mode, hi-boot interfaces are demand-loaded into the external-package table.)
  homeUnitEnv_hpt is not mutable because we only demand-load external packages; the home package is eagerly loaded, module by module, by the compilation manager.
  The HPT may contain modules compiled earlier by --make but not actually below the current module in the dependency graph.
  (This changes a previous invariant: changed Jan 05.)
- homeUnitEnv_home_unit :: !Maybe HomeUnit
  Home-unit

Instances2Outputable

Outputable HomeUnitEnvDefined in ghc-9.10.3 · GHC.Unit.Env
Outputable (UnitEnvGraph HomeUnitEnv)Defined in ghc-9.10.3 · GHC.Unit.Env

valuemkHomeUnitEnv

#

valuelookupHugByModule :: Module -> HomeUnitGraph -> Maybe HomeModInfo

#

valuehugElts :: HomeUnitGraph -> [(UnitId, HomeUnitEnv)]

#

valuelookupHug :: HomeUnitGraph -> UnitId -> ModuleName -> Maybe HomeModInfo

#

valueaddHomeModInfoToHug :: HomeModInfo -> HomeUnitGraph -> HomeUnitGraph

#

UnitEnvGraph

17 declarations

newtypenewtype UnitEnvGraph v

#

Constructors

UnitEnvGraph
- unitEnv_graph :: Map UnitEnvGraphKey v

Instances4Functor, Foldable, Traversable, Outputable

Functor UnitEnvGraphDefined in ghc-9.10.3 · GHC.Unit.Env
Foldable UnitEnvGraphDefined in ghc-9.10.3 · GHC.Unit.Env
Traversable UnitEnvGraphDefined in ghc-9.10.3 · GHC.Unit.Env
Outputable (UnitEnvGraph HomeUnitEnv)Defined in ghc-9.10.3 · GHC.Unit.Env

typetype UnitEnvGraphKey = UnitId

#

valueunitEnv_insert :: UnitEnvGraphKey -> v -> UnitEnvGraph v -> UnitEnvGraph v

#

valueunitEnv_delete :: UnitEnvGraphKey -> UnitEnvGraph v -> UnitEnvGraph v

#

valueunitEnv_adjust

:: v -> v
-> UnitEnvGraphKey
-> UnitEnvGraph v
-> UnitEnvGraph v

#

valueunitEnv_new :: Map UnitEnvGraphKey v -> UnitEnvGraph v

#

valueunitEnv_singleton :: UnitEnvGraphKey -> v -> UnitEnvGraph v

#

valueunitEnv_map :: (v -> v) -> UnitEnvGraph v -> UnitEnvGraph v

#

valueunitEnv_member :: UnitEnvGraphKey -> UnitEnvGraph v -> Bool

#

valueunitEnv_lookup_maybe :: UnitEnvGraphKey -> UnitEnvGraph v -> Maybe v

#

valueunitEnv_lookup :: UnitEnvGraphKey -> UnitEnvGraph v -> v

#

valueunitEnv_keys :: UnitEnvGraph v -> Set UnitEnvGraphKey

#

valueunitEnv_elts :: UnitEnvGraph v -> [(UnitEnvGraphKey, v)]

#

valueunitEnv_hpts :: UnitEnvGraph HomeUnitEnv -> [HomePackageTable]

#

valueunitEnv_foldWithKey

:: b -> UnitEnvGraphKey -> a -> b
-> b
-> UnitEnvGraph a
-> b

#

valueunitEnv_union

:: a -> a -> a
-> UnitEnvGraph a
-> UnitEnvGraph a
-> UnitEnvGraph a

#

valueunitEnv_mapWithKey

:: UnitEnvGraphKey -> v -> b
-> UnitEnvGraph v
-> UnitEnvGraph b

#

Invariants

1 declaration

valueassertUnitEnvInvariant :: HasDebugCallStack => UnitEnv -> UnitEnv

#

Preload units info

2 declarations

valuepreloadUnitsInfo :: UnitEnv -> MaybeErr UnitErr [UnitInfo]

#

Lookup UnitInfo for every preload unit from the UnitState and for every unit used to instantiate the home unit.

valuepreloadUnitsInfo' :: UnitEnv -> [UnitId] -> MaybeErr UnitErr [UnitInfo]

#

Lookup UnitInfo for every preload unit from the UnitState, for every unit used to instantiate the home unit, and for every unit explicitly passed in the given list of UnitId.

Home Module functions

1 declaration

valueisUnitEnvInstalledModule :: UnitEnv -> InstalledModule -> Bool

#

Test if the module comes from the home unit