Cabal-1.2.1: A framework for packaging Haskell software Contents Index

Distribution.Simple.Setup Portability portable Stability alpha Maintainer Isaac Jones <ijones@syntaxpolice.org>

Description

Explanation: Data types and parser for the standard command-line setup. Will also return commands it doesn't know about.

Synopsis

module Distribution.Simple.Compiler data Action = ConfigCmd ConfigFlags | BuildCmd | CleanCmd | CopyCmd CopyDest | HscolourCmd | HaddockCmd | ProgramaticaCmd | InstallCmd | SDistCmd | MakefileCmd | TestCmd | RegisterCmd | UnregisterCmd | HelpCmd data ConfigFlags = ConfigFlags { configPrograms :: ProgramConfiguration configHcFlavor :: (Maybe CompilerFlavor) configHcPath :: (Maybe FilePath) configHcPkg :: (Maybe FilePath) configVanillaLib :: Bool configProfLib :: Bool configSharedLib :: Bool configProfExe :: Bool configConfigureArgs :: [String] configOptimization :: Bool configPrefix :: (Maybe FilePath) configBinDir :: (Maybe FilePath) configLibDir :: (Maybe FilePath) configLibSubDir :: (Maybe FilePath) configLibExecDir :: (Maybe FilePath) configDataDir :: (Maybe FilePath) configDataSubDir :: (Maybe FilePath) configDocDir :: (Maybe FilePath) configHtmlDir :: (Maybe FilePath) configVerbose :: Verbosity configPackageDB :: PackageDB configGHCiLib :: Bool configSplitObjs :: Bool configConfigurationsFlags :: [(String, Bool)] } emptyConfigFlags :: ProgramConfiguration -> ConfigFlags configureArgs :: ConfigFlags -> [String] data CopyFlags = CopyFlags { copyDest :: CopyDest copyVerbose :: Verbosity } data CopyDest = NoCopyDest | CopyTo FilePath | CopyPrefix FilePath emptyCopyFlags :: CopyDest -> CopyFlags data InstallFlags = InstallFlags { installPackageDB :: (Maybe PackageDB) installVerbose :: Verbosity } emptyInstallFlags :: InstallFlags data HaddockFlags = HaddockFlags { haddockHoogle :: Bool haddockHtmlLocation :: (Maybe String) haddockExecutables :: Bool haddockCss :: (Maybe FilePath) haddockHscolour :: Bool haddockHscolourCss :: (Maybe FilePath) haddockVerbose :: Verbosity } emptyHaddockFlags :: HaddockFlags data HscolourFlags = HscolourFlags { hscolourCSS :: (Maybe FilePath) hscolourExecutables :: Bool hscolourVerbose :: Verbosity } emptyHscolourFlags :: HscolourFlags data BuildFlags = BuildFlags { buildVerbose :: Verbosity buildPrograms :: ProgramConfiguration } emptyBuildFlags :: ProgramConfiguration -> BuildFlags data CleanFlags = CleanFlags { cleanSaveConf :: Bool cleanVerbose :: Verbosity } emptyCleanFlags :: CleanFlags data PFEFlags = PFEFlags { pfeVerbose :: Verbosity } data MakefileFlags = MakefileFlags { makefileVerbose :: Verbosity makefileFile :: (Maybe FilePath) } emptyMakefileFlags :: MakefileFlags data RegisterFlags = RegisterFlags { regPackageDB :: (Maybe PackageDB) regGenScript :: Bool regGenPkgConf :: Bool regPkgConfFile :: (Maybe FilePath) regInPlace :: Bool regVerbose :: Verbosity } emptyRegisterFlags :: RegisterFlags data SDistFlags = SDistFlags { sDistSnapshot :: Bool sDistVerbose :: Verbosity } parseGlobalArgs :: ProgramConfiguration -> [String] -> IO (Action, [String]) parseConfigureArgs :: ProgramConfiguration -> ConfigFlags -> [String] -> [OptDescr a] -> IO (ConfigFlags, [a], [String]) parseBuildArgs :: ProgramConfiguration -> BuildFlags -> [String] -> [OptDescr a] -> IO (BuildFlags, [a], [String]) parseCleanArgs :: CleanFlags -> [String] -> [OptDescr a] -> IO (CleanFlags, [a], [String]) parseMakefileArgs :: MakefileFlags -> [String] -> [OptDescr a] -> IO (MakefileFlags, [a], [String]) parseHscolourArgs :: HscolourFlags -> [String] -> [OptDescr a] -> IO (HscolourFlags, [a], [String]) parseHaddockArgs :: HaddockFlags -> [String] -> [OptDescr a] -> IO (HaddockFlags, [a], [String]) parseProgramaticaArgs :: [String] -> [OptDescr a] -> IO (PFEFlags, [a], [String]) parseTestArgs :: [String] -> [OptDescr a] -> IO (Verbosity, [a], [String]) parseInstallArgs :: InstallFlags -> [String] -> [OptDescr a] -> IO (InstallFlags, [a], [String]) parseSDistArgs :: [String] -> [OptDescr a] -> IO (SDistFlags, [a], [String]) parseRegisterArgs :: RegisterFlags -> [String] -> [OptDescr a] -> IO (RegisterFlags, [a], [String]) parseUnregisterArgs :: RegisterFlags -> [String] -> [OptDescr a] -> IO (RegisterFlags, [a], [String]) parseCopyArgs :: CopyFlags -> [String] -> [OptDescr a] -> IO (CopyFlags, [a], [String]) reqPathArg :: (FilePath -> a) -> ArgDescr a reqDirArg :: (FilePath -> a) -> ArgDescr a

