Moduleghc-10.0.0.20260917GHC2024

GHC.Iface.Load

Loading interface files

1 type
26 values

Packageghc-10.0.0.20260917
Exports27
LanguageGHC2024
LicenceBSD-3-Clause
SourceLoad.hs

valuetcLookupImported_maybe :: Name -> TcM (MaybeErr IfaceMessage TyThing)

valueimportDecl :: Name -> IfM lcl (MaybeErr IfaceMessage TyThing)

valuecheckWiredInTyCon :: TyCon -> TcM ()

valueifCheckWiredInThing :: TyThing -> IfL ()

valueloadModuleInterface :: SDoc -> Module -> TcM ModIface

Load interface directly for a fully qualified Module. (This is a fairly rare operation, but in particular it is used to load orphan modules in order to pull their instances into the global package table and to handle some operations in GHCi).

valueloadModuleInterfaces :: SDoc -> [Module] -> TcM ()

Load interfaces for a collection of modules.

valueloadSrcInterface

Load the interface corresponding to an import directive in source code. On a failure, fail in the monad with an error message.

valueloadSrcInterface_maybe

:: SDoc
-> ModuleName
-> IsBootInterface
-> PkgQual
-> RnM (MaybeErr MissingInterfaceError ModIface)

Like loadSrcInterface, but returns a MaybeErr.

valueloadInterfaceForName :: SDoc -> Name -> TcRn ModIface

Loads the interface for a given Name. Should only be called for an imported name; otherwise loadSysInterface may not find the interface

valueloadInterfaceForModule :: SDoc -> Module -> TcRn ModIface

Loads the interface for a given Module.

valueloadInterface

:: SDoc
-> Module
-> WhereFrom
-> IfM lcl (MaybeErr MissingInterfaceError ModIface)

valueloadSysInterface :: SDoc -> Module -> IfM lcl ModIface

Loads a system interface and throws an exception if it fails

valueloadUserInterface :: IsBootInterface -> SDoc -> Module -> IfM lcl ModIface

Loads a user interface and throws an exception if it fails. The first parameter indicates whether we should import the boot variant of the module

valueloadPluginInterface :: SDoc -> Module -> IfM lcl ModIface

valuefindAndReadIface

:: HscEnv
-> SDoc
Reason for loading the iface (used for tracing)
-> InstalledModule
The unique identifier of the on-disk module we're looking for
-> Module
The *actual* module we're looking for. We use this to check the consistency of the requirements of the module we read out.
-> IsBootInterface
Looking for .hi-boot or .hi file
-> IO (MaybeErr MissingInterfaceError (ModIface, ModLocation))

valuereadIface

:: Hooks
-> Logger
-> DynFlags
-> NameCache
-> Module
-> FilePath
-> IO (MaybeErr ReadInterfaceError ModIface)

readIface tries just the one file.

Failed err = file not found, or unreadable, or illegible Succeeded iface = successfully found and parsed

valuewriteIface

:: Logger
-> Profile
-> CompressionIFace
-> FilePath
-> ModIface
-> IO ()

Write interface file

valueflagsToIfCompression :: DynFlags -> CompressionIFace

valuemoduleFreeHolesPrecise

:: SDoc
-> Module
-> TcRnIf gbl lcl (MaybeErr MissingInterfaceError (UniqDSet ModuleName))

Compute the signatures which must be compiled in order to load the interface for a Module. The output of this function is always a subset of moduleFreeHoles; it is more precise because in signature p[A=<A>,B=<B>]:B, although the free holes are A and B, B might not depend on A at all!

If this is invoked on a signature, this does NOT include the signature itself; e.g. precise free module holes of p[A=<A>,B=<B>]:B never includes B.

valueneedWiredInHomeIface :: TyThing -> Bool

valueloadWiredInHomeIface :: Name -> IfM lcl ()

An IfM function to load the home interface for a wired-in thing, so that we're sure that we see its instance declarations and rules See Note [Loading instances for wired-in things]

datadata WhereFrom

Reason for loading an interface file

Used to figure out whether we want to consider loading hi-boot files or not.

Constructors

ImportByUser IsBootInterface
ImportBySystem
ImportByPlugin

Instances1Outputable

Outputable WhereFromDefined in ghc-10.0.0.20260917 · GHC.Iface.Load

valuepprModIfaceSimple :: UnitState -> ModIface -> SDoc

Show a ModIface but don't display details; suitable for ModIfaces stored in the EPT.

valueifaceStats :: ExternalPackageState -> SDoc

valuepprModIface :: UnitState -> ModIface -> SDoc

Show a ModIface

The UnitState is used to pretty-print units

valueshowIface

:: Logger
-> DynFlags
-> UnitState
-> NameCache
-> FilePath
-> IO ()

Read binary interface, and print it out

valuegetGhcPrimIface :: Hooks -> ModIface

Get gHC_PRIM interface file

This is a helper function that takes into account the hook allowing ghc-prim interface to be extended via the ghc-api. Afaik it was introduced for GHCJS so that it can add its own primitive types.

module GHC.Iface.Errors