Copyright	Isaac Jones 2003-2004 Duncan Coutts 2007
License	BSD3
Maintainer	cabal-devel@haskell.org
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Distribution.Simple.Setup

Description

This module defines the command line interface for all the Cabal commands. For each command (like configure, build etc) it defines a type that holds all the flags, the default set of flags and a CommandUI that maps command line flags to and from the corresponding flags type.

All the flags types are instances of Monoid, see http://www.haskell.org/pipermail/cabal-devel/2007-December/001509.html for an explanation.

The types defined here get used in the front end and especially in cabal-install which has to do quite a bit of manipulating sets of command line flags.

This is actually relatively nice, it works quite well. The main change it needs is to unify it with the code for managing sets of fields that can be read and written from files. This would allow us to save configure flags in config files.

Synopsis

data GlobalFlags = GlobalFlags {
- globalVersion :: Flag Bool
- globalNumericVersion :: Flag Bool
- globalWorkingDir :: Flag (SymbolicPath CWD (Dir Pkg))
}
emptyGlobalFlags :: GlobalFlags
defaultGlobalFlags :: GlobalFlags
globalCommand :: [Command action] -> CommandUI GlobalFlags
data CommonSetupFlags = CommonSetupFlags {
- setupVerbosity :: !(Flag Verbosity)
- setupWorkingDir :: !(Flag (SymbolicPath CWD (Dir Pkg)))
- setupDistPref :: !(Flag (SymbolicPath Pkg (Dir Dist)))
- setupCabalFilePath :: !(Flag (SymbolicPath Pkg File))
- setupTargets :: [String]
}
defaultCommonSetupFlags :: CommonSetupFlags
data ConfigFlags where
- ConfigFlags {
  - configCommonFlags :: !CommonSetupFlags
  - configPrograms_ :: Option' (Last' ProgramDb)
  - configProgramPaths :: [(String, FilePath)]
  - configProgramArgs :: [(String, [String])]
  - configProgramPathExtra :: NubList FilePath
  - configHcFlavor :: Flag CompilerFlavor
  - configHcPath :: Flag FilePath
  - configHcPkg :: Flag FilePath
  - configVanillaLib :: Flag Bool
  - configProfLib :: Flag Bool
  - configSharedLib :: Flag Bool
  - configStaticLib :: Flag Bool
  - configDynExe :: Flag Bool
  - configFullyStaticExe :: Flag Bool
  - configProfExe :: Flag Bool
  - configProf :: Flag Bool
  - configProfShared :: Flag Bool
  - configProfDetail :: Flag ProfDetailLevel
  - configProfLibDetail :: Flag ProfDetailLevel
  - configConfigureArgs :: [String]
  - configOptimization :: Flag OptimisationLevel
  - configProgPrefix :: Flag PathTemplate
  - configProgSuffix :: Flag PathTemplate
  - configInstallDirs :: InstallDirs (Flag PathTemplate)
  - configScratchDir :: Flag FilePath
  - configExtraLibDirs :: [SymbolicPath Pkg (Dir Lib)]
  - configExtraLibDirsStatic :: [SymbolicPath Pkg (Dir Lib)]
  - configExtraFrameworkDirs :: [SymbolicPath Pkg (Dir Framework)]
  - configExtraIncludeDirs :: [SymbolicPath Pkg (Dir Include)]
  - configIPID :: Flag String
  - configCID :: Flag ComponentId
  - configDeterministic :: Flag Bool
  - configUserInstall :: Flag Bool
  - configPackageDBs :: [Maybe PackageDB]
  - configGHCiLib :: Flag Bool
  - configSplitSections :: Flag Bool
  - configSplitObjs :: Flag Bool
  - configStripExes :: Flag Bool
  - configStripLibs :: Flag Bool
  - configConstraints :: [PackageVersionConstraint]
  - configDependencies :: [GivenComponent]
  - configPromisedDependencies :: [PromisedComponent]
  - configInstantiateWith :: [(ModuleName, Module)]
  - configConfigurationsFlags :: FlagAssignment
  - configTests :: Flag Bool
  - configBenchmarks :: Flag Bool
  - configCoverage :: Flag Bool
  - configLibCoverage :: Flag Bool
  - configExactConfiguration :: Flag Bool
  - configFlagError :: Flag String
  - configRelocatable :: Flag Bool
  - configDebugInfo :: Flag DebugInfoLevel
  - configDumpBuildInfo :: Flag DumpBuildInfo
  - configUseResponseFiles :: Flag Bool
  - configAllowDependingOnPrivateLibs :: Flag Bool
  - configCoverageFor :: Flag [UnitId]
  - configIgnoreBuildTools :: Flag Bool
  }
- pattern ConfigCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> ConfigFlags
emptyConfigFlags :: ConfigFlags
defaultConfigFlags :: ProgramDb -> ConfigFlags
configureCommand :: ProgramDb -> CommandUI ConfigFlags
configPrograms :: WithCallStack (ConfigFlags -> ProgramDb)
readPackageDb :: String -> Maybe PackageDB
readPackageDbList :: String -> [Maybe PackageDB]
showPackageDb :: Maybe PackageDB -> String
showPackageDbList :: [Maybe PackageDB] -> [String]
data CopyFlags where
- CopyFlags {
  - copyCommonFlags :: !CommonSetupFlags
  - copyDest :: Flag CopyDest
  }
- pattern CopyCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> CopyFlags
emptyCopyFlags :: CopyFlags
defaultCopyFlags :: CopyFlags
copyCommand :: CommandUI CopyFlags
data InstallFlags where
- InstallFlags {
  - installCommonFlags :: !CommonSetupFlags
  - installPackageDB :: Flag PackageDB
  - installDest :: Flag CopyDest
  - installUseWrapper :: Flag Bool
  - installInPlace :: Flag Bool
  }
- pattern InstallCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> InstallFlags
emptyInstallFlags :: InstallFlags
defaultInstallFlags :: InstallFlags
installCommand :: CommandUI InstallFlags
data HaddockTarget
- = ForHackage
- | ForDevelopment
data HaddockFlags where
- HaddockFlags {
  - haddockCommonFlags :: !CommonSetupFlags
  - haddockProgramPaths :: [(String, FilePath)]
  - haddockProgramArgs :: [(String, [String])]
  - haddockHoogle :: Flag Bool
  - haddockHtml :: Flag Bool
  - haddockHtmlLocation :: Flag String
  - haddockForHackage :: Flag HaddockTarget
  - haddockExecutables :: Flag Bool
  - haddockTestSuites :: Flag Bool
  - haddockBenchmarks :: Flag Bool
  - haddockForeignLibs :: Flag Bool
  - haddockInternal :: Flag Bool
  - haddockCss :: Flag FilePath
  - haddockLinkedSource :: Flag Bool
  - haddockQuickJump :: Flag Bool
  - haddockHscolourCss :: Flag FilePath
  - haddockContents :: Flag PathTemplate
  - haddockIndex :: Flag PathTemplate
  - haddockKeepTempFiles :: Flag Bool
  - haddockBaseUrl :: Flag String
  - haddockResourcesDir :: Flag String
  - haddockOutputDir :: Flag FilePath
  - haddockUseUnicode :: Flag Bool
  }
- pattern HaddockCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> HaddockFlags
emptyHaddockFlags :: HaddockFlags
defaultHaddockFlags :: HaddockFlags
haddockCommand :: CommandUI HaddockFlags
data Visibility
- = Visible
- | Hidden
data HaddockProjectFlags = HaddockProjectFlags {
- haddockProjectHackage :: Flag Bool
- haddockProjectDir :: Flag String
- haddockProjectPrologue :: Flag String
- haddockProjectInterfaces :: Flag [(FilePath, Maybe FilePath, Maybe FilePath, Visibility)]
- haddockProjectProgramPaths :: [(String, FilePath)]
- haddockProjectProgramArgs :: [(String, [String])]
- haddockProjectHoogle :: Flag Bool
- haddockProjectHtmlLocation :: Flag String
- haddockProjectExecutables :: Flag Bool
- haddockProjectTestSuites :: Flag Bool
- haddockProjectBenchmarks :: Flag Bool
- haddockProjectForeignLibs :: Flag Bool
- haddockProjectInternal :: Flag Bool
- haddockProjectCss :: Flag FilePath
- haddockProjectHscolourCss :: Flag FilePath
- haddockProjectKeepTempFiles :: Flag Bool
- haddockProjectVerbosity :: Flag Verbosity
- haddockProjectResourcesDir :: Flag String
- haddockProjectUseUnicode :: Flag Bool
}
emptyHaddockProjectFlags :: HaddockProjectFlags
defaultHaddockProjectFlags :: HaddockProjectFlags
haddockProjectCommand :: CommandUI HaddockProjectFlags
data HscolourFlags where
- HscolourFlags {
  - hscolourCommonFlags :: !CommonSetupFlags
  - hscolourCSS :: Flag FilePath
  - hscolourExecutables :: Flag Bool
  - hscolourTestSuites :: Flag Bool
  - hscolourBenchmarks :: Flag Bool
  - hscolourForeignLibs :: Flag Bool
  }
- pattern HscolourCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> HscolourFlags
emptyHscolourFlags :: HscolourFlags
defaultHscolourFlags :: HscolourFlags
hscolourCommand :: CommandUI HscolourFlags
data BuildFlags where
- BuildFlags {
  - buildCommonFlags :: !CommonSetupFlags
  - buildProgramPaths :: [(String, FilePath)]
  - buildProgramArgs :: [(String, [String])]
  - buildNumJobs :: Flag (Maybe Int)
  - buildUseSemaphore :: Flag String
  }
- pattern BuildCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> BuildFlags
emptyBuildFlags :: BuildFlags
defaultBuildFlags :: BuildFlags
buildCommand :: ProgramDb -> CommandUI BuildFlags
data DumpBuildInfo
- = NoDumpBuildInfo
- | DumpBuildInfo
data ReplFlags where
- ReplFlags {
  - replCommonFlags :: !CommonSetupFlags
  - replProgramPaths :: [(String, FilePath)]
  - replProgramArgs :: [(String, [String])]
  - replReload :: Flag Bool
  - replReplOptions :: ReplOptions
  }
- pattern ReplCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> ReplFlags
defaultReplFlags :: ReplFlags
replCommand :: ProgramDb -> CommandUI ReplFlags
data ReplOptions = ReplOptions {
- replOptionsFlags :: [String]
- replOptionsNoLoad :: Flag Bool
- replOptionsFlagOutput :: Flag FilePath
}
data CleanFlags where
- CleanFlags {
  - cleanCommonFlags :: !CommonSetupFlags
  - cleanSaveConf :: Flag Bool
  }
- pattern CleanCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> CleanFlags
emptyCleanFlags :: CleanFlags
defaultCleanFlags :: CleanFlags
cleanCommand :: CommandUI CleanFlags
data RegisterFlags where
- RegisterFlags {
  - registerCommonFlags :: !CommonSetupFlags
  - regPackageDB :: Flag PackageDB
  - regGenScript :: Flag Bool
  - regGenPkgConf :: Flag (Maybe (SymbolicPath Pkg (Dir PkgConf)))
  - regInPlace :: Flag Bool
  - regPrintId :: Flag Bool
  }
- pattern RegisterCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> RegisterFlags
emptyRegisterFlags :: RegisterFlags
defaultRegisterFlags :: RegisterFlags
registerCommand :: CommandUI RegisterFlags
unregisterCommand :: CommandUI RegisterFlags
data SDistFlags where
- SDistFlags {
  - sDistCommonFlags :: !CommonSetupFlags
  - sDistSnapshot :: Flag Bool
  - sDistDirectory :: Flag FilePath
  - sDistListSources :: Flag FilePath
  }
