GHC.Unit.Module.ModSummary

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

Documentation

data ModSummary

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 explicitliy

• 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

Outputable ModSummary

Defined in GHC.Unit.Module.ModSummary

Methods

ppr :: ModSummary -> SDoc

ms_unitid :: ModSummary -> UnitId

ms_installed_mod :: ModSummary -> InstalledModule

ms_mod_name :: ModSummary -> ModuleName

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

Textual imports, plus plugin imports but not SOURCE imports.

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

Plugin imports

ms_mnwib :: ModSummary -> ModuleNameWithIsBoot

ms_home_srcimps :: ModSummary -> [Located ModuleName]

Like ms_home_imps, but for SOURCE imports.

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

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

msDynHiFilePath :: ModSummary -> FilePath

msHsFilePath :: ModSummary -> FilePath

msObjFilePath :: ModSummary -> FilePath

msDynObjFilePath :: ModSummary -> FilePath

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

Returns the dependencies of the ModSummary s.

isBootSummary :: ModSummary -> IsBootInterface

Did this ModSummary originate from a hs-boot file?

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

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