ModuleCabal-3.18.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
15 values

PackageCabal-3.18.1.0
Exports17
LanguageHaskell2010
LicenceBSD-3-Clause
SourceBuild.hs

Build

3 declarations

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.

valuebuild_setupHooks

:: (PreBuildComponentInputs -> IO [MonitorFilePath], PostBuildComponentInputs -> IO ())
build hooks
-> VerbosityHandles
-> 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 [MonitorFilePath]

valuebuildComponent

Repl

3 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 ()

valuerepl_setupHooks

:: (PreBuildComponentInputs -> IO [MonitorFilePath])
pre-build hook
-> VerbosityHandles
-> 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 [MonitorFilePath]

valuestartInterpreter

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

Start an interpreter without loading any package files.

Build preparation

7 declarations

valuepreBuildComponent

:: IO r
pre-build hook
-> Verbosity
-> LocalBuildInfo
Configuration information
-> TargetInfo
-> IO r

Creates the autogenerated files for a particular configured component, and runs the pre-build hook.

valuerunPreBuildHooks

Compute and execute PreBuildComponentRules, returning the monitored files declared by the rules.

valuebuiltinPreBuildHooks

Built-in pre-build SetupHooks for a given BuildType.

datadata AutogenFile

Constructors

AutogenModule !ModuleName !Suffix
AutogenFile !ShortText

Instances3Eq, Ord, Show

Eq AutogenFileDefined in Cabal-3.18.1.0 · Distribution.Simple.Build
Ord AutogenFileDefined in Cabal-3.18.1.0 · Distribution.Simple.Build
Show AutogenFileDefined in Cabal-3.18.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.

Handling of internal build tools

1 declaration

valueaddInternalBuildTools

Update the program database to include any build-tool-depends specified in the given BuildInfo on build tools internal to the current package.

This function:

adds these internal build tools to the ProgramDb, including paths to their respective data directories,
adds their paths to the current progSearchPath, and adds the data directory environment variable for the current package to the current progOverrideEnv, so that any programs configured from now on will be able to invoke these build tools.