- pattern SDistCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> SDistFlags
emptySDistFlags :: SDistFlags
defaultSDistFlags :: SDistFlags
sdistCommand :: CommandUI SDistFlags
data TestFlags where
- TestFlags {
  - testCommonFlags :: !CommonSetupFlags
  - testHumanLog :: Flag PathTemplate
  - testMachineLog :: Flag PathTemplate
  - testShowDetails :: Flag TestShowDetails
  - testKeepTix :: Flag Bool
  - testWrapper :: Flag FilePath
  - testFailWhenNoTestSuites :: Flag Bool
  - testOptions :: [PathTemplate]
  }
- pattern TestCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> TestFlags
emptyTestFlags :: TestFlags
defaultTestFlags :: TestFlags
testCommand :: CommandUI TestFlags
data TestShowDetails
- = Never
- | Failures
- | Always
- | Streaming
- | Direct
data BenchmarkFlags where
- BenchmarkFlags {
  - benchmarkCommonFlags :: !CommonSetupFlags
  - benchmarkOptions :: [PathTemplate]
  }
- pattern BenchmarkCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> BenchmarkFlags
emptyBenchmarkFlags :: BenchmarkFlags
defaultBenchmarkFlags :: BenchmarkFlags
benchmarkCommand :: CommandUI BenchmarkFlags
data CopyDest
- = NoCopyDest
- | CopyTo FilePath
- | CopyToDb FilePath
configureArgs :: Bool -> ConfigFlags -> [String]
configureOptions :: ShowOrParseArgs -> [OptionField ConfigFlags]
configureCCompiler :: Verbosity -> ProgramDb -> IO (FilePath, [String])
configureLinker :: Verbosity -> ProgramDb -> IO (FilePath, [String])
buildOptions :: ProgramDb -> ShowOrParseArgs -> [OptionField BuildFlags]
haddockOptions :: ShowOrParseArgs -> [OptionField HaddockFlags]
haddockProjectOptions :: ShowOrParseArgs -> [OptionField HaddockProjectFlags]
installDirsOptions :: [OptionField (InstallDirs (Flag PathTemplate))]
testOptions' :: ShowOrParseArgs -> [OptionField TestFlags]
benchmarkOptions' :: ShowOrParseArgs -> [OptionField BenchmarkFlags]
programDbOptions :: ProgramDb -> ShowOrParseArgs -> (flags -> [(String, [String])]) -> ([(String, [String])] -> flags -> flags) -> [OptionField flags]
programDbPaths' :: (String -> String) -> ProgramDb -> ShowOrParseArgs -> (flags -> [(String, FilePath)]) -> ([(String, FilePath)] -> flags -> flags) -> [OptionField flags]
programFlagsDescription :: ProgramDb -> String
replOptions :: ShowOrParseArgs -> [OptionField ReplOptions]
splitArgs :: String -> [String]
defaultDistPref :: SymbolicPath Pkg (Dir Dist)
optionDistPref :: (flags -> Flag (SymbolicPath Pkg (Dir Dist))) -> (Flag (SymbolicPath Pkg (Dir Dist)) -> flags -> flags) -> ShowOrParseArgs -> OptionField flags
data Flag a
- = Flag a
- | NoFlag
toFlag :: a -> Flag a
fromFlag :: WithCallStack (Flag a -> a)
fromFlagOrDefault :: a -> Flag a -> a
flagToMaybe :: Flag a -> Maybe a
flagToList :: Flag a -> [a]
maybeToFlag :: Maybe a -> Flag a
class BooleanFlag a where
- asBool :: a -> Bool
boolOpt :: SFlags -> SFlags -> MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a
boolOpt' :: OptFlags -> OptFlags -> MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a
trueArg :: MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a
falseArg :: MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a
optionVerbosity :: (flags -> Flag Verbosity) -> (Flag Verbosity -> flags -> flags) -> OptionField flags
data BuildingWhat
- = BuildNormal BuildFlags
- | BuildRepl ReplFlags
- | BuildHaddock HaddockFlags
- | BuildHscolour HscolourFlags
buildingWhatCommonFlags :: BuildingWhat -> CommonSetupFlags
buildingWhatVerbosity :: BuildingWhat -> Verbosity
buildingWhatWorkingDir :: BuildingWhat -> Maybe (SymbolicPath CWD (Dir Pkg))
buildingWhatDistPref :: BuildingWhat -> SymbolicPath Pkg (Dir Dist)

Documentation

data GlobalFlags Source #

Flags that apply at the top level, not to any sub-command.

Constructors

GlobalFlags
Fields globalVersion :: Flag Bool globalNumericVersion :: Flag Bool globalWorkingDir :: Flag (SymbolicPath CWD (Dir Pkg))

Instances

Instances details

Monoid GlobalFlags Source #
Instance details Defined in Distribution.Simple.Setup.Global Methods mempty :: GlobalFlags # mappend :: GlobalFlags -> GlobalFlags -> GlobalFlags # mconcat :: [GlobalFlags] -> GlobalFlags #
Semigroup GlobalFlags Source #
Instance details Defined in Distribution.Simple.Setup.Global Methods (<>) :: GlobalFlags -> GlobalFlags -> GlobalFlags # sconcat :: NonEmpty GlobalFlags -> GlobalFlags # stimes :: Integral b => b -> GlobalFlags -> GlobalFlags #
Generic GlobalFlags Source #
Instance details Defined in Distribution.Simple.Setup.Global Associated Types type Rep GlobalFlags :: Type -> Type # Methods from :: GlobalFlags -> Rep GlobalFlags x # to :: Rep GlobalFlags x -> GlobalFlags #
type Rep GlobalFlags Source #
Instance details Defined in Distribution.Simple.Setup.Global type Rep GlobalFlags = D1 ('MetaData "GlobalFlags" "Distribution.Simple.Setup.Global" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "GlobalFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: (S1 ('MetaSel ('Just "globalNumericVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "globalWorkingDir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag (SymbolicPath CWD ('Dir Pkg)))))))

emptyGlobalFlags :: GlobalFlags Source #

defaultGlobalFlags :: GlobalFlags Source #

globalCommand :: [Command action] -> CommandUI GlobalFlags Source #

data CommonSetupFlags Source #

A datatype that stores common flags for different invocations of a Setup executable, e.g. configure, build, install.

Constructors

CommonSetupFlags

Fields

setupVerbosity :: !(Flag Verbosity)
Verbosity
setupWorkingDir :: !(Flag (SymbolicPath CWD (Dir Pkg)))
Working directory (optional)
setupDistPref :: !(Flag (SymbolicPath Pkg (Dir Dist)))
Build directory
setupCabalFilePath :: !(Flag (SymbolicPath Pkg File))
Which Cabal file to use (optional)
setupTargets :: [String]
Which targets is this Setup invocation relative to?
TODO: this one should not be here, it's just that the silly UserHooks stop us from passing extra info in other ways

Instances

Instances details

