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

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

Contents Package descriptions Libraries Executables Build information Supplementary build information package configuration Deprecated compat stuff

Description

Package description and parsing.

Synopsis

data PackageDescription = PackageDescription { package :: PackageIdentifier license :: License licenseFile :: FilePath copyright :: String maintainer :: String author :: String stability :: String testedWith :: [(CompilerFlavor, VersionRange)] homepage :: String pkgUrl :: String synopsis :: String description :: String category :: String customFieldsPD :: [(String, String)] buildDepends :: [Dependency] descCabalVersion :: VersionRange buildType :: (Maybe BuildType) library :: (Maybe Library) executables :: [Executable] dataFiles :: [FilePath] extraSrcFiles :: [FilePath] extraTmpFiles :: [FilePath] } emptyPackageDescription :: PackageDescription data BuildType = Simple | Configure | Make | Custom | UnknownBuildType String knownBuildTypes :: [BuildType] data Library = Library { exposedModules :: [String] libBuildInfo :: BuildInfo } emptyLibrary :: Library withLib :: PackageDescription -> a -> (Library -> IO a) -> IO a hasLibs :: PackageDescription -> Bool libModules :: PackageDescription -> [String] data Executable = Executable { exeName :: String modulePath :: FilePath buildInfo :: BuildInfo } emptyExecutable :: Executable withExe :: PackageDescription -> (Executable -> IO a) -> IO () hasExes :: PackageDescription -> Bool exeModules :: PackageDescription -> [String] data BuildInfo = BuildInfo { buildable :: Bool buildTools :: [Dependency] cppOptions :: [String] ccOptions :: [String] ldOptions :: [String] pkgconfigDepends :: [Dependency] frameworks :: [String] cSources :: [FilePath] hsSourceDirs :: [FilePath] otherModules :: [String] extensions :: [Extension] extraLibs :: [String] extraLibDirs :: [String] includeDirs :: [FilePath] includes :: [FilePath] installIncludes :: [FilePath] options :: [(CompilerFlavor, [String])] ghcProfOptions :: [String] ghcSharedOptions :: [String] customFieldsBI :: [(String, String)] } emptyBuildInfo :: BuildInfo allBuildInfo :: PackageDescription -> [BuildInfo] hcOptions :: CompilerFlavor -> BuildInfo -> [String] type HookedBuildInfo = (Maybe BuildInfo, [(String, BuildInfo)]) emptyHookedBuildInfo :: HookedBuildInfo updatePackageDescription :: HookedBuildInfo -> PackageDescription -> PackageDescription data GenericPackageDescription = GenericPackageDescription { packageDescription :: PackageDescription genPackageFlags :: [Flag] condLibrary :: (Maybe (CondTree ConfVar [Dependency] Library)) condExecutables :: [(String, CondTree ConfVar [Dependency] Executable)] } data Flag = MkFlag { flagName :: String flagDescription :: String flagDefault :: Bool } data CondTree v c a = CondNode { condTreeData :: a condTreeConstraints :: c condTreeComponents :: [(Condition v, CondTree v c a, Maybe (CondTree v c a))] } data ConfVar = OS OS | Arch Arch | Flag ConfFlag | Impl CompilerFlavor VersionRange newtype ConfFlag = ConfFlag String data Condition c = Var c | Lit Bool | CNot (Condition c) | COr (Condition c) (Condition c) | CAnd (Condition c) (Condition c) setupMessage :: Verbosity -> String -> PackageDescription -> IO ()

Package descriptions

data PackageDescription

This data type is the internal representation of the file pkg.cabal. It contains two kinds of information about the package: information which is needed for all packages, such as the package name and version, and information which is needed for the simple build system only, such as the compiler options and library name. Constructors PackageDescription package :: PackageIdentifier license :: License licenseFile :: FilePath copyright :: String maintainer :: String author :: String stability :: String testedWith :: [(CompilerFlavor, VersionRange)] homepage :: String pkgUrl :: String synopsis :: String A one-line summary of this package description :: String A more verbose description of this package category :: String customFieldsPD :: [(String, String)] Custom fields starting with x-, stored in a simple assoc-list. buildDepends :: [Dependency] descCabalVersion :: VersionRange If this package depends on a specific version of Cabal, give that here. buildType :: (Maybe BuildType) library :: (Maybe Library) executables :: [Executable] dataFiles :: [FilePath] extraSrcFiles :: [FilePath] extraTmpFiles :: [FilePath] Instances Eq PackageDescription Package PackageDescription Read PackageDescription Show PackageDescription

emptyPackageDescription :: PackageDescription

data BuildType