Documentation

module Distribution.Simple.Compiler

data Action

Constructors ConfigCmd ConfigFlags BuildCmd CleanCmd CopyCmd CopyDest HscolourCmd HaddockCmd ProgramaticaCmd InstallCmd SDistCmd MakefileCmd TestCmd RegisterCmd UnregisterCmd HelpCmd Instances Show Action

data ConfigFlags

Flags to configure command Constructors ConfigFlags configPrograms :: ProgramConfiguration All programs that cabal may run configHcFlavor :: (Maybe CompilerFlavor) The "flavor" of the compiler, sugh as GHC or Hugs. configHcPath :: (Maybe FilePath) given compiler location configHcPkg :: (Maybe FilePath) given hc-pkg location configVanillaLib :: Bool Enable vanilla library configProfLib :: Bool Enable profiling in the library configSharedLib :: Bool Build shared library configProfExe :: Bool Enable profiling in the executables. configConfigureArgs :: [String] Extra arguments to configure configOptimization :: Bool Enable optimization. configPrefix :: (Maybe FilePath) installation prefix configBinDir :: (Maybe FilePath) installation dir for binaries, configLibDir :: (Maybe FilePath) installation dir for object code libraries, configLibSubDir :: (Maybe FilePath) subdirectory of libdir in which libs are installed configLibExecDir :: (Maybe FilePath) installation dir for program executables, configDataDir :: (Maybe FilePath) installation dir for read-only arch-independent data, configDataSubDir :: (Maybe FilePath) subdirectory of datadir in which data files are installed configDocDir :: (Maybe FilePath) installation dir for documentation configHtmlDir :: (Maybe FilePath) installation dir for HTML documentation configVerbose :: Verbosity verbosity level configPackageDB :: PackageDB the --user flag? configGHCiLib :: Bool Enable compiling library for GHCi configSplitObjs :: Bool Enable -split-objs with GHC configConfigurationsFlags :: [(String, Bool)] Instances Show ConfigFlags

emptyConfigFlags :: ProgramConfiguration -> ConfigFlags

The default configuration of a package, before running configure, most things are "Nothing", zero, etc.

configureArgs :: ConfigFlags -> [String]

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

data CopyFlags

Flags to copy: (destdir, copy-prefix (backwards compat), verbosity) Constructors CopyFlags copyDest :: CopyDest copyVerbose :: Verbosity Instances Show CopyFlags

data CopyDest

The location prefix for the copy command. Constructors NoCopyDest CopyTo FilePath CopyPrefix FilePath Instances Eq CopyDest Show CopyDest

emptyCopyFlags :: CopyDest -> CopyFlags

data InstallFlags

