| Copyright | Isaac Jones 2003-2007 |
|---|---|
| License | BSD3 |
| Maintainer | cabal-devel@haskell.org |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell2010 |
Distribution.Simple.GHC
Description
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.
- getGhcInfo :: Verbosity -> ConfiguredProgram -> IO [(String, String)]
- configure :: Verbosity -> Maybe FilePath -> Maybe FilePath -> ProgramDb -> IO (Compiler, Maybe Platform, ProgramDb)
- getInstalledPackages :: Verbosity -> Compiler -> PackageDBStack -> ProgramDb -> IO InstalledPackageIndex
- getInstalledPackagesMonitorFiles :: Verbosity -> Platform -> ProgramDb -> [PackageDB] -> IO [FilePath]
- getPackageDBContents :: Verbosity -> PackageDB -> ProgramDb -> IO InstalledPackageIndex
- buildLib :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO ()
- buildFLib :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> ForeignLib -> ComponentLocalBuildInfo -> IO ()
- buildExe :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO ()
- replLib :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO ()
- replFLib :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> ForeignLib -> ComponentLocalBuildInfo -> IO ()
- replExe :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO ()
- startInterpreter :: Verbosity -> ProgramDb -> Compiler -> Platform -> PackageDBStack -> IO ()
- installLib :: Verbosity -> LocalBuildInfo -> FilePath -> FilePath -> FilePath -> PackageDescription -> Library -> ComponentLocalBuildInfo -> IO ()
- installFLib :: Verbosity -> LocalBuildInfo -> FilePath -> FilePath -> PackageDescription -> ForeignLib -> IO ()
- installExe :: Verbosity -> LocalBuildInfo -> FilePath -> FilePath -> (FilePath, FilePath) -> PackageDescription -> Executable -> IO ()
- libAbiHash :: Verbosity -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO String
- hcPkgInfo :: ProgramDb -> HcPkgInfo
- registerPackage :: Verbosity -> ProgramDb -> PackageDBStack -> InstalledPackageInfo -> RegisterOptions -> IO ()
- componentGhcOptions :: Verbosity -> LocalBuildInfo -> BuildInfo -> ComponentLocalBuildInfo -> FilePath -> GhcOptions
- componentCcGhcOptions :: Verbosity -> LocalBuildInfo -> BuildInfo -> ComponentLocalBuildInfo -> FilePath -> FilePath -> GhcOptions
- getLibDir :: Verbosity -> LocalBuildInfo -> IO FilePath
- isDynamic :: Compiler -> Bool
- getGlobalPackageDB :: Verbosity -> ConfiguredProgram -> IO FilePath
- pkgRoot :: Verbosity -> LocalBuildInfo -> PackageDB -> IO FilePath
- data GhcEnvironmentFileEntry
- simpleGhcEnvironmentFile :: PackageDBStack -> [UnitId] -> [GhcEnvironmentFileEntry]
- writeGhcEnvironmentFile :: FilePath -> Platform -> Version -> [GhcEnvironmentFileEntry] -> NoCallStackIO ()
- getImplInfo :: Compiler -> GhcImplInfo
- data GhcImplInfo = GhcImplInfo {}
Documentation
getGhcInfo :: Verbosity -> ConfiguredProgram -> IO [(String, String)] #
configure :: Verbosity -> Maybe FilePath -> Maybe FilePath -> ProgramDb -> IO (Compiler, Maybe Platform, ProgramDb) #
getInstalledPackages :: Verbosity -> Compiler -> PackageDBStack -> ProgramDb -> IO InstalledPackageIndex #
Given a package DB stack, return all installed packages.
getInstalledPackagesMonitorFiles :: Verbosity -> Platform -> ProgramDb -> [PackageDB] -> IO [FilePath] #
getPackageDBContents :: Verbosity -> PackageDB -> ProgramDb -> IO InstalledPackageIndex #
Given a single package DB, return all installed packages.
buildLib :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO () #
buildFLib :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> ForeignLib -> ComponentLocalBuildInfo -> IO () #
Build a foreign library
buildExe :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO () #
Build an executable with GHC.
replLib :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO () #
replFLib :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> ForeignLib -> ComponentLocalBuildInfo -> IO () #
Build a foreign library
replExe :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO () #
Build an executable with GHC.
startInterpreter :: Verbosity -> ProgramDb -> Compiler -> Platform -> PackageDBStack -> IO () #
Start a REPL without loading any source files.
Arguments
| :: 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
Arguments
| :: Verbosity | |
| -> LocalBuildInfo | |
| -> FilePath | install location |
| -> FilePath | Build location |
| -> PackageDescription | |
| -> ForeignLib | |
| -> IO () |
Install foreign library for GHC.
Arguments
| :: Verbosity | |
| -> LocalBuildInfo | |
| -> FilePath | Where to copy the files to |
| -> FilePath | Build location |
| -> (FilePath, FilePath) | Executable (prefix,suffix) |
| -> PackageDescription | |
| -> Executable | |
| -> IO () |
Install executables for GHC.
libAbiHash :: Verbosity -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO String #
Extracts a String representing a hash of the ABI of a built library. It can fail if the library has not yet been built.
registerPackage :: Verbosity -> ProgramDb -> PackageDBStack -> InstalledPackageInfo -> RegisterOptions -> IO () #
componentGhcOptions :: Verbosity -> LocalBuildInfo -> BuildInfo -> ComponentLocalBuildInfo -> FilePath -> GhcOptions #
componentCcGhcOptions :: Verbosity -> LocalBuildInfo -> BuildInfo -> ComponentLocalBuildInfo -> FilePath -> FilePath -> GhcOptions #
getGlobalPackageDB :: Verbosity -> ConfiguredProgram -> IO FilePath #
Return the FilePath to the global GHC package database.
Constructing GHC environment files
data 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 |
|
| GhcEnvFileClearPackageDbStack | clear-package-db |
simpleGhcEnvironmentFile :: PackageDBStack -> [UnitId] -> [GhcEnvironmentFileEntry] #
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.
Arguments
| :: FilePath | directory in which to put it |
| -> Platform | the GHC target platform |
| -> Version | the GHC version |
| -> [GhcEnvironmentFileEntry] | the content |
| -> NoCallStackIO () |
Version-specific implementation quirks
getImplInfo :: Compiler -> GhcImplInfo #
data 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 | |
Fields
| |