Development.IDE.GHC.Compat.Units

Compat module for UnitState and UnitInfo.

UnitState

type UnitState = PackageState

initUnits :: HscEnv -> IO HscEnv

unitState :: HscEnv -> UnitState

getUnitName :: HscEnv -> UnitId -> Maybe PackageName

explicitUnits :: UnitState -> [Unit]

preloadClosureUs :: HscEnv -> PreloadUnitClosure

listVisibleModuleNames :: HscEnv -> [ModuleName]

data LookupResult

The result of performing a lookup

Constructors

LookupFound Module PackageConfig

Found the module uniquely, nothing else to do

LookupMultiple [(Module, ModuleOrigin)]

Multiple modules with the same name in scope

LookupHidden [(Module, ModuleOrigin)] [(Module, ModuleOrigin)]

No modules found, but there were some hidden ones with an exact name match. First is due to package hidden, second is due to module being hidden

LookupUnusable [(Module, ModuleOrigin)]

No modules found, but there were some unusable ones with an exact name match

LookupNotFound [ModuleSuggestion]

Nothing found, here are some suggested different names

lookupModuleWithSuggestions :: HscEnv -> ModuleName -> Maybe FastString -> LookupResult

UnitInfoMap

type UnitInfoMap = PackageConfigMap

getUnitInfoMap :: HscEnv -> UnitInfoMap

lookupUnit :: HscEnv -> Unit -> Maybe UnitInfo

lookupUnit' :: Bool -> UnitInfoMap -> PreloadUnitClosure -> Unit -> Maybe UnitInfo

UnitInfo

type UnitInfo = PackageConfig

unitExposedModules :: UnitInfo -> [(ModuleName, Maybe Module)]

unitDepends :: UnitInfo -> [UnitId]

unitHaddockInterfaces :: UnitInfo -> [FilePath]

unitInfoId :: UnitInfo -> Unit

unitPackageNameString :: UnitInfo -> String

unitPackageVersion :: UnitInfo -> Version

UnitId helpers

data UnitId

A unit identifier identifies a (possibly partially) instantiated library. It is primarily used as part of Module, which in turn is used in Name, which is used to give names to entities when typechecking.

There are two possible forms for a UnitId. It can be a DefiniteUnitId, in which case we just have a string that uniquely identifies some fully compiled, installed library we have on disk. However, when we are typechecking a library with missing holes, we may need to instantiate a library on the fly (in which case we don't have any on-disk representation.) In that case, you have an IndefiniteUnitId, which explicitly records the instantiation, so that we can substitute over it.

Instances

Eq UnitId

Defined in Module

Methods

(==) :: UnitId -> UnitId -> Bool

(/=) :: UnitId -> UnitId -> Bool

Data UnitId

Defined in Module

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UnitId -> c UnitId

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UnitId

toConstr :: UnitId -> Constr

dataTypeOf :: UnitId -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UnitId)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UnitId)

gmapT :: (forall b. Data b => b -> b) -> UnitId -> UnitId

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UnitId -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UnitId -> r

gmapQ :: (forall d. Data d => d -> u) -> UnitId -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UnitId -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UnitId -> m UnitId

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UnitId -> m UnitId

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UnitId -> m UnitId

Ord UnitId

Defined in Module

Methods

compare :: UnitId -> UnitId -> Ordering

(<) :: UnitId -> UnitId -> Bool

(<=) :: UnitId -> UnitId -> Bool

(>) :: UnitId -> UnitId -> Bool

(>=) :: UnitId -> UnitId -> Bool

max :: UnitId -> UnitId -> UnitId

min :: UnitId -> UnitId -> UnitId

Show UnitId

Defined in Module

Methods

showsPrec :: Int -> UnitId -> ShowS

show :: UnitId -> String

showList :: [UnitId] -> ShowS

NFData UnitId

Defined in Module

Methods

rnf :: UnitId -> ()

Binary UnitId

Defined in Module

Methods

put_ :: BinHandle -> UnitId -> IO ()