Flags to install: (package db, verbosity) Constructors InstallFlags installPackageDB :: (Maybe PackageDB) installVerbose :: Verbosity Instances Show InstallFlags

emptyInstallFlags :: InstallFlags

data HaddockFlags

Constructors HaddockFlags haddockHoogle :: Bool haddockHtmlLocation :: (Maybe String) haddockExecutables :: Bool haddockCss :: (Maybe FilePath) haddockHscolour :: Bool haddockHscolourCss :: (Maybe FilePath) haddockVerbose :: Verbosity Instances Show HaddockFlags

emptyHaddockFlags :: HaddockFlags

data HscolourFlags

Constructors HscolourFlags hscolourCSS :: (Maybe FilePath) hscolourExecutables :: Bool hscolourVerbose :: Verbosity Instances Show HscolourFlags

emptyHscolourFlags :: HscolourFlags

data BuildFlags

Constructors BuildFlags buildVerbose :: Verbosity buildPrograms :: ProgramConfiguration Instances Show BuildFlags

emptyBuildFlags :: ProgramConfiguration -> BuildFlags

data CleanFlags

Constructors CleanFlags cleanSaveConf :: Bool cleanVerbose :: Verbosity Instances Show CleanFlags

emptyCleanFlags :: CleanFlags

data PFEFlags

Constructors PFEFlags pfeVerbose :: Verbosity Instances Show PFEFlags

data MakefileFlags

Constructors MakefileFlags makefileVerbose :: Verbosity makefileFile :: (Maybe FilePath) Instances Show MakefileFlags

emptyMakefileFlags :: MakefileFlags

data RegisterFlags

Flags to register and unregister: (user package, gen-script, in-place, verbosity) Constructors RegisterFlags regPackageDB :: (Maybe PackageDB) regGenScript :: Bool regGenPkgConf :: Bool regPkgConfFile :: (Maybe FilePath) regInPlace :: Bool regVerbose :: Verbosity Instances Show RegisterFlags

emptyRegisterFlags :: RegisterFlags

data SDistFlags

Flags to sdist: (snapshot, verbosity) Constructors SDistFlags sDistSnapshot :: Bool sDistVerbose :: Verbosity Instances Show SDistFlags

parseGlobalArgs :: ProgramConfiguration -> [String] -> IO (Action, [String])

parseConfigureArgs :: ProgramConfiguration -> ConfigFlags -> [String] -> [OptDescr a] -> IO (ConfigFlags, [a], [String])

parseBuildArgs :: ProgramConfiguration -> BuildFlags -> [String] -> [OptDescr a] -> IO (BuildFlags, [a], [String])

parseCleanArgs :: CleanFlags -> [String] -> [OptDescr a] -> IO (CleanFlags, [a], [String])

parseMakefileArgs :: MakefileFlags -> [String] -> [OptDescr a] -> IO (MakefileFlags, [a], [String])

parseHscolourArgs :: HscolourFlags -> [String] -> [OptDescr a] -> IO (HscolourFlags, [a], [String])

parseHaddockArgs :: HaddockFlags -> [String] -> [OptDescr a] -> IO (HaddockFlags, [a], [String])

parseProgramaticaArgs :: [String] -> [OptDescr a] -> IO (PFEFlags, [a], [String])

parseTestArgs :: [String] -> [OptDescr a] -> IO (Verbosity, [a], [String])

parseInstallArgs :: InstallFlags -> [String] -> [OptDescr a] -> IO (InstallFlags, [a], [String])

parseSDistArgs :: [String] -> [OptDescr a] -> IO (SDistFlags, [a], [String])

parseRegisterArgs :: RegisterFlags -> [String] -> [OptDescr a] -> IO (RegisterFlags, [a], [String])

parseUnregisterArgs :: RegisterFlags -> [String] -> [OptDescr a] -> IO (RegisterFlags, [a], [String])

parseCopyArgs :: CopyFlags -> [String] -> [OptDescr a] -> IO (CopyFlags, [a], [String])

reqPathArg :: (FilePath -> a) -> ArgDescr a

reqDirArg :: (FilePath -> a) -> ArgDescr a

Produced by Haddock version 0.8