Structured CommonSetupFlags Source #
Instance details Defined in Distribution.Simple.Setup.Common Methods structure :: Proxy CommonSetupFlags -> Structure structureHash' :: Tagged CommonSetupFlags MD5
Monoid CommonSetupFlags Source #
Instance details Defined in Distribution.Simple.Setup.Common Methods mempty :: CommonSetupFlags # mappend :: CommonSetupFlags -> CommonSetupFlags -> CommonSetupFlags # mconcat :: [CommonSetupFlags] -> CommonSetupFlags #
Semigroup CommonSetupFlags Source #
Instance details Defined in Distribution.Simple.Setup.Common Methods (<>) :: CommonSetupFlags -> CommonSetupFlags -> CommonSetupFlags # sconcat :: NonEmpty CommonSetupFlags -> CommonSetupFlags # stimes :: Integral b => b -> CommonSetupFlags -> CommonSetupFlags #
Generic CommonSetupFlags Source #
Instance details Defined in Distribution.Simple.Setup.Common Associated Types type Rep CommonSetupFlags :: Type -> Type # Methods from :: CommonSetupFlags -> Rep CommonSetupFlags x # to :: Rep CommonSetupFlags x -> CommonSetupFlags #
Read CommonSetupFlags Source #
Instance details Defined in Distribution.Simple.Setup.Common Methods readsPrec :: Int -> ReadS CommonSetupFlags # readList :: ReadS [CommonSetupFlags] # readPrec :: ReadPrec CommonSetupFlags # readListPrec :: ReadPrec [CommonSetupFlags] #
Show CommonSetupFlags Source #
Instance details Defined in Distribution.Simple.Setup.Common Methods showsPrec :: Int -> CommonSetupFlags -> ShowS # show :: CommonSetupFlags -> String # showList :: [CommonSetupFlags] -> ShowS #
Binary CommonSetupFlags Source #
Instance details Defined in Distribution.Simple.Setup.Common Methods put :: CommonSetupFlags -> Put # get :: Get CommonSetupFlags # putList :: [CommonSetupFlags] -> Put #
Eq CommonSetupFlags Source #
Instance details Defined in Distribution.Simple.Setup.Common Methods (==) :: CommonSetupFlags -> CommonSetupFlags -> Bool # (/=) :: CommonSetupFlags -> CommonSetupFlags -> Bool #
type Rep CommonSetupFlags Source #
Instance details Defined in Distribution.Simple.Setup.Common type Rep CommonSetupFlags = D1 ('MetaData "CommonSetupFlags" "Distribution.Simple.Setup.Common" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "CommonSetupFlags" 'PrefixI 'True) ((S1 ('MetaSel ('Just "setupVerbosity") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Flag Verbosity)) :: S1 ('MetaSel ('Just "setupWorkingDir") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Flag (SymbolicPath CWD ('Dir Pkg))))) :: (S1 ('MetaSel ('Just "setupDistPref") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Flag (SymbolicPath Pkg ('Dir Dist)))) :: (S1 ('MetaSel ('Just "setupCabalFilePath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Flag (SymbolicPath Pkg 'File))) :: S1 ('MetaSel ('Just "setupTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String])))))

defaultCommonSetupFlags :: CommonSetupFlags Source #

data ConfigFlags Source #

Flags to configure command.

IMPORTANT: every time a new flag is added, filterConfigureFlags should be updated. IMPORTANT: every time a new flag is added, it should be added to the Eq instance

Constructors

ConfigFlags

Fields

configCommonFlags :: !CommonSetupFlags
configPrograms_ :: Option' (Last' ProgramDb)
All programs that cabal may run
configProgramPaths :: [(String, FilePath)]
user specified programs paths
configProgramArgs :: [(String, [String])]
user specified programs args
configProgramPathExtra :: NubList FilePath
Extend the $PATH
configHcFlavor :: Flag CompilerFlavor
The "flavor" of the compiler, e.g. GHC.
configHcPath :: Flag FilePath
given compiler location
configHcPkg :: Flag FilePath
given hc-pkg location
configVanillaLib :: Flag Bool
Enable vanilla library
configProfLib :: Flag Bool
Enable profiling in the library
configSharedLib :: Flag Bool
Build shared library
configStaticLib :: Flag Bool
Build static library
configDynExe :: Flag Bool
Enable dynamic linking of the executables.
configFullyStaticExe :: Flag Bool
Enable fully static linking of the executables.
configProfExe :: Flag Bool
Enable profiling in the executables.
configProf :: Flag Bool
Enable profiling in the library and executables.
configProfShared :: Flag Bool
Enable shared profiling objects
configProfDetail :: Flag ProfDetailLevel
Profiling detail level in the library and executables.
configProfLibDetail :: Flag ProfDetailLevel
Profiling detail level in the library
configConfigureArgs :: [String]
Extra arguments to configure
configOptimization :: Flag OptimisationLevel
Enable optimization.
configProgPrefix :: Flag PathTemplate
Installed executable prefix.
configProgSuffix :: Flag PathTemplate
Installed executable suffix.
configInstallDirs :: InstallDirs (Flag PathTemplate)
Installation paths
configScratchDir :: Flag FilePath
configExtraLibDirs :: [SymbolicPath Pkg (Dir Lib)]
path to search for extra libraries
configExtraLibDirsStatic :: [SymbolicPath Pkg (Dir Lib)]
path to search for extra libraries when linking fully static executables
configExtraFrameworkDirs :: [SymbolicPath Pkg (Dir Framework)]
path to search for extra frameworks (OS X only)
configExtraIncludeDirs :: [SymbolicPath Pkg (Dir Include)]
path to search for header files
configIPID :: Flag String
explicit IPID to be used
configCID :: Flag ComponentId
explicit CID to be used
configDeterministic :: Flag Bool
be as deterministic as possible (e.g., invariant over GHC, database, etc). Used by the test suite
configUserInstall :: Flag Bool
The --user/--global flag
configPackageDBs :: [Maybe PackageDB]
Which package DBs to use
configGHCiLib :: Flag Bool
Enable compiling library for GHCi
configSplitSections :: Flag Bool
Enable -split-sections with GHC
configSplitObjs :: Flag Bool
Enable -split-objs with GHC
configStripExes :: Flag Bool
Enable executable stripping
configStripLibs :: Flag Bool
Enable library stripping
configConstraints :: [PackageVersionConstraint]
Additional constraints for dependencies.
configDependencies :: [GivenComponent]
The packages depended on which already exist
configPromisedDependencies :: [PromisedComponent]
The packages depended on which doesn't yet exist (i.e. promised). Promising dependencies enables us to configure components in parallel, and avoids expensive builds if they are not necessary. For example, in multi-repl mode, we don't want to build dependencies that are loaded into the interactive session, since we have to build them again.
configInstantiateWith :: [(ModuleName, Module)]
The requested Backpack instantiation. If empty, either this package does not use Backpack, or we just want to typecheck the indefinite package.
configConfigurationsFlags :: FlagAssignment
configTests :: Flag Bool
Enable test suite compilation
configBenchmarks :: Flag Bool
Enable benchmark compilation
configCoverage :: Flag Bool
Enable program coverage
configLibCoverage :: Flag Bool
Enable program coverage (deprecated)
configExactConfiguration :: Flag Bool
All direct dependencies and flags are provided on the command line by the user via the '--dependency' and '--flags' options.
configFlagError :: Flag String
Halt and show an error message indicating an error in flag assignment
configRelocatable :: Flag Bool
Enable relocatable package built
configDebugInfo :: Flag DebugInfoLevel
Emit debug info.
configDumpBuildInfo :: Flag DumpBuildInfo
Should we dump available build information on build? Dump build information to disk before attempting to build, tooling can parse these files and use them to compile the source files themselves.
configUseResponseFiles :: Flag Bool
Whether to use response files at all. They're used for such tools as haddock, or ld.
configAllowDependingOnPrivateLibs :: Flag Bool
Allow depending on private sublibraries. This is used by external tools (like cabal-install) so they can add multiple-public-libraries compatibility to older ghcs by checking visibility externally.
configCoverageFor :: Flag [UnitId]
The list of libraries to be included in the hpc coverage report for testsuites run with --enable-coverage. Notably, this list must exclude indefinite libraries and instantiations because HPC does not support backpack (Nov. 2023).
configIgnoreBuildTools :: Flag Bool
When this flag is set, all tools declared in `build-tool`s and `build-tool-depends` will be ignored. This allows a Cabal package with build-tool-dependencies to be built even if the tool is not found.

Bundled Patterns

pattern ConfigCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> ConfigFlags

Instances

Instances details

Structured ConfigFlags Source #
Instance details Defined in Distribution.Simple.Setup.Config Methods structure :: Proxy ConfigFlags -> Structure structureHash' :: Tagged ConfigFlags MD5
Monoid ConfigFlags Source #
Instance details Defined in Distribution.Simple.Setup.Config Methods mempty :: ConfigFlags # mappend :: ConfigFlags -> ConfigFlags -> ConfigFlags # mconcat :: [ConfigFlags] -> ConfigFlags #
Semigroup ConfigFlags Source #
Instance details Defined in Distribution.Simple.Setup.Config Methods (<>) :: ConfigFlags -> ConfigFlags -> ConfigFlags # sconcat :: NonEmpty ConfigFlags -> ConfigFlags # stimes :: Integral b => b -> ConfigFlags -> ConfigFlags #
Generic ConfigFlags Source #
Instance details Defined in Distribution.Simple.Setup.Config Associated Types type Rep ConfigFlags :: Type -> Type # Methods from :: ConfigFlags -> Rep ConfigFlags x # to :: Rep ConfigFlags x -> ConfigFlags #
Read ConfigFlags Source #
Instance details Defined in Distribution.Simple.Setup.Config Methods readsPrec :: Int -> ReadS ConfigFlags # readList :: ReadS [ConfigFlags] # readPrec :: ReadPrec ConfigFlags # readListPrec :: ReadPrec [ConfigFlags] #
Show ConfigFlags Source #
Instance details Defined in Distribution.Simple.Setup.Config Methods showsPrec :: Int -> ConfigFlags -> ShowS # show :: ConfigFlags -> String # showList :: [ConfigFlags] -> ShowS #
Binary ConfigFlags Source #
Instance details Defined in Distribution.Simple.Setup.Config Methods put :: ConfigFlags -> Put # get :: Get ConfigFlags # putList :: [ConfigFlags] -> Put #
Eq ConfigFlags Source #
Instance details Defined in Distribution.Simple.Setup.Config Methods (==) :: ConfigFlags -> ConfigFlags -> Bool # (/=) :: ConfigFlags -> ConfigFlags -> Bool #
type Rep ConfigFlags Source #
Instance details Defined in Distribution.Simple.Setup.Config type Rep ConfigFlags = D1 ('MetaData "ConfigFlags" "Distribution.Simple.Setup.Config" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "ConfigFlags" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "configCommonFlags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CommonSetupFlags) :: (S1 ('MetaSel ('Just "configPrograms_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Option' (Last' ProgramDb))) :: S1 ('MetaSel ('Just "configProgramPaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, FilePath)]))) :: ((S1 ('MetaSel ('Just "configProgramArgs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, [String])]) :: S1 ('MetaSel ('Just "configProgramPathExtra") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NubList FilePath))) :: (S1 ('MetaSel ('Just "configHcFlavor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag CompilerFlavor)) :: S1 ('MetaSel ('Just "configHcPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath))))) :: ((S1 ('MetaSel ('Just "configHcPkg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath)) :: (S1 ('MetaSel ('Just "configVanillaLib") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "configProfLib") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)))) :: ((S1 ('MetaSel ('Just "configSharedLib") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "configStaticLib") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))) :: (S1 ('MetaSel ('Just "configDynExe") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "configFullyStaticExe") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)))))) :: (((S1 ('MetaSel ('Just "configProfExe") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: (S1 ('MetaSel ('Just "configProf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "configProfShared") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)))) :: ((S1 ('MetaSel ('Just "configProfDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag ProfDetailLevel)) :: S1 ('MetaSel ('Just "configProfLibDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag ProfDetailLevel))) :: (S1 ('MetaSel ('Just "configConfigureArgs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :: S1 ('MetaSel ('Just "configOptimization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag OptimisationLevel))))) :: ((S1 ('MetaSel ('Just "configProgPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag PathTemplate)) :: (S1 ('MetaSel ('Just "configProgSuffix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag PathTemplate)) :: S1 ('MetaSel ('Just "configInstallDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InstallDirs (Flag PathTemplate))))) :: ((S1 ('MetaSel ('Just "configScratchDir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath)) :: S1 ('MetaSel ('Just "configExtraLibDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SymbolicPath Pkg ('Dir Lib)])) :: (S1 ('MetaSel ('Just "configExtraLibDirsStatic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SymbolicPath Pkg ('Dir Lib)]) :: S1 ('MetaSel ('Just "configExtraFrameworkDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SymbolicPath Pkg ('Dir Framework)])))))) :: ((((S1 ('MetaSel ('Just "configExtraIncludeDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SymbolicPath Pkg ('Dir Include)]) :: (S1 ('MetaSel ('Just "configIPID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag String)) :: S1 ('MetaSel ('Just "configCID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag ComponentId)))) :: ((S1 ('MetaSel ('Just "configDeterministic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "configUserInstall") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))) :: (S1 ('MetaSel ('Just "configPackageDBs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Maybe PackageDB]) :: S1 ('MetaSel ('Just "configGHCiLib") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))))) :: ((S1 ('MetaSel ('Just "configSplitSections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: (S1 ('MetaSel ('Just "configSplitObjs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "configStripExes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)))) :: ((S1 ('MetaSel ('Just "configStripLibs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "configConstraints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PackageVersionConstraint])) :: (S1 ('MetaSel ('Just "configDependencies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [GivenComponent]) :: S1 ('MetaSel ('Just "configPromisedDependencies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PromisedComponent]))))) :: (((S1 ('MetaSel ('Just "configInstantiateWith") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(ModuleName, Module)]) :: (S1 ('MetaSel ('Just "configConfigurationsFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FlagAssignment) :: S1 ('MetaSel ('Just "configTests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)))) :: ((S1 ('MetaSel ('Just "configBenchmarks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "configCoverage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))) :: (S1 ('MetaSel ('Just "configLibCoverage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "configExactConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))))) :: (((S1 ('MetaSel ('Just "configFlagError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag String)) :: S1 ('MetaSel ('Just "configRelocatable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))) :: (S1 ('MetaSel ('Just "configDebugInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag DebugInfoLevel)) :: S1 ('MetaSel ('Just "configDumpBuildInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag DumpBuildInfo)))) :: ((S1 ('MetaSel ('Just "configUseResponseFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "configAllowDependingOnPrivateLibs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))) :: (S1 ('MetaSel ('Just "configCoverageFor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag [UnitId])) :: S1 ('MetaSel ('Just "configIgnoreBuildTools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)))))))))

emptyConfigFlags :: ConfigFlags Source #

defaultConfigFlags :: ProgramDb -> ConfigFlags Source #

configureCommand :: ProgramDb -> CommandUI ConfigFlags Source #

configPrograms :: WithCallStack (ConfigFlags -> ProgramDb) Source #

More convenient version of configPrograms. Results in an error if internal invariant is violated.

readPackageDb :: String -> Maybe PackageDB Source #

Parse a PackageDB stack entry

Since: 3.7.0.0

readPackageDbList :: String -> [Maybe PackageDB] Source #

showPackageDb :: Maybe PackageDB -> String Source #

Show a PackageDB stack entry

Since: 3.7.0.0

showPackageDbList :: [Maybe PackageDB] -> [String] Source #

data CopyFlags Source #

Flags to copy: (destdir, copy-prefix (backwards compat), verbosity)

Constructors

CopyFlags
Fields copyCommonFlags :: !CommonSetupFlags copyDest :: Flag CopyDest

Bundled Patterns

pattern CopyCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> CopyFlags

Instances

Instances details

Structured CopyFlags Source #
Instance details Defined in Distribution.Simple.Setup.Copy Methods structure :: Proxy CopyFlags -> Structure structureHash' :: Tagged CopyFlags MD5
Monoid CopyFlags Source #
Instance details Defined in Distribution.Simple.Setup.Copy Methods mempty :: CopyFlags # mappend :: CopyFlags -> CopyFlags -> CopyFlags # mconcat :: [CopyFlags] -> CopyFlags #
Semigroup CopyFlags Source #
Instance details Defined in Distribution.Simple.Setup.Copy Methods (<>) :: CopyFlags -> CopyFlags -> CopyFlags # sconcat :: NonEmpty CopyFlags -> CopyFlags # stimes :: Integral b => b -> CopyFlags -> CopyFlags #
Generic CopyFlags Source #
Instance details Defined in Distribution.Simple.Setup.Copy Associated Types type Rep CopyFlags :: Type -> Type # Methods from :: CopyFlags -> Rep CopyFlags x # to :: Rep CopyFlags x -> CopyFlags #
Show CopyFlags Source #
Instance details Defined in Distribution.Simple.Setup.Copy Methods showsPrec :: Int -> CopyFlags -> ShowS # show :: CopyFlags -> String # showList :: [CopyFlags] -> ShowS #
Binary CopyFlags Source #
Instance details Defined in Distribution.Simple.Setup.Copy Methods put :: CopyFlags -> Put # get :: Get CopyFlags # putList :: [CopyFlags] -> Put #
type Rep CopyFlags Source #
Instance details Defined in Distribution.Simple.Setup.Copy type Rep CopyFlags = D1 ('MetaData "CopyFlags" "Distribution.Simple.Setup.Copy" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "CopyFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "copyCommonFlags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CommonSetupFlags) :*: S1 ('MetaSel ('Just "copyDest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag CopyDest))))

emptyCopyFlags :: CopyFlags Source #

defaultCopyFlags :: CopyFlags Source #

copyCommand :: CommandUI CopyFlags Source #

data InstallFlags Source #

Flags to install: (package db, verbosity)

Constructors

InstallFlags
Fields installCommonFlags :: !CommonSetupFlags installPackageDB :: Flag PackageDB installDest :: Flag CopyDest installUseWrapper :: Flag Bool installInPlace :: Flag Bool

Bundled Patterns

pattern InstallCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> InstallFlags

Instances

Instances details

Monoid InstallFlags Source #
Instance details Defined in Distribution.Simple.Setup.Install Methods mempty :: InstallFlags # mappend :: InstallFlags -> InstallFlags -> InstallFlags # mconcat :: [InstallFlags] -> InstallFlags #
Semigroup InstallFlags Source #
Instance details Defined in Distribution.Simple.Setup.Install Methods (<>) :: InstallFlags -> InstallFlags -> InstallFlags # sconcat :: NonEmpty InstallFlags -> InstallFlags # stimes :: Integral b => b -> InstallFlags -> InstallFlags #
Generic InstallFlags Source #
Instance details Defined in Distribution.Simple.Setup.Install Associated Types type Rep InstallFlags :: Type -> Type # Methods from :: InstallFlags -> Rep InstallFlags x # to :: Rep InstallFlags x -> InstallFlags #
Show InstallFlags Source #
Instance details Defined in Distribution.Simple.Setup.Install Methods showsPrec :: Int -> InstallFlags -> ShowS # show :: InstallFlags -> String # showList :: [InstallFlags] -> ShowS #
type Rep InstallFlags Source #
Instance details Defined in Distribution.Simple.Setup.Install type Rep InstallFlags = D1 ('MetaData "InstallFlags" "Distribution.Simple.Setup.Install" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "InstallFlags" 'PrefixI 'True) ((S1 ('MetaSel ('Just "installCommonFlags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CommonSetupFlags) :: S1 ('MetaSel ('Just "installPackageDB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag PackageDB))) :: (S1 ('MetaSel ('Just "installDest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag CopyDest)) :: (S1 ('MetaSel ('Just "installUseWrapper") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "installInPlace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))))))

emptyInstallFlags :: InstallFlags Source #

defaultInstallFlags :: InstallFlags Source #

installCommand :: CommandUI InstallFlags Source #

data HaddockTarget Source #

When we build haddock documentation, there are two cases:

We build haddocks only for the current development version, intended for local use and not for distribution. In this case, we store the generated documentation in distdochtml/name.
We build haddocks for intended for uploading them to hackage. In this case, we need to follow the layout that hackage expects from documentation tarballs, and we might also want to use different flags than for development builds, so in this case we store the generated documentation in distdochtml/id-docs.

Constructors

ForHackage
ForDevelopment

Instances

Instances details

Parsec HaddockTarget Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods parsec :: CabalParsing m => m HaddockTarget
Pretty HaddockTarget Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods pretty :: HaddockTarget -> Doc prettyVersioned :: CabalSpecVersion -> HaddockTarget -> Doc
Structured HaddockTarget Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods structure :: Proxy HaddockTarget -> Structure structureHash' :: Tagged HaddockTarget MD5
Generic HaddockTarget Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Associated Types type Rep HaddockTarget :: Type -> Type # Methods from :: HaddockTarget -> Rep HaddockTarget x # to :: Rep HaddockTarget x -> HaddockTarget #
Show HaddockTarget Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods showsPrec :: Int -> HaddockTarget -> ShowS # show :: HaddockTarget -> String # showList :: [HaddockTarget] -> ShowS #
Binary HaddockTarget Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods put :: HaddockTarget -> Put # get :: Get HaddockTarget # putList :: [HaddockTarget] -> Put #
Eq HaddockTarget Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods (==) :: HaddockTarget -> HaddockTarget -> Bool # (/=) :: HaddockTarget -> HaddockTarget -> Bool #
type Rep HaddockTarget Source #
Instance details Defined in Distribution.Simple.Setup.Haddock type Rep HaddockTarget = D1 ('MetaData "HaddockTarget" "Distribution.Simple.Setup.Haddock" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "ForHackage" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ForDevelopment" 'PrefixI 'False) (U1 :: Type -> Type))

data HaddockFlags Source #

Constructors

HaddockFlags

Fields

haddockCommonFlags :: !CommonSetupFlags
haddockProgramPaths :: [(String, FilePath)]
haddockProgramArgs :: [(String, [String])]
haddockHoogle :: Flag Bool
haddockHtml :: Flag Bool
haddockHtmlLocation :: Flag String
haddockForHackage :: Flag HaddockTarget
haddockExecutables :: Flag Bool
haddockTestSuites :: Flag Bool
haddockBenchmarks :: Flag Bool
haddockForeignLibs :: Flag Bool
haddockInternal :: Flag Bool
haddockCss :: Flag FilePath
haddockLinkedSource :: Flag Bool
haddockQuickJump :: Flag Bool
haddockHscolourCss :: Flag FilePath
haddockContents :: Flag PathTemplate
haddockIndex :: Flag PathTemplate
haddockKeepTempFiles :: Flag Bool
haddockBaseUrl :: Flag String
haddockResourcesDir :: Flag String
haddockOutputDir :: Flag FilePath
haddockUseUnicode :: Flag Bool

Bundled Patterns

pattern HaddockCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> HaddockFlags

Instances

Instances details

Structured HaddockFlags Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods structure :: Proxy HaddockFlags -> Structure structureHash' :: Tagged HaddockFlags MD5
Monoid HaddockFlags Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods mempty :: HaddockFlags # mappend :: HaddockFlags -> HaddockFlags -> HaddockFlags # mconcat :: [HaddockFlags] -> HaddockFlags #
Semigroup HaddockFlags Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods (<>) :: HaddockFlags -> HaddockFlags -> HaddockFlags # sconcat :: NonEmpty HaddockFlags -> HaddockFlags # stimes :: Integral b => b -> HaddockFlags -> HaddockFlags #
Generic HaddockFlags Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Associated Types type Rep HaddockFlags :: Type -> Type # Methods from :: HaddockFlags -> Rep HaddockFlags x # to :: Rep HaddockFlags x -> HaddockFlags #
Show HaddockFlags Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods showsPrec :: Int -> HaddockFlags -> ShowS # show :: HaddockFlags -> String # showList :: [HaddockFlags] -> ShowS #
Binary HaddockFlags Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods put :: HaddockFlags -> Put # get :: Get HaddockFlags # putList :: [HaddockFlags] -> Put #
type Rep HaddockFlags Source #
Instance details Defined in Distribution.Simple.Setup.Haddock type Rep HaddockFlags = D1 ('MetaData "HaddockFlags" "Distribution.Simple.Setup.Haddock" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "HaddockFlags" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "haddockCommonFlags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CommonSetupFlags) :: S1 ('MetaSel ('Just "haddockProgramPaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, FilePath)])) :: (S1 ('MetaSel ('Just "haddockProgramArgs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, [String])]) :: (S1 ('MetaSel ('Just "haddockHoogle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "haddockHtml") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))))) :: ((S1 ('MetaSel ('Just "haddockHtmlLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag String)) :: (S1 ('MetaSel ('Just "haddockForHackage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag HaddockTarget)) :: S1 ('MetaSel ('Just "haddockExecutables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)))) :: (S1 ('MetaSel ('Just "haddockTestSuites") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: (S1 ('MetaSel ('Just "haddockBenchmarks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "haddockForeignLibs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)))))) :: (((S1 ('MetaSel ('Just "haddockInternal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: (S1 ('MetaSel ('Just "haddockCss") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath)) :: S1 ('MetaSel ('Just "haddockLinkedSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)))) :: (S1 ('MetaSel ('Just "haddockQuickJump") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: (S1 ('MetaSel ('Just "haddockHscolourCss") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath)) :: S1 ('MetaSel ('Just "haddockContents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag PathTemplate))))) :: ((S1 ('MetaSel ('Just "haddockIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag PathTemplate)) :: (S1 ('MetaSel ('Just "haddockKeepTempFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "haddockBaseUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag String)))) :: (S1 ('MetaSel ('Just "haddockResourcesDir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag String)) :: (S1 ('MetaSel ('Just "haddockOutputDir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath)) :: S1 ('MetaSel ('Just "haddockUseUnicode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))))))))

emptyHaddockFlags :: HaddockFlags Source #

defaultHaddockFlags :: HaddockFlags Source #

haddockCommand :: CommandUI HaddockFlags Source #

data Visibility Source #

Governs whether modules from a given interface should be visible or hidden in the Haddock generated content page. We don't expose this functionality to the user, but simply use Visible for only local packages. Visibility of modules is available since haddock-2.26.1.

Constructors

Visible
Hidden

Instances

Instances details

Show Visibility Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods showsPrec :: Int -> Visibility -> ShowS # show :: Visibility -> String # showList :: [Visibility] -> ShowS #
Eq Visibility Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods (==) :: Visibility -> Visibility -> Bool # (/=) :: Visibility -> Visibility -> Bool #

data HaddockProjectFlags Source #

Constructors

HaddockProjectFlags

Fields

haddockProjectHackage :: Flag Bool
a shortcut option which builds documentation linked to hackage. It implies: * `--html-location='https://hackage.haskell.org/package/$prg-$version/docs' * `--quickjump` * `--gen-index` * `--gen-contents` * `--hyperlinked-source`
haddockProjectDir :: Flag String
output directory of combined haddocks, the default is './haddocks'
haddockProjectPrologue :: Flag String
haddockProjectInterfaces :: Flag [(FilePath, Maybe FilePath, Maybe FilePath, Visibility)]
haddocksInterfaces is inferred by the haddocksAction; currently not exposed to the user.
haddockProjectProgramPaths :: [(String, FilePath)]
haddockProjectProgramArgs :: [(String, [String])]
haddockProjectHoogle :: Flag Bool
haddockProjectHtmlLocation :: Flag String
haddockProjectExecutables :: Flag Bool
haddockProjectTestSuites :: Flag Bool
haddockProjectBenchmarks :: Flag Bool
haddockProjectForeignLibs :: Flag Bool
haddockProjectInternal :: Flag Bool
haddockProjectCss :: Flag FilePath
haddockProjectHscolourCss :: Flag FilePath
haddockProjectKeepTempFiles :: Flag Bool
haddockProjectVerbosity :: Flag Verbosity
haddockProjectResourcesDir :: Flag String
haddockProjectUseUnicode :: Flag Bool

Instances

Instances details

Monoid HaddockProjectFlags Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods mempty :: HaddockProjectFlags # mappend :: HaddockProjectFlags -> HaddockProjectFlags -> HaddockProjectFlags # mconcat :: [HaddockProjectFlags] -> HaddockProjectFlags #
Semigroup HaddockProjectFlags Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods (<>) :: HaddockProjectFlags -> HaddockProjectFlags -> HaddockProjectFlags # sconcat :: NonEmpty HaddockProjectFlags -> HaddockProjectFlags # stimes :: Integral b => b -> HaddockProjectFlags -> HaddockProjectFlags #
Generic HaddockProjectFlags Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Associated Types type Rep HaddockProjectFlags :: Type -> Type # Methods from :: HaddockProjectFlags -> Rep HaddockProjectFlags x # to :: Rep HaddockProjectFlags x -> HaddockProjectFlags #
Show HaddockProjectFlags Source #
Instance details Defined in Distribution.Simple.Setup.Haddock Methods showsPrec :: Int -> HaddockProjectFlags -> ShowS # show :: HaddockProjectFlags -> String # showList :: [HaddockProjectFlags] -> ShowS #
type Rep HaddockProjectFlags Source #
Instance details Defined in Distribution.Simple.Setup.Haddock type Rep HaddockProjectFlags = D1 ('MetaData "HaddockProjectFlags" "Distribution.Simple.Setup.Haddock" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "HaddockProjectFlags" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "haddockProjectHackage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "haddockProjectDir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag String))) :: (S1 ('MetaSel ('Just "haddockProjectPrologue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag String)) :: S1 ('MetaSel ('Just "haddockProjectInterfaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag [(FilePath, Maybe FilePath, Maybe FilePath, Visibility)])))) :: ((S1 ('MetaSel ('Just "haddockProjectProgramPaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, FilePath)]) :: S1 ('MetaSel ('Just "haddockProjectProgramArgs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, [String])])) :: (S1 ('MetaSel ('Just "haddockProjectHoogle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: (S1 ('MetaSel ('Just "haddockProjectHtmlLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag String)) :: S1 ('MetaSel ('Just "haddockProjectExecutables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)))))) :: (((S1 ('MetaSel ('Just "haddockProjectTestSuites") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "haddockProjectBenchmarks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))) :: (S1 ('MetaSel ('Just "haddockProjectForeignLibs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: (S1 ('MetaSel ('Just "haddockProjectInternal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "haddockProjectCss") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath))))) :: ((S1 ('MetaSel ('Just "haddockProjectHscolourCss") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath)) :: S1 ('MetaSel ('Just "haddockProjectKeepTempFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))) :: (S1 ('MetaSel ('Just "haddockProjectVerbosity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Verbosity)) :: (S1 ('MetaSel ('Just "haddockProjectResourcesDir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag String)) :: S1 ('MetaSel ('Just "haddockProjectUseUnicode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))))))))

emptyHaddockProjectFlags :: HaddockProjectFlags Source #

defaultHaddockProjectFlags :: HaddockProjectFlags Source #

haddockProjectCommand :: CommandUI HaddockProjectFlags Source #

data HscolourFlags Source #

Constructors

HscolourFlags
Fields hscolourCommonFlags :: !CommonSetupFlags hscolourCSS :: Flag FilePath hscolourExecutables :: Flag Bool hscolourTestSuites :: Flag Bool hscolourBenchmarks :: Flag Bool hscolourForeignLibs :: Flag Bool

Bundled Patterns

pattern HscolourCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> HscolourFlags

Instances

Instances details

Structured HscolourFlags Source #
Instance details Defined in Distribution.Simple.Setup.Hscolour Methods structure :: Proxy HscolourFlags -> Structure structureHash' :: Tagged HscolourFlags MD5
Monoid HscolourFlags Source #
Instance details Defined in Distribution.Simple.Setup.Hscolour Methods mempty :: HscolourFlags # mappend :: HscolourFlags -> HscolourFlags -> HscolourFlags # mconcat :: [HscolourFlags] -> HscolourFlags #
Semigroup HscolourFlags Source #
Instance details Defined in Distribution.Simple.Setup.Hscolour Methods (<>) :: HscolourFlags -> HscolourFlags -> HscolourFlags # sconcat :: NonEmpty HscolourFlags -> HscolourFlags # stimes :: Integral b => b -> HscolourFlags -> HscolourFlags #
Generic HscolourFlags Source #
Instance details Defined in Distribution.Simple.Setup.Hscolour Associated Types type Rep HscolourFlags :: Type -> Type # Methods from :: HscolourFlags -> Rep HscolourFlags x # to :: Rep HscolourFlags x -> HscolourFlags #
Show HscolourFlags Source #
Instance details Defined in Distribution.Simple.Setup.Hscolour Methods showsPrec :: Int -> HscolourFlags -> ShowS # show :: HscolourFlags -> String # showList :: [HscolourFlags] -> ShowS #
Binary HscolourFlags Source #
Instance details Defined in Distribution.Simple.Setup.Hscolour Methods put :: HscolourFlags -> Put # get :: Get HscolourFlags # putList :: [HscolourFlags] -> Put #
type Rep HscolourFlags Source #
Instance details Defined in Distribution.Simple.Setup.Hscolour type Rep HscolourFlags = D1 ('MetaData "HscolourFlags" "Distribution.Simple.Setup.Hscolour" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "HscolourFlags" 'PrefixI 'True) ((S1 ('MetaSel ('Just "hscolourCommonFlags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CommonSetupFlags) :: (S1 ('MetaSel ('Just "hscolourCSS") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath)) :: S1 ('MetaSel ('Just "hscolourExecutables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)))) :: (S1 ('MetaSel ('Just "hscolourTestSuites") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: (S1 ('MetaSel ('Just "hscolourBenchmarks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :*: S1 ('MetaSel ('Just "hscolourForeignLibs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))))))

emptyHscolourFlags :: HscolourFlags Source #

defaultHscolourFlags :: HscolourFlags Source #

hscolourCommand :: CommandUI HscolourFlags Source #

data BuildFlags Source #

Constructors

BuildFlags
Fields buildCommonFlags :: !CommonSetupFlags buildProgramPaths :: [(String, FilePath)] buildProgramArgs :: [(String, [String])] buildNumJobs :: Flag (Maybe Int) buildUseSemaphore :: Flag String

Bundled Patterns

pattern BuildCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> BuildFlags

Instances

Instances details

Structured BuildFlags Source #
Instance details Defined in Distribution.Simple.Setup.Build Methods structure :: Proxy BuildFlags -> Structure structureHash' :: Tagged BuildFlags MD5
Monoid BuildFlags Source #
Instance details Defined in Distribution.Simple.Setup.Build Methods mempty :: BuildFlags # mappend :: BuildFlags -> BuildFlags -> BuildFlags # mconcat :: [BuildFlags] -> BuildFlags #
Semigroup BuildFlags Source #
Instance details Defined in Distribution.Simple.Setup.Build Methods (<>) :: BuildFlags -> BuildFlags -> BuildFlags # sconcat :: NonEmpty BuildFlags -> BuildFlags # stimes :: Integral b => b -> BuildFlags -> BuildFlags #
Generic BuildFlags Source #
Instance details Defined in Distribution.Simple.Setup.Build Associated Types type Rep BuildFlags :: Type -> Type # Methods from :: BuildFlags -> Rep BuildFlags x # to :: Rep BuildFlags x -> BuildFlags #
Read BuildFlags Source #
Instance details Defined in Distribution.Simple.Setup.Build Methods readsPrec :: Int -> ReadS BuildFlags # readList :: ReadS [BuildFlags] # readPrec :: ReadPrec BuildFlags # readListPrec :: ReadPrec [BuildFlags] #
Show BuildFlags Source #
Instance details Defined in Distribution.Simple.Setup.Build Methods showsPrec :: Int -> BuildFlags -> ShowS # show :: BuildFlags -> String # showList :: [BuildFlags] -> ShowS #
Binary BuildFlags Source #
Instance details Defined in Distribution.Simple.Setup.Build Methods put :: BuildFlags -> Put # get :: Get BuildFlags # putList :: [BuildFlags] -> Put #
type Rep BuildFlags Source #
Instance details Defined in Distribution.Simple.Setup.Build type Rep BuildFlags = D1 ('MetaData "BuildFlags" "Distribution.Simple.Setup.Build" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "BuildFlags" 'PrefixI 'True) ((S1 ('MetaSel ('Just "buildCommonFlags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CommonSetupFlags) :: S1 ('MetaSel ('Just "buildProgramPaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, FilePath)])) :: (S1 ('MetaSel ('Just "buildProgramArgs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, [String])]) :: (S1 ('MetaSel ('Just "buildNumJobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag (Maybe Int))) :: S1 ('MetaSel ('Just "buildUseSemaphore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag String))))))

emptyBuildFlags :: BuildFlags Source #

defaultBuildFlags :: BuildFlags Source #

buildCommand :: ProgramDb -> CommandUI BuildFlags Source #

data DumpBuildInfo Source #

Constructors

NoDumpBuildInfo
DumpBuildInfo

Instances

Instances details

Structured DumpBuildInfo Source #
Instance details Defined in Distribution.Types.DumpBuildInfo Methods structure :: Proxy DumpBuildInfo -> Structure structureHash' :: Tagged DumpBuildInfo MD5
Bounded DumpBuildInfo Source #
Instance details Defined in Distribution.Types.DumpBuildInfo Methods minBound :: DumpBuildInfo # maxBound :: DumpBuildInfo #
Enum DumpBuildInfo Source #
Instance details Defined in Distribution.Types.DumpBuildInfo Methods succ :: DumpBuildInfo -> DumpBuildInfo # pred :: DumpBuildInfo -> DumpBuildInfo # toEnum :: Int -> DumpBuildInfo # fromEnum :: DumpBuildInfo -> Int # enumFrom :: DumpBuildInfo -> [DumpBuildInfo] # enumFromThen :: DumpBuildInfo -> DumpBuildInfo -> [DumpBuildInfo] # enumFromTo :: DumpBuildInfo -> DumpBuildInfo -> [DumpBuildInfo] # enumFromThenTo :: DumpBuildInfo -> DumpBuildInfo -> DumpBuildInfo -> [DumpBuildInfo] #
Generic DumpBuildInfo Source #
Instance details Defined in Distribution.Types.DumpBuildInfo Associated Types type Rep DumpBuildInfo :: Type -> Type # Methods from :: DumpBuildInfo -> Rep DumpBuildInfo x # to :: Rep DumpBuildInfo x -> DumpBuildInfo #
Read DumpBuildInfo Source #
Instance details Defined in Distribution.Types.DumpBuildInfo Methods readsPrec :: Int -> ReadS DumpBuildInfo # readList :: ReadS [DumpBuildInfo] # readPrec :: ReadPrec DumpBuildInfo # readListPrec :: ReadPrec [DumpBuildInfo] #
Show DumpBuildInfo Source #
Instance details Defined in Distribution.Types.DumpBuildInfo Methods showsPrec :: Int -> DumpBuildInfo -> ShowS # show :: DumpBuildInfo -> String # showList :: [DumpBuildInfo] -> ShowS #
Binary DumpBuildInfo Source #
Instance details Defined in Distribution.Types.DumpBuildInfo Methods put :: DumpBuildInfo -> Put # get :: Get DumpBuildInfo # putList :: [DumpBuildInfo] -> Put #
Eq DumpBuildInfo Source #
Instance details Defined in Distribution.Types.DumpBuildInfo Methods (==) :: DumpBuildInfo -> DumpBuildInfo -> Bool # (/=) :: DumpBuildInfo -> DumpBuildInfo -> Bool #
Ord DumpBuildInfo Source #
Instance details Defined in Distribution.Types.DumpBuildInfo Methods compare :: DumpBuildInfo -> DumpBuildInfo -> Ordering # (<) :: DumpBuildInfo -> DumpBuildInfo -> Bool # (<=) :: DumpBuildInfo -> DumpBuildInfo -> Bool # (>) :: DumpBuildInfo -> DumpBuildInfo -> Bool # (>=) :: DumpBuildInfo -> DumpBuildInfo -> Bool # max :: DumpBuildInfo -> DumpBuildInfo -> DumpBuildInfo # min :: DumpBuildInfo -> DumpBuildInfo -> DumpBuildInfo #
type Rep DumpBuildInfo Source #
Instance details Defined in Distribution.Types.DumpBuildInfo type Rep DumpBuildInfo = D1 ('MetaData "DumpBuildInfo" "Distribution.Types.DumpBuildInfo" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "NoDumpBuildInfo" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DumpBuildInfo" 'PrefixI 'False) (U1 :: Type -> Type))

data ReplFlags Source #

Constructors

ReplFlags
Fields replCommonFlags :: !CommonSetupFlags replProgramPaths :: [(String, FilePath)] replProgramArgs :: [(String, [String])] replReload :: Flag Bool replReplOptions :: ReplOptions

Bundled Patterns

pattern ReplCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> ReplFlags

Instances

Instances details

Structured ReplFlags Source #
Instance details Defined in Distribution.Simple.Setup.Repl Methods structure :: Proxy ReplFlags -> Structure structureHash' :: Tagged ReplFlags MD5
Monoid ReplFlags Source #
Instance details Defined in Distribution.Simple.Setup.Repl Methods mempty :: ReplFlags # mappend :: ReplFlags -> ReplFlags -> ReplFlags # mconcat :: [ReplFlags] -> ReplFlags #
Semigroup ReplFlags Source #
Instance details Defined in Distribution.Simple.Setup.Repl Methods (<>) :: ReplFlags -> ReplFlags -> ReplFlags # sconcat :: NonEmpty ReplFlags -> ReplFlags # stimes :: Integral b => b -> ReplFlags -> ReplFlags #
Generic ReplFlags Source #
Instance details Defined in Distribution.Simple.Setup.Repl Associated Types type Rep ReplFlags :: Type -> Type # Methods from :: ReplFlags -> Rep ReplFlags x # to :: Rep ReplFlags x -> ReplFlags #
Show ReplFlags Source #
Instance details Defined in Distribution.Simple.Setup.Repl Methods showsPrec :: Int -> ReplFlags -> ShowS # show :: ReplFlags -> String # showList :: [ReplFlags] -> ShowS #
Binary ReplFlags Source #
Instance details Defined in Distribution.Simple.Setup.Repl Methods put :: ReplFlags -> Put # get :: Get ReplFlags # putList :: [ReplFlags] -> Put #
type Rep ReplFlags Source #
Instance details Defined in Distribution.Simple.Setup.Repl type Rep ReplFlags = D1 ('MetaData "ReplFlags" "Distribution.Simple.Setup.Repl" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "ReplFlags" 'PrefixI 'True) ((S1 ('MetaSel ('Just "replCommonFlags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CommonSetupFlags) :: S1 ('MetaSel ('Just "replProgramPaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, FilePath)])) :: (S1 ('MetaSel ('Just "replProgramArgs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, [String])]) :: (S1 ('MetaSel ('Just "replReload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "replReplOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ReplOptions)))))

defaultReplFlags :: ReplFlags Source #

replCommand :: ProgramDb -> CommandUI ReplFlags Source #

data ReplOptions Source #

Constructors

ReplOptions
Fields replOptionsFlags :: [String] replOptionsNoLoad :: Flag Bool replOptionsFlagOutput :: Flag FilePath

Instances

Instances details

Structured ReplOptions Source #
Instance details Defined in Distribution.Simple.Setup.Repl Methods structure :: Proxy ReplOptions -> Structure structureHash' :: Tagged ReplOptions MD5
Monoid ReplOptions Source #
Instance details Defined in Distribution.Simple.Setup.Repl Methods mempty :: ReplOptions # mappend :: ReplOptions -> ReplOptions -> ReplOptions # mconcat :: [ReplOptions] -> ReplOptions #
Semigroup ReplOptions Source #
Instance details Defined in Distribution.Simple.Setup.Repl Methods (<>) :: ReplOptions -> ReplOptions -> ReplOptions # sconcat :: NonEmpty ReplOptions -> ReplOptions # stimes :: Integral b => b -> ReplOptions -> ReplOptions #
Generic ReplOptions Source #
Instance details Defined in Distribution.Simple.Setup.Repl Associated Types type Rep ReplOptions :: Type -> Type # Methods from :: ReplOptions -> Rep ReplOptions x # to :: Rep ReplOptions x -> ReplOptions #
Show ReplOptions Source #
Instance details Defined in Distribution.Simple.Setup.Repl Methods showsPrec :: Int -> ReplOptions -> ShowS # show :: ReplOptions -> String # showList :: [ReplOptions] -> ShowS #
Binary ReplOptions Source #
Instance details Defined in Distribution.Simple.Setup.Repl Methods put :: ReplOptions -> Put # get :: Get ReplOptions # putList :: [ReplOptions] -> Put #
type Rep ReplOptions Source #
Instance details Defined in Distribution.Simple.Setup.Repl type Rep ReplOptions = D1 ('MetaData "ReplOptions" "Distribution.Simple.Setup.Repl" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "ReplOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "replOptionsFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :: (S1 ('MetaSel ('Just "replOptionsNoLoad") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "replOptionsFlagOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath)))))

data CleanFlags Source #

Constructors

CleanFlags
Fields cleanCommonFlags :: !CommonSetupFlags cleanSaveConf :: Flag Bool

Bundled Patterns

pattern CleanCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> CleanFlags

Instances

Instances details

Structured CleanFlags Source #
Instance details Defined in Distribution.Simple.Setup.Clean Methods structure :: Proxy CleanFlags -> Structure structureHash' :: Tagged CleanFlags MD5
Monoid CleanFlags Source #
Instance details Defined in Distribution.Simple.Setup.Clean Methods mempty :: CleanFlags # mappend :: CleanFlags -> CleanFlags -> CleanFlags # mconcat :: [CleanFlags] -> CleanFlags #
Semigroup CleanFlags Source #
Instance details Defined in Distribution.Simple.Setup.Clean Methods (<>) :: CleanFlags -> CleanFlags -> CleanFlags # sconcat :: NonEmpty CleanFlags -> CleanFlags # stimes :: Integral b => b -> CleanFlags -> CleanFlags #
Generic CleanFlags Source #
Instance details Defined in Distribution.Simple.Setup.Clean Associated Types type Rep CleanFlags :: Type -> Type # Methods from :: CleanFlags -> Rep CleanFlags x # to :: Rep CleanFlags x -> CleanFlags #
Show CleanFlags Source #
Instance details Defined in Distribution.Simple.Setup.Clean Methods showsPrec :: Int -> CleanFlags -> ShowS # show :: CleanFlags -> String # showList :: [CleanFlags] -> ShowS #
Binary CleanFlags Source #
Instance details Defined in Distribution.Simple.Setup.Clean Methods put :: CleanFlags -> Put # get :: Get CleanFlags # putList :: [CleanFlags] -> Put #
type Rep CleanFlags Source #
Instance details Defined in Distribution.Simple.Setup.Clean type Rep CleanFlags = D1 ('MetaData "CleanFlags" "Distribution.Simple.Setup.Clean" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "CleanFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "cleanCommonFlags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CommonSetupFlags) :*: S1 ('MetaSel ('Just "cleanSaveConf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))))

emptyCleanFlags :: CleanFlags Source #

defaultCleanFlags :: CleanFlags Source #

cleanCommand :: CommandUI CleanFlags Source #

data RegisterFlags Source #

Flags to register and unregister: (user package, gen-script, in-place, verbosity)

Constructors

RegisterFlags
Fields registerCommonFlags :: !CommonSetupFlags regPackageDB :: Flag PackageDB regGenScript :: Flag Bool regGenPkgConf :: Flag (Maybe (SymbolicPath Pkg (Dir PkgConf))) regInPlace :: Flag Bool regPrintId :: Flag Bool

Bundled Patterns

pattern RegisterCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> RegisterFlags

Instances

Instances details

Monoid RegisterFlags Source #
Instance details Defined in Distribution.Simple.Setup.Register Methods mempty :: RegisterFlags # mappend :: RegisterFlags -> RegisterFlags -> RegisterFlags # mconcat :: [RegisterFlags] -> RegisterFlags #
Semigroup RegisterFlags Source #
Instance details Defined in Distribution.Simple.Setup.Register Methods (<>) :: RegisterFlags -> RegisterFlags -> RegisterFlags # sconcat :: NonEmpty RegisterFlags -> RegisterFlags # stimes :: Integral b => b -> RegisterFlags -> RegisterFlags #
Generic RegisterFlags Source #
Instance details Defined in Distribution.Simple.Setup.Register Associated Types type Rep RegisterFlags :: Type -> Type # Methods from :: RegisterFlags -> Rep RegisterFlags x # to :: Rep RegisterFlags x -> RegisterFlags #
Show RegisterFlags Source #
Instance details Defined in Distribution.Simple.Setup.Register Methods showsPrec :: Int -> RegisterFlags -> ShowS # show :: RegisterFlags -> String # showList :: [RegisterFlags] -> ShowS #
type Rep RegisterFlags Source #
Instance details Defined in Distribution.Simple.Setup.Register type Rep RegisterFlags = D1 ('MetaData "RegisterFlags" "Distribution.Simple.Setup.Register" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "RegisterFlags" 'PrefixI 'True) ((S1 ('MetaSel ('Just "registerCommonFlags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CommonSetupFlags) :: (S1 ('MetaSel ('Just "regPackageDB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag PackageDB)) :: S1 ('MetaSel ('Just "regGenScript") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)))) :: (S1 ('MetaSel ('Just "regGenPkgConf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag (Maybe (SymbolicPath Pkg ('Dir PkgConf))))) :: (S1 ('MetaSel ('Just "regInPlace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :*: S1 ('MetaSel ('Just "regPrintId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))))))

emptyRegisterFlags :: RegisterFlags Source #

defaultRegisterFlags :: RegisterFlags Source #

registerCommand :: CommandUI RegisterFlags Source #

unregisterCommand :: CommandUI RegisterFlags Source #

data SDistFlags Source #

Flags to sdist: (snapshot, verbosity)

Constructors

SDistFlags
Fields sDistCommonFlags :: !CommonSetupFlags sDistSnapshot :: Flag Bool sDistDirectory :: Flag FilePath sDistListSources :: Flag FilePath

Bundled Patterns

pattern SDistCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> SDistFlags

Instances

Instances details

Monoid SDistFlags Source #
Instance details Defined in Distribution.Simple.Setup.SDist Methods mempty :: SDistFlags # mappend :: SDistFlags -> SDistFlags -> SDistFlags # mconcat :: [SDistFlags] -> SDistFlags #
Semigroup SDistFlags Source #
Instance details Defined in Distribution.Simple.Setup.SDist Methods (<>) :: SDistFlags -> SDistFlags -> SDistFlags # sconcat :: NonEmpty SDistFlags -> SDistFlags # stimes :: Integral b => b -> SDistFlags -> SDistFlags #
Generic SDistFlags Source #
Instance details Defined in Distribution.Simple.Setup.SDist Associated Types type Rep SDistFlags :: Type -> Type # Methods from :: SDistFlags -> Rep SDistFlags x # to :: Rep SDistFlags x -> SDistFlags #
Show SDistFlags Source #
Instance details Defined in Distribution.Simple.Setup.SDist Methods showsPrec :: Int -> SDistFlags -> ShowS # show :: SDistFlags -> String # showList :: [SDistFlags] -> ShowS #
type Rep SDistFlags Source #
Instance details Defined in Distribution.Simple.Setup.SDist type Rep SDistFlags = D1 ('MetaData "SDistFlags" "Distribution.Simple.Setup.SDist" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "SDistFlags" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sDistCommonFlags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CommonSetupFlags) :: S1 ('MetaSel ('Just "sDistSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))) :: (S1 ('MetaSel ('Just "sDistDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath)) :*: S1 ('MetaSel ('Just "sDistListSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath)))))

emptySDistFlags :: SDistFlags Source #

defaultSDistFlags :: SDistFlags Source #

sdistCommand :: CommandUI SDistFlags Source #

data TestFlags Source #

Constructors

TestFlags
Fields testCommonFlags :: !CommonSetupFlags testHumanLog :: Flag PathTemplate testMachineLog :: Flag PathTemplate testShowDetails :: Flag TestShowDetails testKeepTix :: Flag Bool testWrapper :: Flag FilePath testFailWhenNoTestSuites :: Flag Bool testOptions :: [PathTemplate]

Bundled Patterns

pattern TestCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> TestFlags

Instances

Instances details

Structured TestFlags Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods structure :: Proxy TestFlags -> Structure structureHash' :: Tagged TestFlags MD5
Monoid TestFlags Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods mempty :: TestFlags # mappend :: TestFlags -> TestFlags -> TestFlags # mconcat :: [TestFlags] -> TestFlags #
Semigroup TestFlags Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods (<>) :: TestFlags -> TestFlags -> TestFlags # sconcat :: NonEmpty TestFlags -> TestFlags # stimes :: Integral b => b -> TestFlags -> TestFlags #
Generic TestFlags Source #
Instance details Defined in Distribution.Simple.Setup.Test Associated Types type Rep TestFlags :: Type -> Type # Methods from :: TestFlags -> Rep TestFlags x # to :: Rep TestFlags x -> TestFlags #
Show TestFlags Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods showsPrec :: Int -> TestFlags -> ShowS # show :: TestFlags -> String # showList :: [TestFlags] -> ShowS #
Binary TestFlags Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods put :: TestFlags -> Put # get :: Get TestFlags # putList :: [TestFlags] -> Put #
type Rep TestFlags Source #
Instance details Defined in Distribution.Simple.Setup.Test type Rep TestFlags = D1 ('MetaData "TestFlags" "Distribution.Simple.Setup.Test" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "TestFlags" 'PrefixI 'True) (((S1 ('MetaSel ('Just "testCommonFlags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CommonSetupFlags) :: S1 ('MetaSel ('Just "testHumanLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag PathTemplate))) :: (S1 ('MetaSel ('Just "testMachineLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag PathTemplate)) :: S1 ('MetaSel ('Just "testShowDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag TestShowDetails)))) :: ((S1 ('MetaSel ('Just "testKeepTix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :: S1 ('MetaSel ('Just "testWrapper") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath))) :: (S1 ('MetaSel ('Just "testFailWhenNoTestSuites") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :*: S1 ('MetaSel ('Just "testOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PathTemplate])))))

emptyTestFlags :: TestFlags Source #

defaultTestFlags :: TestFlags Source #

testCommand :: CommandUI TestFlags Source #

data TestShowDetails Source #

Constructors

Never
Failures
Always
Streaming
Direct

Instances

Instances details

Parsec TestShowDetails Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods parsec :: CabalParsing m => m TestShowDetails
Pretty TestShowDetails Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods pretty :: TestShowDetails -> Doc prettyVersioned :: CabalSpecVersion -> TestShowDetails -> Doc
Structured TestShowDetails Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods structure :: Proxy TestShowDetails -> Structure structureHash' :: Tagged TestShowDetails MD5
Monoid TestShowDetails Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods mempty :: TestShowDetails # mappend :: TestShowDetails -> TestShowDetails -> TestShowDetails # mconcat :: [TestShowDetails] -> TestShowDetails #
Semigroup TestShowDetails Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods (<>) :: TestShowDetails -> TestShowDetails -> TestShowDetails # sconcat :: NonEmpty TestShowDetails -> TestShowDetails # stimes :: Integral b => b -> TestShowDetails -> TestShowDetails #
Bounded TestShowDetails Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods minBound :: TestShowDetails # maxBound :: TestShowDetails #
Enum TestShowDetails Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods succ :: TestShowDetails -> TestShowDetails # pred :: TestShowDetails -> TestShowDetails # toEnum :: Int -> TestShowDetails # fromEnum :: TestShowDetails -> Int # enumFrom :: TestShowDetails -> [TestShowDetails] # enumFromThen :: TestShowDetails -> TestShowDetails -> [TestShowDetails] # enumFromTo :: TestShowDetails -> TestShowDetails -> [TestShowDetails] # enumFromThenTo :: TestShowDetails -> TestShowDetails -> TestShowDetails -> [TestShowDetails] #
Generic TestShowDetails Source #
Instance details Defined in Distribution.Simple.Setup.Test Associated Types type Rep TestShowDetails :: Type -> Type # Methods from :: TestShowDetails -> Rep TestShowDetails x # to :: Rep TestShowDetails x -> TestShowDetails #
Show TestShowDetails Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods showsPrec :: Int -> TestShowDetails -> ShowS # show :: TestShowDetails -> String # showList :: [TestShowDetails] -> ShowS #
Binary TestShowDetails Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods put :: TestShowDetails -> Put # get :: Get TestShowDetails # putList :: [TestShowDetails] -> Put #
Eq TestShowDetails Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods (==) :: TestShowDetails -> TestShowDetails -> Bool # (/=) :: TestShowDetails -> TestShowDetails -> Bool #
Ord TestShowDetails Source #
Instance details Defined in Distribution.Simple.Setup.Test Methods compare :: TestShowDetails -> TestShowDetails -> Ordering # (<) :: TestShowDetails -> TestShowDetails -> Bool # (<=) :: TestShowDetails -> TestShowDetails -> Bool # (>) :: TestShowDetails -> TestShowDetails -> Bool # (>=) :: TestShowDetails -> TestShowDetails -> Bool # max :: TestShowDetails -> TestShowDetails -> TestShowDetails # min :: TestShowDetails -> TestShowDetails -> TestShowDetails #
type Rep TestShowDetails Source #
Instance details Defined in Distribution.Simple.Setup.Test type Rep TestShowDetails = D1 ('MetaData "TestShowDetails" "Distribution.Simple.Setup.Test" "Cabal-3.14.0.0-inplace" 'False) ((C1 ('MetaCons "Never" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Failures" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Always" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Streaming" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Direct" 'PrefixI 'False) (U1 :: Type -> Type))))

data BenchmarkFlags Source #

Constructors

BenchmarkFlags
Fields benchmarkCommonFlags :: !CommonSetupFlags benchmarkOptions :: [PathTemplate]

Bundled Patterns

pattern BenchmarkCommonFlags :: Flag Verbosity -> Flag (SymbolicPath Pkg (Dir Dist)) -> Flag (SymbolicPath CWD (Dir Pkg)) -> Flag (SymbolicPath Pkg File) -> [String] -> BenchmarkFlags

Instances

Instances details

Structured BenchmarkFlags Source #
Instance details Defined in Distribution.Simple.Setup.Benchmark Methods structure :: Proxy BenchmarkFlags -> Structure structureHash' :: Tagged BenchmarkFlags MD5
Monoid BenchmarkFlags Source #
Instance details Defined in Distribution.Simple.Setup.Benchmark Methods mempty :: BenchmarkFlags # mappend :: BenchmarkFlags -> BenchmarkFlags -> BenchmarkFlags # mconcat :: [BenchmarkFlags] -> BenchmarkFlags #
Semigroup BenchmarkFlags Source #
Instance details Defined in Distribution.Simple.Setup.Benchmark Methods (<>) :: BenchmarkFlags -> BenchmarkFlags -> BenchmarkFlags # sconcat :: NonEmpty BenchmarkFlags -> BenchmarkFlags # stimes :: Integral b => b -> BenchmarkFlags -> BenchmarkFlags #
Generic BenchmarkFlags Source #
Instance details Defined in Distribution.Simple.Setup.Benchmark Associated Types type Rep BenchmarkFlags :: Type -> Type # Methods from :: BenchmarkFlags -> Rep BenchmarkFlags x # to :: Rep BenchmarkFlags x -> BenchmarkFlags #
Show BenchmarkFlags Source #
Instance details Defined in Distribution.Simple.Setup.Benchmark Methods showsPrec :: Int -> BenchmarkFlags -> ShowS # show :: BenchmarkFlags -> String # showList :: [BenchmarkFlags] -> ShowS #
Binary BenchmarkFlags Source #
Instance details Defined in Distribution.Simple.Setup.Benchmark Methods put :: BenchmarkFlags -> Put # get :: Get BenchmarkFlags # putList :: [BenchmarkFlags] -> Put #
type Rep BenchmarkFlags Source #
Instance details Defined in Distribution.Simple.Setup.Benchmark type Rep BenchmarkFlags = D1 ('MetaData "BenchmarkFlags" "Distribution.Simple.Setup.Benchmark" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "BenchmarkFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "benchmarkCommonFlags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CommonSetupFlags) :*: S1 ('MetaSel ('Just "benchmarkOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PathTemplate])))

emptyBenchmarkFlags :: BenchmarkFlags Source #

defaultBenchmarkFlags :: BenchmarkFlags Source #

benchmarkCommand :: CommandUI BenchmarkFlags Source #

data CopyDest Source #

The location prefix for the copy command.

Constructors

NoCopyDest
CopyTo FilePath
CopyToDb FilePath	when using the ${pkgroot} as prefix. The CopyToDb will adjust the paths to be relative to the provided package database when copying / installing.

Instances

Instances details

Structured CopyDest Source #
Instance details Defined in Distribution.Simple.InstallDirs Methods structure :: Proxy CopyDest -> Structure structureHash' :: Tagged CopyDest MD5
Generic CopyDest Source #
Instance details Defined in Distribution.Simple.InstallDirs Associated Types type Rep CopyDest :: Type -> Type # Methods from :: CopyDest -> Rep CopyDest x # to :: Rep CopyDest x -> CopyDest #
Show CopyDest Source #
Instance details Defined in Distribution.Simple.InstallDirs Methods showsPrec :: Int -> CopyDest -> ShowS # show :: CopyDest -> String # showList :: [CopyDest] -> ShowS #
Binary CopyDest Source #
Instance details Defined in Distribution.Simple.InstallDirs Methods put :: CopyDest -> Put # get :: Get CopyDest # putList :: [CopyDest] -> Put #
Eq CopyDest Source #
Instance details Defined in Distribution.Simple.InstallDirs Methods (==) :: CopyDest -> CopyDest -> Bool # (/=) :: CopyDest -> CopyDest -> Bool #
type Rep CopyDest Source #
Instance details Defined in Distribution.Simple.InstallDirs type Rep CopyDest = D1 ('MetaData "CopyDest" "Distribution.Simple.InstallDirs" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "NoCopyDest" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CopyTo" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)) :+: C1 ('MetaCons "CopyToDb" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath))))

configureArgs :: Bool -> ConfigFlags -> [String] Source #

Arguments to pass to a configure script, e.g. generated by autoconf.

configureOptions :: ShowOrParseArgs -> [OptionField ConfigFlags] Source #

configureCCompiler :: Verbosity -> ProgramDb -> IO (FilePath, [String]) Source #

configureLinker :: Verbosity -> ProgramDb -> IO (FilePath, [String]) Source #

buildOptions :: ProgramDb -> ShowOrParseArgs -> [OptionField BuildFlags] Source #

haddockOptions :: ShowOrParseArgs -> [OptionField HaddockFlags] Source #

haddockProjectOptions :: ShowOrParseArgs -> [OptionField HaddockProjectFlags] Source #

installDirsOptions :: [OptionField (InstallDirs (Flag PathTemplate))] Source #

testOptions' :: ShowOrParseArgs -> [OptionField TestFlags] Source #

benchmarkOptions' :: ShowOrParseArgs -> [OptionField BenchmarkFlags] Source #

programDbOptions :: ProgramDb -> ShowOrParseArgs -> (flags -> [(String, [String])]) -> ([(String, [String])] -> flags -> flags) -> [OptionField flags] Source #

For each known program PROG in progDb, produce a PROG-options OptionField.

programDbPaths' :: (String -> String) -> ProgramDb -> ShowOrParseArgs -> (flags -> [(String, FilePath)]) -> ([(String, FilePath)] -> flags -> flags) -> [OptionField flags] Source #

Like programDbPaths, but allows to customise the option name.

programFlagsDescription :: ProgramDb -> String Source #

replOptions :: ShowOrParseArgs -> [OptionField ReplOptions] Source #

splitArgs :: String -> [String] Source #

Helper function to split a string into a list of arguments. It's supposed to handle quoted things sensibly, eg:

splitArgs "--foo=\"C:/Program Files/Bar/" --baz"
  = ["--foo=C:/Program Files/Bar", "--baz"]

splitArgs "\"-DMSGSTR=\\\"foo bar\\\"\" --baz"
  = ["-DMSGSTR=\"foo bar\"","--baz"]

defaultDistPref :: SymbolicPath Pkg (Dir Dist) Source #

optionDistPref :: (flags -> Flag (SymbolicPath Pkg (Dir Dist))) -> (Flag (SymbolicPath Pkg (Dir Dist)) -> flags -> flags) -> ShowOrParseArgs -> OptionField flags Source #

data Flag a Source #

All flags are monoids, they come in two flavours:

list flags eg

--ghc-option=foo --ghc-option=bar

gives us all the values ["foo", "bar"]

singular value flags, eg:

--enable-foo --disable-foo

gives us Just False

So, this Flag type is for the latter singular kind of flag. Its monoid instance gives us the behaviour where it starts out as NoFlag and later flags override earlier ones.

Isomorphic to Maybe a.

Constructors

Flag a
NoFlag

Instances

Instances details

Foldable Flag Source #
Instance details Defined in Distribution.Simple.Flag Methods fold :: Monoid m => Flag m -> m # foldMap :: Monoid m => (a -> m) -> Flag a -> m # foldMap' :: Monoid m => (a -> m) -> Flag a -> m # foldr :: (a -> b -> b) -> b -> Flag a -> b # foldr' :: (a -> b -> b) -> b -> Flag a -> b # foldl :: (b -> a -> b) -> b -> Flag a -> b # foldl' :: (b -> a -> b) -> b -> Flag a -> b # foldr1 :: (a -> a -> a) -> Flag a -> a # foldl1 :: (a -> a -> a) -> Flag a -> a # toList :: Flag a -> [a] # null :: Flag a -> Bool # length :: Flag a -> Int # elem :: Eq a => a -> Flag a -> Bool # maximum :: Ord a => Flag a -> a # minimum :: Ord a => Flag a -> a # sum :: Num a => Flag a -> a # product :: Num a => Flag a -> a #
Traversable Flag Source #
Instance details Defined in Distribution.Simple.Flag Methods traverse :: Applicative f => (a -> f b) -> Flag a -> f (Flag b) # sequenceA :: Applicative f => Flag (f a) -> f (Flag a) # mapM :: Monad m => (a -> m b) -> Flag a -> m (Flag b) # sequence :: Monad m => Flag (m a) -> m (Flag a) #
Applicative Flag Source #
Instance details Defined in Distribution.Simple.Flag Methods pure :: a -> Flag a # (<>) :: Flag (a -> b) -> Flag a -> Flag b # liftA2 :: (a -> b -> c) -> Flag a -> Flag b -> Flag c # (>) :: Flag a -> Flag b -> Flag b # (<*) :: Flag a -> Flag b -> Flag a #
Functor Flag Source #
Instance details Defined in Distribution.Simple.Flag Methods fmap :: (a -> b) -> Flag a -> Flag b # (<$) :: a -> Flag b -> Flag a #
Structured a => Structured (Flag a) Source #
Instance details Defined in Distribution.Simple.Flag Methods structure :: Proxy (Flag a) -> Structure structureHash' :: Tagged (Flag a) MD5
Monoid (Flag a) Source #
Instance details Defined in Distribution.Simple.Flag Methods mempty :: Flag a # mappend :: Flag a -> Flag a -> Flag a # mconcat :: [Flag a] -> Flag a #
Semigroup (Flag a) Source #
Instance details Defined in Distribution.Simple.Flag Methods (<>) :: Flag a -> Flag a -> Flag a # sconcat :: NonEmpty (Flag a) -> Flag a # stimes :: Integral b => b -> Flag a -> Flag a #
Bounded a => Bounded (Flag a) Source #
Instance details Defined in Distribution.Simple.Flag Methods minBound :: Flag a # maxBound :: Flag a #
Enum a => Enum (Flag a) Source #
Instance details Defined in Distribution.Simple.Flag Methods succ :: Flag a -> Flag a # pred :: Flag a -> Flag a # toEnum :: Int -> Flag a # fromEnum :: Flag a -> Int # enumFrom :: Flag a -> [Flag a] # enumFromThen :: Flag a -> Flag a -> [Flag a] # enumFromTo :: Flag a -> Flag a -> [Flag a] # enumFromThenTo :: Flag a -> Flag a -> Flag a -> [Flag a] #
Generic (Flag a) Source #
Instance details Defined in Distribution.Simple.Flag Associated Types type Rep (Flag a) :: Type -> Type # Methods from :: Flag a -> Rep (Flag a) x # to :: Rep (Flag a) x -> Flag a #
Read a => Read (Flag a) Source #
Instance details Defined in Distribution.Simple.Flag Methods readsPrec :: Int -> ReadS (Flag a) # readList :: ReadS [Flag a] # readPrec :: ReadPrec (Flag a) # readListPrec :: ReadPrec [Flag a] #
Show a => Show (Flag a) Source #
Instance details Defined in Distribution.Simple.Flag Methods showsPrec :: Int -> Flag a -> ShowS # show :: Flag a -> String # showList :: [Flag a] -> ShowS #
Binary a => Binary (Flag a) Source #
Instance details Defined in Distribution.Simple.Flag Methods put :: Flag a -> Put # get :: Get (Flag a) # putList :: [Flag a] -> Put #
Eq a => Eq (Flag a) Source #
Instance details Defined in Distribution.Simple.Flag Methods (==) :: Flag a -> Flag a -> Bool # (/=) :: Flag a -> Flag a -> Bool #
type Rep (Flag a) Source #
Instance details Defined in Distribution.Simple.Flag type Rep (Flag a) = D1 ('MetaData "Flag" "Distribution.Simple.Flag" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "Flag" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: C1 ('MetaCons "NoFlag" 'PrefixI 'False) (U1 :: Type -> Type))

toFlag :: a -> Flag a Source #

Wraps a value in Flag.

fromFlag :: WithCallStack (Flag a -> a) Source #

Extracts a value from a Flag, and throws an exception on NoFlag.

fromFlagOrDefault :: a -> Flag a -> a Source #

Extracts a value from a Flag, and returns the default value on NoFlag.

flagToMaybe :: Flag a -> Maybe a Source #

Converts a Flag value to a Maybe value.

flagToList :: Flag a -> [a] Source #

Converts a Flag value to a list.

maybeToFlag :: Maybe a -> Flag a Source #

Converts a Maybe value to a Flag value.

class BooleanFlag a where Source #

Types that represent boolean flags.

Methods

asBool :: a -> Bool Source #

Instances

Instances details

BooleanFlag Bool Source #
Instance details Defined in Distribution.Simple.Flag Methods asBool :: Bool -> Bool Source #

boolOpt :: SFlags -> SFlags -> MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a Source #

boolOpt' :: OptFlags -> OptFlags -> MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a Source #

trueArg :: MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a Source #

falseArg :: MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a Source #

optionVerbosity :: (flags -> Flag Verbosity) -> (Flag Verbosity -> flags -> flags) -> OptionField flags Source #

data BuildingWhat Source #

What kind of build phase are we doing/hooking into?

Is this a normal build, or is it perhaps for running an interactive session or Haddock?

Constructors

BuildNormal BuildFlags	A normal build.
BuildRepl ReplFlags	Build steps for an interactive session.
BuildHaddock HaddockFlags	Build steps for generating documentation.
BuildHscolour HscolourFlags	Build steps for Hscolour.

Instances

Instances details

Structured BuildingWhat Source #
Instance details Defined in Distribution.Simple.Setup Methods structure :: Proxy BuildingWhat -> Structure structureHash' :: Tagged BuildingWhat MD5
Generic BuildingWhat Source #
Instance details Defined in Distribution.Simple.Setup Associated Types type Rep BuildingWhat :: Type -> Type # Methods from :: BuildingWhat -> Rep BuildingWhat x # to :: Rep BuildingWhat x -> BuildingWhat #
Show BuildingWhat Source #
Instance details Defined in Distribution.Simple.Setup Methods showsPrec :: Int -> BuildingWhat -> ShowS # show :: BuildingWhat -> String # showList :: [BuildingWhat] -> ShowS #
Binary BuildingWhat Source #
Instance details Defined in Distribution.Simple.Setup Methods put :: BuildingWhat -> Put # get :: Get BuildingWhat # putList :: [BuildingWhat] -> Put #
type Rep BuildingWhat Source #
Instance details Defined in Distribution.Simple.Setup type Rep BuildingWhat = D1 ('MetaData "BuildingWhat" "Distribution.Simple.Setup" "Cabal-3.14.0.0-inplace" 'False) ((C1 ('MetaCons "BuildNormal" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BuildFlags)) :+: C1 ('MetaCons "BuildRepl" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ReplFlags))) :+: (C1 ('MetaCons "BuildHaddock" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HaddockFlags)) :+: C1 ('MetaCons "BuildHscolour" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HscolourFlags))))

buildingWhatCommonFlags :: BuildingWhat -> CommonSetupFlags Source #

buildingWhatVerbosity :: BuildingWhat -> Verbosity Source #

buildingWhatWorkingDir :: BuildingWhat -> Maybe (SymbolicPath CWD (Dir Pkg)) Source #

buildingWhatDistPref :: BuildingWhat -> SymbolicPath Pkg (Dir Dist) Source #