The type of build system used by this package. Constructors Simple calls Distribution.Simple.defaultMain Configure calls Distribution.Simple.defaultMainWithHooks defaultUserHooks, which invokes configure to generate additional build information used by later phases. Make calls Distribution.Make.defaultMain Custom uses user-supplied Setup.hs or Setup.lhs (default) UnknownBuildType String a package that uses an unknown build type cannot actually be built. Doing it this way rather than just giving a parse error means we get better error messages and allows you to inspect the rest of the package description. Instances Eq BuildType Read BuildType Show BuildType Text BuildType

knownBuildTypes :: [BuildType]

Libraries

data Library

Constructors Library exposedModules :: [String] libBuildInfo :: BuildInfo Instances Eq Library Monoid Library Read Library Show Library

emptyLibrary :: Library

withLib :: PackageDescription -> a -> (Library -> IO a) -> IO a

If the package description has a library section, call the given function with the library build info as argument.

hasLibs :: PackageDescription -> Bool

does this package have any libraries?

libModules :: PackageDescription -> [String]

Get all the module names from the libraries in this package

Executables

data Executable

Constructors Executable exeName :: String modulePath :: FilePath buildInfo :: BuildInfo Instances Eq Executable Monoid Executable Read Executable Show Executable

emptyExecutable :: Executable

withExe :: PackageDescription -> (Executable -> IO a) -> IO ()

Perform the action on each buildable Executable in the package description.

hasExes :: PackageDescription -> Bool

does this package have any executables?

exeModules :: PackageDescription -> [String]

Get all the module names from the exes in this package

Build information

data BuildInfo

Constructors BuildInfo buildable :: Bool component is buildable here buildTools :: [Dependency] tools needed to build this bit cppOptions :: [String] options for pre-processing Haskell code ccOptions :: [String] options for C compiler ldOptions :: [String] options for linker pkgconfigDepends :: [Dependency] pkg-config packages that are used frameworks :: [String] support frameworks for Mac OS X cSources :: [FilePath] hsSourceDirs :: [FilePath] where to look for the haskell module hierarchy otherModules :: [String] non-exposed or non-main modules extensions :: [Extension] extraLibs :: [String] what libraries to link with when compiling a program that uses your package extraLibDirs :: [String] includeDirs :: [FilePath] directories to find .h files includes :: [FilePath] The .h files to be found in includeDirs installIncludes :: [FilePath] .h files to install with the package options :: [(CompilerFlavor, [String])] ghcProfOptions :: [String] ghcSharedOptions :: [String] customFieldsBI :: [(String, String)] Custom fields starting with x-, stored in a simple assoc-list. Instances Eq BuildInfo Monoid BuildInfo Read BuildInfo Show BuildInfo

emptyBuildInfo :: BuildInfo

allBuildInfo :: PackageDescription -> [BuildInfo]

The BuildInfo for the library (if there is one and it's buildable) and all the buildable executables. Useful for gathering dependencies.

hcOptions :: CompilerFlavor -> BuildInfo -> [String]

Select options for a particular Haskell compiler.

Supplementary build information

type HookedBuildInfo = (Maybe BuildInfo, [(String, BuildInfo)])

emptyHookedBuildInfo :: HookedBuildInfo

updatePackageDescription :: HookedBuildInfo -> PackageDescription -> PackageDescription

package configuration

data GenericPackageDescription

Constructors GenericPackageDescription packageDescription :: PackageDescription genPackageFlags :: [Flag] condLibrary :: (Maybe (CondTree ConfVar [Dependency] Library)) condExecutables :: [(String, CondTree ConfVar [Dependency] Executable)] Instances Package GenericPackageDescription Show GenericPackageDescription

data Flag

A flag can represent a feature to be included, or a way of linking a target against its dependencies, or in fact whatever you can think of. Constructors MkFlag flagName :: String flagDescription :: String flagDefault :: Bool Instances Show Flag

data CondTree v c a

Constructors CondNode condTreeData :: a condTreeConstraints :: c condTreeComponents :: [(Condition v, CondTree v c a, Maybe (CondTree v c a))] Instances (Show a, Show c, ??? a c v) => Show (CondTree v c a)

data ConfVar

A ConfVar represents the variable type used. Constructors OS OS Arch Arch Flag ConfFlag Impl CompilerFlavor VersionRange Instances Eq ConfVar Show ConfVar

newtype ConfFlag

A ConfFlag represents an user-defined flag Constructors ConfFlag String Instances Eq ConfFlag Show ConfFlag

data Condition c

A boolean expression parameterized over the variable type used. Constructors Var c Lit Bool CNot (Condition c) COr (Condition c) (Condition c) CAnd (Condition c) (Condition c) Instances Show c => Show (Condition c)

Deprecated compat stuff

setupMessage :: Verbosity -> String -> PackageDescription -> IO ()

Produced by Haddock version 0.8