ghc-8.2.2: The GHC API

Safe Haskell | None
Language | Haskell2010

Packages

Contents

- Reading the package config, and processing cmdline args
- Querying the package config
- Inspecting the set of packages in scope
- Utils

Description

Package manipulation

Synopsis

- module PackageConfig
- data PackageState
- data PackageConfigMap
- emptyPackageState :: PackageState
- initPackages :: DynFlags -> IO (DynFlags, [PreloadUnitId])
- readPackageConfigs :: DynFlags -> IO [(FilePath, [PackageConfig])]
- getPackageConfRefs :: DynFlags -> IO [PkgConfRef]
- resolvePackageConfig :: DynFlags -> PkgConfRef -> IO (Maybe FilePath)
- readPackageConfig :: DynFlags -> FilePath -> IO (FilePath, [PackageConfig])
- listPackageConfigMap :: DynFlags -> [PackageConfig]
- lookupPackage :: DynFlags -> UnitId -> Maybe PackageConfig
- lookupPackage' :: Bool -> PackageConfigMap -> UnitId -> Maybe PackageConfig
- lookupInstalledPackage :: DynFlags -> InstalledUnitId -> Maybe PackageConfig
- lookupPackageName :: DynFlags -> PackageName -> Maybe ComponentId
- improveUnitId :: PackageConfigMap -> UnitId -> UnitId
- searchPackageId :: DynFlags -> SourcePackageId -> [PackageConfig]
- getPackageDetails :: DynFlags -> UnitId -> PackageConfig
- getInstalledPackageDetails :: DynFlags -> InstalledUnitId -> PackageConfig
- componentIdString :: DynFlags -> ComponentId -> Maybe String
- displayInstalledUnitId :: DynFlags -> InstalledUnitId -> Maybe String
- listVisibleModuleNames :: DynFlags -> [ModuleName]
- lookupModuleInAllPackages :: DynFlags -> ModuleName -> [(Module, PackageConfig)]
- lookupModuleWithSuggestions :: DynFlags -> ModuleName -> Maybe FastString -> LookupResult
- lookupPluginModuleWithSuggestions :: DynFlags -> ModuleName -> Maybe FastString -> LookupResult
- data LookupResult
  - = LookupFound Module PackageConfig
  - | LookupMultiple [(Module, ModuleOrigin)]
  - | LookupHidden [(Module, ModuleOrigin)] [(Module, ModuleOrigin)]
  - | LookupNotFound [ModuleSuggestion]
- data ModuleSuggestion
  - = SuggestVisible ModuleName Module ModuleOrigin
  - | SuggestHidden ModuleName Module ModuleOrigin
- data ModuleOrigin
  - = ModHidden
  - | ModOrigin {
    - fromOrigPackage :: Maybe Bool
    - fromExposedReexport :: [PackageConfig]
    - fromHiddenReexport :: [PackageConfig]
    - fromPackageFlag :: Bool
    }
- getPackageIncludePath :: DynFlags -> [PreloadUnitId] -> IO [String]
- getPackageLibraryPath :: DynFlags -> [PreloadUnitId] -> IO [String]
- getPackageLinkOpts :: DynFlags -> [PreloadUnitId] -> IO ([String], [String], [String])
- getPackageExtraCcOpts :: DynFlags -> [PreloadUnitId] -> IO [String]
- getPackageFrameworkPath :: DynFlags -> [PreloadUnitId] -> IO [String]
- getPackageFrameworks :: DynFlags -> [PreloadUnitId] -> IO [String]
- getPackageConfigMap :: DynFlags -> PackageConfigMap
- getPreloadPackagesAnd :: DynFlags -> [PreloadUnitId] -> IO [PackageConfig]
- collectIncludeDirs :: [PackageConfig] -> [FilePath]
- collectLibraryPaths :: DynFlags -> [PackageConfig] -> [FilePath]
- collectLinkOpts :: DynFlags -> [PackageConfig] -> ([String], [String], [String])
- packageHsLibs :: DynFlags -> PackageConfig -> [String]
- unwireUnitId :: DynFlags -> UnitId -> UnitId
- pprFlag :: PackageFlag -> SDoc
- pprPackages :: DynFlags -> SDoc
- pprPackagesSimple :: DynFlags -> SDoc
- pprModuleMap :: ModuleToPkgConfAll -> SDoc
- isDllName :: DynFlags -> Module -> Name -> Bool

# Documentation

module PackageConfig

# Reading the package config, and processing cmdline args

data PackageState #

data PackageConfigMap #

