Documentation

Fields

• ghcOptMode :: Flag GhcMode

  The major mode for the ghc invocation.

• ghcOptExtra :: [String]

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

• ghcOptExtraDefault :: [String]

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

• ghcOptInputFiles :: NubListR (SymbolicPath Pkg File)

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

• ghcOptInputScripts :: NubListR (SymbolicPath Pkg File)

  Script files with irregular extensions that need -x hs.

• ghcOptInputModules :: NubListR ModuleName

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

• ghcOptOutputFile :: Flag (SymbolicPath Pkg File)

  Location for output file; the ghc -o flag.

• ghcOptOutputDynFile :: Flag FilePath

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

• ghcOptSourcePathClear :: Flag Bool

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

• ghcOptSourcePath :: NubListR (SymbolicPath Pkg (Dir Source))

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

• ghcOptThisUnitId :: Flag String

  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.)

• ghcOptThisComponentId :: Flag ComponentId

  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

• ghcOptInstantiatedWith :: [(ModuleName, OpenModule)]

  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.

• ghcOptNoCode :: Flag Bool

  No code? (But we turn on interface writing

• ghcOptPackageDBs :: PackageDBStack

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

• ghcOptPackages :: NubListR (OpenUnitId, ModuleRenaming)

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

• ghcOptHideAllPackages :: Flag Bool

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

• ghcOptWarnMissingHomeModules :: Flag Bool

  Warn about modules, not listed in command line

• ghcOptNoAutoLinkPackages :: Flag Bool

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

• ghcOptLinkLibs :: [FilePath]

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

• ghcOptLinkLibPath :: NubListR (SymbolicPath Pkg (Dir Lib))

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

• ghcOptLinkOptions :: [String]

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

• ghcOptLinkFrameworks :: NubListR String

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

• ghcOptLinkFrameworkDirs :: NubListR (SymbolicPath Pkg (Dir Framework))

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

• ghcOptLinkRts :: Flag Bool

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

• ghcOptNoLink :: Flag Bool

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

• ghcOptLinkNoHsMain :: Flag Bool

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

• ghcOptLinkModDefFiles :: NubListR FilePath

  Module definition files (Windows specific)

• ghcOptCcOptions :: [String]

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

• ghcOptCxxOptions :: [String]

  Options to pass through to the C++ compiler.

• ghcOptAsmOptions :: [String]

  Options to pass through to the Assembler.

• ghcOptCppOptions :: [String]

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

• ghcOptCppIncludePath :: NubListR (SymbolicPath Pkg (Dir Include))

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

• ghcOptCppIncludes :: NubListR (SymbolicPath Pkg File)

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

• ghcOptFfiIncludes :: NubListR FilePath

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

• ghcOptCcProgram :: Flag FilePath

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

• ghcOptLanguage :: Flag Language

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

• ghcOptExtensions :: NubListR Extension

  The language extensions; the ghc -X flag.

• ghcOptExtensionMap :: Map Extension (Maybe CompilerFlag)

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

• ghcOptOptimisation :: Flag GhcOptimisation

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

• ghcOptDebugInfo :: Flag DebugInfoLevel

  Emit debug info; the ghc -g flag.

• ghcOptProfilingMode :: Flag Bool

  Compile in profiling mode; the ghc -prof flag.

• ghcOptProfilingAuto :: Flag GhcProfAuto

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

• ghcOptSplitSections :: Flag Bool

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

• ghcOptSplitObjs :: Flag Bool

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

• ghcOptNumJobs :: Flag ParStrat

  Run N jobs simultaneously (if possible).

• ghcOptHPCDir :: Flag (SymbolicPath Pkg (Dir Mix))

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

• ghcOptGHCiScripts :: [FilePath]

  Extra GHCi startup scripts; the -ghci-script flag

• ghcOptHiSuffix :: Flag String
   
• ghcOptObjSuffix :: Flag String
   
• ghcOptDynHiSuffix :: Flag String

  only in GhcStaticAndDynamic mode

• ghcOptDynObjSuffix :: Flag String

  only in GhcStaticAndDynamic mode

• ghcOptHiDir :: Flag (SymbolicPath Pkg (Dir Artifacts))
   
• ghcOptHieDir :: Flag (SymbolicPath Pkg (Dir Artifacts))
   
• ghcOptObjDir :: Flag (SymbolicPath Pkg (Dir Artifacts))
   
• ghcOptOutputDir :: Flag (SymbolicPath Pkg (Dir Artifacts))
   
• ghcOptStubDir :: Flag (SymbolicPath Pkg (Dir Artifacts))
   
• ghcOptDynLinkMode :: Flag GhcDynLinkMode
   
• ghcOptStaticLib :: Flag Bool
   
• ghcOptShared :: Flag Bool
   
• ghcOptFPic :: Flag Bool
   
• ghcOptDylibName :: Flag String
   
• ghcOptRPaths :: NubListR FilePath
   
• ghcOptVerbosity :: Flag Verbosity

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

• ghcOptExtraPath :: NubListR (SymbolicPath Pkg (Dir Build))

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

• ghcOptCabal :: Flag Bool

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