ModuleCabal-3.12.1.0Haskell2010

Distribution.Simple.GHC

This is a fairly large module. It contains most of the GHC-specific code for configuring, building and installing packages. It also exports a function for finding out what packages are already installed. Configuring involves finding the ghc and ghc-pkg programs, finding what language extensions this version of ghc supports and returning a Compiler value.

getInstalledPackages involves calling the ghc-pkg program to find out what packages are installed.

Building is somewhat complex as there is quite a bit of information to take into account. We have to build libs and programs, possibly for profiling and shared libs. We have to support building libraries that will be usable by GHCi and also ghc's -split-objs feature. We have to compile any C files using ghc. Linking, especially for split-objs is remarkably complex, partly because there tend to be 1,000's of .o files and this can often be more than we can pass to the ld or ar programs in one go.

Installing for libs and exes involves finding the right files and copying them to the right places. One of the more tricky things about this module is remembering the layout of files in the build directory (which is not explicitly documented) and thus what search dirs are used for various kinds of files.

3 types
32 values

PackageCabal-3.12.1.0
Exports35
LanguageHaskell2010
LicenceBSD-3-Clause
SourceGHC.hs

valuegetGhcInfo :: Verbosity -> ConfiguredProgram -> IO [(String, String)]

valueconfigure

:: Verbosity
-> Maybe FilePath
-> Maybe FilePath
-> ProgramDb
-> IO (Compiler, Maybe Platform, ProgramDb)

valuegetInstalledPackages

Given a package DB stack, return all installed packages.

valuegetInstalledPackagesMonitorFiles

:: Verbosity
-> Platform
-> ProgramDb
-> [PackageDB]
-> IO [FilePath]

valuegetPackageDBContents

Given a single package DB, return all installed packages.

valuebuildLib

valuebuildFLib

Build a foreign library

valuebuildExe

Build an executable with GHC.

valuereplLib

valuereplFLib

valuereplExe

valuestartInterpreter

:: Verbosity
-> ProgramDb
-> Compiler
-> Platform
-> PackageDBStack
-> IO ()

Start a REPL without loading any source files.

valueinstallLib

:: Verbosity
-> LocalBuildInfo
-> FilePath
install location
-> FilePath
install location for dynamic libraries
-> FilePath
Build location
-> PackageDescription
-> Library
-> ComponentLocalBuildInfo
-> IO ()

Install for ghc, .hi, .a and, if --with-ghci given, .o

valueinstallFLib

:: Verbosity
-> LocalBuildInfo
-> FilePath
install location
-> FilePath
Build location
-> PackageDescription
-> ForeignLib
-> IO ()

Install foreign library for GHC.

valueinstallExe

:: Verbosity
-> LocalBuildInfo
-> FilePath
Where to copy the files to
-> FilePath
Build location
-> (FilePath, FilePath)
Executable (prefix,suffix)
-> PackageDescription
-> Executable
-> IO ()

Install executables for GHC.

valuelibAbiHash

Extracts a String representing a hash of the ABI of a built library. It can fail if the library has not yet been built.

valuehcPkgInfo :: ProgramDb -> HcPkgInfo

valueregisterPackage

valuecomponentGhcOptions

valuecomponentCcGhcOptions

valuegetGhcAppDir :: IO FilePath

Return the FilePath to the GHC application data directory.

valuegetLibDir :: Verbosity -> LocalBuildInfo -> IO FilePath

valueisDynamic :: Compiler -> Bool

Is this compiler's RTS dynamically linked?

valuegetGlobalPackageDB :: Verbosity -> ConfiguredProgram -> IO FilePath

Return the FilePath to the global GHC package database.

valuepkgRoot :: Verbosity -> LocalBuildInfo -> PackageDB -> IO FilePath

Constructing and deconstructing GHC environment files

8 declarations

datadata GhcEnvironmentFileEntry

The kinds of entries we can stick in a .ghc.environment file.

Constructors