put :: BinHandle -> UnitId -> IO (Bin UnitId)

get :: BinHandle -> IO UnitId

Uniquable UnitId

Defined in Module

Methods

getUnique :: UnitId -> Unique

Outputable UnitId

Defined in Module

Methods

ppr :: UnitId -> SDoc

pprPrec :: Rational -> UnitId -> SDoc

DbUnitIdModuleRep InstalledUnitId ComponentId UnitId ModuleName Module

Defined in Module

Methods

fromDbModule :: DbModule InstalledUnitId ComponentId UnitId ModuleName Module -> Module

toDbModule :: Module -> DbModule InstalledUnitId ComponentId UnitId ModuleName Module

fromDbUnitId :: DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module -> UnitId

toDbUnitId :: UnitId -> DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module

type Unit = UnitId

unitString :: Unit -> String

stringToUnit :: String -> Unit

pattern RealUnit :: DefUnitId -> UnitId

definiteUnitId :: DefUnitId -> UnitId

defUnitId :: UnitId -> DefUnitId

installedModule :: UnitId -> ModuleName -> InstalledModule

Module

toUnitId :: Unit -> UnitId

moduleUnitId :: Module -> UnitId

moduleUnit :: Module -> Unit

ExternalPackageState

data ExternalPackageState

Information about other packages that we have slurped in by reading their interface files

Constructors

EPS

Fields

• eps_is_boot :: !(ModuleNameEnv (ModuleName, IsBootInterface))

  In OneShot mode (only), home-package modules accumulate in the external package state, and are sucked in lazily. For these home-pkg modules (only) we need to record which are boot modules. We set this field after loading all the explicitly-imported interfaces, but before doing anything else

  The ModuleName part is not necessary, but it's useful for debug prints, and it's convenient because this field comes direct from imp_dep_mods

• eps_PIT :: !PackageIfaceTable

  The ModIfaces for modules in external packages whose interfaces we have opened. The declarations in these interface files are held in the eps_decls, eps_inst_env, eps_fam_inst_env and eps_rules fields of this record, not in the mi_decls fields of the interface we have sucked in.

  What is in the PIT is:

  • The Module
  • Fingerprint info
  • Its exports
  • Fixities
  • Deprecations and warnings
• eps_free_holes :: InstalledModuleEnv (UniqDSet ModuleName)

  Cache for mi_free_holes. Ordinarily, we can rely on the eps_PIT for this information, EXCEPT that when we do dependency analysis, we need to look at the Dependencies of our imports to determine what their precise free holes are (moduleFreeHolesPrecise). We don't want to repeatedly reread in the interface for every import, so cache it here. When the PIT gets filled in we can drop these entries.

• eps_PTE :: !PackageTypeEnv

  Result of typechecking all the external package interface files we have sucked in. The domain of the mapping is external-package modules

• eps_inst_env :: !PackageInstEnv

  The total InstEnv accumulated from all the external-package modules

• eps_fam_inst_env :: !PackageFamInstEnv

  The total FamInstEnv accumulated from all the external-package modules

• eps_rule_base :: !PackageRuleBase

  The total RuleEnv accumulated from all the external-package modules

• eps_ann_env :: !PackageAnnEnv

  The total AnnEnv accumulated from all the external-package modules

• eps_complete_matches :: !PackageCompleteMatchMap

  The total CompleteMatchMap accumulated from all the external-package modules

• eps_mod_fam_inst_env :: !(ModuleEnv FamInstEnv)

  The family instances accumulated from external packages, keyed off the module that declared them

• eps_stats :: !EpsStats

  Stastics about what was loaded from external packages

Utils

filterInplaceUnits :: [UnitId] -> [PackageFlag] -> ([UnitId], [PackageFlag])

type FinderCache = InstalledModuleEnv InstalledFindResult

The FinderCache maps modules to the result of searching for that module. It records the results of searching for modules along the search path. On :load, we flush the entire contents of this cache.

showSDocForUser' :: HscEnv -> PrintUnqualified -> SDoc -> String