`UniqFM` map from `UnitId` to `PackageConfig`, plus the transitive closure of preload packages.

emptyPackageState :: PackageState #

initPackages :: DynFlags -> IO (DynFlags, [PreloadUnitId]) #

Call this after `parseDynFlags`. It reads the package database files, and sets up various internal tables of package information, according to the package-related flags on the command-line (`-package`, `-hide-package` etc.)

Returns a list of packages to link in if we're doing dynamic linking. This list contains the packages that the user explicitly mentioned with `-package` flags.

`initPackages` can be called again subsequently after updating the `packageFlags` field of the `DynFlags`, and it will update the `pkgState` in `DynFlags` and return a list of packages to link in.

readPackageConfigs :: DynFlags -> IO [(FilePath, [PackageConfig])] #

getPackageConfRefs :: DynFlags -> IO [PkgConfRef] #

resolvePackageConfig :: DynFlags -> PkgConfRef -> IO (Maybe FilePath) #

readPackageConfig :: DynFlags -> FilePath -> IO (FilePath, [PackageConfig]) #

listPackageConfigMap :: DynFlags -> [PackageConfig] #

Get a list of entries from the package database. NB: be careful with this function, although all packages in this map are "visible", this does not imply that the exposed-modules of the package are available (they may have been thinned or renamed).

# Querying the package config

lookupPackage :: DynFlags -> UnitId -> Maybe PackageConfig #

Find the package we know about with the given unit id, if any

lookupPackage' :: Bool -> PackageConfigMap -> UnitId -> Maybe PackageConfig #

