Safe Haskell	None
Language	GHC2021

GHC.Unit.Module.ModSummary

Description

A ModSummary is a node in the compilation manager's dependency graph (ModuleGraph)

Synopsis

data ModSummary = ModSummary {
- ms_mod :: Module
- ms_hsc_src :: HscSource
- ms_location :: ModLocation
- ms_hs_hash :: Fingerprint
- ms_obj_date :: Maybe UTCTime
- ms_dyn_obj_date :: !(Maybe UTCTime)
- ms_iface_date :: Maybe UTCTime
- ms_hie_date :: Maybe UTCTime
- ms_srcimps :: [(PkgQual, Located ModuleName)]
- ms_textual_imps :: [(PkgQual, Located ModuleName)]
- ms_ghc_prim_import :: !Bool
- ms_parsed_mod :: Maybe HsParsedModule
- ms_hspp_file :: FilePath
- ms_hspp_opts :: DynFlags
- ms_hspp_buf :: Maybe StringBuffer
}
ms_unitid :: ModSummary -> UnitId
ms_installed_mod :: ModSummary -> InstalledModule
ms_mod_name :: ModSummary -> ModuleName
ms_imps :: ModSummary -> [(PkgQual, Located ModuleName)]
ms_plugin_imps :: ModSummary -> [(PkgQual, Located ModuleName)]
ms_mnwib :: ModSummary -> ModuleNameWithIsBoot
ms_home_srcimps :: ModSummary -> [Located ModuleName]
ms_home_imps :: ModSummary -> [(PkgQual, Located ModuleName)]
msHiFilePath :: ModSummary -> FilePath
msDynHiFilePath :: ModSummary -> FilePath
msHsFilePath :: ModSummary -> FilePath
msObjFilePath :: ModSummary -> FilePath
msDynObjFilePath :: ModSummary -> FilePath
msHsFileOsPath :: ModSummary -> OsPath
msHiFileOsPath :: ModSummary -> OsPath
msDynHiFileOsPath :: ModSummary -> OsPath
msObjFileOsPath :: ModSummary -> OsPath
msDynObjFileOsPath :: ModSummary -> OsPath
msDeps :: ModSummary -> [(PkgQual, GenWithIsBoot (Located ModuleName))]
isBootSummary :: ModSummary -> IsBootInterface
isTemplateHaskellOrQQNonBoot :: ModSummary -> Bool
findTarget :: ModSummary -> [Target] -> Maybe Target

Documentation

data ModSummary Source #

Data for a module node in a ModuleGraph. Module nodes of the module graph are one of:

A regular Haskell source module
A hi-boot source module

Constructors

ModSummary

Fields

ms_mod :: Module
Identity of the module
ms_hsc_src :: HscSource
The module source either plain Haskell, hs-boot, or hsig
ms_location :: ModLocation
Location of the various files belonging to the module
ms_hs_hash :: Fingerprint
Content hash of source file
ms_obj_date :: Maybe UTCTime
Timestamp of object, if we have one
ms_dyn_obj_date :: !(Maybe UTCTime)
Timestamp of dynamic object, if we have one
ms_iface_date :: Maybe UTCTime
Timestamp of hi file, if we have one See Note [When source is considered modified] and #9243
ms_hie_date :: Maybe UTCTime
Timestamp of hie file, if we have one
ms_srcimps :: [(PkgQual, Located ModuleName)]
Source imports of the module
ms_textual_imps :: [(PkgQual, Located ModuleName)]
Non-source imports of the module from the module *text*
ms_ghc_prim_import :: !Bool
Whether the special module GHC.Prim was imported explicitly
ms_parsed_mod :: Maybe HsParsedModule
The parsed, nonrenamed source, if we have it. This is also used to support "inline module syntax" in Backpack files.
ms_hspp_file :: FilePath
Filename of preprocessed source file
ms_hspp_opts :: DynFlags
Cached flags from OPTIONS, INCLUDE and LANGUAGE pragmas in the modules source code
ms_hspp_buf :: Maybe StringBuffer
The actual preprocessed source, if we have it

Instances

Instances details

Outputable ModSummary Source #
Instance details Defined in GHC.Unit.Module.ModSummary Methods ppr :: ModSummary -> SDoc Source #

ms_unitid :: ModSummary -> UnitId Source #

ms_installed_mod :: ModSummary -> InstalledModule Source #

ms_mod_name :: ModSummary -> ModuleName Source #

ms_imps :: ModSummary -> [(PkgQual, Located ModuleName)] Source #

Textual imports, plus plugin imports but not SOURCE imports.

ms_plugin_imps :: ModSummary -> [(PkgQual, Located ModuleName)] Source #

Plugin imports

ms_mnwib :: ModSummary -> ModuleNameWithIsBoot Source #

ms_home_srcimps :: ModSummary -> [Located ModuleName] Source #

Like ms_home_imps, but for SOURCE imports.

ms_home_imps :: ModSummary -> [(PkgQual, Located ModuleName)] Source #

All of the (possibly) home module imports from a ModSummary; that is to say, each of these module names could be a home import if an appropriately named file existed. (This is in contrast to package qualified imports, which are guaranteed not to be home imports.)

msHiFilePath :: ModSummary -> FilePath Source #

msDynHiFilePath :: ModSummary -> FilePath Source #

msHsFilePath :: ModSummary -> FilePath Source #

msObjFilePath :: ModSummary -> FilePath Source #

msDynObjFilePath :: ModSummary -> FilePath Source #

msHsFileOsPath :: ModSummary -> OsPath Source #

msHiFileOsPath :: ModSummary -> OsPath Source #

msDynHiFileOsPath :: ModSummary -> OsPath Source #

msObjFileOsPath :: ModSummary -> OsPath Source #

msDynObjFileOsPath :: ModSummary -> OsPath Source #

msDeps :: ModSummary -> [(PkgQual, GenWithIsBoot (Located ModuleName))] Source #

Returns the dependencies of the ModSummary s.

isBootSummary :: ModSummary -> IsBootInterface Source #

Did this ModSummary originate from a hs-boot file?

isTemplateHaskellOrQQNonBoot :: ModSummary -> Bool Source #

findTarget :: ModSummary -> [Target] -> Maybe Target Source #

Find the first target in the provided list which matches the specified ModSummary.