GhcEnvFileComment String
```
-- a comment
```
GhcEnvFilePackageId UnitId
```
package-id foo-1.0-4fe301a...
```
GhcEnvFilePackageDb PackageDB
global-package-db, user-package-db or package-db blahpackage.conf.d
GhcEnvFileClearPackageDbStack
```
clear-package-db
```

Instances3Eq, Ord, Show

Eq GhcEnvironmentFileEntryDefined in Cabal-3.12.1.0 · Distribution.Simple.GHC.Internal
Ord GhcEnvironmentFileEntryDefined in Cabal-3.12.1.0 · Distribution.Simple.GHC.Internal
Show GhcEnvironmentFileEntryDefined in Cabal-3.12.1.0 · Distribution.Simple.GHC.Internal

valuesimpleGhcEnvironmentFile

Make entries for a GHC environment file based on a PackageDBStack and a bunch of package (unit) ids.

If you need to do anything more complicated then either use this as a basis and add more entries, or just make all the entries directly.

valuerenderGhcEnvironmentFile :: [GhcEnvironmentFileEntry] -> String

Render a bunch of GHC environment file entries

valuewriteGhcEnvironmentFile

:: FilePath
directory in which to put it
-> Platform
the GHC target platform
-> Version
the GHC version
-> [GhcEnvironmentFileEntry]
the content
-> IO FilePath

Write a .ghc.environment-$arch-$os-$ver file in the given directory.

The Platform and GHC Version are needed as part of the file name.

Returns the name of the file written.

valueghcPlatformAndVersionString :: Platform -> Version -> String

GHC's rendering of its platform and compiler version string as used in certain file locations (such as user package db location). For example x86_64-linux-7.10.4

valuereadGhcEnvironmentFile :: FilePath -> IO [GhcEnvironmentFileEntry]

valueparseGhcEnvironmentFile :: Parser [GhcEnvironmentFileEntry]

newtypenewtype ParseErrorExc

Constructors

ParseErrorExc ParseError

Instances2Show, Exception

Show ParseErrorExcDefined in Cabal-3.12.1.0 · Distribution.Simple.GHC.EnvironmentParser
Exception ParseErrorExcDefined in Cabal-3.12.1.0 · Distribution.Simple.GHC.EnvironmentParser

Version-specific implementation quirks

2 declarations

valuegetImplInfo :: Compiler -> GhcImplInfo

datadata GhcImplInfo

Information about features and quirks of a GHC-based implementation.

Compiler flavors based on GHC behave similarly enough that some of the support code for them is shared. Every implementation has its own peculiarities, that may or may not be a direct result of the underlying GHC version. This record keeps track of these differences.

All shared code (i.e. everything not in the Distribution.Simple.FLAVOR module) should use implementation info rather than version numbers to test for supported features.

Constructors

GhcImplInfo
- supportsHaskell2010 :: Bool
  - XHaskell2010 and -XHaskell98 flags
- supportsGHC2021 :: Bool
  - XGHC2021 flag
- supportsGHC2024 :: Bool
  - XGHC2024 flag
- reportsNoExt :: Bool
  - -supported-languages gives Ext and NoExt
- alwaysNondecIndent :: Bool
  NondecreasingIndentation is always on
- flagGhciScript :: Bool
  - ghci-script flag supported
- flagProfAuto :: Bool
  new style -fprof-auto* flags
- flagProfLate :: Bool
  fprof-late flag
- flagPackageConf :: Bool
  use package-conf instead of package-db
- flagDebugInfo :: Bool
  - g flag supported
- flagHie :: Bool
  - hiedir flag supported
- supportsDebugLevels :: Bool
  supports numeric -g levels
- supportsPkgEnvFiles :: Bool
  picks up .ghc.environment files
- flagWarnMissingHomeModules :: Bool
  - Wmissing-home-modules is supported
- unitIdForExes :: Bool
  Pass -this-unit-id flag when building executables