A more specialized interface, which takes a boolean specifying whether or not to look for on-the-fly renamed interfaces, and just a `PackageConfigMap` rather than a `DynFlags` (so it can be used while we're initializing `DynFlags`

lookupInstalledPackage :: DynFlags -> InstalledUnitId -> Maybe PackageConfig #

lookupPackageName :: DynFlags -> PackageName -> Maybe ComponentId #

Find the package we know about with the given package name (e.g. `foo`), if any (NB: there might be a locally defined unit name which overrides this)

improveUnitId :: PackageConfigMap -> UnitId -> UnitId #

Given a fully instantiated `UnitId`, improve it into a `InstalledUnitId` if we can find it in the package database.

searchPackageId :: DynFlags -> SourcePackageId -> [PackageConfig] #

Search for packages with a given package ID (e.g. "foo-0.1")

getPackageDetails :: DynFlags -> UnitId -> PackageConfig #

Looks up the package with the given id in the package state, panicing if it is not found

getInstalledPackageDetails :: DynFlags -> InstalledUnitId -> PackageConfig #

componentIdString :: DynFlags -> ComponentId -> Maybe String #

displayInstalledUnitId :: DynFlags -> InstalledUnitId -> Maybe String #

listVisibleModuleNames :: DynFlags -> [ModuleName] #

lookupModuleInAllPackages :: DynFlags -> ModuleName -> [(Module, PackageConfig)] #

Takes a `ModuleName`, and if the module is in any package returns list of modules which take that name.

lookupModuleWithSuggestions :: DynFlags -> ModuleName -> Maybe FastString -> LookupResult #

lookupPluginModuleWithSuggestions :: DynFlags -> ModuleName -> Maybe FastString -> LookupResult #

data LookupResult #

The result of performing a lookup

Constructors

LookupFound Module PackageConfig | Found the module uniquely, nothing else to do
LookupMultiple [(Module, ModuleOrigin)] | Multiple modules with the same name in scope
LookupHidden [(Module, ModuleOrigin)] [(Module, ModuleOrigin)] | No modules found, but there were some hidden ones with an exact name match. First is due to package hidden, second is due to module being hidden
LookupNotFound [ModuleSuggestion] | Nothing found, here are some suggested different names

data ModuleSuggestion #

Constructors

SuggestVisible ModuleName Module ModuleOrigin |
SuggestHidden ModuleName Module ModuleOrigin |

data ModuleOrigin #

Package state is all stored in `DynFlags`, including the details of all packages, which packages are exposed, and which modules they provide.

The package state is computed by `initPackages`, and kept in DynFlags. It is influenced by various package flags:

- `-package pkg` and `-package-id pkg` cause `pkg` to become exposed. If `-hide-all-packages` was not specified, these commands also cause all other packages with the same name to become hidden.
- `-hide-package pkg` causes `pkg` to become hidden.
- (there are a few more flags, check below for their semantics)

The package state has the following properties.

- Let `exposedPackages` be the set of packages thus exposed. Let `depExposedPackages` be the transitive closure from `exposedPackages` of their dependencies.
- When searching for a module from an preload import declaration, only the exposed modules in `exposedPackages` are valid.
- When searching for a module from an implicit import, all modules from `depExposedPackages` are valid.
- When linking in a compilation manager mode, we link in packages the program depends on (the compiler knows this list by the time it gets to the link step). Also, we link in all packages which were mentioned with preload `-package` flags on the command-line, or are a transitive dependency of same, or are "base"/"rts". The reason for this is that we might need packages which don't contain any Haskell modules, and therefore won't be discovered by the normal mechanism of dependency tracking.

Given a module name, there may be multiple ways it came into scope, possibly simultaneously. This data type tracks all the possible ways it could have come into scope. Warning: don't use the record functions, they're partial!

Constructors

ModHidden | Module is hidden, and thus never will be available for import. (But maybe the user didn't realize), so we'll still keep track of these modules.)
ModOrigin | Module is public, and could have come from some places.

Fields

- fromOrigPackage :: Maybe Bool

  `Just False` means that this module is in someone's `exported-modules` list, but that package is hidden; `Just True` means that it is available; `Nothing` means neither applies.

- fromExposedReexport :: [PackageConfig]

  Is the module available from a reexport of an exposed package? There could be multiple.

- fromHiddenReexport :: [PackageConfig]

  Is the module available from a reexport of a hidden package?

- fromPackageFlag :: Bool

  Did the module export come from a package flag? (ToDo: track more information.

Instances

Semigroup ModuleOrigin # |
Methods (<>) :: ModuleOrigin -> ModuleOrigin -> ModuleOrigin Source # sconcat :: NonEmpty ModuleOrigin -> ModuleOrigin Source # stimes :: Integral b => b -> ModuleOrigin -> ModuleOrigin Source #
Monoid ModuleOrigin # |
Methods mempty :: ModuleOrigin Source # mappend :: ModuleOrigin -> ModuleOrigin -> ModuleOrigin Source # mconcat :: [ModuleOrigin] -> ModuleOrigin Source #
Outputable ModuleOrigin # |
Methods ppr :: ModuleOrigin -> SDoc # pprPrec :: Rational -> ModuleOrigin -> SDoc #

# Inspecting the set of packages in scope

getPackageIncludePath :: DynFlags -> [PreloadUnitId] -> IO [String] #

Find all the include directories in these and the preload packages

getPackageLibraryPath :: DynFlags -> [PreloadUnitId] -> IO [String] #

Find all the library paths in these and the preload packages

getPackageLinkOpts :: DynFlags -> [PreloadUnitId] -> IO ([String], [String], [String]) #

Find all the link options in these and the preload packages, returning (package hs lib options, extra library options, other flags)

getPackageExtraCcOpts :: DynFlags -> [PreloadUnitId] -> IO [String] #

Find all the C-compiler options in these and the preload packages

getPackageFrameworkPath :: DynFlags -> [PreloadUnitId] -> IO [String] #

Find all the package framework paths in these and the preload packages

getPackageFrameworks :: DynFlags -> [PreloadUnitId] -> IO [String] #

Find all the package frameworks in these and the preload packages

getPackageConfigMap :: DynFlags -> PackageConfigMap #

Retrieve the `PackageConfigMap` from `DynFlags`; used in the `hs-boot` loop-breaker.

getPreloadPackagesAnd :: DynFlags -> [PreloadUnitId] -> IO [PackageConfig] #

Find all the `PackageConfig` in both the preload packages from `DynFlags` and corresponding to the list of `PackageConfig`s

collectIncludeDirs :: [PackageConfig] -> [FilePath] #

collectLibraryPaths :: DynFlags -> [PackageConfig] -> [FilePath] #

collectLinkOpts :: DynFlags -> [PackageConfig] -> ([String], [String], [String]) #

packageHsLibs :: DynFlags -> PackageConfig -> [String] #

# Utils

unwireUnitId :: DynFlags -> UnitId -> UnitId #

Given a wired-in `UnitId`, "unwire" it into the `UnitId` that it was recorded as in the package database.

pprFlag :: PackageFlag -> SDoc #

pprPackages :: DynFlags -> SDoc #

Show (very verbose) package info

pprPackagesSimple :: DynFlags -> SDoc #

Show simplified package info.

The idea is to only print package id, and any information that might be different from the package databases (exposure, trust)

pprModuleMap :: ModuleToPkgConfAll -> SDoc #

Show the mapping of modules to where they come from.

isDllName :: DynFlags -> Module -> Name -> Bool #

Will the `Name` come from a dynamically linked library?