Safe Haskell	None
Language	GHC2021

GHC.Unit.Finder

Description

Module finder

Synopsis

data FindResult
- = Found ModLocation Module
- | NoPackage Unit
- | FoundMultiple [(Module, ModuleOrigin)]
- | NotFound {
  - fr_paths :: [FilePath]
  - fr_pkg :: Maybe Unit
  - fr_mods_hidden :: [Unit]
  - fr_pkgs_hidden :: [Unit]
  - fr_unusables :: [UnusableUnit]
  - fr_suggestions :: [ModuleSuggestion]
  }
data InstalledFindResult
- = InstalledFound ModLocation
- | InstalledNoPackage UnitId
- | InstalledNotFound [OsPath] (Maybe UnitId)
data FinderOpts = FinderOpts {
- finder_importPaths :: [OsPath]
- finder_lookupHomeInterfaces :: Bool
- finder_bypassHiFileCheck :: Bool
- finder_ways :: Ways
- finder_enableSuggestions :: Bool
- finder_workingDirectory :: Maybe OsPath
- finder_thisPackageName :: Maybe FastString
- finder_hiddenModules :: Set ModuleName
- finder_reexportedModules :: Map ModuleName ModuleName
- finder_hieDir :: Maybe OsPath
- finder_hieSuf :: OsString
- finder_hiDir :: Maybe OsPath
- finder_hiSuf :: OsString
- finder_dynHiSuf :: OsString
- finder_objectDir :: Maybe OsPath
- finder_objectSuf :: OsString
- finder_dynObjectSuf :: OsString
- finder_stubDir :: Maybe OsPath
}
data FinderCache = FinderCache {
- flushFinderCaches :: UnitEnv -> IO ()
- addToFinderCache :: InstalledModule -> InstalledFindResult -> IO ()
- lookupFinderCache :: InstalledModule -> IO (Maybe InstalledFindResult)
- lookupFileCache :: FilePath -> IO Fingerprint
}
initFinderCache :: IO FinderCache
findImportedModule :: HscEnv -> ModuleName -> PkgQual -> IO FindResult
findImportedModuleWithIsBoot :: HscEnv -> ModuleName -> IsBootInterface -> PkgQual -> IO FindResult
findPluginModule :: FinderCache -> FinderOpts -> UnitState -> Maybe HomeUnit -> ModuleName -> IO FindResult
findExactModule :: FinderCache -> FinderOpts -> UnitEnvGraph FinderOpts -> UnitState -> Maybe HomeUnit -> InstalledModule -> IsBootInterface -> IO InstalledFindResult
findHomeModule :: FinderCache -> FinderOpts -> HomeUnit -> ModuleName -> IO FindResult
findExposedPackageModule :: FinderCache -> FinderOpts -> UnitState -> ModuleName -> PkgQual -> IO FindResult
mkHomeModLocation :: FinderOpts -> ModuleName -> OsPath -> FileExt -> HscSource -> ModLocation
mkHomeModLocation2 :: FinderOpts -> ModuleName -> OsPath -> FileExt -> ModLocation
mkHiOnlyModLocation :: FinderOpts -> FileExt -> FileExt -> OsPath -> OsPath -> ModLocation
mkHiPath :: FinderOpts -> OsPath -> OsPath -> OsPath
mkObjPath :: FinderOpts -> OsPath -> OsPath -> OsPath
addModuleToFinder :: FinderCache -> Module -> ModLocation -> HscSource -> IO ()
addHomeModuleToFinder :: FinderCache -> HomeUnit -> ModuleName -> ModLocation -> HscSource -> IO Module
mkStubPaths :: FinderOpts -> ModuleName -> ModLocation -> Maybe OsPath
findObjectLinkableMaybe :: Module -> ModLocation -> IO (Maybe Linkable)
findObjectLinkable :: Module -> FilePath -> UTCTime -> IO Linkable

Documentation

data FindResult Source #

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
Fields 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 :: [Unit] 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

data InstalledFindResult Source #

Constructors

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

data FinderOpts Source #

Locations and information the finder cares about.

Should be taken from DynFlags via initFinderOpts.

Constructors

FinderOpts

Fields

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 :: Set ModuleName
finder_reexportedModules :: Map ModuleName ModuleName
finder_hieDir :: Maybe OsPath
finder_hieSuf :: OsString
finder_hiDir :: Maybe OsPath
finder_hiSuf :: OsString
finder_dynHiSuf :: OsString
finder_objectDir :: Maybe OsPath
finder_objectSuf :: OsString
finder_dynObjectSuf :: OsString
finder_stubDir :: Maybe OsPath

data FinderCache Source #

Constructors

FinderCache

Fields

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.

initFinderCache :: IO FinderCache Source #

findImportedModule :: HscEnv -> ModuleName -> PkgQual -> IO FindResult Source #

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.

findImportedModuleWithIsBoot :: HscEnv -> ModuleName -> IsBootInterface -> PkgQual -> IO FindResult Source #

findPluginModule :: FinderCache -> FinderOpts -> UnitState -> Maybe HomeUnit -> ModuleName -> IO FindResult Source #

Locate a plugin module requested by the user, for a compiler plugin. This consults the same set of exposed packages as findImportedModule, unless -hide-all-plugin-packages or -plugin-package are specified.

findExactModule :: FinderCache -> FinderOpts -> UnitEnvGraph FinderOpts -> UnitState -> Maybe HomeUnit -> InstalledModule -> IsBootInterface -> IO InstalledFindResult Source #

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").

findHomeModule :: FinderCache -> FinderOpts -> HomeUnit -> ModuleName -> IO FindResult Source #

findExposedPackageModule :: FinderCache -> FinderOpts -> UnitState -> ModuleName -> PkgQual -> IO FindResult Source #

mkHomeModLocation :: FinderOpts -> ModuleName -> OsPath -> FileExt -> HscSource -> ModLocation Source #

mkHomeModLocation2 :: FinderOpts -> ModuleName -> OsPath -> FileExt -> ModLocation Source #

mkHiOnlyModLocation :: FinderOpts -> FileExt -> FileExt -> OsPath -> OsPath -> ModLocation Source #

mkHiPath :: FinderOpts -> OsPath -> OsPath -> OsPath Source #

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

mkObjPath :: FinderOpts -> OsPath -> OsPath -> OsPath Source #

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

addModuleToFinder :: FinderCache -> Module -> ModLocation -> HscSource -> IO () Source #

addHomeModuleToFinder :: FinderCache -> HomeUnit -> ModuleName -> ModLocation -> HscSource -> IO Module Source #

mkStubPaths :: FinderOpts -> ModuleName -> ModLocation -> Maybe OsPath Source #

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.

findObjectLinkableMaybe :: Module -> ModLocation -> IO (Maybe Linkable) Source #

findObjectLinkable :: Module -> FilePath -> UTCTime -> IO Linkable Source #