ModuleCabal-3.12.1.0Haskell2010

Distribution.Simple.Build

This is the entry point to actually building the modules in a package. It doesn't actually do much itself, most of the work is delegated to compiler-specific actions. It does do some non-compiler specific bits like running pre-processors.

2 types
9 values

PackageCabal-3.12.1.0
Exports11
LanguageHaskell2010
LicenceBSD-3-Clause
SourceBuild.hs

Build

1 declaration

valuebuild

:: PackageDescription
Mostly information from the .cabal file
-> LocalBuildInfo
Configuration information
-> BuildFlags
Flags that the user passed to build
-> [PPSuffixHandler]
preprocessors to run before compiling
-> IO ()

Build the libraries and executables in this package.

Repl

2 declarations

valuerepl

:: PackageDescription
Mostly information from the .cabal file
-> LocalBuildInfo
Configuration information
-> ReplFlags
Flags that the user passed to build
-> [PPSuffixHandler]
preprocessors to run before compiling
-> [String]
-> IO ()

valuestartInterpreter

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

Start an interpreter without loading any package files.

Build preparation

5 declarations

valuepreBuildComponent

:: Verbosity
-> LocalBuildInfo
Configuration information
-> TargetInfo
-> IO ()

Pre-build steps for a component: creates the autogenerated files for a particular configured component.

datadata AutogenFile

Constructors

AutogenModule !ModuleName !Suffix
AutogenFile !ShortText

Instances3Eq, Ord, Show

Eq AutogenFileDefined in Cabal-3.12.1.0 · Distribution.Simple.Build
Ord AutogenFileDefined in Cabal-3.12.1.0 · Distribution.Simple.Build
Show AutogenFileDefined in Cabal-3.12.1.0 · Distribution.Simple.Build

typetype AutogenFileContents = ByteString

A representation of the contents of an autogenerated file.

valuewriteBuiltinAutogenFiles

Generate and write to disk all built-in autogenerated files for the specified component. These files will be put in the autogenerated module directory for this component (see autogenComponentsModuleDir).

This includes:

Paths_pkg.hs,
PackageInfo_pkg.hs,
Backpack signature files for components that are not fully instantiated,
cabal_macros.h.

valuewriteAutogenFiles

:: Verbosity
-> LocalBuildInfo
-> ComponentLocalBuildInfo
-> Map AutogenFile AutogenFileContents
-> IO ()

Write the given autogenerated files in the autogenerated modules directory for the component.

Legacy functions

valuecomponentInitialBuildSteps

:: FilePath
"dist" prefix
-> PackageDescription
mostly information from the .cabal file
-> LocalBuildInfo
Configuration information
-> ComponentLocalBuildInfo
Build info about the component
-> Verbosity
The verbosity to use
-> IO ()

Deprecated. This function does not prepare all source files for a component. Suggestion: use 'Setup repl compName --repl-multi-file=fn'.

Creates the autogenerated files for a particular configured component.

Legacy function: does not run pre-build hooks or pre-processors. This function is insufficient on its own to prepare the build for a component.

Consumers wanting to prepare the sources of a component, e.g. in order to launch a REPL session, are advised to run Setup repl compName --repl-multi-file=fn instead.

valueinitialBuildSteps

:: FilePath
"dist" prefix
-> PackageDescription
mostly information from the .cabal file
-> LocalBuildInfo
Configuration information
-> Verbosity
The verbosity to use
-> IO ()

Deprecated. This function does not prepare all source files for a package. Suggestion: use 'Setup repl --repl-multi-file=fn'.

Runs componentInitialBuildSteps on every configured component.

Legacy function: does not run pre-build hooks or pre-processors. This function is insufficient on its own to prepare the build for a package.

Consumers wanting to prepare the sources of a package, e.g. in order to launch a REPL session, are advised to run Setup repl --repl-multi-file=fn instead.

Internal package database creation

1 declaration

valuecreateInternalPackageDB

Initialize a new package db file for libraries defined internally to the package.