Distribution.Simple.Program.GHC

The major mode for the ghc invocation.

Any extra options to pass directly to ghc. These go at the end and hence override other stuff.

Extra default flags to pass directly to ghc. These go at the beginning and so can be overridden by other stuff.

The main input files; could be .hs, .hi, .c, .o, depending on mode.

Script files with irregular extensions that need -x hs.

The names of input Haskell modules, mainly for --make mode.

Location for output file; the ghc -o flag.

Location for dynamic output file in GhcStaticAndDynamic mode; the ghc -dyno flag.

Start with an empty search path for Haskell source files; the ghc -i flag (-i on its own with no path argument).

Search path for Haskell source files; the ghc -i flag.

Unit files to load; the ghc -unit flag.

The unit ID the modules will belong to; the ghc -this-unit-id flag (or -this-package-key or -package-name on older versions of GHC). This is a String because we assume you've already figured out what the correct format for this string is (we need to handle backwards compatibility.)

GHC doesn't make any assumptions about the format of definite unit ids, so when we are instantiating a package it needs to be told explicitly what the component being instantiated is. This only gets set when ghcOptInstantiatedWith is non-empty

How the requirements of the package being compiled are to be filled. When typechecking an indefinite package, the OpenModule is always a OpenModuleVar; otherwise, it specifies the installed module that instantiates a package.

No code? (But we turn on interface writing

GHC package databases to use, the ghc -package-conf flag.

The GHC packages to bring into scope when compiling, the ghc -package-id flags.

Start with a clean package set; the ghc -hide-all-packages flag

Warn about modules, not listed in command line

Don't automatically link in Haskell98 etc; the ghc -no-auto-link-packages flag.

Names of libraries to link in; the ghc -l flag.

Search path for libraries to link in; the ghc -L flag.

Options to pass through to the linker; the ghc -optl flag.

OSX only: frameworks to link in; the ghc -framework flag.

OSX only: Search path for frameworks to link in; the ghc -framework-path flag.

Instruct GHC to link against libHSrts when producing a shared library.

Don't do the link step, useful in make mode; the ghc -no-link flag.

Don't link in the normal RTS main entry point; the ghc -no-hs-main flag.

Module definition files (Windows specific)

Options to pass through to the C compiler; the ghc -optc flag.

Options to pass through to the C++ compiler.

Options to pass through to the Assembler.

Options to pass through to CPP; the ghc -optP flag.

Options to pass through to CPP; the ghc -optJSP flag. @since 3.16.0.0

Search path for CPP includes like header files; the ghc -I flag.

Extra header files to include at CPP stage; the ghc -optP-include flag.

Extra header files to include for old-style FFI; the ghc -#include flag.

Program to use for the C and C++ compiler; the ghc -pgmc flag.

The base language; the ghc -XHaskell98 or -XHaskell2010 flag.

The language extensions; the ghc -X flag.

A GHC version-dependent mapping of extensions to flags. This must be set to be able to make use of the ghcOptExtensions.

What optimisation level to use; the ghc -O flag.

Emit debug info; the ghc -g flag.

Compile in profiling mode; the ghc -prof flag.

Automatically add profiling cost centers; the ghc -fprof-auto* flags.

Use the "split sections" feature; the ghc -split-sections flag.

Use the "split object files" feature; the ghc -split-objs flag.

Run N jobs simultaneously (if possible).

Enable coverage analysis; the ghc -fhpc -hpcdir flags.

Extra GHCi startup scripts; the -ghci-script flag

only in GhcStaticAndDynamic mode

only in GhcStaticAndDynamic mode

Get GHC to be quiet or verbose with what it's doing; the ghc -v flag.

Put the extra folders in the PATH environment variable we invoke GHC with

Let GHC know that it is Cabal that's calling it. Modifies some of the GHC error messages.