Moduleghc-10.0.0.20260917GHC2024

GHC.Unit.Finder

Module finder

4 types
18 values

Packageghc-10.0.0.20260917
Exports22
LanguageGHC2024
LicenceBSD-3-Clause
SourceFinder.hs

datadata FindResult

The result of searching for an imported module.

NB: FindResult manages both user source-import lookups (which can result in Module) as well as direct imports for interfaces (which always result in InstalledModule).

Constructors

Found ModLocation Module
The module was found
NoPackage Unit
The requested unit was not found
FoundMultiple [(Module, ModuleOrigin)]
_Error_: both in multiple packages
NotFound
Not found
- fr_paths :: [FilePath]
  Places where I looked
- fr_pkg :: Maybe Unit
  Just p => module is in this unit's manifest, but couldn't find the .hi file
- fr_mods_hidden :: [Unit]
  Module is in these units, but the *module* is hidden
- fr_pkgs_hidden :: [UnitInfo]
  Module is in these units, but the *unit* is hidden
- fr_unusables :: [UnusableUnit]
  Module is in these units, but it is unusable
- fr_suggestions :: [ModuleSuggestion]
  Possible mis-spelled modules

datadata InstalledFindResult

Constructors

InstalledFound ModLocation
InstalledNoPackage UnitId
InstalledNotFound [OsPath] (Maybe UnitId)

datadata FinderOpts

Locations and information the finder cares about.

Should be taken from DynFlags via initFinderOpts.

Constructors

FinderOpts
- finder_importPaths :: [OsPath]
  Where are we allowed to look for Modules and Source files
- finder_lookupHomeInterfaces :: Bool
  When looking up a home module:
  - True: search interface files (e.g. in '-c' mode)
  - False: search source files (e.g. in '--make' mode)
- finder_bypassHiFileCheck :: Bool
  Don't check that an imported interface file actually exists if it can only be at one location. The interface will be reported as InstalledFound even if the file doesn't exist, so this is only useful in specific cases (e.g. to generate dependencies with `ghc -M`)
- finder_ways :: Ways
- finder_enableSuggestions :: Bool
  If we encounter unknown modules, should we suggest modules that have a similar name.
- finder_workingDirectory :: Maybe OsPath
- finder_thisPackageName :: Maybe FastString
- finder_hiddenModules :: !UniqSet ModuleName
- finder_reexportedModules :: !UniqMap ModuleName ModuleName
- finder_hieDir :: Maybe OsPath
- finder_hieSuf :: OsString
- finder_hiDir :: Maybe OsPath
- finder_hiSuf :: OsString
- finder_bytecodeDir :: Maybe OsPath
- finder_bytecodeSuf :: OsString
- finder_dynHiSuf :: OsString
- finder_objectDir :: Maybe OsPath
- finder_objectSuf :: OsString
- finder_dynObjectSuf :: OsString
- finder_stubDir :: Maybe OsPath

datadata FinderCache

Constructors

FinderCache
- flushFinderCaches :: UnitEnv -> IO ()
  remove all the home modules from the cache; package modules are assumed to not move around during a session; also flush the file hash cache.
- addToFinderCache :: InstalledModule -> InstalledFindResult -> IO ()
  Add a found location to the cache for the module.
- lookupFinderCache :: InstalledModule -> IO (Maybe InstalledFindResult)
  Look for a location in the cache.
- lookupFileCache :: FilePath -> IO Fingerprint
  Look for the hash of a file in the cache. This should add it to the cache. If the file doesn't exist, raise an IOException.
- lookupDirCache :: FilePath -> IO Fingerprint

valueinitFinderCache :: IO FinderCache

valuefindImportedModule :: HscEnv -> ModuleName -> PkgQual -> IO FindResult

Locate a module that was imported by the user. We have the module's name, and possibly a package name. Without a package name, this function will use the search path and the known exposed packages to find the module, if a package is specified then only that package is searched for the module.

valuefindImportedModuleWithIsBoot

valuefindPluginModule :: HscEnv -> ModuleName -> IO FindResult

valuefindExactModule

Locate a specific Module. The purpose of this function is to create a ModLocation for a given Module, that is to find out where the files associated with this module live. It is used when reading the interface for a module mentioned by another interface, for example (a "system import").

valuefindHomeModule

valuefindExposedPackageModule

valuemkHomeModLocation

:: FinderOpts
-> ModuleName
-> OsPath
-> FileExt
-> HscSource
-> ModLocation

valuemkHomeModLocation2

:: FinderOpts
-> ModuleName
-> OsPath
-> FileExt
-> ModLocation

valuemkHiOnlyModLocation

:: FinderOpts
-> FileExt
-> FileExt
-> OsPath
-> OsPath
-> ModLocation

valuemkHiPath :: FinderOpts -> OsPath -> OsPath -> OsPath

Constructs the filename of a .hi file for a given source file. Does not check whether the .hi file exists

valuemkObjPath :: FinderOpts -> OsPath -> OsPath -> OsPath

Constructs the filename of a .o file for a given source file. Does not check whether the .o file exists

valueaddModuleToFinder

:: FinderCache
-> Module
-> ModLocation
-> HscSource
-> IO ()

valueaddHomeModuleToFinder

valuemkStubPaths :: FinderOpts -> ModuleName -> ModLocation -> Maybe OsPath

Compute the file name of a header file for foreign stubs, using either the directory explicitly specified in the command line option -stubdir, or the directory of the module's source file.

When compiling bytecode from interface Core bindings, ModLocation does not contain a source file path, so the header isn't written. This doesn't have an impact, since we cannot support headers importing Haskell symbols defined in bytecode for TH whatsoever at the moment.

valuefindObjectLinkableMaybe :: Module -> ModLocation -> IO (Maybe Linkable)

valuefindObjectLinkable :: Module -> FilePath -> UTCTime -> IO Linkable

valuegetDirHash :: FilePath -> IO Fingerprint

This function computes a shallow hash of a directory, so really just what files and directories are directly inside it. It does not look at the contents of the files, or the contents of the directories it contains.