diff --git a/Cabal.cabal b/Cabal.cabal --- a/Cabal.cabal +++ b/Cabal.cabal @@ -1,5 +1,5 @@ name: Cabal -version: 2.4.0.0 +version: 2.4.0.1 copyright: 2003-2018, Cabal Development Team (see AUTHORS file) license: BSD3 license-file: LICENSE diff --git a/ChangeLog.md b/ChangeLog.md --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,4 +1,10 @@ +### 2.4.0.1 [Mikhail Glushenkov](mailto:mikhail.glushenkov@gmail.com) September 2018 + + * Allow arguments to be passed to `Setup.hs haddock` for `build-type:configure` + ([#5503](https://github.com/haskell/cabal/issues/5503)). + # 2.4.0.0 [Mikhail Glushenkov](mailto:mikhail.glushenkov@gmail.com) September 2018 + * Due to [#5119](https://github.com/haskell/cabal/issues/5119), the `cabal check` warning for bounds on internal libraries has been disabled. diff --git a/Distribution/Simple.hs b/Distribution/Simple.hs --- a/Distribution/Simple.hs +++ b/Distribution/Simple.hs @@ -668,7 +668,7 @@ preClean = readHook cleanVerbosity cleanDistPref, preInst = readHook installVerbosity installDistPref, preHscolour = readHook hscolourVerbosity hscolourDistPref, - preHaddock = readHook haddockVerbosity haddockDistPref, + preHaddock = readHookWithArgs haddockVerbosity haddockDistPref, preReg = readHook regVerbosity regDistPref, preUnreg = readHook regVerbosity regDistPref } diff --git a/doc/API/Cabal/Cabal.haddock b/doc/API/Cabal/Cabal.haddock new file mode 100644 Binary files /dev/null and b/doc/API/Cabal/Cabal.haddock differ diff --git a/doc/API/Cabal/Distribution-Backpack-ComponentsGraph.html b/doc/API/Cabal/Distribution-Backpack-ComponentsGraph.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Backpack-ComponentsGraph.html @@ -0,0 +1,8 @@ +Distribution.Backpack.ComponentsGraph

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Backpack.ComponentsGraph

Description

See https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst

Synopsis

Documentation

type ComponentsGraph = Graph (Node ComponentName Component) #

A graph of source-level components by their source-level + dependencies

type ComponentsWithDeps = [(Component, [ComponentName])] #

A list of components associated with the source level + dependencies between them.

mkComponentsGraph :: ComponentRequestedSpec -> PackageDescription -> Either [ComponentName] ComponentsGraph #

Create a Graph of Component, or report a cycle if there is a + problem.

componentsGraphToList :: ComponentsGraph -> ComponentsWithDeps #

Given the package description and a PackageDescription (used + to determine if a package name is internal or not), sort the + components in dependency order (fewest dependencies first). This is + NOT necessarily the build order (although it is in the absence of + Backpack.)

dispComponentsWithDeps :: ComponentsWithDeps -> Doc #

Pretty-print ComponentsWithDeps.

componentCycleMsg :: [ComponentName] -> Doc #

Error message when there is a cycle; takes the SCC of components.

diff --git a/doc/API/Cabal/Distribution-Backpack-Configure.html b/doc/API/Cabal/Distribution-Backpack-Configure.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Backpack-Configure.html @@ -0,0 +1,2 @@ +Distribution.Backpack.Configure

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Backpack.Configure

Description

See https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst

WARNING: The contents of this module are HIGHLY experimental. + We may refactor it under you.

Documentation

configureComponentLocalBuildInfos :: Verbosity -> Bool -> ComponentRequestedSpec -> Bool -> Flag String -> Flag ComponentId -> PackageDescription -> [PreExistingComponent] -> FlagAssignment -> [(ModuleName, Module)] -> InstalledPackageIndex -> Compiler -> LogProgress ([ComponentLocalBuildInfo], InstalledPackageIndex) #

diff --git a/doc/API/Cabal/Distribution-Backpack-ConfiguredComponent.html b/doc/API/Cabal/Distribution-Backpack-ConfiguredComponent.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Backpack-ConfiguredComponent.html @@ -0,0 +1,13 @@ +Distribution.Backpack.ConfiguredComponent

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Backpack.ConfiguredComponent

Description

See https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst

Synopsis

Documentation

data ConfiguredComponent #

A configured component, we know exactly what its ComponentId is, + and the ComponentIds of the things it depends on.

Constructors

ConfiguredComponent 

Fields

  • cc_ann_id :: AnnotatedId ComponentId

    Unique identifier of component, plus extra useful info.

  • cc_component :: Component

    The fragment of syntax from the Cabal file describing this + component.

  • cc_public :: Bool

    Is this the public library component of the package? + (If we invoke Setup with an instantiation, this is the + component the instantiation applies to.) + Note that in one-component configure mode, this is + always True, because any component is the "public" one.)

  • cc_exe_deps :: [AnnotatedId ComponentId]

    Dependencies on executables from build-tools and + build-tool-depends.

  • cc_includes :: [ComponentInclude ComponentId IncludeRenaming]

    The mixins of this package, including both explicit (from + the mixins field) and implicit (from build-depends). Not + mix-in linked yet; component configuration only looks at + ComponentIds.

cc_name :: ConfiguredComponent -> ComponentName #

The ComponentName of a component; this uniquely identifies + a fragment of syntax within a specified Cabal file describing the + component.

cc_cid :: ConfiguredComponent -> ComponentId #

Uniquely identifies a configured component.

cc_pkgid :: ConfiguredComponent -> PackageId #

The package this component came from.

toConfiguredComponent :: PackageDescription -> ComponentId -> ConfiguredComponentMap -> ConfiguredComponentMap -> Component -> LogProgress ConfiguredComponent #

toConfiguredComponents :: Bool -> FlagAssignment -> Bool -> Flag String -> Flag ComponentId -> PackageDescription -> ConfiguredComponentMap -> [Component] -> LogProgress [ConfiguredComponent] #

dispConfiguredComponent :: ConfiguredComponent -> Doc #

Pretty-print a ConfiguredComponent.

type ConfiguredComponentMap = Map PackageName (Map ComponentName (AnnotatedId ComponentId)) #

extendConfiguredComponentMap :: ConfiguredComponent -> ConfiguredComponentMap -> ConfiguredComponentMap #

newPackageDepsBehaviour :: PackageDescription -> Bool #

diff --git a/doc/API/Cabal/Distribution-Backpack-DescribeUnitId.html b/doc/API/Cabal/Distribution-Backpack-DescribeUnitId.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Backpack-DescribeUnitId.html @@ -0,0 +1,5 @@ +Distribution.Backpack.DescribeUnitId

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Backpack.DescribeUnitId

Synopsis

Documentation

setupMessage' #

Arguments

:: Text a 
=> Verbosity 
-> String

Operation being done (capitalized), on:

-> PackageIdentifier

Package

-> ComponentName

Component name

-> Maybe [(ModuleName, a)]

Instantiation, if available. + Polymorphic to take + OpenModule or Module

-> IO () 

Print a Setup message stating (1) what operation we are doing, + for (2) which component (with enough details to uniquely identify + the build in question.)

diff --git a/doc/API/Cabal/Distribution-Backpack-FullUnitId.html b/doc/API/Cabal/Distribution-Backpack-FullUnitId.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Backpack-FullUnitId.html @@ -0,0 +1,1 @@ +Distribution.Backpack.FullUnitId

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Backpack.FullUnitId

Documentation

data FullUnitId #

Constructors

FullUnitId ComponentId OpenModuleSubst 
Instances
Show FullUnitId # 
Instance details

Defined in Distribution.Backpack.FullUnitId

Methods

showsPrec :: Int -> FullUnitId -> ShowS #

show :: FullUnitId -> String #

showList :: [FullUnitId] -> ShowS #

Generic FullUnitId # 
Instance details

Defined in Distribution.Backpack.FullUnitId

Associated Types

type Rep FullUnitId :: * -> * #

Methods

from :: FullUnitId -> Rep FullUnitId x #

to :: Rep FullUnitId x -> FullUnitId #

type Rep FullUnitId # 
Instance details

Defined in Distribution.Backpack.FullUnitId

type Rep FullUnitId = D1 (MetaData "FullUnitId" "Distribution.Backpack.FullUnitId" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "FullUnitId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OpenModuleSubst)))

type FullDb = DefUnitId -> FullUnitId #

expandOpenUnitId :: FullDb -> OpenUnitId -> FullUnitId #

expandUnitId :: FullDb -> DefUnitId -> FullUnitId #

diff --git a/doc/API/Cabal/Distribution-Backpack-LinkedComponent.html b/doc/API/Cabal/Distribution-Backpack-LinkedComponent.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Backpack-LinkedComponent.html @@ -0,0 +1,17 @@ +Distribution.Backpack.LinkedComponent

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Backpack.LinkedComponent

Description

See https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst

Synopsis

Documentation

data LinkedComponent #

A linked component is a component that has been mix-in linked, at + which point we have determined how all the dependencies of the + component are explicitly instantiated (in the form of an OpenUnitId). + ConfiguredComponent is mix-in linked into LinkedComponent, which + is then instantiated into ReadyComponent.

Constructors

LinkedComponent 

Fields

Instances
Package LinkedComponent # 
Instance details

Defined in Distribution.Backpack.LinkedComponent

Methods

packageId :: LinkedComponent -> PackageIdentifier #

lc_insts :: LinkedComponent -> [(ModuleName, OpenModule)] #

The instantiation of lc_uid; this always has the invariant + that it is a mapping from a module name A to A (the hole A).

lc_uid :: LinkedComponent -> OpenUnitId #

The OpenUnitId of this component in the "default" instantiation. + See also lc_insts. LinkedComponents cannot be instantiated + (e.g., there is no ModSubst instance for them).

lc_cid :: LinkedComponent -> ComponentId #

Uniquely identifies a LinkedComponent. Corresponds to + cc_cid.

lc_pkgid :: LinkedComponent -> PackageId #

Corresponds to cc_pkgid.

toLinkedComponent :: Verbosity -> FullDb -> PackageId -> LinkedComponentMap -> ConfiguredComponent -> LogProgress LinkedComponent #

toLinkedComponents :: Verbosity -> FullDb -> PackageId -> LinkedComponentMap -> [ConfiguredComponent] -> LogProgress [LinkedComponent] #

dispLinkedComponent :: LinkedComponent -> Doc #

type LinkedComponentMap = Map ComponentId (OpenUnitId, ModuleShape) #

extendLinkedComponentMap :: LinkedComponent -> LinkedComponentMap -> LinkedComponentMap #

diff --git a/doc/API/Cabal/Distribution-Backpack-ModSubst.html b/doc/API/Cabal/Distribution-Backpack-ModSubst.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Backpack-ModSubst.html @@ -0,0 +1,2 @@ +Distribution.Backpack.ModSubst

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Backpack.ModSubst

Description

A type class ModSubst for objects which can have ModuleSubst + applied to them.

See also https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst

Synopsis

Documentation

class ModSubst a where #

Applying module substitutions to semantic objects.

Minimal complete definition

modSubst

Methods

modSubst :: OpenModuleSubst -> a -> a #

Instances
ModSubst OpenModule # 
Instance details

Defined in Distribution.Backpack.ModSubst

Methods

modSubst :: OpenModuleSubst -> OpenModule -> OpenModule #

ModSubst OpenUnitId # 
Instance details

Defined in Distribution.Backpack.ModSubst

Methods

modSubst :: OpenModuleSubst -> OpenUnitId -> OpenUnitId #

ModSubst ModuleShape # 
Instance details

Defined in Distribution.Backpack.ModuleShape

Methods

modSubst :: OpenModuleSubst -> ModuleShape -> ModuleShape #

ModSubst a => ModSubst [a] # 
Instance details

Defined in Distribution.Backpack.ModSubst

Methods

modSubst :: OpenModuleSubst -> [a] -> [a] #

ModSubst (Set ModuleName) # 
Instance details

Defined in Distribution.Backpack.ModSubst

Methods

modSubst :: OpenModuleSubst -> Set ModuleName -> Set ModuleName #

ModSubst a => ModSubst (k, a) # 
Instance details

Defined in Distribution.Backpack.ModSubst

Methods

modSubst :: OpenModuleSubst -> (k, a) -> (k, a) #

ModSubst a => ModSubst (Map k a) # 
Instance details

Defined in Distribution.Backpack.ModSubst

Methods

modSubst :: OpenModuleSubst -> Map k a -> Map k a #

diff --git a/doc/API/Cabal/Distribution-Backpack-ModuleShape.html b/doc/API/Cabal/Distribution-Backpack-ModuleShape.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Backpack-ModuleShape.html @@ -0,0 +1,3 @@ +Distribution.Backpack.ModuleShape

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Backpack.ModuleShape

Contents

Description

See https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst

Synopsis

Module shapes

data ModuleShape #

A ModuleShape describes the provisions and requirements of + a library. We can extract a ModuleShape from an + InstalledPackageInfo.

Constructors

ModuleShape 

Fields

Instances
Eq ModuleShape # 
Instance details

Defined in Distribution.Backpack.ModuleShape

Methods

(==) :: ModuleShape -> ModuleShape -> Bool #

(/=) :: ModuleShape -> ModuleShape -> Bool #

Show ModuleShape # 
Instance details

Defined in Distribution.Backpack.ModuleShape

Methods

showsPrec :: Int -> ModuleShape -> ShowS #

show :: ModuleShape -> String #

showList :: [ModuleShape] -> ShowS #

Generic ModuleShape # 
Instance details

Defined in Distribution.Backpack.ModuleShape

Associated Types

type Rep ModuleShape :: * -> * #

Methods

from :: ModuleShape -> Rep ModuleShape x #

to :: Rep ModuleShape x -> ModuleShape #

Binary ModuleShape # 
Instance details

Defined in Distribution.Backpack.ModuleShape

Methods

put :: ModuleShape -> Put #

get :: Get ModuleShape #

putList :: [ModuleShape] -> Put #

ModSubst ModuleShape # 
Instance details

Defined in Distribution.Backpack.ModuleShape

Methods

modSubst :: OpenModuleSubst -> ModuleShape -> ModuleShape #

type Rep ModuleShape # 
Instance details

Defined in Distribution.Backpack.ModuleShape

type Rep ModuleShape = D1 (MetaData "ModuleShape" "Distribution.Backpack.ModuleShape" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ModuleShape" PrefixI True) (S1 (MetaSel (Just "modShapeProvides") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OpenModuleSubst) :*: S1 (MetaSel (Just "modShapeRequires") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set ModuleName))))

emptyModuleShape :: ModuleShape #

The default module shape, with no provisions and no requirements.

shapeInstalledPackage :: InstalledPackageInfo -> ModuleShape #

diff --git a/doc/API/Cabal/Distribution-Backpack-PreModuleShape.html b/doc/API/Cabal/Distribution-Backpack-PreModuleShape.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Backpack-PreModuleShape.html @@ -0,0 +1,1 @@ +Distribution.Backpack.PreModuleShape

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Backpack.PreModuleShape

Documentation

data PreModuleShape #

Constructors

PreModuleShape 

Fields

Instances
Eq PreModuleShape # 
Instance details

Defined in Distribution.Backpack.PreModuleShape

Methods

(==) :: PreModuleShape -> PreModuleShape -> Bool #

(/=) :: PreModuleShape -> PreModuleShape -> Bool #

Show PreModuleShape # 
Instance details

Defined in Distribution.Backpack.PreModuleShape

Methods

showsPrec :: Int -> PreModuleShape -> ShowS #

show :: PreModuleShape -> String #

showList :: [PreModuleShape] -> ShowS #

Generic PreModuleShape # 
Instance details

Defined in Distribution.Backpack.PreModuleShape

Associated Types

type Rep PreModuleShape :: * -> * #

Methods

from :: PreModuleShape -> Rep PreModuleShape x #

to :: Rep PreModuleShape x -> PreModuleShape #

type Rep PreModuleShape # 
Instance details

Defined in Distribution.Backpack.PreModuleShape

type Rep PreModuleShape = D1 (MetaData "PreModuleShape" "Distribution.Backpack.PreModuleShape" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "PreModuleShape" PrefixI True) (S1 (MetaSel (Just "preModShapeProvides") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set ModuleName)) :*: S1 (MetaSel (Just "preModShapeRequires") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set ModuleName))))

toPreModuleShape :: ModuleShape -> PreModuleShape #

renamePreModuleShape :: PreModuleShape -> IncludeRenaming -> PreModuleShape #

mixLinkPreModuleShape :: [PreModuleShape] -> PreModuleShape #

diff --git a/doc/API/Cabal/Distribution-Backpack.html b/doc/API/Cabal/Distribution-Backpack.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Backpack.html @@ -0,0 +1,42 @@ +Distribution.Backpack

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Backpack

Contents

Description

This module defines the core data types for Backpack. For more + details, see:

https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst

Synopsis

OpenUnitId

data OpenUnitId #

An OpenUnitId describes a (possibly partially) instantiated + Backpack component, with a description of how the holes are filled + in. Unlike OpenUnitId, the ModuleSubst is kept in a structured + form that allows for substitution (which fills in holes.) This form + of unit cannot be installed. It must first be converted to a + UnitId.

In the absence of Backpack, there are no holes to fill, so any such + component always has an empty module substitution; thus we can lossly + represent it as an 'OpenUnitId uid'.

For a source component using Backpack, however, there is more + structure as components may be parametrized over some signatures, and + these "holes" may be partially or wholly filled.

OpenUnitId plays an important role when we are mix-in linking, + and is recorded to the installed packaged database for indefinite + packages; however, for compiled packages that are fully instantiated, + we instantiate OpenUnitId into UnitId.

For more details see the Backpack spec + https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst

Constructors

IndefFullUnitId ComponentId OpenModuleSubst

Identifies a component which may have some unfilled holes; + specifying its ComponentId and its OpenModuleSubst. + TODO: Invariant that OpenModuleSubst is non-empty? + See also the Text instance.

DefiniteUnitId DefUnitId

Identifies a fully instantiated component, which has + been compiled and abbreviated as a hash. The embedded UnitId + MUST NOT be for an indefinite component; an OpenUnitId + is guaranteed not to have any holes.

Instances
Eq OpenUnitId # 
Instance details

Defined in Distribution.Backpack

Methods

(==) :: OpenUnitId -> OpenUnitId -> Bool #

(/=) :: OpenUnitId -> OpenUnitId -> Bool #

Data OpenUnitId # 
Instance details

Defined in Distribution.Backpack

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OpenUnitId -> c OpenUnitId #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OpenUnitId #

toConstr :: OpenUnitId -> Constr #

dataTypeOf :: OpenUnitId -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OpenUnitId) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OpenUnitId) #

gmapT :: (forall b. Data b => b -> b) -> OpenUnitId -> OpenUnitId #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OpenUnitId -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OpenUnitId -> r #

gmapQ :: (forall d. Data d => d -> u) -> OpenUnitId -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> OpenUnitId -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> OpenUnitId -> m OpenUnitId #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OpenUnitId -> m OpenUnitId #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OpenUnitId -> m OpenUnitId #

Ord OpenUnitId # 
Instance details

Defined in Distribution.Backpack

Methods

compare :: OpenUnitId -> OpenUnitId -> Ordering #

(<) :: OpenUnitId -> OpenUnitId -> Bool #

(<=) :: OpenUnitId -> OpenUnitId -> Bool #

(>) :: OpenUnitId -> OpenUnitId -> Bool #

(>=) :: OpenUnitId -> OpenUnitId -> Bool #

max :: OpenUnitId -> OpenUnitId -> OpenUnitId #

min :: OpenUnitId -> OpenUnitId -> OpenUnitId #

Read OpenUnitId # 
Instance details

Defined in Distribution.Backpack

Methods

readsPrec :: Int -> ReadS OpenUnitId #

readList :: ReadS [OpenUnitId] #

readPrec :: ReadPrec OpenUnitId #

readListPrec :: ReadPrec [OpenUnitId] #

Show OpenUnitId # 
Instance details

Defined in Distribution.Backpack

Methods

showsPrec :: Int -> OpenUnitId -> ShowS #

show :: OpenUnitId -> String #

showList :: [OpenUnitId] -> ShowS #

Generic OpenUnitId # 
Instance details

Defined in Distribution.Backpack

Associated Types

type Rep OpenUnitId :: * -> * #

Methods

from :: OpenUnitId -> Rep OpenUnitId x #

to :: Rep OpenUnitId x -> OpenUnitId #

Binary OpenUnitId # 
Instance details

Defined in Distribution.Backpack

Methods

put :: OpenUnitId -> Put #

get :: Get OpenUnitId #

putList :: [OpenUnitId] -> Put #

NFData OpenUnitId # 
Instance details

Defined in Distribution.Backpack

Methods

rnf :: OpenUnitId -> () #

Pretty OpenUnitId # 
Instance details

Defined in Distribution.Backpack

Methods

pretty :: OpenUnitId -> Doc #

Parsec OpenUnitId #
>>> eitherParsec "foobar" :: Either String OpenUnitId
+Right (DefiniteUnitId (DefUnitId {unDefUnitId = UnitId "foobar"}))
+
>>> eitherParsec "foo[Str=text-1.2.3:Data.Text.Text]" :: Either String OpenUnitId
+Right (IndefFullUnitId (ComponentId "foo") (fromList [(ModuleName ["Str"],OpenModule (DefiniteUnitId (DefUnitId {unDefUnitId = UnitId "text-1.2.3"})) (ModuleName ["Data","Text","Text"]))]))
+
Instance details

Defined in Distribution.Backpack

Methods

parsec :: CabalParsing m => m OpenUnitId #

Text OpenUnitId # 
Instance details

Defined in Distribution.Backpack

Methods

disp :: OpenUnitId -> Doc #

parse :: ReadP r OpenUnitId #

ModSubst OpenUnitId # 
Instance details

Defined in Distribution.Backpack.ModSubst

Methods

modSubst :: OpenModuleSubst -> OpenUnitId -> OpenUnitId #

type Rep OpenUnitId # 
Instance details

Defined in Distribution.Backpack

type Rep OpenUnitId = D1 (MetaData "OpenUnitId" "Distribution.Backpack" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "IndefFullUnitId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OpenModuleSubst)) :+: C1 (MetaCons "DefiniteUnitId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 DefUnitId)))

openUnitIdFreeHoles :: OpenUnitId -> Set ModuleName #

Get the set of holes (ModuleVar) embedded in a UnitId.

mkOpenUnitId :: UnitId -> ComponentId -> OpenModuleSubst -> OpenUnitId #

Safe constructor from a UnitId. The only way to do this safely + is if the instantiation is provided.

DefUnitId

data DefUnitId #

A UnitId for a definite package. The DefUnitId invariant says + that a UnitId identified this way is definite; i.e., it has no + unfilled holes.

Instances
Eq DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

(==) :: DefUnitId -> DefUnitId -> Bool #

(/=) :: DefUnitId -> DefUnitId -> Bool #

Data DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DefUnitId -> c DefUnitId #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DefUnitId #

toConstr :: DefUnitId -> Constr #

dataTypeOf :: DefUnitId -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DefUnitId) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DefUnitId) #

gmapT :: (forall b. Data b => b -> b) -> DefUnitId -> DefUnitId #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DefUnitId -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DefUnitId -> r #

gmapQ :: (forall d. Data d => d -> u) -> DefUnitId -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DefUnitId -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DefUnitId -> m DefUnitId #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DefUnitId -> m DefUnitId #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DefUnitId -> m DefUnitId #

Ord DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

compare :: DefUnitId -> DefUnitId -> Ordering #

(<) :: DefUnitId -> DefUnitId -> Bool #

(<=) :: DefUnitId -> DefUnitId -> Bool #

(>) :: DefUnitId -> DefUnitId -> Bool #

(>=) :: DefUnitId -> DefUnitId -> Bool #

max :: DefUnitId -> DefUnitId -> DefUnitId #

min :: DefUnitId -> DefUnitId -> DefUnitId #

Read DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

readsPrec :: Int -> ReadS DefUnitId #

readList :: ReadS [DefUnitId] #

readPrec :: ReadPrec DefUnitId #

readListPrec :: ReadPrec [DefUnitId] #

Show DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

showsPrec :: Int -> DefUnitId -> ShowS #

show :: DefUnitId -> String #

showList :: [DefUnitId] -> ShowS #

Generic DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Associated Types

type Rep DefUnitId :: * -> * #

Methods

from :: DefUnitId -> Rep DefUnitId x #

to :: Rep DefUnitId x -> DefUnitId #

Binary DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

put :: DefUnitId -> Put #

get :: Get DefUnitId #

putList :: [DefUnitId] -> Put #

NFData DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

rnf :: DefUnitId -> () #

Pretty DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

pretty :: DefUnitId -> Doc #

Parsec DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

parsec :: CabalParsing m => m DefUnitId #

Text DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

disp :: DefUnitId -> Doc #

parse :: ReadP r DefUnitId #

type Rep DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

type Rep DefUnitId = D1 (MetaData "DefUnitId" "Distribution.Types.UnitId" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "DefUnitId" PrefixI True) (S1 (MetaSel (Just "unDefUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId)))

unDefUnitId :: DefUnitId -> UnitId #

mkDefUnitId :: ComponentId -> Map ModuleName Module -> DefUnitId #

Create a DefUnitId from a ComponentId and an instantiation + with no holes.

OpenModule

data OpenModule #

Unlike a Module, an OpenModule is either an ordinary + module from some unit, OR an OpenModuleVar, representing a + hole that needs to be filled in. Substitutions are over + module variables.

Constructors

OpenModule OpenUnitId ModuleName 
OpenModuleVar ModuleName 
Instances
Eq OpenModule # 
Instance details

Defined in Distribution.Backpack

Methods

(==) :: OpenModule -> OpenModule -> Bool #

(/=) :: OpenModule -> OpenModule -> Bool #

Data OpenModule # 
Instance details

Defined in Distribution.Backpack

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OpenModule -> c OpenModule #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OpenModule #

toConstr :: OpenModule -> Constr #

dataTypeOf :: OpenModule -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OpenModule) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OpenModule) #

gmapT :: (forall b. Data b => b -> b) -> OpenModule -> OpenModule #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OpenModule -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OpenModule -> r #

gmapQ :: (forall d. Data d => d -> u) -> OpenModule -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> OpenModule -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> OpenModule -> m OpenModule #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OpenModule -> m OpenModule #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OpenModule -> m OpenModule #

Ord OpenModule # 
Instance details

Defined in Distribution.Backpack

Methods

compare :: OpenModule -> OpenModule -> Ordering #

(<) :: OpenModule -> OpenModule -> Bool #

(<=) :: OpenModule -> OpenModule -> Bool #

(>) :: OpenModule -> OpenModule -> Bool #

(>=) :: OpenModule -> OpenModule -> Bool #

max :: OpenModule -> OpenModule -> OpenModule #

min :: OpenModule -> OpenModule -> OpenModule #

Read OpenModule # 
Instance details

Defined in Distribution.Backpack

Methods

readsPrec :: Int -> ReadS OpenModule #

readList :: ReadS [OpenModule] #

readPrec :: ReadPrec OpenModule #

readListPrec :: ReadPrec [OpenModule] #

Show OpenModule # 
Instance details

Defined in Distribution.Backpack

Methods

showsPrec :: Int -> OpenModule -> ShowS #

show :: OpenModule -> String #

showList :: [OpenModule] -> ShowS #

Generic OpenModule # 
Instance details

Defined in Distribution.Backpack

Associated Types

type Rep OpenModule :: * -> * #

Methods

from :: OpenModule -> Rep OpenModule x #

to :: Rep OpenModule x -> OpenModule #

Binary OpenModule # 
Instance details

Defined in Distribution.Backpack

Methods

put :: OpenModule -> Put #

get :: Get OpenModule #

putList :: [OpenModule] -> Put #

NFData OpenModule # 
Instance details

Defined in Distribution.Backpack

Methods

rnf :: OpenModule -> () #

Pretty OpenModule # 
Instance details

Defined in Distribution.Backpack

Methods

pretty :: OpenModule -> Doc #

Parsec OpenModule #
>>> eitherParsec "Includes2-0.1.0.0-inplace-mysql:Database.MySQL" :: Either String OpenModule
+Right (OpenModule (DefiniteUnitId (DefUnitId {unDefUnitId = UnitId "Includes2-0.1.0.0-inplace-mysql"})) (ModuleName ["Database","MySQL"]))
+
Instance details

Defined in Distribution.Backpack

Methods

parsec :: CabalParsing m => m OpenModule #

Text OpenModule # 
Instance details

Defined in Distribution.Backpack

Methods

disp :: OpenModule -> Doc #

parse :: ReadP r OpenModule #

ModSubst OpenModule # 
Instance details

Defined in Distribution.Backpack.ModSubst

Methods

modSubst :: OpenModuleSubst -> OpenModule -> OpenModule #

type Rep OpenModule # 
Instance details

Defined in Distribution.Backpack

type Rep OpenModule = D1 (MetaData "OpenModule" "Distribution.Backpack" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "OpenModule" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OpenUnitId) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleName)) :+: C1 (MetaCons "OpenModuleVar" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleName)))

openModuleFreeHoles :: OpenModule -> Set ModuleName #

Get the set of holes (ModuleVar) embedded in a Module.

OpenModuleSubst

type OpenModuleSubst = Map ModuleName OpenModule #

An explicit substitution on modules.

NB: These substitutions are NOT idempotent, for example, a + valid substitution is (A -> B, B -> A).

dispOpenModuleSubst :: OpenModuleSubst -> Doc #

Pretty-print the entries of a module substitution, suitable + for embedding into a OpenUnitId or passing to GHC via --instantiate-with.

dispOpenModuleSubstEntry :: (ModuleName, OpenModule) -> Doc #

Pretty-print a single entry of a module substitution.

parseOpenModuleSubst :: ReadP r OpenModuleSubst #

Inverse to dispModSubst.

parseOpenModuleSubstEntry :: ReadP r (ModuleName, OpenModule) #

Inverse to dispModSubstEntry.

parsecOpenModuleSubst :: CabalParsing m => m OpenModuleSubst #

Inverse to dispModSubst.

Since: 2.2

parsecOpenModuleSubstEntry :: CabalParsing m => m (ModuleName, OpenModule) #

Inverse to dispModSubstEntry.

Since: 2.2

openModuleSubstFreeHoles :: OpenModuleSubst -> Set ModuleName #

Get the set of holes (ModuleVar) embedded in a OpenModuleSubst. + This is NOT the domain of the substitution.

Conversions to UnitId

abstractUnitId :: OpenUnitId -> UnitId #

When typechecking, we don't demand that a freshly instantiated + IndefFullUnitId be compiled; instead, we just depend on the + installed indefinite unit installed at the ComponentId.

hashModuleSubst :: Map ModuleName Module -> Maybe String #

Take a module substitution and hash it into a string suitable for + UnitId. Note that since this takes Module, not OpenModule, + you are responsible for recursively converting OpenModule + into Module. See also Distribution.Backpack.ReadyComponent.

diff --git a/doc/API/Cabal/Distribution-CabalSpecVersion.html b/doc/API/Cabal/Distribution-CabalSpecVersion.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-CabalSpecVersion.html @@ -0,0 +1,2 @@ +Distribution.CabalSpecVersion

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.CabalSpecVersion

Synopsis

Documentation

data CabalSpecVersion #

Different Cabal-the-spec versions.

We branch based on this at least in the parser.

Constructors

CabalSpecOld 
CabalSpecV1_22 
CabalSpecV1_24 
CabalSpecV2_0 
CabalSpecV2_2 
CabalSpecV2_4 
Instances
Bounded CabalSpecVersion # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

minBound :: CabalSpecVersion #

maxBound :: CabalSpecVersion #

Enum CabalSpecVersion # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

succ :: CabalSpecVersion -> CabalSpecVersion #

pred :: CabalSpecVersion -> CabalSpecVersion #

toEnum :: Int -> CabalSpecVersion #

fromEnum :: CabalSpecVersion -> Int #

enumFrom :: CabalSpecVersion -> [CabalSpecVersion] #

enumFromThen :: CabalSpecVersion -> CabalSpecVersion -> [CabalSpecVersion] #

enumFromTo :: CabalSpecVersion -> CabalSpecVersion -> [CabalSpecVersion] #

enumFromThenTo :: CabalSpecVersion -> CabalSpecVersion -> CabalSpecVersion -> [CabalSpecVersion] #

Eq CabalSpecVersion # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

(==) :: CabalSpecVersion -> CabalSpecVersion -> Bool #

(/=) :: CabalSpecVersion -> CabalSpecVersion -> Bool #

Data CabalSpecVersion # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CabalSpecVersion -> c CabalSpecVersion #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CabalSpecVersion #

toConstr :: CabalSpecVersion -> Constr #

dataTypeOf :: CabalSpecVersion -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CabalSpecVersion) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CabalSpecVersion) #

gmapT :: (forall b. Data b => b -> b) -> CabalSpecVersion -> CabalSpecVersion #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CabalSpecVersion -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CabalSpecVersion -> r #

gmapQ :: (forall d. Data d => d -> u) -> CabalSpecVersion -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CabalSpecVersion -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CabalSpecVersion -> m CabalSpecVersion #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CabalSpecVersion -> m CabalSpecVersion #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CabalSpecVersion -> m CabalSpecVersion #

Ord CabalSpecVersion # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

compare :: CabalSpecVersion -> CabalSpecVersion -> Ordering #

(<) :: CabalSpecVersion -> CabalSpecVersion -> Bool #

(<=) :: CabalSpecVersion -> CabalSpecVersion -> Bool #

(>) :: CabalSpecVersion -> CabalSpecVersion -> Bool #

(>=) :: CabalSpecVersion -> CabalSpecVersion -> Bool #

max :: CabalSpecVersion -> CabalSpecVersion -> CabalSpecVersion #

min :: CabalSpecVersion -> CabalSpecVersion -> CabalSpecVersion #

Read CabalSpecVersion # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

readsPrec :: Int -> ReadS CabalSpecVersion #

readList :: ReadS [CabalSpecVersion] #

readPrec :: ReadPrec CabalSpecVersion #

readListPrec :: ReadPrec [CabalSpecVersion] #

Show CabalSpecVersion # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

showsPrec :: Int -> CabalSpecVersion -> ShowS #

show :: CabalSpecVersion -> String #

showList :: [CabalSpecVersion] -> ShowS #

Generic CabalSpecVersion # 
Instance details

Defined in Distribution.CabalSpecVersion

Associated Types

type Rep CabalSpecVersion :: * -> * #

Methods

from :: CabalSpecVersion -> Rep CabalSpecVersion x #

to :: Rep CabalSpecVersion x -> CabalSpecVersion #

type Rep CabalSpecVersion # 
Instance details

Defined in Distribution.CabalSpecVersion

type Rep CabalSpecVersion = D1 (MetaData "CabalSpecVersion" "Distribution.CabalSpecVersion" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "CabalSpecOld" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CabalSpecV1_22" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CabalSpecV1_24" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "CabalSpecV2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CabalSpecV2_2" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CabalSpecV2_4" PrefixI False) (U1 :: * -> *))))

cabalSpecLatest :: CabalSpecVersion #

cabalSpecFeatures :: CabalSpecVersion -> Set CabalFeature #

cabalSpecSupports :: CabalSpecVersion -> [Int] -> Bool #

specHasCommonStanzas :: CabalSpecVersion -> HasCommonStanzas #

specHasElif :: CabalSpecVersion -> HasElif #

data CabalFeature #

Constructors

Elif 
CommonStanzas 
Globstar

Implemented in #5284. Not actually a change to the parser, + as filename patterns are opaque to it currently.

Instances
Bounded CabalFeature # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

minBound :: CabalFeature #

maxBound :: CabalFeature #

Enum CabalFeature # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

succ :: CabalFeature -> CabalFeature #

pred :: CabalFeature -> CabalFeature #

toEnum :: Int -> CabalFeature #

fromEnum :: CabalFeature -> Int #

enumFrom :: CabalFeature -> [CabalFeature] #

enumFromThen :: CabalFeature -> CabalFeature -> [CabalFeature] #

enumFromTo :: CabalFeature -> CabalFeature -> [CabalFeature] #

enumFromThenTo :: CabalFeature -> CabalFeature -> CabalFeature -> [CabalFeature] #

Eq CabalFeature # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

(==) :: CabalFeature -> CabalFeature -> Bool #

(/=) :: CabalFeature -> CabalFeature -> Bool #

Data CabalFeature # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CabalFeature -> c CabalFeature #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CabalFeature #

toConstr :: CabalFeature -> Constr #

dataTypeOf :: CabalFeature -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CabalFeature) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CabalFeature) #

gmapT :: (forall b. Data b => b -> b) -> CabalFeature -> CabalFeature #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CabalFeature -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CabalFeature -> r #

gmapQ :: (forall d. Data d => d -> u) -> CabalFeature -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CabalFeature -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CabalFeature -> m CabalFeature #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CabalFeature -> m CabalFeature #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CabalFeature -> m CabalFeature #

Ord CabalFeature # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

compare :: CabalFeature -> CabalFeature -> Ordering #

(<) :: CabalFeature -> CabalFeature -> Bool #

(<=) :: CabalFeature -> CabalFeature -> Bool #

(>) :: CabalFeature -> CabalFeature -> Bool #

(>=) :: CabalFeature -> CabalFeature -> Bool #

max :: CabalFeature -> CabalFeature -> CabalFeature #

min :: CabalFeature -> CabalFeature -> CabalFeature #

Read CabalFeature # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

readsPrec :: Int -> ReadS CabalFeature #

readList :: ReadS [CabalFeature] #

readPrec :: ReadPrec CabalFeature #

readListPrec :: ReadPrec [CabalFeature] #

Show CabalFeature # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

showsPrec :: Int -> CabalFeature -> ShowS #

show :: CabalFeature -> String #

showList :: [CabalFeature] -> ShowS #

Generic CabalFeature # 
Instance details

Defined in Distribution.CabalSpecVersion

Associated Types

type Rep CabalFeature :: * -> * #

Methods

from :: CabalFeature -> Rep CabalFeature x #

to :: Rep CabalFeature x -> CabalFeature #

type Rep CabalFeature # 
Instance details

Defined in Distribution.CabalSpecVersion

type Rep CabalFeature = D1 (MetaData "CabalFeature" "Distribution.CabalSpecVersion" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Elif" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CommonStanzas" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Globstar" PrefixI False) (U1 :: * -> *)))

data HasElif #

Constructors

HasElif 
NoElif 
Instances
Eq HasElif # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

(==) :: HasElif -> HasElif -> Bool #

(/=) :: HasElif -> HasElif -> Bool #

Show HasElif # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

showsPrec :: Int -> HasElif -> ShowS #

show :: HasElif -> String #

showList :: [HasElif] -> ShowS #

data HasCommonStanzas #

Constructors

HasCommonStanzas 
NoCommonStanzas 
Instances
Eq HasCommonStanzas # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

(==) :: HasCommonStanzas -> HasCommonStanzas -> Bool #

(/=) :: HasCommonStanzas -> HasCommonStanzas -> Bool #

Show HasCommonStanzas # 
Instance details

Defined in Distribution.CabalSpecVersion

Methods

showsPrec :: Int -> HasCommonStanzas -> ShowS #

show :: HasCommonStanzas -> String #

showList :: [HasCommonStanzas] -> ShowS #

data HasGlobstar #

Constructors

HasGlobstar 
NoGlobstar 
diff --git a/doc/API/Cabal/Distribution-Compat-Binary.html b/doc/API/Cabal/Distribution-Compat-Binary.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compat-Binary.html @@ -0,0 +1,1 @@ +Distribution.Compat.Binary

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellSafe
LanguageHaskell2010

Distribution.Compat.Binary

Synopsis

Documentation

decodeOrFailIO :: Binary a => ByteString -> IO (Either String a) #

decodeFileOrFail' :: Binary a => FilePath -> IO (Either String a) #

Lazily reconstruct a value previously written to a file.

module Data.Binary

diff --git a/doc/API/Cabal/Distribution-Compat-CharParsing.html b/doc/API/Cabal/Distribution-Compat-CharParsing.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compat-CharParsing.html @@ -0,0 +1,17 @@ +Distribution.Compat.CharParsing

Cabal-2.4.0.1: A framework for packaging Haskell software

Copyright(c) Edward Kmett 2011
LicenseBSD3
Maintainerekmett@gmail.com
Stabilityexperimental
Portabilitynon-portable
Safe HaskellNone
LanguageHaskell2010

Distribution.Compat.CharParsing

Contents

Description

Parsers for character streams

Originally in parsers package.

Synopsis

Combinators

oneOf :: CharParsing m => [Char] -> m Char #

oneOf cs succeeds if the current character is in the supplied + list of characters cs. Returns the parsed character. See also + satisfy.

  vowel  = oneOf "aeiou"

noneOf :: CharParsing m => [Char] -> m Char #

As the dual of oneOf, noneOf cs succeeds if the current + character is not in the supplied list of characters cs. Returns the + parsed character.

 consonant = noneOf "aeiou"

spaces :: CharParsing m => m () #

Skips zero or more white space characters. See also skipMany.

space :: CharParsing m => m Char #

Parses a white space character (any character which satisfies isSpace) + Returns the parsed character.

newline :: CharParsing m => m Char #

Parses a newline character ('\n'). Returns a newline character.

tab :: CharParsing m => m Char #

Parses a tab character ('\t'). Returns a tab character.

upper :: CharParsing m => m Char #

Parses an upper case letter. Returns the parsed character.

lower :: CharParsing m => m Char #

Parses a lower case character. Returns the parsed character.

alphaNum :: CharParsing m => m Char #

Parses a letter or digit. Returns the parsed character.

letter :: CharParsing m => m Char #

Parses a letter (an upper case or lower case character). Returns the + parsed character.

digit :: CharParsing m => m Char #

Parses a digit. Returns the parsed character.

hexDigit :: CharParsing m => m Char #

Parses a hexadecimal digit (a digit or a letter between 'a' and + 'f' or 'A' and 'F'). Returns the parsed character.

octDigit :: CharParsing m => m Char #

Parses an octal digit (a character between '0' and '7'). Returns + the parsed character.

satisfyRange :: CharParsing m => Char -> Char -> m Char #

Class

class Parsing m => CharParsing m where #

Additional functionality needed to parse character streams.

Minimal complete definition

satisfy

Methods

satisfy :: (Char -> Bool) -> m Char #

Parse a single character of the input, with UTF-8 decoding

char :: Char -> m Char #

char c parses a single character c. Returns the parsed + character (i.e. c).

e.g.

semiColon = char ';'

notChar :: Char -> m Char #

notChar c parses any single character other than c. Returns the parsed + character.

anyChar :: m Char #

This parser succeeds for any character. Returns the parsed character.

string :: String -> m String #

string s parses a sequence of characters given by s. Returns + the parsed string (i.e. s).

 divOrMod    =   string "div"
+             <|> string "mod"

text :: Text -> m Text #

text t parses a sequence of characters determined by the text t Returns + the parsed text fragment (i.e. t).

Using OverloadedStrings:

 divOrMod    =   text "div"
+             <|> text "mod"
Instances
CharParsing ParsecParser # 
Instance details

Defined in Distribution.Parsec.Class

Methods

satisfy :: (Char -> Bool) -> ParsecParser Char #

char :: Char -> ParsecParser Char #

notChar :: Char -> ParsecParser Char #

anyChar :: ParsecParser Char #

string :: String -> ParsecParser String #

text :: Text -> ParsecParser Text #

(CharParsing m, MonadPlus m) => CharParsing (IdentityT m) # 
Instance details

Defined in Distribution.Compat.CharParsing

Methods

satisfy :: (Char -> Bool) -> IdentityT m Char #

char :: Char -> IdentityT m Char #

notChar :: Char -> IdentityT m Char #

anyChar :: IdentityT m Char #

string :: String -> IdentityT m String #

text :: Text -> IdentityT m Text #

(CharParsing m, MonadPlus m) => CharParsing (StateT s m) # 
Instance details

Defined in Distribution.Compat.CharParsing

Methods

satisfy :: (Char -> Bool) -> StateT s m Char #

char :: Char -> StateT s m Char #

notChar :: Char -> StateT s m Char #

anyChar :: StateT s m Char #

string :: String -> StateT s m String #

text :: Text -> StateT s m Text #

(CharParsing m, MonadPlus m) => CharParsing (StateT s m) # 
Instance details

Defined in Distribution.Compat.CharParsing

Methods

satisfy :: (Char -> Bool) -> StateT s m Char #

char :: Char -> StateT s m Char #

notChar :: Char -> StateT s m Char #

anyChar :: StateT s m Char #

string :: String -> StateT s m String #

text :: Text -> StateT s m Text #

(CharParsing m, MonadPlus m, Monoid w) => CharParsing (WriterT w m) # 
Instance details

Defined in Distribution.Compat.CharParsing

Methods

satisfy :: (Char -> Bool) -> WriterT w m Char #

char :: Char -> WriterT w m Char #

notChar :: Char -> WriterT w m Char #

anyChar :: WriterT w m Char #

string :: String -> WriterT w m String #

text :: Text -> WriterT w m Text #

(CharParsing m, MonadPlus m, Monoid w) => CharParsing (WriterT w m) # 
Instance details

Defined in Distribution.Compat.CharParsing

Methods

satisfy :: (Char -> Bool) -> WriterT w m Char #

char :: Char -> WriterT w m Char #

notChar :: Char -> WriterT w m Char #

anyChar :: WriterT w m Char #

string :: String -> WriterT w m String #

text :: Text -> WriterT w m Text #

t ~ Char => CharParsing (Parser r t) # 
Instance details

Defined in Distribution.Compat.CharParsing

Methods

satisfy :: (Char -> Bool) -> Parser r t Char #

char :: Char -> Parser r t Char #

notChar :: Char -> Parser r t Char #

anyChar :: Parser r t Char #

string :: String -> Parser r t String #

text :: Text -> Parser r t Text #

(CharParsing m, MonadPlus m) => CharParsing (ReaderT e m) # 
Instance details

Defined in Distribution.Compat.CharParsing

Methods

satisfy :: (Char -> Bool) -> ReaderT e m Char #

char :: Char -> ReaderT e m Char #

notChar :: Char -> ReaderT e m Char #

anyChar :: ReaderT e m Char #

string :: String -> ReaderT e m String #

text :: Text -> ReaderT e m Text #

Stream s m Char => CharParsing (ParsecT s u m) # 
Instance details

Defined in Distribution.Compat.CharParsing

Methods

satisfy :: (Char -> Bool) -> ParsecT s u m Char #

char :: Char -> ParsecT s u m Char #

notChar :: Char -> ParsecT s u m Char #

anyChar :: ParsecT s u m Char #

string :: String -> ParsecT s u m String #

text :: Text -> ParsecT s u m Text #

(CharParsing m, MonadPlus m, Monoid w) => CharParsing (RWST r w s m) # 
Instance details

Defined in Distribution.Compat.CharParsing

Methods

satisfy :: (Char -> Bool) -> RWST r w s m Char #

char :: Char -> RWST r w s m Char #

notChar :: Char -> RWST r w s m Char #

anyChar :: RWST r w s m Char #

string :: String -> RWST r w s m String #

text :: Text -> RWST r w s m Text #

(CharParsing m, MonadPlus m, Monoid w) => CharParsing (RWST r w s m) # 
Instance details

Defined in Distribution.Compat.CharParsing

Methods

satisfy :: (Char -> Bool) -> RWST r w s m Char #

char :: Char -> RWST r w s m Char #

notChar :: Char -> RWST r w s m Char #

anyChar :: RWST r w s m Char #

string :: String -> RWST r w s m String #

text :: Text -> RWST r w s m Text #

Cabal additions

integral :: (CharParsing m, Integral a) => m a #

munch1 :: CharParsing m => (Char -> Bool) -> m String #

Greedily munch characters while predicate holds. + Require at least one character.

munch :: CharParsing m => (Char -> Bool) -> m String #

Greedely munch characters while predicate holds. + Always succeeds.

skipSpaces1 :: CharParsing m => m () #

module Distribution.Compat.Parsing

diff --git a/doc/API/Cabal/Distribution-Compat-CreatePipe.html b/doc/API/Cabal/Distribution-Compat-CreatePipe.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compat-CreatePipe.html @@ -0,0 +1,1 @@ +Distribution.Compat.CreatePipe

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Compat.CreatePipe

Documentation

createPipe :: IO (Handle, Handle) #

diff --git a/doc/API/Cabal/Distribution-Compat-DList.html b/doc/API/Cabal/Distribution-Compat-DList.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compat-DList.html @@ -0,0 +1,1 @@ +Distribution.Compat.DList

Cabal-2.4.0.1: A framework for packaging Haskell software

Copyright(c) Ben Gamari 2015-2019
LicenseBSD3
Maintainercabal-dev@haskell.org
Stabilityexperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Compat.DList

Description

A very simple difference list.

Synopsis

Documentation

data DList a #

Difference list.

Instances
Semigroup (DList a) # 
Instance details

Defined in Distribution.Compat.DList

Methods

(<>) :: DList a -> DList a -> DList a #

sconcat :: NonEmpty (DList a) -> DList a #

stimes :: Integral b => b -> DList a -> DList a #

Monoid (DList a) # 
Instance details

Defined in Distribution.Compat.DList

Methods

mempty :: DList a #

mappend :: DList a -> DList a -> DList a #

mconcat :: [DList a] -> DList a #

runDList :: DList a -> [a] #

singleton :: a -> DList a #

Make DList with containing single element.

fromList :: [a] -> DList a #

toList :: DList a -> [a] #

snoc :: DList a -> a -> DList a #

diff --git a/doc/API/Cabal/Distribution-Compat-Directory.html b/doc/API/Cabal/Distribution-Compat-Directory.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compat-Directory.html @@ -0,0 +1,19 @@ +Distribution.Compat.Directory

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellSafe
LanguageHaskell2010

Distribution.Compat.Directory

Synopsis

Documentation

listDirectory :: FilePath -> IO [FilePath] #

listDirectory dir returns a list of all entries in dir without + the special entries (. and ..).

The operation may fail with:

  • HardwareFault + A physical I/O error has occurred. + [EIO]
  • InvalidArgument + The operand is not a valid directory name. + [ENAMETOOLONG, ELOOP]
  • isDoesNotExistError / NoSuchThing + The directory does not exist. + [ENOENT, ENOTDIR]
  • isPermissionError / PermissionDenied + The process has insufficient privileges to perform the operation. + [EACCES]
  • ResourceExhausted + Insufficient resources are available to perform the operation. + [EMFILE, ENFILE]
  • InappropriateType + The path refers to an existing non-directory object. + [ENOTDIR]

Since: directory-1.2.5.0

makeAbsolute :: FilePath -> IO FilePath #

Convert a path into an absolute path. If the given path is relative, the + current directory is prepended and then the combined result is + normalised. If the path is already absolute, the path is simply + normalised. The function preserves the presence or absence of the + trailing path separator unless the path refers to the root directory /.

If the path is already absolute, the operation never fails. Otherwise, the + operation may fail with the same exceptions as getCurrentDirectory.

Since: directory-1.2.2.0

diff --git a/doc/API/Cabal/Distribution-Compat-Exception.html b/doc/API/Cabal/Distribution-Compat-Exception.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compat-Exception.html @@ -0,0 +1,1 @@ +Distribution.Compat.Exception

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellSafe
LanguageHaskell2010

Distribution.Compat.Exception

Synopsis

Documentation

catchIO :: IO a -> (IOException -> IO a) -> IO a #

catchExit :: IO a -> (ExitCode -> IO a) -> IO a #

tryIO :: IO a -> IO (Either IOException a) #

displayException :: Exception e => e -> String #

Render this exception value in a human-friendly manner.

Default implementation: show.

Since: base-4.8.0.0

diff --git a/doc/API/Cabal/Distribution-Compat-Graph.html b/doc/API/Cabal/Distribution-Compat-Graph.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compat-Graph.html @@ -0,0 +1,43 @@ +Distribution.Compat.Graph

Cabal-2.4.0.1: A framework for packaging Haskell software

Copyright(c) Edward Z. Yang 2016
LicenseBSD3
Maintainercabal-dev@haskell.org
Stabilityexperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Compat.Graph

Contents

Description

A data type representing directed graphs, backed by Data.Graph. + It is strict in the node type.

This is an alternative interface to Data.Graph. In this interface, + nodes (identified by the IsNode type class) are associated with a + key and record the keys of their neighbors. This interface is more + convenient than Graph, which requires vertices to be + explicitly handled by integer indexes.

The current implementation has somewhat peculiar performance + characteristics. The asymptotics of all map-like operations mirror + their counterparts in Data.Map. However, to perform a graph + operation, we first must build the Data.Graph representation, an + operation that takes O(V + E log V). However, this operation can + be amortized across all queries on that particular graph.

Some nodes may be broken, i.e., refer to neighbors which are not + stored in the graph. In our graph algorithms, we transparently + ignore such edges; however, you can easily query for the broken + vertices of a graph using broken (and should, e.g., to ensure that + a closure of a graph is well-formed.) It's possible to take a closed + subset of a broken graph and get a well-formed graph.

Synopsis

Graph type

data Graph a #

A graph of nodes a. The nodes are expected to have instance + of class IsNode.

Instances
Foldable Graph # 
Instance details

Defined in Distribution.Compat.Graph

Methods

fold :: Monoid m => Graph m -> m #

foldMap :: Monoid m => (a -> m) -> Graph a -> m #

foldr :: (a -> b -> b) -> b -> Graph a -> b #

foldr' :: (a -> b -> b) -> b -> Graph a -> b #

foldl :: (b -> a -> b) -> b -> Graph a -> b #

foldl' :: (b -> a -> b) -> b -> Graph a -> b #

foldr1 :: (a -> a -> a) -> Graph a -> a #

foldl1 :: (a -> a -> a) -> Graph a -> a #

toList :: Graph a -> [a] #

null :: Graph a -> Bool #

length :: Graph a -> Int #

elem :: Eq a => a -> Graph a -> Bool #

maximum :: Ord a => Graph a -> a #

minimum :: Ord a => Graph a -> a #

sum :: Num a => Graph a -> a #

product :: Num a => Graph a -> a #

(Eq (Key a), Eq a) => Eq (Graph a) # 
Instance details

Defined in Distribution.Compat.Graph

Methods

(==) :: Graph a -> Graph a -> Bool #

(/=) :: Graph a -> Graph a -> Bool #

(IsNode a, Read a, Show (Key a)) => Read (Graph a) # 
Instance details

Defined in Distribution.Compat.Graph

Methods

readsPrec :: Int -> ReadS (Graph a) #

readList :: ReadS [Graph a] #

readPrec :: ReadPrec (Graph a) #

readListPrec :: ReadPrec [Graph a] #

Show a => Show (Graph a) # 
Instance details

Defined in Distribution.Compat.Graph

Methods

showsPrec :: Int -> Graph a -> ShowS #

show :: Graph a -> String #

showList :: [Graph a] -> ShowS #

(IsNode a, Binary a, Show (Key a)) => Binary (Graph a) # 
Instance details

Defined in Distribution.Compat.Graph

Methods

put :: Graph a -> Put #

get :: Get (Graph a) #

putList :: [Graph a] -> Put #

(NFData a, NFData (Key a)) => NFData (Graph a) # 
Instance details

Defined in Distribution.Compat.Graph

Methods

rnf :: Graph a -> () #

class Ord (Key a) => IsNode a where #

The IsNode class is used for datatypes which represent directed + graph nodes. A node of type a is associated with some unique key of + type Key a; given a node we can determine its key (nodeKey) + and the keys of its neighbors (nodeNeighbors).

Minimal complete definition

nodeKey, nodeNeighbors

Associated Types

type Key a :: * #

Methods

nodeKey :: a -> Key a #

nodeNeighbors :: a -> [Key a] #

Instances
IsNode InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Associated Types

type Key InstalledPackageInfo :: * #

Methods

nodeKey :: InstalledPackageInfo -> Key InstalledPackageInfo #

nodeNeighbors :: InstalledPackageInfo -> [Key InstalledPackageInfo] #

IsNode ComponentLocalBuildInfo # 
Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Associated Types

type Key ComponentLocalBuildInfo :: * #

Methods

nodeKey :: ComponentLocalBuildInfo -> Key ComponentLocalBuildInfo #

nodeNeighbors :: ComponentLocalBuildInfo -> [Key ComponentLocalBuildInfo] #

IsNode TargetInfo # 
Instance details

Defined in Distribution.Types.TargetInfo

Associated Types

type Key TargetInfo :: * #

Methods

nodeKey :: TargetInfo -> Key TargetInfo #

nodeNeighbors :: TargetInfo -> [Key TargetInfo] #

(IsNode a, IsNode b, Key a ~ Key b) => IsNode (Either a b) # 
Instance details

Defined in Distribution.Compat.Graph

Associated Types

type Key (Either a b) :: * #

Methods

nodeKey :: Either a b -> Key (Either a b) #

nodeNeighbors :: Either a b -> [Key (Either a b)] #

Ord k => IsNode (Node k a) # 
Instance details

Defined in Distribution.Compat.Graph

Associated Types

type Key (Node k a) :: * #

Methods

nodeKey :: Node k a -> Key (Node k a) #

nodeNeighbors :: Node k a -> [Key (Node k a)] #

Query

null :: Graph a -> Bool #

O(1). Is the graph empty?

size :: Graph a -> Int #

O(1). The number of nodes in the graph.

member :: IsNode a => Key a -> Graph a -> Bool #

O(log V). Check if the key is in the graph.

lookup :: IsNode a => Key a -> Graph a -> Maybe a #

O(log V). Lookup the node at a key in the graph.

Construction

empty :: IsNode a => Graph a #

O(1). The empty graph.

insert :: IsNode a => a -> Graph a -> Graph a #

O(log V). Insert a node into a graph.

deleteKey :: IsNode a => Key a -> Graph a -> Graph a #

O(log V). Delete the node at a key from the graph.

deleteLookup :: IsNode a => Key a -> Graph a -> (Maybe a, Graph a) #

O(log V). Lookup and delete. This function returns the deleted + value if it existed.

Combine

unionLeft :: IsNode a => Graph a -> Graph a -> Graph a #

O(V + V'). Left-biased union, preferring entries from + the first map when conflicts occur.

unionRight :: IsNode a => Graph a -> Graph a -> Graph a #

O(V + V'). Right-biased union, preferring entries + from the second map when conflicts occur. + nodeKey x = nodeKey (f x).

Graph algorithms

stronglyConnComp :: Graph a -> [SCC a] #

Ω(V + E). Compute the strongly connected components of a graph. + Requires amortized construction of graph.

data SCC vertex #

Strongly connected component.

Constructors

AcyclicSCC vertex

A single vertex that is not + in any cycle.

CyclicSCC [vertex]

A maximal set of mutually + reachable vertices.

Instances
Functor SCC

Since: containers-0.5.4

Instance details

Defined in Data.Graph

Methods

fmap :: (a -> b) -> SCC a -> SCC b #

(<$) :: a -> SCC b -> SCC a #

Foldable SCC

Since: containers-0.5.9

Instance details

Defined in Data.Graph

Methods

fold :: Monoid m => SCC m -> m #

foldMap :: Monoid m => (a -> m) -> SCC a -> m #

foldr :: (a -> b -> b) -> b -> SCC a -> b #

foldr' :: (a -> b -> b) -> b -> SCC a -> b #

foldl :: (b -> a -> b) -> b -> SCC a -> b #

foldl' :: (b -> a -> b) -> b -> SCC a -> b #

foldr1 :: (a -> a -> a) -> SCC a -> a #

foldl1 :: (a -> a -> a) -> SCC a -> a #

toList :: SCC a -> [a] #

null :: SCC a -> Bool #

length :: SCC a -> Int #

elem :: Eq a => a -> SCC a -> Bool #

maximum :: Ord a => SCC a -> a #

minimum :: Ord a => SCC a -> a #

sum :: Num a => SCC a -> a #

product :: Num a => SCC a -> a #

Traversable SCC

Since: containers-0.5.9

Instance details

Defined in Data.Graph

Methods

traverse :: Applicative f => (a -> f b) -> SCC a -> f (SCC b) #

sequenceA :: Applicative f => SCC (f a) -> f (SCC a) #

mapM :: Monad m => (a -> m b) -> SCC a -> m (SCC b) #

sequence :: Monad m => SCC (m a) -> m (SCC a) #

Eq1 SCC

Since: containers-0.5.9

Instance details

Defined in Data.Graph

Methods

liftEq :: (a -> b -> Bool) -> SCC a -> SCC b -> Bool #

Read1 SCC

Since: containers-0.5.9

Instance details

Defined in Data.Graph

Methods

liftReadsPrec :: (Int -> ReadS a) -> ReadS [a] -> Int -> ReadS (SCC a) #

liftReadList :: (Int -> ReadS a) -> ReadS [a] -> ReadS [SCC a] #

liftReadPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec (SCC a) #

liftReadListPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec [SCC a] #

Show1 SCC

Since: containers-0.5.9

Instance details

Defined in Data.Graph

Methods

liftShowsPrec :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> Int -> SCC a -> ShowS #

liftShowList :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> [SCC a] -> ShowS #

Eq vertex => Eq (SCC vertex)

Since: containers-0.5.9

Instance details

Defined in Data.Graph

Methods

(==) :: SCC vertex -> SCC vertex -> Bool #

(/=) :: SCC vertex -> SCC vertex -> Bool #

Data vertex => Data (SCC vertex)

Since: containers-0.5.9

Instance details

Defined in Data.Graph

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SCC vertex -> c (SCC vertex) #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (SCC vertex) #

toConstr :: SCC vertex -> Constr #

dataTypeOf :: SCC vertex -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (SCC vertex)) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (SCC vertex)) #

gmapT :: (forall b. Data b => b -> b) -> SCC vertex -> SCC vertex #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SCC vertex -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SCC vertex -> r #

gmapQ :: (forall d. Data d => d -> u) -> SCC vertex -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SCC vertex -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SCC vertex -> m (SCC vertex) #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SCC vertex -> m (SCC vertex) #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SCC vertex -> m (SCC vertex) #

Read vertex => Read (SCC vertex)

Since: containers-0.5.9

Instance details

Defined in Data.Graph

Methods

readsPrec :: Int -> ReadS (SCC vertex) #

readList :: ReadS [SCC vertex] #

readPrec :: ReadPrec (SCC vertex) #

readListPrec :: ReadPrec [SCC vertex] #

Show vertex => Show (SCC vertex)

Since: containers-0.5.9

Instance details

Defined in Data.Graph

Methods

showsPrec :: Int -> SCC vertex -> ShowS #

show :: SCC vertex -> String #

showList :: [SCC vertex] -> ShowS #

Generic (SCC vertex) 
Instance details

Defined in Data.Graph

Associated Types

type Rep (SCC vertex) :: * -> * #

Methods

from :: SCC vertex -> Rep (SCC vertex) x #

to :: Rep (SCC vertex) x -> SCC vertex #

NFData a => NFData (SCC a) 
Instance details

Defined in Data.Graph

Methods

rnf :: SCC a -> () #

Generic1 SCC 
Instance details

Defined in Data.Graph

Associated Types

type Rep1 SCC :: k -> * #

Methods

from1 :: SCC a -> Rep1 SCC a #

to1 :: Rep1 SCC a -> SCC a #

type Rep (SCC vertex)

Since: containers-0.5.9

Instance details

Defined in Data.Graph

type Rep (SCC vertex) = D1 (MetaData "SCC" "Data.Graph" "containers-0.5.11.0" False) (C1 (MetaCons "AcyclicSCC" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 vertex)) :+: C1 (MetaCons "CyclicSCC" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [vertex])))
type Rep1 SCC

Since: containers-0.5.9

Instance details

Defined in Data.Graph

type Rep1 SCC = D1 (MetaData "SCC" "Data.Graph" "containers-0.5.11.0" False) (C1 (MetaCons "AcyclicSCC" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) Par1) :+: C1 (MetaCons "CyclicSCC" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec1 [])))

cycles :: Graph a -> [[a]] #

Ω(V + E). Compute the cycles of a graph. + Requires amortized construction of graph.

broken :: Graph a -> [(a, [Key a])] #

O(1). Return a list of nodes paired with their broken + neighbors (i.e., neighbor keys which are not in the graph). + Requires amortized construction of graph.

neighbors :: Graph a -> Key a -> Maybe [a] #

Lookup the immediate neighbors from a key in the graph. + Requires amortized construction of graph.

revNeighbors :: Graph a -> Key a -> Maybe [a] #

Lookup the immediate reverse neighbors from a key in the graph. + Requires amortized construction of graph.

closure :: Graph a -> [Key a] -> Maybe [a] #

Compute the subgraph which is the closure of some set of keys. + Returns Nothing if one (or more) keys are not present in + the graph. + Requires amortized construction of graph.

revClosure :: Graph a -> [Key a] -> Maybe [a] #

Compute the reverse closure of a graph from some set + of keys. Returns Nothing if one (or more) keys are not present in + the graph. + Requires amortized construction of graph.

topSort :: Graph a -> [a] #

Topologically sort the nodes of a graph. + Requires amortized construction of graph.

revTopSort :: Graph a -> [a] #

Reverse topologically sort the nodes of a graph. + Requires amortized construction of graph.

Conversions

Maps

toMap :: Graph a -> Map (Key a) a #

O(1). Convert a graph into a map from keys to nodes. + The resulting map m is guaranteed to have the property that + all ((k,n) -> k == nodeKey n) (toList m).

Lists

fromDistinctList :: (IsNode a, Show (Key a)) => [a] -> Graph a #

O(V log V). Convert a list of nodes (with distinct keys) into a graph.

toList :: Graph a -> [a] #

O(V). Convert a graph into a list of nodes.

keys :: Graph a -> [Key a] #

O(V). Convert a graph into a list of keys.

Sets

keysSet :: Graph a -> Set (Key a) #

O(V). Convert a graph into a set of keys.

Graphs

toGraph :: Graph a -> (Graph, Vertex -> a, Key a -> Maybe Vertex) #

O(1). Convert a graph into a Graph. + Requires amortized construction of graph.

Node type

data Node k a #

A simple, trivial data type which admits an IsNode instance.

Constructors

N a k [k] 
Instances
Functor (Node k) # 
Instance details

Defined in Distribution.Compat.Graph

Methods

fmap :: (a -> b) -> Node k a -> Node k b #

(<$) :: a -> Node k b -> Node k a #

(Eq a, Eq k) => Eq (Node k a) # 
Instance details

Defined in Distribution.Compat.Graph

Methods

(==) :: Node k a -> Node k a -> Bool #

(/=) :: Node k a -> Node k a -> Bool #

(Show a, Show k) => Show (Node k a) # 
Instance details

Defined in Distribution.Compat.Graph

Methods

showsPrec :: Int -> Node k a -> ShowS #

show :: Node k a -> String #

showList :: [Node k a] -> ShowS #

Ord k => IsNode (Node k a) # 
Instance details

Defined in Distribution.Compat.Graph

Associated Types

type Key (Node k a) :: * #

Methods

nodeKey :: Node k a -> Key (Node k a) #

nodeNeighbors :: Node k a -> [Key (Node k a)] #

type Key (Node k a) # 
Instance details

Defined in Distribution.Compat.Graph

type Key (Node k a) = k

nodeValue :: Node k a -> a #

Get the value from a Node.

diff --git a/doc/API/Cabal/Distribution-Compat-Lens.html b/doc/API/Cabal/Distribution-Compat-Lens.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compat-Lens.html @@ -0,0 +1,12 @@ +Distribution.Compat.Lens

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Compat.Lens

Contents

Description

This module provides very basic lens functionality, without extra dependencies.

For the documentation of the combinators see lens package. + This module uses the same vocabulary.

Synopsis

Types

type Lens s t a b = forall f. Functor f => LensLike f s t a b #

type Lens' s a = Lens s s a a #

type Traversal s t a b = forall f. Applicative f => LensLike f s t a b #

type Traversal' s a = Traversal s s a a #

LensLike

type LensLike f s t a b = (a -> f b) -> s -> f t #

type LensLike' f s a = (a -> f a) -> s -> f s #

rank-1 types

type Getting r s a = LensLike (Const r) s s a a #

type AGetter s a = LensLike (Const a) s s a a #

type ASetter s t a b = LensLike Identity s t a b #

type ALens s t a b = LensLike (Pretext a b) s t a b #

type ALens' s a = ALens s s a a #

Getter

view :: Getting a s a -> s -> a #

use :: MonadState s m => Getting a s a -> m a #

getting :: (s -> a) -> Getting r s a #

>>> (3 :: Int) ^. getting (+2) . getting show
+"5"
+

Since: 2.4

Setter

set :: ASetter s t a b -> b -> s -> t #

over :: ASetter s t a b -> (a -> b) -> s -> t #

Fold

toDListOf :: Getting (DList a) s a -> s -> DList a #

toListOf :: Getting (DList a) s a -> s -> [a] #

toSetOf :: Getting (Set a) s a -> s -> Set a #

Lens

cloneLens :: Functor f => ALens s t a b -> LensLike f s t a b #

aview :: ALens s t a b -> s -> a #

Common lenses

_1 :: Lens (a, c) (b, c) a b #

_2 :: Lens (c, a) (c, b) a b #

Operators

(&) :: a -> (a -> b) -> b infixl 1 #

& is a reverse application operator

(^.) :: s -> Getting a s a -> a infixl 8 #

(.~) :: ASetter s t a b -> b -> s -> t infixr 4 #

(?~) :: ASetter s t a (Maybe b) -> b -> s -> t infixr 4 #

(%~) :: ASetter s t a b -> (a -> b) -> s -> t infixr 4 #

(.=) :: MonadState s m => ASetter s s a b -> b -> m () infixr 4 #

(?=) :: MonadState s m => ASetter s s a (Maybe b) -> b -> m () infixr 4 #

(%=) :: MonadState s m => ASetter s s a b -> (a -> b) -> m () infixr 4 #

(^#) :: s -> ALens s t a b -> a infixl 8 #

(#~) :: ALens s t a b -> b -> s -> t infixr 4 #

(#%~) :: ALens s t a b -> (a -> b) -> s -> t infixr 4 #

Internal Comonads

data Pretext a b t #

lens variant is also parametrised by profunctor.

Constructors

Pretext 

Fields

Instances
Functor (Pretext a b) # 
Instance details

Defined in Distribution.Compat.Lens

Methods

fmap :: (a0 -> b0) -> Pretext a b a0 -> Pretext a b b0 #

(<$) :: a0 -> Pretext a b b0 -> Pretext a b a0 #

Cabal developer info

We cannot depend on template-haskell, because Cabal is a boot library. + This fact makes defining optics a manual task. Here is a small recipe to + make the process less tedious.

First start a repl

cabal new-repl Cabal:hackage-tests

Because --extra-package isn't yet implemented, we use a test-suite + with generics-sop dependency.

In the repl, we load a helper script:

:l ../generics-sop-lens.hs

Now we are set up to derive lenses!

:m +Distribution.Types.SourceRepo
+putStr $ genericLenses (Proxy :: Proxy SourceRepo)
repoKind :: Lens' SourceRepo RepoKind
+repoKind f s = fmap (\x -> s { T.repoKind = x }) (f (T.repoKind s))
+{--}
+...
+

Note: You may need to adjust type-aliases, e.g. String to FilePath.

diff --git a/doc/API/Cabal/Distribution-Compat-Newtype.html b/doc/API/Cabal/Distribution-Compat-Newtype.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compat-Newtype.html @@ -0,0 +1,12 @@ +Distribution.Compat.Newtype

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellSafe
LanguageHaskell2010

Distribution.Compat.Newtype

Description

Per Conor McBride, the Newtype typeclass represents the packing and + unpacking of a newtype, and allows you to operatate under that newtype with + functions such as ala.

Synopsis

Documentation

class Newtype n o | n -> o where #

The FunctionalDependencies version of Newtype type-class.

Note: for actual newtypes the implementation can be + pack = coerce; unpack = coerce. We don't have default implementation, + because Cabal have to support older than base >= 4.7 compilers. + Also, Newtype could witness a non-structural isomorphism.

Minimal complete definition

pack, unpack

Methods

pack :: o -> n #

unpack :: n -> o #

Instances
Newtype FilePathNT String # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: String -> FilePathNT #

unpack :: FilePathNT -> String #

Newtype FreeText String # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: String -> FreeText #

unpack :: FreeText -> String #

Newtype Token' String # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: String -> Token' #

unpack :: Token' -> String #

Newtype Token String # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: String -> Token #

unpack :: Token -> String #

Newtype TestedWith (CompilerFlavor, VersionRange) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: (CompilerFlavor, VersionRange) -> TestedWith #

unpack :: TestedWith -> (CompilerFlavor, VersionRange) #

Newtype SpecLicense (Either License License) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: Either License0 License -> SpecLicense #

unpack :: SpecLicense -> Either License0 License #

Newtype SpecVersion (Either Version VersionRange) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: Either Version VersionRange -> SpecVersion #

unpack :: SpecVersion -> Either Version VersionRange #

Newtype (Identity a) a # 
Instance details

Defined in Distribution.Compat.Newtype

Methods

pack :: a -> Identity a #

unpack :: Identity a -> a #

Newtype (Sum a) a # 
Instance details

Defined in Distribution.Compat.Newtype

Methods

pack :: a -> Sum a #

unpack :: Sum a -> a #

Newtype (Product a) a # 
Instance details

Defined in Distribution.Compat.Newtype

Methods

pack :: a -> Product a #

unpack :: Product a -> a #

Newtype (MQuoted a) a # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: a -> MQuoted a #

unpack :: MQuoted a -> a #

Newtype (Endo a) (a -> a) # 
Instance details

Defined in Distribution.Compat.Newtype

Methods

pack :: (a -> a) -> Endo a #

unpack :: Endo a -> a -> a #

Newtype (List sep wrapper a) [a] # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: [a] -> List sep wrapper a #

unpack :: List sep wrapper a -> [a] #

ala :: (Newtype n o, Newtype n' o') => (o -> n) -> ((o -> n) -> b -> n') -> b -> o' #

>>> ala Sum foldMap [1, 2, 3, 4 :: Int]
+10
+

Note: the user supplied function for the newtype is ignored.

>>> ala (Sum . (+1)) foldMap [1, 2, 3, 4 :: Int]
+10
+

alaf :: (Newtype n o, Newtype n' o') => (o -> n) -> ((a -> n) -> b -> n') -> (a -> o) -> b -> o' #

>>> alaf Sum foldMap length ["cabal", "install"]
+12
+

Note: as with ala, the user supplied function for the newtype is ignored.

pack' :: Newtype n o => (o -> n) -> o -> n #

Variant of pack, which takes a phantom type.

unpack' :: Newtype n o => (o -> n) -> n -> o #

Variant of pack, which takes a phantom type.

diff --git a/doc/API/Cabal/Distribution-Compat-Parsing.html b/doc/API/Cabal/Distribution-Compat-Parsing.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compat-Parsing.html @@ -0,0 +1,56 @@ +Distribution.Compat.Parsing

Cabal-2.4.0.1: A framework for packaging Haskell software

Copyright(c) Edward Kmett 2011-2012
LicenseBSD3
Maintainerekmett@gmail.com
Stabilityexperimental
Portabilitynon-portable
Safe HaskellNone
LanguageHaskell2010

Distribution.Compat.Parsing

Contents

Description

Alternative parser combinators.

Originally in parsers package.

Synopsis

Parsing Combinators

choice :: Alternative m => [m a] -> m a #

choice ps tries to apply the parsers in the list ps in order, + until one of them succeeds. Returns the value of the succeeding + parser.

option :: Alternative m => a -> m a -> m a #

option x p tries to apply parser p. If p fails without + consuming input, it returns the value x, otherwise the value + returned by p.

 priority = option 0 (digitToInt <$> digit)

optional :: Alternative f => f a -> f (Maybe a) #

One or none.

skipOptional :: Alternative m => m a -> m () #

skipOptional p tries to apply parser p. It will parse p or nothing. + It only fails if p fails after consuming input. It discards the result + of p. (Plays the role of parsec's optional, which conflicts with Applicative's optional)

between :: Applicative m => m bra -> m ket -> m a -> m a #

between open close p parses open, followed by p and close. + Returns the value returned by p.

 braces  = between (symbol "{") (symbol "}")

some :: Alternative f => f a -> f [a] #

One or more.

many :: Alternative f => f a -> f [a] #

Zero or more.

sepBy :: Alternative m => m a -> m sep -> m [a] #

sepBy p sep parses zero or more occurrences of p, separated + by sep. Returns a list of values returned by p.

 commaSep p  = p `sepBy` (symbol ",")

sepBy1 :: Alternative m => m a -> m sep -> m [a] #

sepBy1 p sep parses one or more occurrences of p, separated + by sep. Returns a list of values returned by p.

sepEndBy1 :: Alternative m => m a -> m sep -> m [a] #

sepEndBy1 p sep parses one or more occurrences of p, + separated and optionally ended by sep. Returns a list of values + returned by p.

sepEndBy :: Alternative m => m a -> m sep -> m [a] #

sepEndBy p sep parses zero or more occurrences of p, + separated and optionally ended by sep, ie. haskell style + statements. Returns a list of values returned by p.

 haskellStatements  = haskellStatement `sepEndBy` semi

endBy1 :: Alternative m => m a -> m sep -> m [a] #

endBy1 p sep parses one or more occurrences of p, separated + and ended by sep. Returns a list of values returned by p.

endBy :: Alternative m => m a -> m sep -> m [a] #

endBy p sep parses zero or more occurrences of p, separated + and ended by sep. Returns a list of values returned by p.

  cStatements  = cStatement `endBy` semi

count :: Applicative m => Int -> m a -> m [a] #

count n p parses n occurrences of p. If n is smaller or + equal to zero, the parser equals to return []. Returns a list of + n values returned by p.

chainl :: Alternative m => m a -> m (a -> a -> a) -> a -> m a #

chainl p op x parses zero or more occurrences of p, + separated by op. Returns a value obtained by a left associative + application of all functions returned by op to the values returned + by p. If there are zero occurrences of p, the value x is + returned.

chainr :: Alternative m => m a -> m (a -> a -> a) -> a -> m a #

chainr p op x parses zero or more occurrences of p, + separated by op Returns a value obtained by a right associative + application of all functions returned by op to the values returned + by p. If there are no occurrences of p, the value x is + returned.

chainl1 :: Alternative m => m a -> m (a -> a -> a) -> m a #

chainl1 p op x parses one or more occurrences of p, + separated by op Returns a value obtained by a left associative + application of all functions returned by op to the values returned + by p. . This parser can for example be used to eliminate left + recursion which typically occurs in expression grammars.

 expr   = term   `chainl1` addop
+ term   = factor `chainl1` mulop
+ factor = parens expr <|> integer
+
+ mulop  = (*) <$ symbol "*"
+      <|> div <$ symbol "/"
+
+ addop  = (+) <$ symbol "+"
+      <|> (-) <$ symbol "-"

chainr1 :: Alternative m => m a -> m (a -> a -> a) -> m a #

chainr1 p op x parses one or more occurrences of p, + separated by op Returns a value obtained by a right associative + application of all functions returned by op to the values returned + by p.

manyTill :: Alternative m => m a -> m end -> m [a] #

manyTill p end applies parser p zero or more times until + parser end succeeds. Returns the list of values returned by p. + This parser can be used to scan comments:

 simpleComment   = do{ string "<!--"
+                     ; manyTill anyChar (try (string "-->"))
+                     }

Note the overlapping parsers anyChar and string "-->", and + therefore the use of the try combinator.

Parsing Class

class Alternative m => Parsing m where #

Additional functionality needed to describe parsers independent of input type.

Minimal complete definition

try, (<?>), unexpected, eof, notFollowedBy

Methods

try :: m a -> m a #

Take a parser that may consume input, and on failure, go back to + where we started and fail as if we didn't consume input.

(<?>) :: m a -> String -> m a infixr 0 #

Give a parser a name

skipMany :: m a -> m () #

A version of many that discards its input. Specialized because it + can often be implemented more cheaply.

skipSome :: m a -> m () #

skipSome p applies the parser p one or more times, skipping + its result. (aka skipMany1 in parsec)

unexpected :: String -> m a #

Used to emit an error on an unexpected token

eof :: m () #

This parser only succeeds at the end of the input. This is not a + primitive parser but it is defined using notFollowedBy.

 eof  = notFollowedBy anyChar <?> "end of input"

notFollowedBy :: Show a => m a -> m () #

notFollowedBy p only succeeds when parser p fails. This parser + does not consume any input. This parser can be used to implement the + 'longest match' rule. For example, when recognizing keywords (for + example let), we want to make sure that a keyword is not followed + by a legal identifier character, in which case the keyword is + actually an identifier (for example lets). We can program this + behaviour as follows:

 keywordLet  = try $ string "let" <* notFollowedBy alphaNum
Instances
Parsing ParsecParser # 
Instance details

Defined in Distribution.Parsec.Class

Methods

try :: ParsecParser a -> ParsecParser a #

(<?>) :: ParsecParser a -> String -> ParsecParser a #

skipMany :: ParsecParser a -> ParsecParser () #

skipSome :: ParsecParser a -> ParsecParser () #

unexpected :: String -> ParsecParser a #

eof :: ParsecParser () #

notFollowedBy :: Show a => ParsecParser a -> ParsecParser () #

(Parsing m, Monad m) => Parsing (IdentityT m) # 
Instance details

Defined in Distribution.Compat.Parsing

Methods

try :: IdentityT m a -> IdentityT m a #

(<?>) :: IdentityT m a -> String -> IdentityT m a #

skipMany :: IdentityT m a -> IdentityT m () #

skipSome :: IdentityT m a -> IdentityT m () #

unexpected :: String -> IdentityT m a #

eof :: IdentityT m () #

notFollowedBy :: Show a => IdentityT m a -> IdentityT m () #

(Parsing m, MonadPlus m) => Parsing (StateT s m) # 
Instance details

Defined in Distribution.Compat.Parsing

Methods

try :: StateT s m a -> StateT s m a #

(<?>) :: StateT s m a -> String -> StateT s m a #

skipMany :: StateT s m a -> StateT s m () #

skipSome :: StateT s m a -> StateT s m () #

unexpected :: String -> StateT s m a #

eof :: StateT s m () #

notFollowedBy :: Show a => StateT s m a -> StateT s m () #

(Parsing m, MonadPlus m) => Parsing (StateT s m) # 
Instance details

Defined in Distribution.Compat.Parsing

Methods

try :: StateT s m a -> StateT s m a #

(<?>) :: StateT s m a -> String -> StateT s m a #

skipMany :: StateT s m a -> StateT s m () #

skipSome :: StateT s m a -> StateT s m () #

unexpected :: String -> StateT s m a #

eof :: StateT s m () #

notFollowedBy :: Show a => StateT s m a -> StateT s m () #

(Parsing m, MonadPlus m, Monoid w) => Parsing (WriterT w m) # 
Instance details

Defined in Distribution.Compat.Parsing

Methods

try :: WriterT w m a -> WriterT w m a #

(<?>) :: WriterT w m a -> String -> WriterT w m a #

skipMany :: WriterT w m a -> WriterT w m () #

skipSome :: WriterT w m a -> WriterT w m () #

unexpected :: String -> WriterT w m a #

eof :: WriterT w m () #

notFollowedBy :: Show a => WriterT w m a -> WriterT w m () #

(Parsing m, MonadPlus m, Monoid w) => Parsing (WriterT w m) # 
Instance details

Defined in Distribution.Compat.Parsing

Methods

try :: WriterT w m a -> WriterT w m a #

(<?>) :: WriterT w m a -> String -> WriterT w m a #

skipMany :: WriterT w m a -> WriterT w m () #

skipSome :: WriterT w m a -> WriterT w m () #

unexpected :: String -> WriterT w m a #

eof :: WriterT w m () #

notFollowedBy :: Show a => WriterT w m a -> WriterT w m () #

t ~ Char => Parsing (Parser r t) # 
Instance details

Defined in Distribution.Compat.Parsing

Methods

try :: Parser r t a -> Parser r t a #

(<?>) :: Parser r t a -> String -> Parser r t a #

skipMany :: Parser r t a -> Parser r t () #

skipSome :: Parser r t a -> Parser r t () #

unexpected :: String -> Parser r t a #

eof :: Parser r t () #

notFollowedBy :: Show a => Parser r t a -> Parser r t () #

(Parsing m, MonadPlus m) => Parsing (ReaderT e m) # 
Instance details

Defined in Distribution.Compat.Parsing

Methods

try :: ReaderT e m a -> ReaderT e m a #

(<?>) :: ReaderT e m a -> String -> ReaderT e m a #

skipMany :: ReaderT e m a -> ReaderT e m () #

skipSome :: ReaderT e m a -> ReaderT e m () #

unexpected :: String -> ReaderT e m a #

eof :: ReaderT e m () #

notFollowedBy :: Show a => ReaderT e m a -> ReaderT e m () #

(Stream s m t, Show t) => Parsing (ParsecT s u m) # 
Instance details

Defined in Distribution.Compat.Parsing

Methods

try :: ParsecT s u m a -> ParsecT s u m a #

(<?>) :: ParsecT s u m a -> String -> ParsecT s u m a #

skipMany :: ParsecT s u m a -> ParsecT s u m () #

skipSome :: ParsecT s u m a -> ParsecT s u m () #

unexpected :: String -> ParsecT s u m a #

eof :: ParsecT s u m () #

notFollowedBy :: Show a => ParsecT s u m a -> ParsecT s u m () #

(Parsing m, MonadPlus m, Monoid w) => Parsing (RWST r w s m) # 
Instance details

Defined in Distribution.Compat.Parsing

Methods

try :: RWST r w s m a -> RWST r w s m a #

(<?>) :: RWST r w s m a -> String -> RWST r w s m a #

skipMany :: RWST r w s m a -> RWST r w s m () #

skipSome :: RWST r w s m a -> RWST r w s m () #

unexpected :: String -> RWST r w s m a #

eof :: RWST r w s m () #

notFollowedBy :: Show a => RWST r w s m a -> RWST r w s m () #

(Parsing m, MonadPlus m, Monoid w) => Parsing (RWST r w s m) # 
Instance details

Defined in Distribution.Compat.Parsing

Methods

try :: RWST r w s m a -> RWST r w s m a #

(<?>) :: RWST r w s m a -> String -> RWST r w s m a #

skipMany :: RWST r w s m a -> RWST r w s m () #

skipSome :: RWST r w s m a -> RWST r w s m () #

unexpected :: String -> RWST r w s m a #

eof :: RWST r w s m () #

notFollowedBy :: Show a => RWST r w s m a -> RWST r w s m () #

diff --git a/doc/API/Cabal/Distribution-Compat-Prelude-Internal.html b/doc/API/Cabal/Distribution-Compat-Prelude-Internal.html new file mode 100644 # file too large to diff: doc/API/Cabal/Distribution-Compat-Prelude-Internal.html diff --git a/doc/API/Cabal/Distribution-Compat-ReadP.html b/doc/API/Cabal/Distribution-Compat-ReadP.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compat-ReadP.html @@ -0,0 +1,38 @@ +Distribution.Compat.ReadP

Cabal-2.4.0.1: A framework for packaging Haskell software

Copyright(c) The University of Glasgow 2002
LicenseBSD-style (see the file libraries/base/LICENSE)
Maintainerlibraries@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Compat.ReadP

Contents

Description

This is a library of parser combinators, originally written by Koen Claessen. + It parses all alternatives in parallel, so it never keeps hold of + the beginning of the input string, a common source of space leaks with + other parsers. The '(+++)' choice combinator is genuinely commutative; + it makes no difference which branch is "shorter".

See also Koen's paper Parallel Parsing Processes + (http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.19.9217).

This version of ReadP has been locally hacked to make it H98, by + Martin Sjögren mailto:msjogren@gmail.com

The unit tests have been moved to UnitTest.Distribution.Compat.ReadP, by + Mark Lentczner mailto:mark@glyphic.com

Synopsis

The ReadP type

type ReadP r a = Parser r Char a #

Primitive operations

get :: ReadP r Char #

Consumes and returns the next character. + Fails if there is no input left.

look :: ReadP r String #

Look-ahead: returns the part of the input that is left, without + consuming it.

(+++) :: ReadP r a -> ReadP r a -> ReadP r a infixr 5 #

Symmetric choice.

(<++) :: ReadP a a -> ReadP r a -> ReadP r a infixr 5 #

Local, exclusive, left-biased choice: If left parser + locally produces any result at all, then right parser is + not used.

gather :: ReadP (String -> P Char r) a -> ReadP r (String, a) #

Transforms a parser into one that does the same, but + in addition returns the exact characters read. + IMPORTANT NOTE: gather gives a runtime error if its first argument + is built using any occurrences of readS_to_P.

Other operations

pfail :: ReadP r a #

Always fails.

eof :: ReadP r () #

Succeeds iff we are at the end of input

satisfy :: (Char -> Bool) -> ReadP r Char #

Consumes and returns the next character, if it satisfies the + specified predicate.

char :: Char -> ReadP r Char #

Parses and returns the specified character.

string :: String -> ReadP r String #

Parses and returns the specified string.

munch :: (Char -> Bool) -> ReadP r String #

Parses the first zero or more characters satisfying the predicate.

munch1 :: (Char -> Bool) -> ReadP r String #

Parses the first one or more characters satisfying the predicate.

skipSpaces :: ReadP r () #

Skips all whitespace.

skipSpaces1 :: ReadP r () #

Like skipSpaces but succeeds only if there is at least one + whitespace character to skip.

choice :: [ReadP r a] -> ReadP r a #

Combines all parsers in the specified list.

count :: Int -> ReadP r a -> ReadP r [a] #

count n p parses n occurrences of p in sequence. A list of + results is returned.

between :: ReadP r open -> ReadP r close -> ReadP r a -> ReadP r a #

between open close p parses open, followed by p and finally + close. Only the value of p is returned.

option :: a -> ReadP r a -> ReadP r a #

option x p will either parse p or return x without consuming + any input.

optional :: ReadP r a -> ReadP r () #

optional p optionally parses p and always returns ().

many :: ReadP r a -> ReadP r [a] #

Parses zero or more occurrences of the given parser.

many1 :: ReadP r a -> ReadP r [a] #

Parses one or more occurrences of the given parser.

skipMany :: ReadP r a -> ReadP r () #

Like many, but discards the result.

skipMany1 :: ReadP r a -> ReadP r () #

Like many1, but discards the result.

sepBy :: ReadP r a -> ReadP r sep -> ReadP r [a] #

sepBy p sep parses zero or more occurrences of p, separated by sep. + Returns a list of values returned by p.

sepBy1 :: ReadP r a -> ReadP r sep -> ReadP r [a] #

sepBy1 p sep parses one or more occurrences of p, separated by sep. + Returns a list of values returned by p.

endBy :: ReadP r a -> ReadP r sep -> ReadP r [a] #

endBy p sep parses zero or more occurrences of p, separated and ended + by sep.

endBy1 :: ReadP r a -> ReadP r sep -> ReadP r [a] #

endBy p sep parses one or more occurrences of p, separated and ended + by sep.

chainr :: ReadP r a -> ReadP r (a -> a -> a) -> a -> ReadP r a #

chainr p op x parses zero or more occurrences of p, separated by op. + Returns a value produced by a right associative application of all + functions returned by op. If there are no occurrences of p, x is + returned.

chainl :: ReadP r a -> ReadP r (a -> a -> a) -> a -> ReadP r a #

chainl p op x parses zero or more occurrences of p, separated by op. + Returns a value produced by a left associative application of all + functions returned by op. If there are no occurrences of p, x is + returned.

chainl1 :: ReadP r a -> ReadP r (a -> a -> a) -> ReadP r a #

Like chainl, but parses one or more occurrences of p.

chainr1 :: ReadP r a -> ReadP r (a -> a -> a) -> ReadP r a #

Like chainr, but parses one or more occurrences of p.

manyTill :: ReadP r a -> ReadP [a] end -> ReadP r [a] #

manyTill p end parses zero or more occurrences of p, until end + succeeds. Returns a list of values returned by p.

Running a parser

type ReadS a = String -> [(a, String)] #

A parser for a type a, represented as a function that takes a + String and returns a list of possible parses as (a,String) pairs.

Note that this kind of backtracking parser is very inefficient; + reading a large structure may be quite slow (cf ReadP).

readP_to_S :: ReadP a a -> ReadS a #

Converts a parser into a Haskell ReadS-style function. + This is the main way in which you can "run" a ReadP parser: + the expanded type is + readP_to_S :: ReadP a -> String -> [(a,String)]

readS_to_P :: ReadS a -> ReadP r a #

Converts a Haskell ReadS-style function into a parser. + Warning: This introduces local backtracking in the resulting + parser, and therefore a possible inefficiency.

Internal

data Parser r s a #

Instances
Monad (Parser r s) # 
Instance details

Defined in Distribution.Compat.ReadP

Methods

(>>=) :: Parser r s a -> (a -> Parser r s b) -> Parser r s b #

(>>) :: Parser r s a -> Parser r s b -> Parser r s b #

return :: a -> Parser r s a #

fail :: String -> Parser r s a #

Functor (Parser r s) # 
Instance details

Defined in Distribution.Compat.ReadP

Methods

fmap :: (a -> b) -> Parser r s a -> Parser r s b #

(<$) :: a -> Parser r s b -> Parser r s a #

MonadFail (Parser r s) # 
Instance details

Defined in Distribution.Compat.ReadP

Methods

fail :: String -> Parser r s a #

Applicative (Parser r s) # 
Instance details

Defined in Distribution.Compat.ReadP

Methods

pure :: a -> Parser r s a #

(<*>) :: Parser r s (a -> b) -> Parser r s a -> Parser r s b #

liftA2 :: (a -> b -> c) -> Parser r s a -> Parser r s b -> Parser r s c #

(*>) :: Parser r s a -> Parser r s b -> Parser r s b #

(<*) :: Parser r s a -> Parser r s b -> Parser r s a #

s ~ Char => Alternative (Parser r s) # 
Instance details

Defined in Distribution.Compat.ReadP

Methods

empty :: Parser r s a #

(<|>) :: Parser r s a -> Parser r s a -> Parser r s a #

some :: Parser r s a -> Parser r s [a] #

many :: Parser r s a -> Parser r s [a] #

s ~ Char => MonadPlus (Parser r s) # 
Instance details

Defined in Distribution.Compat.ReadP

Methods

mzero :: Parser r s a #

mplus :: Parser r s a -> Parser r s a -> Parser r s a #

t ~ Char => Parsing (Parser r t) # 
Instance details

Defined in Distribution.Compat.Parsing

Methods

try :: Parser r t a -> Parser r t a #

(<?>) :: Parser r t a -> String -> Parser r t a #

skipMany :: Parser r t a -> Parser r t () #

skipSome :: Parser r t a -> Parser r t () #

unexpected :: String -> Parser r t a #

eof :: Parser r t () #

notFollowedBy :: Show a => Parser r t a -> Parser r t () #

t ~ Char => CharParsing (Parser r t) # 
Instance details

Defined in Distribution.Compat.CharParsing

Methods

satisfy :: (Char -> Bool) -> Parser r t Char #

char :: Char -> Parser r t Char #

notChar :: Char -> Parser r t Char #

anyChar :: Parser r t Char #

string :: String -> Parser r t String #

text :: Text -> Parser r t Text #

t ~ Char => CabalParsing (Parser r t) # 
Instance details

Defined in Distribution.Parsec.Class

Methods

parsecWarning :: PWarnType -> String -> Parser r t () #

parsecHaskellString :: Parser r t String #

askCabalSpecVersion :: Parser r t CabalSpecVersion #

diff --git a/doc/API/Cabal/Distribution-Compat-Semigroup.html b/doc/API/Cabal/Distribution-Compat-Semigroup.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compat-Semigroup.html @@ -0,0 +1,42 @@ +Distribution.Compat.Semigroup

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Compat.Semigroup

Description

Compatibility layer for Data.Semigroup

Synopsis

Documentation

class Semigroup a where #

The class of semigroups (types with an associative binary operation).

Instances should satisfy the associativity law:

Since: base-4.9.0.0

Minimal complete definition

(<>)

Methods

(<>) :: a -> a -> a infixr 6 #

An associative operation.

Instances
Semigroup Ordering

Since: base-4.9.0.0

Instance details

Defined in GHC.Base

Methods

(<>) :: Ordering -> Ordering -> Ordering #

sconcat :: NonEmpty Ordering -> Ordering #

stimes :: Integral b => b -> Ordering -> Ordering #

Semigroup ()

Since: base-4.9.0.0

Instance details

Defined in GHC.Base

Methods

(<>) :: () -> () -> () #

sconcat :: NonEmpty () -> () #

stimes :: Integral b => b -> () -> () #

Semigroup Void

Since: base-4.9.0.0

Instance details

Defined in Data.Void

Methods

(<>) :: Void -> Void -> Void #

sconcat :: NonEmpty Void -> Void #

stimes :: Integral b => b -> Void -> Void #

Semigroup All

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup.Internal

Methods

(<>) :: All -> All -> All #

sconcat :: NonEmpty All -> All #

stimes :: Integral b => b -> All -> All #

Semigroup Any

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup.Internal

Methods

(<>) :: Any -> Any -> Any #

sconcat :: NonEmpty Any -> Any #

stimes :: Integral b => b -> Any -> Any #

Semigroup ShortByteString 
Instance details

Defined in Data.ByteString.Short.Internal

Methods

(<>) :: ShortByteString -> ShortByteString -> ShortByteString #

sconcat :: NonEmpty ShortByteString -> ShortByteString #

stimes :: Integral b => b -> ShortByteString -> ShortByteString #

Semigroup ByteString 
Instance details

Defined in Data.ByteString.Lazy.Internal

Methods

(<>) :: ByteString -> ByteString -> ByteString #

sconcat :: NonEmpty ByteString -> ByteString #

stimes :: Integral b => b -> ByteString -> ByteString #

Semigroup ByteString 
Instance details

Defined in Data.ByteString.Internal

Methods

(<>) :: ByteString -> ByteString -> ByteString #

sconcat :: NonEmpty ByteString -> ByteString #

stimes :: Integral b => b -> ByteString -> ByteString #

Semigroup Builder 
Instance details

Defined in Data.ByteString.Builder.Internal

Methods

(<>) :: Builder -> Builder -> Builder #

sconcat :: NonEmpty Builder -> Builder #

stimes :: Integral b => b -> Builder -> Builder #

Semigroup IntSet

Since: containers-0.5.7

Instance details

Defined in Data.IntSet.Internal

Methods

(<>) :: IntSet -> IntSet -> IntSet #

sconcat :: NonEmpty IntSet -> IntSet #

stimes :: Integral b => b -> IntSet -> IntSet #

Semigroup Doc 
Instance details

Defined in Text.PrettyPrint.HughesPJ

Methods

(<>) :: Doc -> Doc -> Doc #

sconcat :: NonEmpty Doc -> Doc #

stimes :: Integral b => b -> Doc -> Doc #

Semigroup CDialect # 
Instance details

Defined in Distribution.Simple.CCompiler

Methods

(<>) :: CDialect -> CDialect -> CDialect #

sconcat :: NonEmpty CDialect -> CDialect #

stimes :: Integral b => b -> CDialect -> CDialect #

Semigroup ShortText # 
Instance details

Defined in Distribution.Utils.ShortText

Methods

(<>) :: ShortText -> ShortText -> ShortText #

sconcat :: NonEmpty ShortText -> ShortText #

stimes :: Integral b => b -> ShortText -> ShortText #

Semigroup ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

(<>) :: ForeignLibType -> ForeignLibType -> ForeignLibType #

sconcat :: NonEmpty ForeignLibType -> ForeignLibType #

stimes :: Integral b => b -> ForeignLibType -> ForeignLibType #

Semigroup ExecutableScope #

Any like semigroup, where ExecutablePrivate is 'Any True'

Instance details

Defined in Distribution.Types.ExecutableScope

Methods

(<>) :: ExecutableScope -> ExecutableScope -> ExecutableScope #

sconcat :: NonEmpty ExecutableScope -> ExecutableScope #

stimes :: Integral b => b -> ExecutableScope -> ExecutableScope #

Semigroup TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

(<>) :: TestSuiteInterface -> TestSuiteInterface -> TestSuiteInterface #

sconcat :: NonEmpty TestSuiteInterface -> TestSuiteInterface #

stimes :: Integral b => b -> TestSuiteInterface -> TestSuiteInterface #

Semigroup BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

(<>) :: BenchmarkInterface -> BenchmarkInterface -> BenchmarkInterface #

sconcat :: NonEmpty BenchmarkInterface -> BenchmarkInterface #

stimes :: Integral b => b -> BenchmarkInterface -> BenchmarkInterface #

Semigroup UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

(<>) :: UnqualComponentName -> UnqualComponentName -> UnqualComponentName #

sconcat :: NonEmpty UnqualComponentName -> UnqualComponentName #

stimes :: Integral b => b -> UnqualComponentName -> UnqualComponentName #

Semigroup SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

(<>) :: SetupBuildInfo -> SetupBuildInfo -> SetupBuildInfo #

sconcat :: NonEmpty SetupBuildInfo -> SetupBuildInfo #

stimes :: Integral b => b -> SetupBuildInfo -> SetupBuildInfo #

Semigroup DependencyMap # 
Instance details

Defined in Distribution.Types.DependencyMap

Methods

(<>) :: DependencyMap -> DependencyMap -> DependencyMap #

sconcat :: NonEmpty DependencyMap -> DependencyMap #

stimes :: Integral b => b -> DependencyMap -> DependencyMap #

Semigroup BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

(<>) :: BuildInfo -> BuildInfo -> BuildInfo #

sconcat :: NonEmpty BuildInfo -> BuildInfo #

stimes :: Integral b => b -> BuildInfo -> BuildInfo #

Semigroup TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

(<>) :: TestSuite -> TestSuite -> TestSuite #

sconcat :: NonEmpty TestSuite -> TestSuite #

stimes :: Integral b => b -> TestSuite -> TestSuite #

Semigroup Library # 
Instance details

Defined in Distribution.Types.Library

Methods

(<>) :: Library -> Library -> Library #

sconcat :: NonEmpty Library -> Library #

stimes :: Integral b => b -> Library -> Library #

Semigroup ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

(<>) :: ForeignLib -> ForeignLib -> ForeignLib #

sconcat :: NonEmpty ForeignLib -> ForeignLib #

stimes :: Integral b => b -> ForeignLib -> ForeignLib #

Semigroup Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

(<>) :: Executable -> Executable -> Executable #

sconcat :: NonEmpty Executable -> Executable #

stimes :: Integral b => b -> Executable -> Executable #

Semigroup Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

(<>) :: Benchmark -> Benchmark -> Benchmark #

sconcat :: NonEmpty Benchmark -> Benchmark #

stimes :: Integral b => b -> Benchmark -> Benchmark #

Semigroup Component # 
Instance details

Defined in Distribution.Types.Component

Methods

(<>) :: Component -> Component -> Component #

sconcat :: NonEmpty Component -> Component #

stimes :: Integral b => b -> Component -> Component #

Semigroup FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(<>) :: FlagAssignment -> FlagAssignment -> FlagAssignment #

sconcat :: NonEmpty FlagAssignment -> FlagAssignment #

stimes :: Integral b => b -> FlagAssignment -> FlagAssignment #

Semigroup GhcOptions # 
Instance details

Defined in Distribution.Simple.Program.GHC

Methods

(<>) :: GhcOptions -> GhcOptions -> GhcOptions #

sconcat :: NonEmpty GhcOptions -> GhcOptions #

stimes :: Integral b => b -> GhcOptions -> GhcOptions #

Semigroup BenchmarkFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: BenchmarkFlags -> BenchmarkFlags -> BenchmarkFlags #

sconcat :: NonEmpty BenchmarkFlags -> BenchmarkFlags #

stimes :: Integral b => b -> BenchmarkFlags -> BenchmarkFlags #

Semigroup TestFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: TestFlags -> TestFlags -> TestFlags #

sconcat :: NonEmpty TestFlags -> TestFlags #

stimes :: Integral b => b -> TestFlags -> TestFlags #

Semigroup TestShowDetails # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: TestShowDetails -> TestShowDetails -> TestShowDetails #

sconcat :: NonEmpty TestShowDetails -> TestShowDetails #

stimes :: Integral b => b -> TestShowDetails -> TestShowDetails #

Semigroup ReplFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: ReplFlags -> ReplFlags -> ReplFlags #

sconcat :: NonEmpty ReplFlags -> ReplFlags #

stimes :: Integral b => b -> ReplFlags -> ReplFlags #

Semigroup BuildFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: BuildFlags -> BuildFlags -> BuildFlags #

sconcat :: NonEmpty BuildFlags -> BuildFlags #

stimes :: Integral b => b -> BuildFlags -> BuildFlags #

Semigroup CleanFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: CleanFlags -> CleanFlags -> CleanFlags #

sconcat :: NonEmpty CleanFlags -> CleanFlags #

stimes :: Integral b => b -> CleanFlags -> CleanFlags #

Semigroup HaddockFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: HaddockFlags -> HaddockFlags -> HaddockFlags #

sconcat :: NonEmpty HaddockFlags -> HaddockFlags #

stimes :: Integral b => b -> HaddockFlags -> HaddockFlags #

Semigroup DoctestFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: DoctestFlags -> DoctestFlags -> DoctestFlags #

sconcat :: NonEmpty DoctestFlags -> DoctestFlags #

stimes :: Integral b => b -> DoctestFlags -> DoctestFlags #

Semigroup HscolourFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: HscolourFlags -> HscolourFlags -> HscolourFlags #

sconcat :: NonEmpty HscolourFlags -> HscolourFlags #

stimes :: Integral b => b -> HscolourFlags -> HscolourFlags #

Semigroup RegisterFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: RegisterFlags -> RegisterFlags -> RegisterFlags #

sconcat :: NonEmpty RegisterFlags -> RegisterFlags #

stimes :: Integral b => b -> RegisterFlags -> RegisterFlags #

Semigroup SDistFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: SDistFlags -> SDistFlags -> SDistFlags #

sconcat :: NonEmpty SDistFlags -> SDistFlags #

stimes :: Integral b => b -> SDistFlags -> SDistFlags #

Semigroup InstallFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: InstallFlags -> InstallFlags -> InstallFlags #

sconcat :: NonEmpty InstallFlags -> InstallFlags #

stimes :: Integral b => b -> InstallFlags -> InstallFlags #

Semigroup CopyFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: CopyFlags -> CopyFlags -> CopyFlags #

sconcat :: NonEmpty CopyFlags -> CopyFlags #

stimes :: Integral b => b -> CopyFlags -> CopyFlags #

Semigroup ConfigFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: ConfigFlags -> ConfigFlags -> ConfigFlags #

sconcat :: NonEmpty ConfigFlags -> ConfigFlags #

stimes :: Integral b => b -> ConfigFlags -> ConfigFlags #

Semigroup GlobalFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: GlobalFlags -> GlobalFlags -> GlobalFlags #

sconcat :: NonEmpty GlobalFlags -> GlobalFlags #

stimes :: Integral b => b -> GlobalFlags -> GlobalFlags #

Semigroup [a]

Since: base-4.9.0.0

Instance details

Defined in GHC.Base

Methods

(<>) :: [a] -> [a] -> [a] #

sconcat :: NonEmpty [a] -> [a] #

stimes :: Integral b => b -> [a] -> [a] #

Semigroup a => Semigroup (Maybe a)

Since: base-4.9.0.0

Instance details

Defined in GHC.Base

Methods

(<>) :: Maybe a -> Maybe a -> Maybe a #

sconcat :: NonEmpty (Maybe a) -> Maybe a #

stimes :: Integral b => b -> Maybe a -> Maybe a #

Semigroup a => Semigroup (IO a)

Since: base-4.10.0.0

Instance details

Defined in GHC.Base

Methods

(<>) :: IO a -> IO a -> IO a #

sconcat :: NonEmpty (IO a) -> IO a #

stimes :: Integral b => b -> IO a -> IO a #

Ord a => Semigroup (Min a)

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup

Methods

(<>) :: Min a -> Min a -> Min a #

sconcat :: NonEmpty (Min a) -> Min a #

stimes :: Integral b => b -> Min a -> Min a #

Ord a => Semigroup (Max a)

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup

Methods

(<>) :: Max a -> Max a -> Max a #

sconcat :: NonEmpty (Max a) -> Max a #

stimes :: Integral b => b -> Max a -> Max a #

Semigroup (First a)

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup

Methods

(<>) :: First a -> First a -> First a #

sconcat :: NonEmpty (First a) -> First a #

stimes :: Integral b => b -> First a -> First a #

Semigroup (Last a)

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup

Methods

(<>) :: Last a -> Last a -> Last a #

sconcat :: NonEmpty (Last a) -> Last a #

stimes :: Integral b => b -> Last a -> Last a #

Monoid m => Semigroup (WrappedMonoid m)

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup

Methods

(<>) :: WrappedMonoid m -> WrappedMonoid m -> WrappedMonoid m #

sconcat :: NonEmpty (WrappedMonoid m) -> WrappedMonoid m #

stimes :: Integral b => b -> WrappedMonoid m -> WrappedMonoid m #

Semigroup a => Semigroup (Option a)

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup

Methods

(<>) :: Option a -> Option a -> Option a #

sconcat :: NonEmpty (Option a) -> Option a #

stimes :: Integral b => b -> Option a -> Option a #

Semigroup a => Semigroup (Identity a) 
Instance details

Defined in Data.Functor.Identity

Methods

(<>) :: Identity a -> Identity a -> Identity a #

sconcat :: NonEmpty (Identity a) -> Identity a #

stimes :: Integral b => b -> Identity a -> Identity a #

Semigroup (First a)

Since: base-4.9.0.0

Instance details

Defined in Data.Monoid

Methods

(<>) :: First a -> First a -> First a #

sconcat :: NonEmpty (First a) -> First a #

stimes :: Integral b => b -> First a -> First a #

Semigroup (Last a)

Since: base-4.9.0.0

Instance details

Defined in Data.Monoid

Methods

(<>) :: Last a -> Last a -> Last a #

sconcat :: NonEmpty (Last a) -> Last a #

stimes :: Integral b => b -> Last a -> Last a #

Semigroup a => Semigroup (Dual a)

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup.Internal

Methods

(<>) :: Dual a -> Dual a -> Dual a #

sconcat :: NonEmpty (Dual a) -> Dual a #

stimes :: Integral b => b -> Dual a -> Dual a #

Semigroup (Endo a)

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup.Internal

Methods

(<>) :: Endo a -> Endo a -> Endo a #

sconcat :: NonEmpty (Endo a) -> Endo a #

stimes :: Integral b => b -> Endo a -> Endo a #

Num a => Semigroup (Sum a)

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup.Internal

Methods

(<>) :: Sum a -> Sum a -> Sum a #

sconcat :: NonEmpty (Sum a) -> Sum a #

stimes :: Integral b => b -> Sum a -> Sum a #

Num a => Semigroup (Product a)

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup.Internal

Methods

(<>) :: Product a -> Product a -> Product a #

sconcat :: NonEmpty (Product a) -> Product a #

stimes :: Integral b => b -> Product a -> Product a #

Semigroup a => Semigroup (Down a)

Since: base-4.11.0.0

Instance details

Defined in Data.Ord

Methods

(<>) :: Down a -> Down a -> Down a #

sconcat :: NonEmpty (Down a) -> Down a #

stimes :: Integral b => b -> Down a -> Down a #

Semigroup (NonEmpty a)

Since: base-4.9.0.0

Instance details

Defined in GHC.Base

Methods

(<>) :: NonEmpty a -> NonEmpty a -> NonEmpty a #

sconcat :: NonEmpty (NonEmpty a) -> NonEmpty a #

stimes :: Integral b => b -> NonEmpty a -> NonEmpty a #

Semigroup (PutM ()) 
Instance details

Defined in Data.Binary.Put

Methods

(<>) :: PutM () -> PutM () -> PutM () #

sconcat :: NonEmpty (PutM ()) -> PutM () #

stimes :: Integral b => b -> PutM () -> PutM () #

Semigroup (IntMap a)

Since: containers-0.5.7

Instance details

Defined in Data.IntMap.Internal

Methods

(<>) :: IntMap a -> IntMap a -> IntMap a #

sconcat :: NonEmpty (IntMap a) -> IntMap a #

stimes :: Integral b => b -> IntMap a -> IntMap a #

Semigroup (Seq a)

Since: containers-0.5.7

Instance details

Defined in Data.Sequence.Internal

Methods

(<>) :: Seq a -> Seq a -> Seq a #

sconcat :: NonEmpty (Seq a) -> Seq a #

stimes :: Integral b => b -> Seq a -> Seq a #

Ord a => Semigroup (Set a)

Since: containers-0.5.7

Instance details

Defined in Data.Set.Internal

Methods

(<>) :: Set a -> Set a -> Set a #

sconcat :: NonEmpty (Set a) -> Set a #

stimes :: Integral b => b -> Set a -> Set a #

Semigroup (Doc a) 
Instance details

Defined in Text.PrettyPrint.Annotated.HughesPJ

Methods

(<>) :: Doc a -> Doc a -> Doc a #

sconcat :: NonEmpty (Doc a) -> Doc a #

stimes :: Integral b => b -> Doc a -> Doc a #

Semigroup (MergeSet a) 
Instance details

Defined in Data.Set.Internal

Methods

(<>) :: MergeSet a -> MergeSet a -> MergeSet a #

sconcat :: NonEmpty (MergeSet a) -> MergeSet a #

stimes :: Integral b => b -> MergeSet a -> MergeSet a #

Semigroup (Last' a) # 
Instance details

Defined in Distribution.Compat.Semigroup

Methods

(<>) :: Last' a -> Last' a -> Last' a #

sconcat :: NonEmpty (Last' a) -> Last' a #

stimes :: Integral b => b -> Last' a -> Last' a #

Semigroup (DList a) # 
Instance details

Defined in Distribution.Compat.DList

Methods

(<>) :: DList a -> DList a -> DList a #

sconcat :: NonEmpty (DList a) -> DList a #

stimes :: Integral b => b -> DList a -> DList a #

Semigroup (Flag a) # 
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 #

Semigroup (Condition a) # 
Instance details

Defined in Distribution.Types.Condition

Methods

(<>) :: Condition a -> Condition a -> Condition a #

sconcat :: NonEmpty (Condition a) -> Condition a #

stimes :: Integral b => b -> Condition a -> Condition a #

Semigroup dir => Semigroup (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

(<>) :: InstallDirs dir -> InstallDirs dir -> InstallDirs dir #

sconcat :: NonEmpty (InstallDirs dir) -> InstallDirs dir #

stimes :: Integral b => b -> InstallDirs dir -> InstallDirs dir #

Ord a => Semigroup (NubListR a) # 
Instance details

Defined in Distribution.Utils.NubList

Methods

(<>) :: NubListR a -> NubListR a -> NubListR a #

sconcat :: NonEmpty (NubListR a) -> NubListR a #

stimes :: Integral b => b -> NubListR a -> NubListR a #

Ord a => Semigroup (NubList a) # 
Instance details

Defined in Distribution.Utils.NubList

Methods

(<>) :: NubList a -> NubList a -> NubList a #

sconcat :: NonEmpty (NubList a) -> NubList a #

stimes :: Integral b => b -> NubList a -> NubList a #

Semigroup (PackageIndex InstalledPackageInfo) # 
Instance details

Defined in Distribution.Simple.PackageIndex

Methods

(<>) :: PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo #

sconcat :: NonEmpty (PackageIndex InstalledPackageInfo) -> PackageIndex InstalledPackageInfo #

stimes :: Integral b => b -> PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo #

Semigroup b => Semigroup (a -> b)

Since: base-4.9.0.0

Instance details

Defined in GHC.Base

Methods

(<>) :: (a -> b) -> (a -> b) -> a -> b #

sconcat :: NonEmpty (a -> b) -> a -> b #

stimes :: Integral b0 => b0 -> (a -> b) -> a -> b #

Semigroup (Either a b)

Since: base-4.9.0.0

Instance details

Defined in Data.Either

Methods

(<>) :: Either a b -> Either a b -> Either a b #

sconcat :: NonEmpty (Either a b) -> Either a b #

stimes :: Integral b0 => b0 -> Either a b -> Either a b #

(Semigroup a, Semigroup b) => Semigroup (a, b)

Since: base-4.9.0.0

Instance details

Defined in GHC.Base

Methods

(<>) :: (a, b) -> (a, b) -> (a, b) #

sconcat :: NonEmpty (a, b) -> (a, b) #

stimes :: Integral b0 => b0 -> (a, b) -> (a, b) #

Semigroup a => Semigroup (ST s a)

Since: base-4.11.0.0

Instance details

Defined in GHC.ST

Methods

(<>) :: ST s a -> ST s a -> ST s a #

sconcat :: NonEmpty (ST s a) -> ST s a #

stimes :: Integral b => b -> ST s a -> ST s a #

Semigroup (Proxy s)

Since: base-4.9.0.0

Instance details

Defined in Data.Proxy

Methods

(<>) :: Proxy s -> Proxy s -> Proxy s #

sconcat :: NonEmpty (Proxy s) -> Proxy s #

stimes :: Integral b => b -> Proxy s -> Proxy s #

Ord k => Semigroup (Map k v) 
Instance details

Defined in Data.Map.Internal

Methods

(<>) :: Map k v -> Map k v -> Map k v #

sconcat :: NonEmpty (Map k v) -> Map k v #

stimes :: Integral b => b -> Map k v -> Map k v #

(Semigroup a, Semigroup b, Semigroup c) => Semigroup (a, b, c)

Since: base-4.9.0.0

Instance details

Defined in GHC.Base

Methods

(<>) :: (a, b, c) -> (a, b, c) -> (a, b, c) #

sconcat :: NonEmpty (a, b, c) -> (a, b, c) #

stimes :: Integral b0 => b0 -> (a, b, c) -> (a, b, c) #

Semigroup a => Semigroup (Const a b) 
Instance details

Defined in Data.Functor.Const

Methods

(<>) :: Const a b -> Const a b -> Const a b #

sconcat :: NonEmpty (Const a b) -> Const a b #

stimes :: Integral b0 => b0 -> Const a b -> Const a b #

Alternative f => Semigroup (Alt f a)

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup.Internal

Methods

(<>) :: Alt f a -> Alt f a -> Alt f a #

sconcat :: NonEmpty (Alt f a) -> Alt f a #

stimes :: Integral b => b -> Alt f a -> Alt f a #

(Semigroup a, Semigroup b, Semigroup c, Semigroup d) => Semigroup (a, b, c, d)

Since: base-4.9.0.0

Instance details

Defined in GHC.Base

Methods

(<>) :: (a, b, c, d) -> (a, b, c, d) -> (a, b, c, d) #

sconcat :: NonEmpty (a, b, c, d) -> (a, b, c, d) #

stimes :: Integral b0 => b0 -> (a, b, c, d) -> (a, b, c, d) #

Semigroup a => Semigroup (ParsecT s u m a)

The Semigroup instance for ParsecT is used to append the result + of several parsers, for example:

(many $ char a) <> (many $ char b)
+

The above will parse a string like "aabbb" and return a successful + parse result "aabbb". Compare against the below which will + produce a result of "bbb" for the same input:

(many $ char a) >> (many $ char b)
+(many $ char a) *> (many $ char b)
+

Since: parsec-3.1.12

Instance details

Defined in Text.Parsec.Prim

Methods

(<>) :: ParsecT s u m a -> ParsecT s u m a -> ParsecT s u m a #

sconcat :: NonEmpty (ParsecT s u m a) -> ParsecT s u m a #

stimes :: Integral b => b -> ParsecT s u m a -> ParsecT s u m a #

(Semigroup a, Semigroup b, Semigroup c, Semigroup d, Semigroup e) => Semigroup (a, b, c, d, e)

Since: base-4.9.0.0

Instance details

Defined in GHC.Base

Methods

(<>) :: (a, b, c, d, e) -> (a, b, c, d, e) -> (a, b, c, d, e) #

sconcat :: NonEmpty (a, b, c, d, e) -> (a, b, c, d, e) #

stimes :: Integral b0 => b0 -> (a, b, c, d, e) -> (a, b, c, d, e) #

class Semigroup a => Monoid a where #

The class of monoids (types with an associative binary operation that + has an identity). Instances should satisfy the following laws:

The method names refer to the monoid of lists under concatenation, + but there are many other instances.

Some types can be viewed as a monoid in more than one way, + e.g. both addition and multiplication on numbers. + In such cases we often define newtypes and make those instances + of Monoid, e.g. Sum and Product.

NOTE: Semigroup is a superclass of Monoid since base-4.11.0.0.

Minimal complete definition

mempty

Methods

mempty :: a #

Identity of mappend

mappend :: a -> a -> a #

An associative operation

NOTE: This method is redundant and has the default + implementation mappend = '(<>)' since base-4.11.0.0.

mconcat :: [a] -> a #

Fold a list using the monoid.

For most types, the default definition for mconcat will be + used, but the function is included in the class definition so + that an optimized version can be provided for specific types.

Instances
Monoid Ordering

Since: base-2.1

Instance details

Defined in GHC.Base

Methods

mempty :: Ordering #

mappend :: Ordering -> Ordering -> Ordering #

mconcat :: [Ordering] -> Ordering #

Monoid ()

Since: base-2.1

Instance details

Defined in GHC.Base

Methods

mempty :: () #

mappend :: () -> () -> () #

mconcat :: [()] -> () #

Monoid All

Since: base-2.1

Instance details

Defined in Data.Semigroup.Internal

Methods

mempty :: All #

mappend :: All -> All -> All #

mconcat :: [All] -> All #

Monoid Any

Since: base-2.1

Instance details

Defined in Data.Semigroup.Internal

Methods

mempty :: Any #

mappend :: Any -> Any -> Any #

mconcat :: [Any] -> Any #

Monoid ShortByteString 
Instance details

Defined in Data.ByteString.Short.Internal

Methods

mempty :: ShortByteString #

mappend :: ShortByteString -> ShortByteString -> ShortByteString #

mconcat :: [ShortByteString] -> ShortByteString #

Monoid ByteString 
Instance details

Defined in Data.ByteString.Lazy.Internal

Methods

mempty :: ByteString #

mappend :: ByteString -> ByteString -> ByteString #

mconcat :: [ByteString] -> ByteString #

Monoid ByteString 
Instance details

Defined in Data.ByteString.Internal

Methods

mempty :: ByteString #

mappend :: ByteString -> ByteString -> ByteString #

mconcat :: [ByteString] -> ByteString #

Monoid Builder 
Instance details

Defined in Data.ByteString.Builder.Internal

Methods

mempty :: Builder #

mappend :: Builder -> Builder -> Builder #

mconcat :: [Builder] -> Builder #

Monoid IntSet 
Instance details

Defined in Data.IntSet.Internal

Methods

mempty :: IntSet #

mappend :: IntSet -> IntSet -> IntSet #

mconcat :: [IntSet] -> IntSet #

Monoid Doc 
Instance details

Defined in Text.PrettyPrint.HughesPJ

Methods

mempty :: Doc #

mappend :: Doc -> Doc -> Doc #

mconcat :: [Doc] -> Doc #

Monoid CDialect # 
Instance details

Defined in Distribution.Simple.CCompiler

Methods

mempty :: CDialect #

mappend :: CDialect -> CDialect -> CDialect #

mconcat :: [CDialect] -> CDialect #

Monoid ShortText # 
Instance details

Defined in Distribution.Utils.ShortText

Methods

mempty :: ShortText #

mappend :: ShortText -> ShortText -> ShortText #

mconcat :: [ShortText] -> ShortText #

Monoid ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

mempty :: ForeignLibType #

mappend :: ForeignLibType -> ForeignLibType -> ForeignLibType #

mconcat :: [ForeignLibType] -> ForeignLibType #

Monoid ExecutableScope #

mempty = ExecutablePublic

Instance details

Defined in Distribution.Types.ExecutableScope

Methods

mempty :: ExecutableScope #

mappend :: ExecutableScope -> ExecutableScope -> ExecutableScope #

mconcat :: [ExecutableScope] -> ExecutableScope #

Monoid TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

mempty :: TestSuiteInterface #

mappend :: TestSuiteInterface -> TestSuiteInterface -> TestSuiteInterface #

mconcat :: [TestSuiteInterface] -> TestSuiteInterface #

Monoid BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

mempty :: BenchmarkInterface #

mappend :: BenchmarkInterface -> BenchmarkInterface -> BenchmarkInterface #

mconcat :: [BenchmarkInterface] -> BenchmarkInterface #

Monoid UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

mempty :: UnqualComponentName #

mappend :: UnqualComponentName -> UnqualComponentName -> UnqualComponentName #

mconcat :: [UnqualComponentName] -> UnqualComponentName #

Monoid SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

mempty :: SetupBuildInfo #

mappend :: SetupBuildInfo -> SetupBuildInfo -> SetupBuildInfo #

mconcat :: [SetupBuildInfo] -> SetupBuildInfo #

Monoid DependencyMap # 
Instance details

Defined in Distribution.Types.DependencyMap

Methods

mempty :: DependencyMap #

mappend :: DependencyMap -> DependencyMap -> DependencyMap #

mconcat :: [DependencyMap] -> DependencyMap #

Monoid BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

mempty :: BuildInfo #

mappend :: BuildInfo -> BuildInfo -> BuildInfo #

mconcat :: [BuildInfo] -> BuildInfo #

Monoid TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

mempty :: TestSuite #

mappend :: TestSuite -> TestSuite -> TestSuite #

mconcat :: [TestSuite] -> TestSuite #

Monoid Library # 
Instance details

Defined in Distribution.Types.Library

Methods

mempty :: Library #

mappend :: Library -> Library -> Library #

mconcat :: [Library] -> Library #

Monoid ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

mempty :: ForeignLib #

mappend :: ForeignLib -> ForeignLib -> ForeignLib #

mconcat :: [ForeignLib] -> ForeignLib #

Monoid Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

mempty :: Executable #

mappend :: Executable -> Executable -> Executable #

mconcat :: [Executable] -> Executable #

Monoid Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

mempty :: Benchmark #

mappend :: Benchmark -> Benchmark -> Benchmark #

mconcat :: [Benchmark] -> Benchmark #

Monoid FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

mempty :: FlagAssignment #

mappend :: FlagAssignment -> FlagAssignment -> FlagAssignment #

mconcat :: [FlagAssignment] -> FlagAssignment #

Monoid GhcOptions # 
Instance details

Defined in Distribution.Simple.Program.GHC

Methods

mempty :: GhcOptions #

mappend :: GhcOptions -> GhcOptions -> GhcOptions #

mconcat :: [GhcOptions] -> GhcOptions #

Monoid BenchmarkFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: BenchmarkFlags #

mappend :: BenchmarkFlags -> BenchmarkFlags -> BenchmarkFlags #

mconcat :: [BenchmarkFlags] -> BenchmarkFlags #

Monoid TestFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: TestFlags #

mappend :: TestFlags -> TestFlags -> TestFlags #

mconcat :: [TestFlags] -> TestFlags #

Monoid TestShowDetails # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: TestShowDetails #

mappend :: TestShowDetails -> TestShowDetails -> TestShowDetails #

mconcat :: [TestShowDetails] -> TestShowDetails #

Monoid ReplFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: ReplFlags #

mappend :: ReplFlags -> ReplFlags -> ReplFlags #

mconcat :: [ReplFlags] -> ReplFlags #

Monoid BuildFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: BuildFlags #

mappend :: BuildFlags -> BuildFlags -> BuildFlags #

mconcat :: [BuildFlags] -> BuildFlags #

Monoid CleanFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: CleanFlags #

mappend :: CleanFlags -> CleanFlags -> CleanFlags #

mconcat :: [CleanFlags] -> CleanFlags #

Monoid HaddockFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: HaddockFlags #

mappend :: HaddockFlags -> HaddockFlags -> HaddockFlags #

mconcat :: [HaddockFlags] -> HaddockFlags #

Monoid DoctestFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: DoctestFlags #

mappend :: DoctestFlags -> DoctestFlags -> DoctestFlags #

mconcat :: [DoctestFlags] -> DoctestFlags #

Monoid HscolourFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: HscolourFlags #

mappend :: HscolourFlags -> HscolourFlags -> HscolourFlags #

mconcat :: [HscolourFlags] -> HscolourFlags #

Monoid RegisterFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: RegisterFlags #

mappend :: RegisterFlags -> RegisterFlags -> RegisterFlags #

mconcat :: [RegisterFlags] -> RegisterFlags #

Monoid SDistFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: SDistFlags #

mappend :: SDistFlags -> SDistFlags -> SDistFlags #

mconcat :: [SDistFlags] -> SDistFlags #

Monoid InstallFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: InstallFlags #

mappend :: InstallFlags -> InstallFlags -> InstallFlags #

mconcat :: [InstallFlags] -> InstallFlags #

Monoid CopyFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: CopyFlags #

mappend :: CopyFlags -> CopyFlags -> CopyFlags #

mconcat :: [CopyFlags] -> CopyFlags #

Monoid ConfigFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: ConfigFlags #

mappend :: ConfigFlags -> ConfigFlags -> ConfigFlags #

mconcat :: [ConfigFlags] -> ConfigFlags #

Monoid GlobalFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: GlobalFlags #

mappend :: GlobalFlags -> GlobalFlags -> GlobalFlags #

mconcat :: [GlobalFlags] -> GlobalFlags #

Monoid [a]

Since: base-2.1

Instance details

Defined in GHC.Base

Methods

mempty :: [a] #

mappend :: [a] -> [a] -> [a] #

mconcat :: [[a]] -> [a] #

Semigroup a => Monoid (Maybe a)

Lift a semigroup into Maybe forming a Monoid according to + http://en.wikipedia.org/wiki/Monoid: "Any semigroup S may be + turned into a monoid simply by adjoining an element e not in S + and defining e*e = e and e*s = s = s*e for all s ∈ S."

Since 4.11.0: constraint on inner a value generalised from + Monoid to Semigroup.

Since: base-2.1

Instance details

Defined in GHC.Base

Methods

mempty :: Maybe a #

mappend :: Maybe a -> Maybe a -> Maybe a #

mconcat :: [Maybe a] -> Maybe a #

Monoid a => Monoid (IO a)

Since: base-4.9.0.0

Instance details

Defined in GHC.Base

Methods

mempty :: IO a #

mappend :: IO a -> IO a -> IO a #

mconcat :: [IO a] -> IO a #

(Ord a, Bounded a) => Monoid (Min a)

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup

Methods

mempty :: Min a #

mappend :: Min a -> Min a -> Min a #

mconcat :: [Min a] -> Min a #

(Ord a, Bounded a) => Monoid (Max a)

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup

Methods

mempty :: Max a #

mappend :: Max a -> Max a -> Max a #

mconcat :: [Max a] -> Max a #

Monoid m => Monoid (WrappedMonoid m)

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup

Methods

mempty :: WrappedMonoid m #

mappend :: WrappedMonoid m -> WrappedMonoid m -> WrappedMonoid m #

mconcat :: [WrappedMonoid m] -> WrappedMonoid m #

Semigroup a => Monoid (Option a)

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup

Methods

mempty :: Option a #

mappend :: Option a -> Option a -> Option a #

mconcat :: [Option a] -> Option a #

Monoid a => Monoid (Identity a) 
Instance details

Defined in Data.Functor.Identity

Methods

mempty :: Identity a #

mappend :: Identity a -> Identity a -> Identity a #

mconcat :: [Identity a] -> Identity a #

Monoid (First a)

Since: base-2.1

Instance details

Defined in Data.Monoid

Methods

mempty :: First a #

mappend :: First a -> First a -> First a #

mconcat :: [First a] -> First a #

Monoid (Last a)

Since: base-2.1

Instance details

Defined in Data.Monoid

Methods

mempty :: Last a #

mappend :: Last a -> Last a -> Last a #

mconcat :: [Last a] -> Last a #

Monoid a => Monoid (Dual a)

Since: base-2.1

Instance details

Defined in Data.Semigroup.Internal

Methods

mempty :: Dual a #

mappend :: Dual a -> Dual a -> Dual a #

mconcat :: [Dual a] -> Dual a #

Monoid (Endo a)

Since: base-2.1

Instance details

Defined in Data.Semigroup.Internal

Methods

mempty :: Endo a #

mappend :: Endo a -> Endo a -> Endo a #

mconcat :: [Endo a] -> Endo a #

Num a => Monoid (Sum a)

Since: base-2.1

Instance details

Defined in Data.Semigroup.Internal

Methods

mempty :: Sum a #

mappend :: Sum a -> Sum a -> Sum a #

mconcat :: [Sum a] -> Sum a #

Num a => Monoid (Product a)

Since: base-2.1

Instance details

Defined in Data.Semigroup.Internal

Methods

mempty :: Product a #

mappend :: Product a -> Product a -> Product a #

mconcat :: [Product a] -> Product a #

Monoid a => Monoid (Down a)

Since: base-4.11.0.0

Instance details

Defined in Data.Ord

Methods

mempty :: Down a #

mappend :: Down a -> Down a -> Down a #

mconcat :: [Down a] -> Down a #

Monoid (PutM ()) 
Instance details

Defined in Data.Binary.Put

Methods

mempty :: PutM () #

mappend :: PutM () -> PutM () -> PutM () #

mconcat :: [PutM ()] -> PutM () #

Monoid (IntMap a) 
Instance details

Defined in Data.IntMap.Internal

Methods

mempty :: IntMap a #

mappend :: IntMap a -> IntMap a -> IntMap a #

mconcat :: [IntMap a] -> IntMap a #

Monoid (Seq a) 
Instance details

Defined in Data.Sequence.Internal

Methods

mempty :: Seq a #

mappend :: Seq a -> Seq a -> Seq a #

mconcat :: [Seq a] -> Seq a #

Ord a => Monoid (Set a) 
Instance details

Defined in Data.Set.Internal

Methods

mempty :: Set a #

mappend :: Set a -> Set a -> Set a #

mconcat :: [Set a] -> Set a #

Monoid (Doc a) 
Instance details

Defined in Text.PrettyPrint.Annotated.HughesPJ

Methods

mempty :: Doc a #

mappend :: Doc a -> Doc a -> Doc a #

mconcat :: [Doc a] -> Doc a #

Monoid (MergeSet a) 
Instance details

Defined in Data.Set.Internal

Methods

mempty :: MergeSet a #

mappend :: MergeSet a -> MergeSet a -> MergeSet a #

mconcat :: [MergeSet a] -> MergeSet a #

Monoid (Last' a) # 
Instance details

Defined in Distribution.Compat.Semigroup

Methods

mempty :: Last' a #

mappend :: Last' a -> Last' a -> Last' a #

mconcat :: [Last' a] -> Last' a #

Monoid (DList a) # 
Instance details

Defined in Distribution.Compat.DList

Methods

mempty :: DList a #

mappend :: DList a -> DList a -> DList a #

mconcat :: [DList a] -> DList a #

Monoid (Flag a) # 
Instance details

Defined in Distribution.Simple.Flag

Methods

mempty :: Flag a #

mappend :: Flag a -> Flag a -> Flag a #

mconcat :: [Flag a] -> Flag a #

Monoid (Condition a) # 
Instance details

Defined in Distribution.Types.Condition

Methods

mempty :: Condition a #

mappend :: Condition a -> Condition a -> Condition a #

mconcat :: [Condition a] -> Condition a #

(Semigroup dir, Monoid dir) => Monoid (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

mempty :: InstallDirs dir #

mappend :: InstallDirs dir -> InstallDirs dir -> InstallDirs dir #

mconcat :: [InstallDirs dir] -> InstallDirs dir #

Ord a => Monoid (NubListR a) # 
Instance details

Defined in Distribution.Utils.NubList

Methods

mempty :: NubListR a #

mappend :: NubListR a -> NubListR a -> NubListR a #

mconcat :: [NubListR a] -> NubListR a #

Ord a => Monoid (NubList a) #

Monoid operations on NubLists. + For a valid Monoid instance we need to satistfy the required monoid laws; + identity, associativity and closure.

Identity : by inspection: + mempty mappend NubList xs == NubList xs mappend mempty

Associativity : by inspection: + (NubList xs mappend NubList ys) mappend NubList zs + == NubList xs mappend (NubList ys mappend NubList zs)

Closure : appending two lists of type a and removing duplicates obviously + does not change the type.

Instance details

Defined in Distribution.Utils.NubList

Methods

mempty :: NubList a #

mappend :: NubList a -> NubList a -> NubList a #

mconcat :: [NubList a] -> NubList a #

Monoid (PackageIndex InstalledPackageInfo) # 
Instance details

Defined in Distribution.Simple.PackageIndex

Methods

mempty :: PackageIndex InstalledPackageInfo #

mappend :: PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo #

mconcat :: [PackageIndex InstalledPackageInfo] -> PackageIndex InstalledPackageInfo #

Monoid b => Monoid (a -> b)

Since: base-2.1

Instance details

Defined in GHC.Base

Methods

mempty :: a -> b #

mappend :: (a -> b) -> (a -> b) -> a -> b #

mconcat :: [a -> b] -> a -> b #

(Monoid a, Monoid b) => Monoid (a, b)

Since: base-2.1

Instance details

Defined in GHC.Base

Methods

mempty :: (a, b) #

mappend :: (a, b) -> (a, b) -> (a, b) #

mconcat :: [(a, b)] -> (a, b) #

Monoid a => Monoid (ST s a)

Since: base-4.11.0.0

Instance details

Defined in GHC.ST

Methods

mempty :: ST s a #

mappend :: ST s a -> ST s a -> ST s a #

mconcat :: [ST s a] -> ST s a #

Monoid (Proxy s)

Since: base-4.7.0.0

Instance details

Defined in Data.Proxy

Methods

mempty :: Proxy s #

mappend :: Proxy s -> Proxy s -> Proxy s #

mconcat :: [Proxy s] -> Proxy s #

Ord k => Monoid (Map k v) 
Instance details

Defined in Data.Map.Internal

Methods

mempty :: Map k v #

mappend :: Map k v -> Map k v -> Map k v #

mconcat :: [Map k v] -> Map k v #

(Monoid a, Monoid b, Monoid c) => Monoid (a, b, c)

Since: base-2.1

Instance details

Defined in GHC.Base

Methods

mempty :: (a, b, c) #

mappend :: (a, b, c) -> (a, b, c) -> (a, b, c) #

mconcat :: [(a, b, c)] -> (a, b, c) #

Monoid a => Monoid (Const a b) 
Instance details

Defined in Data.Functor.Const

Methods

mempty :: Const a b #

mappend :: Const a b -> Const a b -> Const a b #

mconcat :: [Const a b] -> Const a b #

Alternative f => Monoid (Alt f a)

Since: base-4.8.0.0

Instance details

Defined in Data.Semigroup.Internal

Methods

mempty :: Alt f a #

mappend :: Alt f a -> Alt f a -> Alt f a #

mconcat :: [Alt f a] -> Alt f a #

(Monoid a, Monoid b, Monoid c, Monoid d) => Monoid (a, b, c, d)

Since: base-2.1

Instance details

Defined in GHC.Base

Methods

mempty :: (a, b, c, d) #

mappend :: (a, b, c, d) -> (a, b, c, d) -> (a, b, c, d) #

mconcat :: [(a, b, c, d)] -> (a, b, c, d) #

(Monoid a, Semigroup (ParsecT s u m a)) => Monoid (ParsecT s u m a)

The Monoid instance for ParsecT is used for the same purposes as + the Semigroup instance.

Since: parsec-3.1.12

Instance details

Defined in Text.Parsec.Prim

Methods

mempty :: ParsecT s u m a #

mappend :: ParsecT s u m a -> ParsecT s u m a -> ParsecT s u m a #

mconcat :: [ParsecT s u m a] -> ParsecT s u m a #

(Monoid a, Monoid b, Monoid c, Monoid d, Monoid e) => Monoid (a, b, c, d, e)

Since: base-2.1

Instance details

Defined in GHC.Base

Methods

mempty :: (a, b, c, d, e) #

mappend :: (a, b, c, d, e) -> (a, b, c, d, e) -> (a, b, c, d, e) #

mconcat :: [(a, b, c, d, e)] -> (a, b, c, d, e) #

newtype All #

Boolean monoid under conjunction (&&).

>>> getAll (All True <> mempty <> All False)
+False
+
>>> getAll (mconcat (map (\x -> All (even x)) [2,4,6,7,8]))
+False
+

Constructors

All 

Fields

Instances
Bounded All 
Instance details

Defined in Data.Semigroup.Internal

Methods

minBound :: All #

maxBound :: All #

Eq All 
Instance details

Defined in Data.Semigroup.Internal

Methods

(==) :: All -> All -> Bool #

(/=) :: All -> All -> Bool #

Data All

Since: base-4.8.0.0

Instance details

Defined in Data.Data

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> All -> c All #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c All #

toConstr :: All -> Constr #

dataTypeOf :: All -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c All) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c All) #

gmapT :: (forall b. Data b => b -> b) -> All -> All #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> All -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> All -> r #

gmapQ :: (forall d. Data d => d -> u) -> All -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> All -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> All -> m All #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> All -> m All #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> All -> m All #

Ord All 
Instance details

Defined in Data.Semigroup.Internal

Methods

compare :: All -> All -> Ordering #

(<) :: All -> All -> Bool #

(<=) :: All -> All -> Bool #

(>) :: All -> All -> Bool #

(>=) :: All -> All -> Bool #

max :: All -> All -> All #

min :: All -> All -> All #

Read All 
Instance details

Defined in Data.Semigroup.Internal

Methods

readsPrec :: Int -> ReadS All #

readList :: ReadS [All] #

readPrec :: ReadPrec All #

readListPrec :: ReadPrec [All] #

Show All 
Instance details

Defined in Data.Semigroup.Internal

Methods

showsPrec :: Int -> All -> ShowS #

show :: All -> String #

showList :: [All] -> ShowS #

Generic All 
Instance details

Defined in Data.Semigroup.Internal

Associated Types

type Rep All :: * -> * #

Methods

from :: All -> Rep All x #

to :: Rep All x -> All #

Semigroup All

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup.Internal

Methods

(<>) :: All -> All -> All #

sconcat :: NonEmpty All -> All #

stimes :: Integral b => b -> All -> All #

Monoid All

Since: base-2.1

Instance details

Defined in Data.Semigroup.Internal

Methods

mempty :: All #

mappend :: All -> All -> All #

mconcat :: [All] -> All #

Binary All

Since: 0.8.4.0

Instance details

Defined in Data.Binary.Class

Methods

put :: All -> Put #

get :: Get All #

putList :: [All] -> Put #

NFData All

Since: deepseq-1.4.0.0

Instance details

Defined in Control.DeepSeq

Methods

rnf :: All -> () #

type Rep All 
Instance details

Defined in Data.Semigroup.Internal

type Rep All = D1 (MetaData "All" "Data.Semigroup.Internal" "base" True) (C1 (MetaCons "All" PrefixI True) (S1 (MetaSel (Just "getAll") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))

newtype Any #

Boolean monoid under disjunction (||).

>>> getAny (Any True <> mempty <> Any False)
+True
+
>>> getAny (mconcat (map (\x -> Any (even x)) [2,4,6,7,8]))
+True
+

Constructors

Any 

Fields

Instances
Bounded Any 
Instance details

Defined in Data.Semigroup.Internal

Methods

minBound :: Any #

maxBound :: Any #

Eq Any 
Instance details

Defined in Data.Semigroup.Internal

Methods

(==) :: Any -> Any -> Bool #

(/=) :: Any -> Any -> Bool #

Data Any

Since: base-4.8.0.0

Instance details

Defined in Data.Data

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Any -> c Any #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Any #

toConstr :: Any -> Constr #

dataTypeOf :: Any -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Any) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Any) #

gmapT :: (forall b. Data b => b -> b) -> Any -> Any #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Any -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Any -> r #

gmapQ :: (forall d. Data d => d -> u) -> Any -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Any -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Any -> m Any #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Any -> m Any #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Any -> m Any #

Ord Any 
Instance details

Defined in Data.Semigroup.Internal

Methods

compare :: Any -> Any -> Ordering #

(<) :: Any -> Any -> Bool #

(<=) :: Any -> Any -> Bool #

(>) :: Any -> Any -> Bool #

(>=) :: Any -> Any -> Bool #

max :: Any -> Any -> Any #

min :: Any -> Any -> Any #

Read Any 
Instance details

Defined in Data.Semigroup.Internal

Methods

readsPrec :: Int -> ReadS Any #

readList :: ReadS [Any] #

readPrec :: ReadPrec Any #

readListPrec :: ReadPrec [Any] #

Show Any 
Instance details

Defined in Data.Semigroup.Internal

Methods

showsPrec :: Int -> Any -> ShowS #

show :: Any -> String #

showList :: [Any] -> ShowS #

Generic Any 
Instance details

Defined in Data.Semigroup.Internal

Associated Types

type Rep Any :: * -> * #

Methods

from :: Any -> Rep Any x #

to :: Rep Any x -> Any #

Semigroup Any

Since: base-4.9.0.0

Instance details

Defined in Data.Semigroup.Internal

Methods

(<>) :: Any -> Any -> Any #

sconcat :: NonEmpty Any -> Any #

stimes :: Integral b => b -> Any -> Any #

Monoid Any

Since: base-2.1

Instance details

Defined in Data.Semigroup.Internal

Methods

mempty :: Any #

mappend :: Any -> Any -> Any #

mconcat :: [Any] -> Any #

Binary Any

Since: 0.8.4.0

Instance details

Defined in Data.Binary.Class

Methods

put :: Any -> Put #

get :: Get Any #

putList :: [Any] -> Put #

NFData Any

Since: deepseq-1.4.0.0

Instance details

Defined in Control.DeepSeq

Methods

rnf :: Any -> () #

type Rep Any 
Instance details

Defined in Data.Semigroup.Internal

type Rep Any = D1 (MetaData "Any" "Data.Semigroup.Internal" "base" True) (C1 (MetaCons "Any" PrefixI True) (S1 (MetaSel (Just "getAny") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))

newtype Last' a #

Cabal's own Last copy to avoid requiring an orphan + Binary instance.

Once the oldest binary version we support provides a Binary + instance for Last we can remove this one here.

NB: Last is defined differently and not a Monoid

Constructors

Last' 

Fields

Instances
Functor Last' # 
Instance details

Defined in Distribution.Compat.Semigroup

Methods

fmap :: (a -> b) -> Last' a -> Last' b #

(<$) :: a -> Last' b -> Last' a #

Applicative Last' # 
Instance details

Defined in Distribution.Compat.Semigroup

Methods

pure :: a -> Last' a #

(<*>) :: Last' (a -> b) -> Last' a -> Last' b #

liftA2 :: (a -> b -> c) -> Last' a -> Last' b -> Last' c #

(*>) :: Last' a -> Last' b -> Last' b #

(<*) :: Last' a -> Last' b -> Last' a #

Eq a => Eq (Last' a) # 
Instance details

Defined in Distribution.Compat.Semigroup

Methods

(==) :: Last' a -> Last' a -> Bool #

(/=) :: Last' a -> Last' a -> Bool #

Ord a => Ord (Last' a) # 
Instance details

Defined in Distribution.Compat.Semigroup

Methods

compare :: Last' a -> Last' a -> Ordering #

(<) :: Last' a -> Last' a -> Bool #

(<=) :: Last' a -> Last' a -> Bool #

(>) :: Last' a -> Last' a -> Bool #

(>=) :: Last' a -> Last' a -> Bool #

max :: Last' a -> Last' a -> Last' a #

min :: Last' a -> Last' a -> Last' a #

Read a => Read (Last' a) # 
Instance details

Defined in Distribution.Compat.Semigroup

Methods

readsPrec :: Int -> ReadS (Last' a) #

readList :: ReadS [Last' a] #

readPrec :: ReadPrec (Last' a) #

readListPrec :: ReadPrec [Last' a] #

Show a => Show (Last' a) # 
Instance details

Defined in Distribution.Compat.Semigroup

Methods

showsPrec :: Int -> Last' a -> ShowS #

show :: Last' a -> String #

showList :: [Last' a] -> ShowS #

Generic (Last' a) # 
Instance details

Defined in Distribution.Compat.Semigroup

Associated Types

type Rep (Last' a) :: * -> * #

Methods

from :: Last' a -> Rep (Last' a) x #

to :: Rep (Last' a) x -> Last' a #

Semigroup (Last' a) # 
Instance details

Defined in Distribution.Compat.Semigroup

Methods

(<>) :: Last' a -> Last' a -> Last' a #

sconcat :: NonEmpty (Last' a) -> Last' a #

stimes :: Integral b => b -> Last' a -> Last' a #

Monoid (Last' a) # 
Instance details

Defined in Distribution.Compat.Semigroup

Methods

mempty :: Last' a #

mappend :: Last' a -> Last' a -> Last' a #

mconcat :: [Last' a] -> Last' a #

Binary a => Binary (Last' a) # 
Instance details

Defined in Distribution.Compat.Semigroup

Methods

put :: Last' a -> Put #

get :: Get (Last' a) #

putList :: [Last' a] -> Put #

type Rep (Last' a) # 
Instance details

Defined in Distribution.Compat.Semigroup

type Rep (Last' a) = D1 (MetaData "Last'" "Distribution.Compat.Semigroup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "Last'" PrefixI True) (S1 (MetaSel (Just "getLast'") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe a))))

gmappend :: (Generic a, GSemigroup (Rep a)) => a -> a -> a #

Generically generate a Semigroup (<>) operation for any type + implementing Generic. This operation will append two values + by point-wise appending their component fields. It is only defined + for product types.

gmappend a (gmappend b c) = gmappend (gmappend a b) c
+

gmempty :: (Generic a, GMonoid (Rep a)) => a #

Generically generate a Monoid mempty for any product-like type + implementing Generic.

It is only defined for product types.

gmappend gmempty a = a = gmappend a gmempty
+
diff --git a/doc/API/Cabal/Distribution-Compat-Stack.html b/doc/API/Cabal/Distribution-Compat-Stack.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compat-Stack.html @@ -0,0 +1,41 @@ +Distribution.Compat.Stack

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellSafe
LanguageHaskell2010

Distribution.Compat.Stack

Synopsis

Documentation

type WithCallStack a = HasCallStack => a #

data CallStack #

CallStacks are a lightweight method of obtaining a + partial call-stack at any point in the program.

A function can request its call-site with the HasCallStack constraint. + For example, we can define

putStrLnWithCallStack :: HasCallStack => String -> IO ()
+

as a variant of putStrLn that will get its call-site and print it, + along with the string given as argument. We can access the + call-stack inside putStrLnWithCallStack with callStack.

putStrLnWithCallStack :: HasCallStack => String -> IO ()
+putStrLnWithCallStack msg = do
+  putStrLn msg
+  putStrLn (prettyCallStack callStack)
+

Thus, if we call putStrLnWithCallStack we will get a formatted call-stack + alongside our string.

>>> putStrLnWithCallStack "hello"
+hello
+CallStack (from HasCallStack):
+  putStrLnWithCallStack, called at <interactive>:2:1 in interactive:Ghci1
+

GHC solves HasCallStack constraints in three steps:

  1. If there is a CallStack in scope -- i.e. the enclosing function + has a HasCallStack constraint -- GHC will append the new + call-site to the existing CallStack.
  2. If there is no CallStack in scope -- e.g. in the GHCi session + above -- and the enclosing definition does not have an explicit + type signature, GHC will infer a HasCallStack constraint for the + enclosing definition (subject to the monomorphism restriction).
  3. If there is no CallStack in scope and the enclosing definition + has an explicit type signature, GHC will solve the HasCallStack + constraint for the singleton CallStack containing just the + current call-site.

CallStacks do not interact with the RTS and do not require compilation + with -prof. On the other hand, as they are built up explicitly via the + HasCallStack constraints, they will generally not contain as much + information as the simulated call-stacks maintained by the RTS.

A CallStack is a [(String, SrcLoc)]. The String is the name of + function that was called, the SrcLoc is the call-site. The list is + ordered with the most recently called function at the head.

NOTE: The intrepid user may notice that HasCallStack is just an + alias for an implicit parameter ?callStack :: CallStack. This is an + implementation detail and should not be considered part of the + CallStack API, we may decide to change the implementation in the + future.

Since: base-4.8.1.0

Instances
IsList CallStack

Be aware that 'fromList . toList = id' only for unfrozen CallStacks, + since toList removes frozenness information.

Since: base-4.9.0.0

Instance details

Defined in GHC.Exts

Associated Types

type Item CallStack :: * #

Methods

fromList :: [Item CallStack] -> CallStack #

fromListN :: Int -> [Item CallStack] -> CallStack #

toList :: CallStack -> [Item CallStack] #

Show CallStack

Since: base-4.9.0.0

Instance details

Defined in GHC.Show

Methods

showsPrec :: Int -> CallStack -> ShowS #

show :: CallStack -> String #

showList :: [CallStack] -> ShowS #

NFData CallStack

Since: deepseq-1.4.2.0

Instance details

Defined in Control.DeepSeq

Methods

rnf :: CallStack -> () #

type Item CallStack 
Instance details

Defined in GHC.Exts

type Item CallStack = (String, SrcLoc)

annotateCallStackIO :: WithCallStack (IO a -> IO a) #

This function is for when you *really* want to add a call + stack to raised IO, but you don't have a + Verbosity so you can't use + annotateIO. If you have a Verbosity, + please use that function instead.

withFrozenCallStack :: HasCallStack => (HasCallStack -> a) -> a #

Perform some computation without adding new entries to the CallStack.

Since: base-4.9.0.0

withLexicalCallStack :: (a -> WithCallStack (IO b)) -> WithCallStack (a -> IO b) #

callStack :: HasCallStack -> CallStack #

Return the current CallStack.

Does *not* include the call-site of callStack.

Since: base-4.9.0.0

prettyCallStack :: CallStack -> String #

Pretty print a CallStack.

Since: base-4.9.0.0

parentSrcLocPrefix :: WithCallStack String #

Give the *parent* of the person who invoked this; + so it's most suitable for being called from a utility function. + You probably want to call this using withFrozenCallStack; otherwise + it's not very useful. We didn't implement this for base-4.8.1 + because we cannot rely on freezing to have taken place.

diff --git a/doc/API/Cabal/Distribution-Compat-Time.html b/doc/API/Cabal/Distribution-Compat-Time.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compat-Time.html @@ -0,0 +1,9 @@ +Distribution.Compat.Time

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Compat.Time

Synopsis

Documentation

newtype ModTime #

An opaque type representing a file's modification time, represented + internally as a 64-bit unsigned integer in the Windows UTC format.

Constructors

ModTime Word64 
Instances
Bounded ModTime # 
Instance details

Defined in Distribution.Compat.Time

Methods

minBound :: ModTime #

maxBound :: ModTime #

Eq ModTime # 
Instance details

Defined in Distribution.Compat.Time

Methods

(==) :: ModTime -> ModTime -> Bool #

(/=) :: ModTime -> ModTime -> Bool #

Ord ModTime # 
Instance details

Defined in Distribution.Compat.Time

Methods

compare :: ModTime -> ModTime -> Ordering #

(<) :: ModTime -> ModTime -> Bool #

(<=) :: ModTime -> ModTime -> Bool #

(>) :: ModTime -> ModTime -> Bool #

(>=) :: ModTime -> ModTime -> Bool #

max :: ModTime -> ModTime -> ModTime #

min :: ModTime -> ModTime -> ModTime #

Read ModTime # 
Instance details

Defined in Distribution.Compat.Time

Methods

readsPrec :: Int -> ReadS ModTime #

readList :: ReadS [ModTime] #

readPrec :: ReadPrec ModTime #

readListPrec :: ReadPrec [ModTime] #

Show ModTime # 
Instance details

Defined in Distribution.Compat.Time

Methods

showsPrec :: Int -> ModTime -> ShowS #

show :: ModTime -> String #

showList :: [ModTime] -> ShowS #

Binary ModTime # 
Instance details

Defined in Distribution.Compat.Time

Methods

put :: ModTime -> Put #

get :: Get ModTime #

putList :: [ModTime] -> Put #

getModTime :: FilePath -> NoCallStackIO ModTime #

Return modification time of the given file. Works around the low clock + resolution problem that getModificationTime has on GHC < 7.8.

This is a modified version of the code originally written for Shake by Neil + Mitchell. See module Development.Shake.FileInfo.

getFileAge :: FilePath -> NoCallStackIO Double #

Return age of given file in days.

getCurTime :: NoCallStackIO ModTime #

Return the current time as ModTime.

posixSecondsToModTime :: Int64 -> ModTime #

Convert POSIX seconds to ModTime.

calibrateMtimeChangeDelay :: IO (Int, Int) #

Based on code written by Neil Mitchell for Shake. See + sleepFileTimeCalibrate in Type. Returns a pair + of microsecond values: first, the maximum delay seen, and the + recommended delay to use before testing for file modification change. + The returned delay is never smaller + than 10 ms, but never larger than 1 second.

diff --git a/doc/API/Cabal/Distribution-Compiler.html b/doc/API/Cabal/Distribution-Compiler.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compiler.html @@ -0,0 +1,22 @@ +Distribution.Compiler

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2004
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Compiler

Contents

Description

This has an enumeration of the various compilers that Cabal knows about. It + also specifies the default compiler. Sadly you'll often see code that does + case analysis on this compiler flavour enumeration like:

case compilerFlavor comp of
+  GHC -> GHC.getInstalledPackages verbosity packageDb progdb

Obviously it would be better to use the proper Compiler abstraction + because that would keep all the compiler-specific code together. + Unfortunately we cannot make this change yet without breaking the + UserHooks api, which would break all custom Setup.hs files, so for the + moment we just have to live with this deficiency. If you're interested, see + ticket #57.

Synopsis

Compiler flavor

data CompilerFlavor #

Constructors

GHC 
GHCJS 
NHC 
YHC 
Hugs 
HBC 
Helium 
JHC 
LHC 
UHC 
Eta 
HaskellSuite String 
OtherCompiler String 
Instances
Eq CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

(==) :: CompilerFlavor -> CompilerFlavor -> Bool #

(/=) :: CompilerFlavor -> CompilerFlavor -> Bool #

Data CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CompilerFlavor -> c CompilerFlavor #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CompilerFlavor #

toConstr :: CompilerFlavor -> Constr #

dataTypeOf :: CompilerFlavor -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CompilerFlavor) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CompilerFlavor) #

gmapT :: (forall b. Data b => b -> b) -> CompilerFlavor -> CompilerFlavor #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CompilerFlavor -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CompilerFlavor -> r #

gmapQ :: (forall d. Data d => d -> u) -> CompilerFlavor -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CompilerFlavor -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CompilerFlavor -> m CompilerFlavor #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CompilerFlavor -> m CompilerFlavor #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CompilerFlavor -> m CompilerFlavor #

Ord CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

compare :: CompilerFlavor -> CompilerFlavor -> Ordering #

(<) :: CompilerFlavor -> CompilerFlavor -> Bool #

(<=) :: CompilerFlavor -> CompilerFlavor -> Bool #

(>) :: CompilerFlavor -> CompilerFlavor -> Bool #

(>=) :: CompilerFlavor -> CompilerFlavor -> Bool #

max :: CompilerFlavor -> CompilerFlavor -> CompilerFlavor #

min :: CompilerFlavor -> CompilerFlavor -> CompilerFlavor #

Read CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

readsPrec :: Int -> ReadS CompilerFlavor #

readList :: ReadS [CompilerFlavor] #

readPrec :: ReadPrec CompilerFlavor #

readListPrec :: ReadPrec [CompilerFlavor] #

Show CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

showsPrec :: Int -> CompilerFlavor -> ShowS #

show :: CompilerFlavor -> String #

showList :: [CompilerFlavor] -> ShowS #

Generic CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Associated Types

type Rep CompilerFlavor :: * -> * #

Methods

from :: CompilerFlavor -> Rep CompilerFlavor x #

to :: Rep CompilerFlavor x -> CompilerFlavor #

Binary CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

put :: CompilerFlavor -> Put #

get :: Get CompilerFlavor #

putList :: [CompilerFlavor] -> Put #

NFData CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

rnf :: CompilerFlavor -> () #

Pretty CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

pretty :: CompilerFlavor -> Doc #

Parsec CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

parsec :: CabalParsing m => m CompilerFlavor #

Text CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

disp :: CompilerFlavor -> Doc #

parse :: ReadP r CompilerFlavor #

Newtype TestedWith (CompilerFlavor, VersionRange) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: (CompilerFlavor, VersionRange) -> TestedWith #

unpack :: TestedWith -> (CompilerFlavor, VersionRange) #

type Rep CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

type Rep CompilerFlavor = D1 (MetaData "CompilerFlavor" "Distribution.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (((C1 (MetaCons "GHC" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "GHCJS" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NHC" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "YHC" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Hugs" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "HBC" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Helium" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "JHC" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LHC" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "UHC" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Eta" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "HaskellSuite" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "OtherCompiler" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))))

buildCompilerId :: CompilerId #

buildCompilerFlavor :: CompilerFlavor #

defaultCompilerFlavor :: Maybe CompilerFlavor #

The default compiler flavour to pick when compiling stuff. This defaults + to the compiler used to build the Cabal lib.

However if it's not a recognised compiler then it's Nothing and the user + will have to specify which compiler they want.

parseCompilerFlavorCompat :: ReadP r CompilerFlavor #

Like classifyCompilerFlavor but compatible with the old ReadS parser.

It is compatible in the sense that it accepts only the same strings, + eg GHC but not "ghc". However other strings get mapped to OtherCompiler. + The point of this is that we do not allow extra valid values that would + upset older Cabal versions that had a stricter parser however we cope with + new values more gracefully so that we'll be able to introduce new value in + future without breaking things so much.

classifyCompilerFlavor :: String -> CompilerFlavor #

knownCompilerFlavors :: [CompilerFlavor] #

Compiler id

data CompilerId #

Constructors

CompilerId CompilerFlavor Version 
Instances
Eq CompilerId # 
Instance details

Defined in Distribution.Compiler

Methods

(==) :: CompilerId -> CompilerId -> Bool #

(/=) :: CompilerId -> CompilerId -> Bool #

Ord CompilerId # 
Instance details

Defined in Distribution.Compiler

Methods

compare :: CompilerId -> CompilerId -> Ordering #

(<) :: CompilerId -> CompilerId -> Bool #

(<=) :: CompilerId -> CompilerId -> Bool #

(>) :: CompilerId -> CompilerId -> Bool #

(>=) :: CompilerId -> CompilerId -> Bool #

max :: CompilerId -> CompilerId -> CompilerId #

min :: CompilerId -> CompilerId -> CompilerId #

Read CompilerId # 
Instance details

Defined in Distribution.Compiler

Methods

readsPrec :: Int -> ReadS CompilerId #

readList :: ReadS [CompilerId] #

readPrec :: ReadPrec CompilerId #

readListPrec :: ReadPrec [CompilerId] #

Show CompilerId # 
Instance details

Defined in Distribution.Compiler

Methods

showsPrec :: Int -> CompilerId -> ShowS #

show :: CompilerId -> String #

showList :: [CompilerId] -> ShowS #

Generic CompilerId # 
Instance details

Defined in Distribution.Compiler

Associated Types

type Rep CompilerId :: * -> * #

Methods

from :: CompilerId -> Rep CompilerId x #

to :: Rep CompilerId x -> CompilerId #

Binary CompilerId # 
Instance details

Defined in Distribution.Compiler

Methods

put :: CompilerId -> Put #

get :: Get CompilerId #

putList :: [CompilerId] -> Put #

NFData CompilerId # 
Instance details

Defined in Distribution.Compiler

Methods

rnf :: CompilerId -> () #

Text CompilerId # 
Instance details

Defined in Distribution.Compiler

Methods

disp :: CompilerId -> Doc #

parse :: ReadP r CompilerId #

type Rep CompilerId # 
Instance details

Defined in Distribution.Compiler

type Rep CompilerId = D1 (MetaData "CompilerId" "Distribution.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "CompilerId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CompilerFlavor) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)))

Compiler info

data CompilerInfo #

Compiler information used for resolving configurations. Some + fields can be set to Nothing to indicate that the information is + unknown.

Constructors

CompilerInfo 

Fields

Instances
Read CompilerInfo # 
Instance details

Defined in Distribution.Compiler

Methods

readsPrec :: Int -> ReadS CompilerInfo #

readList :: ReadS [CompilerInfo] #

readPrec :: ReadPrec CompilerInfo #

readListPrec :: ReadPrec [CompilerInfo] #

Show CompilerInfo # 
Instance details

Defined in Distribution.Compiler

Methods

showsPrec :: Int -> CompilerInfo -> ShowS #

show :: CompilerInfo -> String #

showList :: [CompilerInfo] -> ShowS #

Generic CompilerInfo # 
Instance details

Defined in Distribution.Compiler

Associated Types

type Rep CompilerInfo :: * -> * #

Methods

from :: CompilerInfo -> Rep CompilerInfo x #

to :: Rep CompilerInfo x -> CompilerInfo #

Binary CompilerInfo # 
Instance details

Defined in Distribution.Compiler

Methods

put :: CompilerInfo -> Put #

get :: Get CompilerInfo #

putList :: [CompilerInfo] -> Put #

type Rep CompilerInfo # 
Instance details

Defined in Distribution.Compiler

type Rep CompilerInfo = D1 (MetaData "CompilerInfo" "Distribution.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "CompilerInfo" PrefixI True) ((S1 (MetaSel (Just "compilerInfoId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CompilerId) :*: S1 (MetaSel (Just "compilerInfoAbiTag") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AbiTag)) :*: (S1 (MetaSel (Just "compilerInfoCompat") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [CompilerId])) :*: (S1 (MetaSel (Just "compilerInfoLanguages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Language])) :*: S1 (MetaSel (Just "compilerInfoExtensions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Extension]))))))

unknownCompilerInfo :: CompilerId -> AbiTag -> CompilerInfo #

Make a CompilerInfo of which only the known information is its CompilerId, + its AbiTag and that it does not claim to be compatible with other + compiler id's.

data AbiTag #

Constructors

NoAbiTag 
AbiTag String 
Instances
Eq AbiTag # 
Instance details

Defined in Distribution.Compiler

Methods

(==) :: AbiTag -> AbiTag -> Bool #

(/=) :: AbiTag -> AbiTag -> Bool #

Read AbiTag # 
Instance details

Defined in Distribution.Compiler

Methods

readsPrec :: Int -> ReadS AbiTag #

readList :: ReadS [AbiTag] #

readPrec :: ReadPrec AbiTag #

readListPrec :: ReadPrec [AbiTag] #

Show AbiTag # 
Instance details

Defined in Distribution.Compiler

Methods

showsPrec :: Int -> AbiTag -> ShowS #

show :: AbiTag -> String #

showList :: [AbiTag] -> ShowS #

Generic AbiTag # 
Instance details

Defined in Distribution.Compiler

Associated Types

type Rep AbiTag :: * -> * #

Methods

from :: AbiTag -> Rep AbiTag x #

to :: Rep AbiTag x -> AbiTag #

Binary AbiTag # 
Instance details

Defined in Distribution.Compiler

Methods

put :: AbiTag -> Put #

get :: Get AbiTag #

putList :: [AbiTag] -> Put #

Text AbiTag # 
Instance details

Defined in Distribution.Compiler

Methods

disp :: AbiTag -> Doc #

parse :: ReadP r AbiTag #

type Rep AbiTag # 
Instance details

Defined in Distribution.Compiler

type Rep AbiTag = D1 (MetaData "AbiTag" "Distribution.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "NoAbiTag" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "AbiTag" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))

abiTagString :: AbiTag -> String #

diff --git a/doc/API/Cabal/Distribution-FieldGrammar-Class.html b/doc/API/Cabal/Distribution-FieldGrammar-Class.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-FieldGrammar-Class.html @@ -0,0 +1,2 @@ +Distribution.FieldGrammar.Class

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.FieldGrammar.Class

Synopsis

Documentation

class FieldGrammar g where #

FieldGrammar is parametrised by

  • s which is a structure we are parsing. We need this to provide prettyprinter + functionality
  • a type of the field.

Note: We'd like to have forall s. Applicative (f s) context.

Minimal complete definition

blurFieldGrammar, uniqueFieldAla, booleanFieldDef, optionalFieldAla, optionalFieldDefAla, monoidalFieldAla, prefixedFields, knownField, hiddenField, deprecatedSince, availableSince

Methods

blurFieldGrammar :: ALens' a b -> g b c -> g a c #

Unfocus, zoom out, blur FieldGrammar.

uniqueFieldAla #

Arguments

:: (Parsec b, Pretty b, Newtype b a) 
=> FieldName

field name

-> (a -> b)

Newtype pack

-> ALens' s a

lens into the field

-> g s a 

Field which should be defined, exactly once.

booleanFieldDef #

Arguments

:: FieldName

field name

-> ALens' s Bool

lens into the field

-> Bool

default

-> g s Bool 

Boolean field with a default value.

optionalFieldAla #

Arguments

:: (Parsec b, Pretty b, Newtype b a) 
=> FieldName

field name

-> (a -> b)

pack

-> ALens' s (Maybe a)

lens into the field

-> g s (Maybe a) 

Optional field.

optionalFieldDefAla #

Arguments

:: (Parsec b, Pretty b, Newtype b a, Eq a) 
=> FieldName

field name

-> (a -> b)

Newtype pack

-> ALens' s a

Lens' s a: lens into the field

-> a

default value

-> g s a 

Optional field with default value.

monoidalFieldAla #

Arguments

:: (Parsec b, Pretty b, Monoid a, Newtype b a) 
=> FieldName

field name

-> (a -> b)

pack

-> ALens' s a

lens into the field

-> g s a 

Monoidal field.

Values are combined with mappend.

Note: optionalFieldAla is a monoidalField with Last monoid.

prefixedFields #

Arguments

:: FieldName

field name prefix

-> ALens' s [(String, String)]

lens into the field

-> g s [(String, String)] 

Parser matching all fields with a name starting with a prefix.

knownField :: FieldName -> g s () #

Known field, which we don't parse, neither pretty print.

hiddenField :: g s a -> g s a #

Field which is parsed but not pretty printed.

deprecatedSince #

Arguments

:: [Int]

version

-> String

deprecation message

-> g s a 
-> g s a 

Deprecated since

availableSince #

Arguments

:: [Int]

spec version

-> a

default value

-> g s a 
-> g s a 

Annotate field with since spec-version.

Instances
FieldGrammar PrettyFieldGrammar # 
Instance details

Defined in Distribution.FieldGrammar.Pretty

Methods

blurFieldGrammar :: ALens' a b -> PrettyFieldGrammar b c -> PrettyFieldGrammar a c #

uniqueFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a #

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> PrettyFieldGrammar s Bool #

optionalFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> PrettyFieldGrammar s (Maybe a) #

optionalFieldDefAla :: (Parsec b, Pretty b, Newtype b a, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> PrettyFieldGrammar s a #

monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a #

prefixedFields :: FieldName -> ALens' s [(String, String)] -> PrettyFieldGrammar s [(String, String)] #

knownField :: FieldName -> PrettyFieldGrammar s () #

hiddenField :: PrettyFieldGrammar s a -> PrettyFieldGrammar s a #

deprecatedSince :: [Int] -> String -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a #

availableSince :: [Int] -> a -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a #

FieldGrammar ParsecFieldGrammar # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

blurFieldGrammar :: ALens' a b -> ParsecFieldGrammar b c -> ParsecFieldGrammar a c #

uniqueFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> ParsecFieldGrammar s a #

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> ParsecFieldGrammar s Bool #

optionalFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> ParsecFieldGrammar s (Maybe a) #

optionalFieldDefAla :: (Parsec b, Pretty b, Newtype b a, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> ParsecFieldGrammar s a #

monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> ParsecFieldGrammar s a #

prefixedFields :: FieldName -> ALens' s [(String, String)] -> ParsecFieldGrammar s [(String, String)] #

knownField :: FieldName -> ParsecFieldGrammar s () #

hiddenField :: ParsecFieldGrammar s a -> ParsecFieldGrammar s a #

deprecatedSince :: [Int] -> String -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a #

availableSince :: [Int] -> a -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a #

FieldGrammar FieldDescrs #

Note: default values are printed.

Instance details

Defined in Distribution.FieldGrammar.FieldDescrs

Methods

blurFieldGrammar :: ALens' a b -> FieldDescrs b c -> FieldDescrs a c #

uniqueFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> FieldDescrs s a #

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> FieldDescrs s Bool #

optionalFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> FieldDescrs s (Maybe a) #

optionalFieldDefAla :: (Parsec b, Pretty b, Newtype b a, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> FieldDescrs s a #

monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> FieldDescrs s a #

prefixedFields :: FieldName -> ALens' s [(String, String)] -> FieldDescrs s [(String, String)] #

knownField :: FieldName -> FieldDescrs s () #

hiddenField :: FieldDescrs s a -> FieldDescrs s a #

deprecatedSince :: [Int] -> String -> FieldDescrs s a -> FieldDescrs s a #

availableSince :: [Int] -> a -> FieldDescrs s a -> FieldDescrs s a #

uniqueField #

Arguments

:: (FieldGrammar g, Parsec a, Pretty a) 
=> FieldName

field name

-> ALens' s a

lens into the field

-> g s a 

Field which can be defined at most once.

optionalField #

Arguments

:: (FieldGrammar g, Parsec a, Pretty a) 
=> FieldName

field name

-> ALens' s (Maybe a)

lens into the field

-> g s (Maybe a) 

Field which can be defined at most once.

optionalFieldDef #

Arguments

:: (FieldGrammar g, Functor (g s), Parsec a, Pretty a, Eq a) 
=> FieldName

field name

-> ALens' s a

Lens' s a: lens into the field

-> a

default value

-> g s a 

Optional field with default value.

monoidalField #

Arguments

:: (FieldGrammar g, Parsec a, Pretty a, Monoid a) 
=> FieldName

field name

-> ALens' s a

lens into the field

-> g s a 

Field which can be define multiple times, and the results are mappended.

deprecatedField' #

Arguments

:: FieldGrammar g 
=> String

deprecation message

-> g s a 
-> g s a 

Deprecated field. If found, warning is issued.

Note: also it's not pretty printed!

diff --git a/doc/API/Cabal/Distribution-FieldGrammar-FieldDescrs.html b/doc/API/Cabal/Distribution-FieldGrammar-FieldDescrs.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-FieldGrammar-FieldDescrs.html @@ -0,0 +1,1 @@ +Distribution.FieldGrammar.FieldDescrs

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.FieldGrammar.FieldDescrs

Synopsis

Documentation

data FieldDescrs s a #

A collection field parsers and pretty-printers.

Instances
FieldGrammar FieldDescrs #

Note: default values are printed.

Instance details

Defined in Distribution.FieldGrammar.FieldDescrs

Methods

blurFieldGrammar :: ALens' a b -> FieldDescrs b c -> FieldDescrs a c #

uniqueFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> FieldDescrs s a #

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> FieldDescrs s Bool #

optionalFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> FieldDescrs s (Maybe a) #

optionalFieldDefAla :: (Parsec b, Pretty b, Newtype b a, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> FieldDescrs s a #

monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> FieldDescrs s a #

prefixedFields :: FieldName -> ALens' s [(String, String)] -> FieldDescrs s [(String, String)] #

knownField :: FieldName -> FieldDescrs s () #

hiddenField :: FieldDescrs s a -> FieldDescrs s a #

deprecatedSince :: [Int] -> String -> FieldDescrs s a -> FieldDescrs s a #

availableSince :: [Int] -> a -> FieldDescrs s a -> FieldDescrs s a #

Functor (FieldDescrs s) # 
Instance details

Defined in Distribution.FieldGrammar.FieldDescrs

Methods

fmap :: (a -> b) -> FieldDescrs s a -> FieldDescrs s b #

(<$) :: a -> FieldDescrs s b -> FieldDescrs s a #

Applicative (FieldDescrs s) # 
Instance details

Defined in Distribution.FieldGrammar.FieldDescrs

Methods

pure :: a -> FieldDescrs s a #

(<*>) :: FieldDescrs s (a -> b) -> FieldDescrs s a -> FieldDescrs s b #

liftA2 :: (a -> b -> c) -> FieldDescrs s a -> FieldDescrs s b -> FieldDescrs s c #

(*>) :: FieldDescrs s a -> FieldDescrs s b -> FieldDescrs s b #

(<*) :: FieldDescrs s a -> FieldDescrs s b -> FieldDescrs s a #

fieldDescrPretty :: FieldDescrs s a -> String -> Maybe (s -> Doc) #

Lookup a field value pretty-printer.

fieldDescrParse :: CabalParsing m => FieldDescrs s a -> String -> Maybe (s -> m s) #

Lookup a field value parser.

fieldDescrsToList :: CabalParsing m => FieldDescrs s a -> [(String, s -> Doc, s -> m s)] #

diff --git a/doc/API/Cabal/Distribution-FieldGrammar-Parsec.html b/doc/API/Cabal/Distribution-FieldGrammar-Parsec.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-FieldGrammar-Parsec.html @@ -0,0 +1,25 @@ +Distribution.FieldGrammar.Parsec

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.FieldGrammar.Parsec

Contents

Description

This module provides a FieldGrammarParser, one way to parse + .cabal -like files.

Fields can be specified multiple times in the .cabal files. The order of + such entries is important, but the mutual ordering of different fields is + not.Also conditional sections are considered after non-conditional data. + The example of this silent-commutation quirk is the fact that

buildable: True
+if os(linux)
+  buildable: False
+

and

if os(linux)
+  buildable: False
+buildable: True
+

behave the same! This is the limitation of GeneralPackageDescription + structure.

So we transform the list of fields [Field ann] into + a map of grouped ordinary fields and a list of lists of sections: + Fields ann = Map FieldName [NamelessField ann] and [[Section ann]].

We need list of list of sections, because we need to distinguish situations + where there are fields in between. For example

if flag(bytestring-lt-0_10_4)
+  build-depends: bytestring < 0.10.4
+
+default-language: Haskell2020
+
+else
+  build-depends: bytestring >= 0.10.4
+
+

is obviously invalid specification.

We can parse Fields like we parse aeson objects, yet we use + slighly higher-level API, so we can process unspecified fields, + to report unknown fields and save custom x-fields.

Synopsis

Documentation

data ParsecFieldGrammar s a #

Instances
FieldGrammar ParsecFieldGrammar # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

blurFieldGrammar :: ALens' a b -> ParsecFieldGrammar b c -> ParsecFieldGrammar a c #

uniqueFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> ParsecFieldGrammar s a #

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> ParsecFieldGrammar s Bool #

optionalFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> ParsecFieldGrammar s (Maybe a) #

optionalFieldDefAla :: (Parsec b, Pretty b, Newtype b a, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> ParsecFieldGrammar s a #

monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> ParsecFieldGrammar s a #

prefixedFields :: FieldName -> ALens' s [(String, String)] -> ParsecFieldGrammar s [(String, String)] #

knownField :: FieldName -> ParsecFieldGrammar s () #

hiddenField :: ParsecFieldGrammar s a -> ParsecFieldGrammar s a #

deprecatedSince :: [Int] -> String -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a #

availableSince :: [Int] -> a -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a #

Functor (ParsecFieldGrammar s) # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

fmap :: (a -> b) -> ParsecFieldGrammar s a -> ParsecFieldGrammar s b #

(<$) :: a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s a #

Applicative (ParsecFieldGrammar s) # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

pure :: a -> ParsecFieldGrammar s a #

(<*>) :: ParsecFieldGrammar s (a -> b) -> ParsecFieldGrammar s a -> ParsecFieldGrammar s b #

liftA2 :: (a -> b -> c) -> ParsecFieldGrammar s a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s c #

(*>) :: ParsecFieldGrammar s a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s b #

(<*) :: ParsecFieldGrammar s a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s a #

parseFieldGrammar :: CabalSpecVersion -> Fields Position -> ParsecFieldGrammar s a -> ParseResult a #

fieldGrammarKnownFieldList :: ParsecFieldGrammar s a -> [FieldName] #

Auxiliary

type Fields ann = Map FieldName [NamelessField ann] #

data NamelessField ann #

Single field, without name, but with its annotation.

Constructors

MkNamelessField !ann [FieldLine ann] 
Instances
Functor NamelessField # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

fmap :: (a -> b) -> NamelessField a -> NamelessField b #

(<$) :: a -> NamelessField b -> NamelessField a #

Eq ann => Eq (NamelessField ann) # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

(==) :: NamelessField ann -> NamelessField ann -> Bool #

(/=) :: NamelessField ann -> NamelessField ann -> Bool #

Show ann => Show (NamelessField ann) # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

showsPrec :: Int -> NamelessField ann -> ShowS #

show :: NamelessField ann -> String #

showList :: [NamelessField ann] -> ShowS #

namelessFieldAnn :: NamelessField ann -> ann #

data Section ann #

The Section constructor of Field.

Constructors

MkSection !(Name ann) [SectionArg ann] [Field ann] 
Instances
Functor Section # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

fmap :: (a -> b) -> Section a -> Section b #

(<$) :: a -> Section b -> Section a #

Eq ann => Eq (Section ann) # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

(==) :: Section ann -> Section ann -> Bool #

(/=) :: Section ann -> Section ann -> Bool #

Show ann => Show (Section ann) # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

showsPrec :: Int -> Section ann -> ShowS #

show :: Section ann -> String #

showList :: [Section ann] -> ShowS #

runFieldParser :: Position -> ParsecParser a -> CabalSpecVersion -> [FieldLine Position] -> ParseResult a #

runFieldParser' :: Position -> ParsecParser a -> CabalSpecVersion -> FieldLineStream -> ParseResult a #

diff --git a/doc/API/Cabal/Distribution-FieldGrammar-Pretty.html b/doc/API/Cabal/Distribution-FieldGrammar-Pretty.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-FieldGrammar-Pretty.html @@ -0,0 +1,1 @@ +Distribution.FieldGrammar.Pretty

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.FieldGrammar.Pretty

Synopsis

Documentation

data PrettyFieldGrammar s a #

Instances
FieldGrammar PrettyFieldGrammar # 
Instance details

Defined in Distribution.FieldGrammar.Pretty

Methods

blurFieldGrammar :: ALens' a b -> PrettyFieldGrammar b c -> PrettyFieldGrammar a c #

uniqueFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a #

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> PrettyFieldGrammar s Bool #

optionalFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> PrettyFieldGrammar s (Maybe a) #

optionalFieldDefAla :: (Parsec b, Pretty b, Newtype b a, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> PrettyFieldGrammar s a #

monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a #

prefixedFields :: FieldName -> ALens' s [(String, String)] -> PrettyFieldGrammar s [(String, String)] #

knownField :: FieldName -> PrettyFieldGrammar s () #

hiddenField :: PrettyFieldGrammar s a -> PrettyFieldGrammar s a #

deprecatedSince :: [Int] -> String -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a #

availableSince :: [Int] -> a -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a #

Functor (PrettyFieldGrammar s) # 
Instance details

Defined in Distribution.FieldGrammar.Pretty

Methods

fmap :: (a -> b) -> PrettyFieldGrammar s a -> PrettyFieldGrammar s b #

(<$) :: a -> PrettyFieldGrammar s b -> PrettyFieldGrammar s a #

Applicative (PrettyFieldGrammar s) # 
Instance details

Defined in Distribution.FieldGrammar.Pretty

Methods

pure :: a -> PrettyFieldGrammar s a #

(<*>) :: PrettyFieldGrammar s (a -> b) -> PrettyFieldGrammar s a -> PrettyFieldGrammar s b #

liftA2 :: (a -> b -> c) -> PrettyFieldGrammar s a -> PrettyFieldGrammar s b -> PrettyFieldGrammar s c #

(*>) :: PrettyFieldGrammar s a -> PrettyFieldGrammar s b -> PrettyFieldGrammar s b #

(<*) :: PrettyFieldGrammar s a -> PrettyFieldGrammar s b -> PrettyFieldGrammar s a #

prettyFieldGrammar :: PrettyFieldGrammar s a -> s -> Doc #

We can use PrettyFieldGrammar to pp print the s.

Note: there is not trailing ($+$ text "").

diff --git a/doc/API/Cabal/Distribution-FieldGrammar.html b/doc/API/Cabal/Distribution-FieldGrammar.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-FieldGrammar.html @@ -0,0 +1,5 @@ +Distribution.FieldGrammar

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.FieldGrammar

Contents

Description

This module provides a way to specify a grammar of .cabal -like files.

Synopsis

Field grammar type

class FieldGrammar g where #

FieldGrammar is parametrised by

  • s which is a structure we are parsing. We need this to provide prettyprinter + functionality
  • a type of the field.

Note: We'd like to have forall s. Applicative (f s) context.

Minimal complete definition

blurFieldGrammar, uniqueFieldAla, booleanFieldDef, optionalFieldAla, optionalFieldDefAla, monoidalFieldAla, prefixedFields, knownField, hiddenField, deprecatedSince, availableSince

Methods

blurFieldGrammar :: ALens' a b -> g b c -> g a c #

Unfocus, zoom out, blur FieldGrammar.

uniqueFieldAla #

Arguments

:: (Parsec b, Pretty b, Newtype b a) 
=> FieldName

field name

-> (a -> b)

Newtype pack

-> ALens' s a

lens into the field

-> g s a 

Field which should be defined, exactly once.

booleanFieldDef #

Arguments

:: FieldName

field name

-> ALens' s Bool

lens into the field

-> Bool

default

-> g s Bool 

Boolean field with a default value.

optionalFieldAla #

Arguments

:: (Parsec b, Pretty b, Newtype b a) 
=> FieldName

field name

-> (a -> b)

pack

-> ALens' s (Maybe a)

lens into the field

-> g s (Maybe a) 

Optional field.

optionalFieldDefAla #

Arguments

:: (Parsec b, Pretty b, Newtype b a, Eq a) 
=> FieldName

field name

-> (a -> b)

Newtype pack

-> ALens' s a

Lens' s a: lens into the field

-> a

default value

-> g s a 

Optional field with default value.

monoidalFieldAla #

Arguments

:: (Parsec b, Pretty b, Monoid a, Newtype b a) 
=> FieldName

field name

-> (a -> b)

pack

-> ALens' s a

lens into the field

-> g s a 

Monoidal field.

Values are combined with mappend.

Note: optionalFieldAla is a monoidalField with Last monoid.

prefixedFields #

Arguments

:: FieldName

field name prefix

-> ALens' s [(String, String)]

lens into the field

-> g s [(String, String)] 

Parser matching all fields with a name starting with a prefix.

knownField :: FieldName -> g s () #

Known field, which we don't parse, neither pretty print.

hiddenField :: g s a -> g s a #

Field which is parsed but not pretty printed.

deprecatedSince #

Arguments

:: [Int]

version

-> String

deprecation message

-> g s a 
-> g s a 

Deprecated since

availableSince #

Arguments

:: [Int]

spec version

-> a

default value

-> g s a 
-> g s a 

Annotate field with since spec-version.

Instances
FieldGrammar PrettyFieldGrammar # 
Instance details

Defined in Distribution.FieldGrammar.Pretty

Methods

blurFieldGrammar :: ALens' a b -> PrettyFieldGrammar b c -> PrettyFieldGrammar a c #

uniqueFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a #

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> PrettyFieldGrammar s Bool #

optionalFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> PrettyFieldGrammar s (Maybe a) #

optionalFieldDefAla :: (Parsec b, Pretty b, Newtype b a, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> PrettyFieldGrammar s a #

monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a #

prefixedFields :: FieldName -> ALens' s [(String, String)] -> PrettyFieldGrammar s [(String, String)] #

knownField :: FieldName -> PrettyFieldGrammar s () #

hiddenField :: PrettyFieldGrammar s a -> PrettyFieldGrammar s a #

deprecatedSince :: [Int] -> String -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a #

availableSince :: [Int] -> a -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a #

FieldGrammar ParsecFieldGrammar # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

blurFieldGrammar :: ALens' a b -> ParsecFieldGrammar b c -> ParsecFieldGrammar a c #

uniqueFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> ParsecFieldGrammar s a #

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> ParsecFieldGrammar s Bool #

optionalFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> ParsecFieldGrammar s (Maybe a) #

optionalFieldDefAla :: (Parsec b, Pretty b, Newtype b a, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> ParsecFieldGrammar s a #

monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> ParsecFieldGrammar s a #

prefixedFields :: FieldName -> ALens' s [(String, String)] -> ParsecFieldGrammar s [(String, String)] #

knownField :: FieldName -> ParsecFieldGrammar s () #

hiddenField :: ParsecFieldGrammar s a -> ParsecFieldGrammar s a #

deprecatedSince :: [Int] -> String -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a #

availableSince :: [Int] -> a -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a #

FieldGrammar FieldDescrs #

Note: default values are printed.

Instance details

Defined in Distribution.FieldGrammar.FieldDescrs

Methods

blurFieldGrammar :: ALens' a b -> FieldDescrs b c -> FieldDescrs a c #

uniqueFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> FieldDescrs s a #

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> FieldDescrs s Bool #

optionalFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> FieldDescrs s (Maybe a) #

optionalFieldDefAla :: (Parsec b, Pretty b, Newtype b a, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> FieldDescrs s a #

monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> FieldDescrs s a #

prefixedFields :: FieldName -> ALens' s [(String, String)] -> FieldDescrs s [(String, String)] #

knownField :: FieldName -> FieldDescrs s () #

hiddenField :: FieldDescrs s a -> FieldDescrs s a #

deprecatedSince :: [Int] -> String -> FieldDescrs s a -> FieldDescrs s a #

availableSince :: [Int] -> a -> FieldDescrs s a -> FieldDescrs s a #

uniqueField #

Arguments

:: (FieldGrammar g, Parsec a, Pretty a) 
=> FieldName

field name

-> ALens' s a

lens into the field

-> g s a 

Field which can be defined at most once.

optionalField #

Arguments

:: (FieldGrammar g, Parsec a, Pretty a) 
=> FieldName

field name

-> ALens' s (Maybe a)

lens into the field

-> g s (Maybe a) 

Field which can be defined at most once.

optionalFieldDef #

Arguments

:: (FieldGrammar g, Functor (g s), Parsec a, Pretty a, Eq a) 
=> FieldName

field name

-> ALens' s a

Lens' s a: lens into the field

-> a

default value

-> g s a 

Optional field with default value.

monoidalField #

Arguments

:: (FieldGrammar g, Parsec a, Pretty a, Monoid a) 
=> FieldName

field name

-> ALens' s a

lens into the field

-> g s a 

Field which can be define multiple times, and the results are mappended.

deprecatedField' #

Arguments

:: FieldGrammar g 
=> String

deprecation message

-> g s a 
-> g s a 

Deprecated field. If found, warning is issued.

Note: also it's not pretty printed!

Concrete grammar implementations

data ParsecFieldGrammar s a #

Instances
FieldGrammar ParsecFieldGrammar # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

blurFieldGrammar :: ALens' a b -> ParsecFieldGrammar b c -> ParsecFieldGrammar a c #

uniqueFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> ParsecFieldGrammar s a #

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> ParsecFieldGrammar s Bool #

optionalFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> ParsecFieldGrammar s (Maybe a) #

optionalFieldDefAla :: (Parsec b, Pretty b, Newtype b a, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> ParsecFieldGrammar s a #

monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> ParsecFieldGrammar s a #

prefixedFields :: FieldName -> ALens' s [(String, String)] -> ParsecFieldGrammar s [(String, String)] #

knownField :: FieldName -> ParsecFieldGrammar s () #

hiddenField :: ParsecFieldGrammar s a -> ParsecFieldGrammar s a #

deprecatedSince :: [Int] -> String -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a #

availableSince :: [Int] -> a -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a #

Functor (ParsecFieldGrammar s) # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

fmap :: (a -> b) -> ParsecFieldGrammar s a -> ParsecFieldGrammar s b #

(<$) :: a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s a #

Applicative (ParsecFieldGrammar s) # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

pure :: a -> ParsecFieldGrammar s a #

(<*>) :: ParsecFieldGrammar s (a -> b) -> ParsecFieldGrammar s a -> ParsecFieldGrammar s b #

liftA2 :: (a -> b -> c) -> ParsecFieldGrammar s a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s c #

(*>) :: ParsecFieldGrammar s a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s b #

(<*) :: ParsecFieldGrammar s a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s a #

type ParsecFieldGrammar' a = ParsecFieldGrammar a a #

parseFieldGrammar :: CabalSpecVersion -> Fields Position -> ParsecFieldGrammar s a -> ParseResult a #

fieldGrammarKnownFieldList :: ParsecFieldGrammar s a -> [FieldName] #

data PrettyFieldGrammar s a #

Instances
FieldGrammar PrettyFieldGrammar # 
Instance details

Defined in Distribution.FieldGrammar.Pretty

Methods

blurFieldGrammar :: ALens' a b -> PrettyFieldGrammar b c -> PrettyFieldGrammar a c #

uniqueFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a #

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> PrettyFieldGrammar s Bool #

optionalFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> PrettyFieldGrammar s (Maybe a) #

optionalFieldDefAla :: (Parsec b, Pretty b, Newtype b a, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> PrettyFieldGrammar s a #

monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a #

prefixedFields :: FieldName -> ALens' s [(String, String)] -> PrettyFieldGrammar s [(String, String)] #

knownField :: FieldName -> PrettyFieldGrammar s () #

hiddenField :: PrettyFieldGrammar s a -> PrettyFieldGrammar s a #

deprecatedSince :: [Int] -> String -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a #

availableSince :: [Int] -> a -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a #

Functor (PrettyFieldGrammar s) # 
Instance details

Defined in Distribution.FieldGrammar.Pretty

Methods

fmap :: (a -> b) -> PrettyFieldGrammar s a -> PrettyFieldGrammar s b #

(<$) :: a -> PrettyFieldGrammar s b -> PrettyFieldGrammar s a #

Applicative (PrettyFieldGrammar s) # 
Instance details

Defined in Distribution.FieldGrammar.Pretty

Methods

pure :: a -> PrettyFieldGrammar s a #

(<*>) :: PrettyFieldGrammar s (a -> b) -> PrettyFieldGrammar s a -> PrettyFieldGrammar s b #

liftA2 :: (a -> b -> c) -> PrettyFieldGrammar s a -> PrettyFieldGrammar s b -> PrettyFieldGrammar s c #

(*>) :: PrettyFieldGrammar s a -> PrettyFieldGrammar s b -> PrettyFieldGrammar s b #

(<*) :: PrettyFieldGrammar s a -> PrettyFieldGrammar s b -> PrettyFieldGrammar s a #

type PrettyFieldGrammar' a = PrettyFieldGrammar a a #

prettyFieldGrammar :: PrettyFieldGrammar s a -> s -> Doc #

We can use PrettyFieldGrammar to pp print the s.

Note: there is not trailing ($+$ text "").

Auxlilary

(^^^) :: a -> (a -> b) -> b infixl 5 #

Reverse function application which binds tighter than <$> and <*>. + Useful for refining grammar specification.

<*> monoidalFieldAla "extensions"           (alaList' FSep MQuoted)       oldExtensions
+    ^^^ deprecatedSince [1,12] "Please use 'default-extensions' or 'other-extensions' fields."
+

data Section ann #

The Section constructor of Field.

Constructors

MkSection !(Name ann) [SectionArg ann] [Field ann] 
Instances
Functor Section # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

fmap :: (a -> b) -> Section a -> Section b #

(<$) :: a -> Section b -> Section a #

Eq ann => Eq (Section ann) # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

(==) :: Section ann -> Section ann -> Bool #

(/=) :: Section ann -> Section ann -> Bool #

Show ann => Show (Section ann) # 
Instance details

Defined in Distribution.FieldGrammar.Parsec

Methods

showsPrec :: Int -> Section ann -> ShowS #

show :: Section ann -> String #

showList :: [Section ann] -> ShowS #

type Fields ann = Map FieldName [NamelessField ann] #

partitionFields :: [Field ann] -> (Fields ann, [[Section ann]]) #

Partition field list into field map and groups of sections.

takeFields :: [Field ann] -> (Fields ann, [Field ann]) #

Take all fields from the front.

runFieldParser :: Position -> ParsecParser a -> CabalSpecVersion -> [FieldLine Position] -> ParseResult a #

runFieldParser' :: Position -> ParsecParser a -> CabalSpecVersion -> FieldLineStream -> ParseResult a #

diff --git a/doc/API/Cabal/Distribution-InstalledPackageInfo.html b/doc/API/Cabal/Distribution-InstalledPackageInfo.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-InstalledPackageInfo.html @@ -0,0 +1,30 @@ +Distribution.InstalledPackageInfo

Cabal-2.4.0.1: A framework for packaging Haskell software

Copyright(c) The University of Glasgow 2004
Maintainerlibraries@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.InstalledPackageInfo

Description

This is the information about an installed package that + is communicated to the ghc-pkg program in order to register + a package. ghc-pkg now consumes this package format (as of version + 6.4). This is specific to GHC at the moment.

The .cabal file format is for describing a package that is not yet + installed. It has a lot of flexibility, like conditionals and dependency + ranges. As such, that format is not at all suitable for describing a package + that has already been built and installed. By the time we get to that stage, + we have resolved all conditionals and resolved dependency version + constraints to exact versions of dependent packages. So, this module defines + the InstalledPackageInfo data structure that contains all the info we keep + about an installed package. There is a parser and pretty printer. The + textual format is rather simpler than the .cabal format: there are no + sections, for example.

Synopsis

Documentation

data InstalledPackageInfo #

Constructors

InstalledPackageInfo 

Fields

Instances
Eq InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

(==) :: InstalledPackageInfo -> InstalledPackageInfo -> Bool #

(/=) :: InstalledPackageInfo -> InstalledPackageInfo -> Bool #

Read InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

readsPrec :: Int -> ReadS InstalledPackageInfo #

readList :: ReadS [InstalledPackageInfo] #

readPrec :: ReadPrec InstalledPackageInfo #

readListPrec :: ReadPrec [InstalledPackageInfo] #

Show InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

showsPrec :: Int -> InstalledPackageInfo -> ShowS #

show :: InstalledPackageInfo -> String #

showList :: [InstalledPackageInfo] -> ShowS #

Generic InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Associated Types

type Rep InstalledPackageInfo :: * -> * #

Methods

from :: InstalledPackageInfo -> Rep InstalledPackageInfo x #

to :: Rep InstalledPackageInfo x -> InstalledPackageInfo #

Binary InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

put :: InstalledPackageInfo -> Put #

get :: Get InstalledPackageInfo #

putList :: [InstalledPackageInfo] -> Put #

NFData InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

rnf :: InstalledPackageInfo -> () #

IsNode InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Associated Types

type Key InstalledPackageInfo :: * #

Methods

nodeKey :: InstalledPackageInfo -> Key InstalledPackageInfo #

nodeNeighbors :: InstalledPackageInfo -> [Key InstalledPackageInfo] #

PackageInstalled InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

installedDepends :: InstalledPackageInfo -> [UnitId] #

HasUnitId InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

installedUnitId :: InstalledPackageInfo -> UnitId #

HasMungedPackageId InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

mungedId :: InstalledPackageInfo -> MungedPackageId #

Package InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

packageId :: InstalledPackageInfo -> PackageIdentifier #

Semigroup (PackageIndex InstalledPackageInfo) # 
Instance details

Defined in Distribution.Simple.PackageIndex

Methods

(<>) :: PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo #

sconcat :: NonEmpty (PackageIndex InstalledPackageInfo) -> PackageIndex InstalledPackageInfo #

stimes :: Integral b => b -> PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo #

Monoid (PackageIndex InstalledPackageInfo) # 
Instance details

Defined in Distribution.Simple.PackageIndex

Methods

mempty :: PackageIndex InstalledPackageInfo #

mappend :: PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo #

mconcat :: [PackageIndex InstalledPackageInfo] -> PackageIndex InstalledPackageInfo #

type Rep InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

type Rep InstalledPackageInfo = D1 (MetaData "InstalledPackageInfo" "Distribution.Types.InstalledPackageInfo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "InstalledPackageInfo" PrefixI True) (((((S1 (MetaSel (Just "sourcePackageId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageId) :*: S1 (MetaSel (Just "sourceLibName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UnqualComponentName))) :*: (S1 (MetaSel (Just "installedComponentId_") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: (S1 (MetaSel (Just "installedUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId) :*: S1 (MetaSel (Just "instantiatedWith") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(ModuleName, OpenModule)])))) :*: ((S1 (MetaSel (Just "compatPackageKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "license") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Either License License))) :*: (S1 (MetaSel (Just "copyright") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: (S1 (MetaSel (Just "maintainer") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "author") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))) :*: (((S1 (MetaSel (Just "stability") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "homepage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :*: (S1 (MetaSel (Just "pkgUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: (S1 (MetaSel (Just "synopsis") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "description") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))) :*: ((S1 (MetaSel (Just "category") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "abiHash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AbiHash)) :*: (S1 (MetaSel (Just "indefinite") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: (S1 (MetaSel (Just "exposed") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "exposedModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ExposedModule])))))) :*: ((((S1 (MetaSel (Just "hiddenModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]) :*: S1 (MetaSel (Just "trusted") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "importDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: (S1 (MetaSel (Just "libraryDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "libraryDynDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))) :*: ((S1 (MetaSel (Just "dataDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "hsLibraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) :*: (S1 (MetaSel (Just "extraLibraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: (S1 (MetaSel (Just "extraGHCiLibraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "includeDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]))))) :*: (((S1 (MetaSel (Just "includes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "depends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId])) :*: (S1 (MetaSel (Just "abiDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [AbiDependency]) :*: (S1 (MetaSel (Just "ccOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "cxxOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])))) :*: ((S1 (MetaSel (Just "ldOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: (S1 (MetaSel (Just "frameworkDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "frameworks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]))) :*: (S1 (MetaSel (Just "haddockInterfaces") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: (S1 (MetaSel (Just "haddockHTMLs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "pkgRoot") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)))))))))
type Key InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

type Key InstalledPackageInfo = UnitId

installedPackageId :: InstalledPackageInfo -> UnitId #

Deprecated: Use installedUnitId instead

Backwards compatibility with Cabal pre-1.24.

This type synonym is slightly awful because in cabal-install + we define an InstalledPackageId but it's a ComponentId, + not a UnitId!

installedComponentId :: InstalledPackageInfo -> ComponentId #

installedOpenUnitId :: InstalledPackageInfo -> OpenUnitId #

Get the indefinite unit identity representing this package. + This IS NOT guaranteed to give you a substitution; for + instantiated packages you will get DefiniteUnitId (installedUnitId ipi). + For indefinite libraries, however, you will correctly get + an OpenUnitId with the appropriate OpenModuleSubst.

sourceComponentName :: InstalledPackageInfo -> ComponentName #

requiredSignatures :: InstalledPackageInfo -> Set ModuleName #

Returns the set of module names which need to be filled for + an indefinite package, or the empty set if the package is definite.

data ExposedModule #

Constructors

ExposedModule 

Fields

Instances
Eq ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

(==) :: ExposedModule -> ExposedModule -> Bool #

(/=) :: ExposedModule -> ExposedModule -> Bool #

Read ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

readsPrec :: Int -> ReadS ExposedModule #

readList :: ReadS [ExposedModule] #

readPrec :: ReadPrec ExposedModule #

readListPrec :: ReadPrec [ExposedModule] #

Show ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

showsPrec :: Int -> ExposedModule -> ShowS #

show :: ExposedModule -> String #

showList :: [ExposedModule] -> ShowS #

Generic ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Associated Types

type Rep ExposedModule :: * -> * #

Methods

from :: ExposedModule -> Rep ExposedModule x #

to :: Rep ExposedModule x -> ExposedModule #

Binary ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

put :: ExposedModule -> Put #

get :: Get ExposedModule #

putList :: [ExposedModule] -> Put #

NFData ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

rnf :: ExposedModule -> () #

Pretty ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

pretty :: ExposedModule -> Doc #

Parsec ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

parsec :: CabalParsing m => m ExposedModule #

Text ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

disp :: ExposedModule -> Doc #

parse :: ReadP r ExposedModule #

type Rep ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

type Rep ExposedModule = D1 (MetaData "ExposedModule" "Distribution.Types.ExposedModule" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ExposedModule" PrefixI True) (S1 (MetaSel (Just "exposedName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleName) :*: S1 (MetaSel (Just "exposedReexport") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe OpenModule))))

data AbiDependency #

An ABI dependency is a dependency on a library which also + records the ABI hash (abiHash) of the library it depends + on.

The primary utility of this is to enable an extra sanity when + GHC loads libraries: it can check if the dependency has a matching + ABI and if not, refuse to load this library. This information + is critical if we are shadowing libraries; differences in the + ABI hash let us know what packages get shadowed by the new version + of a package.

Constructors

AbiDependency 

Fields

Instances
Eq AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

(==) :: AbiDependency -> AbiDependency -> Bool #

(/=) :: AbiDependency -> AbiDependency -> Bool #

Read AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

readsPrec :: Int -> ReadS AbiDependency #

readList :: ReadS [AbiDependency] #

readPrec :: ReadPrec AbiDependency #

readListPrec :: ReadPrec [AbiDependency] #

Show AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

showsPrec :: Int -> AbiDependency -> ShowS #

show :: AbiDependency -> String #

showList :: [AbiDependency] -> ShowS #

Generic AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Associated Types

type Rep AbiDependency :: * -> * #

Methods

from :: AbiDependency -> Rep AbiDependency x #

to :: Rep AbiDependency x -> AbiDependency #

Binary AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

put :: AbiDependency -> Put #

get :: Get AbiDependency #

putList :: [AbiDependency] -> Put #

NFData AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

rnf :: AbiDependency -> () #

Pretty AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

pretty :: AbiDependency -> Doc #

Parsec AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

parsec :: CabalParsing m => m AbiDependency #

Text AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

disp :: AbiDependency -> Doc #

parse :: ReadP r AbiDependency #

type Rep AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

type Rep AbiDependency = D1 (MetaData "AbiDependency" "Distribution.Types.AbiDependency" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "AbiDependency" PrefixI True) (S1 (MetaSel (Just "depUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId) :*: S1 (MetaSel (Just "depAbiHash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AbiHash)))

data ParseResult a #

Constructors

ParseFailed PError 
ParseOk [PWarning] a 
Instances
Monad ParseResult # 
Instance details

Defined in Distribution.ParseUtils

Methods

(>>=) :: ParseResult a -> (a -> ParseResult b) -> ParseResult b #

(>>) :: ParseResult a -> ParseResult b -> ParseResult b #

return :: a -> ParseResult a #

fail :: String -> ParseResult a #

Functor ParseResult # 
Instance details

Defined in Distribution.ParseUtils

Methods

fmap :: (a -> b) -> ParseResult a -> ParseResult b #

(<$) :: a -> ParseResult b -> ParseResult a #

MonadFail ParseResult # 
Instance details

Defined in Distribution.ParseUtils

Methods

fail :: String -> ParseResult a #

Applicative ParseResult # 
Instance details

Defined in Distribution.ParseUtils

Methods

pure :: a -> ParseResult a #

(<*>) :: ParseResult (a -> b) -> ParseResult a -> ParseResult b #

liftA2 :: (a -> b -> c) -> ParseResult a -> ParseResult b -> ParseResult c #

(*>) :: ParseResult a -> ParseResult b -> ParseResult b #

(<*) :: ParseResult a -> ParseResult b -> ParseResult a #

Show a => Show (ParseResult a) # 
Instance details

Defined in Distribution.ParseUtils

Methods

showsPrec :: Int -> ParseResult a -> ShowS #

show :: ParseResult a -> String #

showList :: [ParseResult a] -> ShowS #

data PError #

Constructors

AmbiguousParse String LineNo 
NoParse String LineNo 
TabsError LineNo 
FromString String (Maybe LineNo) 
Instances
Eq PError # 
Instance details

Defined in Distribution.ParseUtils

Methods

(==) :: PError -> PError -> Bool #

(/=) :: PError -> PError -> Bool #

Show PError # 
Instance details

Defined in Distribution.ParseUtils

Methods

showsPrec :: Int -> PError -> ShowS #

show :: PError -> String #

showList :: [PError] -> ShowS #

data PWarning #

Instances
Eq PWarning # 
Instance details

Defined in Distribution.ParseUtils

Methods

(==) :: PWarning -> PWarning -> Bool #

(/=) :: PWarning -> PWarning -> Bool #

Show PWarning # 
Instance details

Defined in Distribution.ParseUtils

Methods

showsPrec :: Int -> PWarning -> ShowS #

show :: PWarning -> String #

showList :: [PWarning] -> ShowS #

emptyInstalledPackageInfo :: InstalledPackageInfo #

parseInstalledPackageInfo :: String -> ParseResult InstalledPackageInfo #

showInstalledPackageInfo :: InstalledPackageInfo -> String #

Pretty print InstalledPackageInfo.

pkgRoot isn't printed, as ghc-pkg prints it manually (as GHC-8.4).

showFullInstalledPackageInfo :: InstalledPackageInfo -> String #

The variant of showInstalledPackageInfo which outputs pkgroot field too.

showInstalledPackageInfoField :: String -> Maybe (InstalledPackageInfo -> String) #

>>> let ipi = emptyInstalledPackageInfo { maintainer = "Tester" }
+>>> fmap ($ ipi) $ showInstalledPackageInfoField "maintainer"
+Just "maintainer: Tester"
+

showSimpleInstalledPackageInfoField :: String -> Maybe (InstalledPackageInfo -> String) #

diff --git a/doc/API/Cabal/Distribution-License.html b/doc/API/Cabal/Distribution-License.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-License.html @@ -0,0 +1,44 @@ +Distribution.License

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2005
Duncan Coutts 2008
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.License

Description

Package descriptions contain fields for specifying the name of a software + license and the name of the file containing the text of that license. While + package authors may choose any license they like, Cabal provides an + enumeration of a small set of common free and open source software licenses. + This is done so that Hackage can recognise licenses, so that tools can detect + licensing conflicts, + and to deter + license proliferation.

It is recommended that all package authors use the license-file or + license-files fields in their package descriptions. Further information + about these fields can be found in the + Cabal users guide.

Additional resources

The following websites provide information about free and open source + software licenses:

Disclaimer

The descriptions of software licenses provided by this documentation are + intended for informational purposes only and in no way constitute legal + advice. Please read the text of the licenses and consult a lawyer for any + advice regarding software licensing.

Synopsis

Documentation

data License #

Indicates the license under which a package's source code is released. + Versions of the licenses not listed here will be rejected by Hackage and + cause cabal check to issue a warning.

Constructors

GPL (Maybe Version)

GNU General Public License, + version 2 or + version 3.

AGPL (Maybe Version)

GNU Affero General Public License, version 3.

LGPL (Maybe Version)

GNU Lesser General Public License, + version 2.1 or + version 3.

BSD2

2-clause BSD license.

BSD3

3-clause BSD license.

BSD4

4-clause BSD license. + This license has not been approved by the OSI and is incompatible with + the GNU GPL. It is provided for historical reasons and should be avoided.

MIT

MIT license.

ISC

ISC license

MPL Version

Mozilla Public License, version 2.0.

Apache (Maybe Version)

Apache License, version 2.0.

PublicDomain

The author of a package disclaims any copyright to its source code and + dedicates it to the public domain. This is not a software license. Please + note that it is not possible to dedicate works to the public domain in + every jurisdiction, nor is a work that is in the public domain in one + jurisdiction necessarily in the public domain elsewhere.

AllRightsReserved

Explicitly 'All Rights Reserved', eg for proprietary software. The + package may not be legally modified or redistributed by anyone but the + rightsholder.

UnspecifiedLicense

No license specified which legally defaults to 'All Rights Reserved'. + The package may not be legally modified or redistributed by anyone but + the rightsholder.

OtherLicense

Any other software license.

UnknownLicense String

Indicates an erroneous license name.

Instances
Eq License # 
Instance details

Defined in Distribution.License

Methods

(==) :: License -> License -> Bool #

(/=) :: License -> License -> Bool #

Data License # 
Instance details

Defined in Distribution.License

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> License -> c License #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c License #

toConstr :: License -> Constr #

dataTypeOf :: License -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c License) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c License) #

gmapT :: (forall b. Data b => b -> b) -> License -> License #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> License -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> License -> r #

gmapQ :: (forall d. Data d => d -> u) -> License -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> License -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> License -> m License #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> License -> m License #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> License -> m License #

Read License # 
Instance details

Defined in Distribution.License

Methods

readsPrec :: Int -> ReadS License #

readList :: ReadS [License] #

readPrec :: ReadPrec License #

readListPrec :: ReadPrec [License] #

Show License # 
Instance details

Defined in Distribution.License

Methods

showsPrec :: Int -> License -> ShowS #

show :: License -> String #

showList :: [License] -> ShowS #

Generic License # 
Instance details

Defined in Distribution.License

Associated Types

type Rep License :: * -> * #

Methods

from :: License -> Rep License x #

to :: Rep License x -> License #

Binary License # 
Instance details

Defined in Distribution.License

Methods

put :: License -> Put #

get :: Get License #

putList :: [License] -> Put #

NFData License # 
Instance details

Defined in Distribution.License

Methods

rnf :: License -> () #

Pretty License # 
Instance details

Defined in Distribution.License

Methods

pretty :: License -> Doc #

Parsec License # 
Instance details

Defined in Distribution.License

Methods

parsec :: CabalParsing m => m License #

Text License # 
Instance details

Defined in Distribution.License

Methods

disp :: License -> Doc #

parse :: ReadP r License #

Newtype SpecLicense (Either License License) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: Either License0 License -> SpecLicense #

unpack :: SpecLicense -> Either License0 License #

type Rep License # 
Instance details

Defined in Distribution.License

type Rep License = D1 (MetaData "License" "Distribution.License" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (((C1 (MetaCons "GPL" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Version))) :+: (C1 (MetaCons "AGPL" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Version))) :+: C1 (MetaCons "LGPL" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Version))))) :+: ((C1 (MetaCons "BSD2" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BSD3" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "BSD4" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MIT" PrefixI False) (U1 :: * -> *)))) :+: (((C1 (MetaCons "ISC" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MPL" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version))) :+: (C1 (MetaCons "Apache" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Version))) :+: C1 (MetaCons "PublicDomain" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "AllRightsReserved" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "UnspecifiedLicense" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "OtherLicense" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "UnknownLicense" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))))

knownLicenses :: [License] #

The list of all currently recognised licenses.

licenseToSPDX :: License -> License #

Convert old License to SPDX License. + Non-SPDX licenses are converted to LicenseRef.

Since: 2.2.0.0

licenseFromSPDX :: License -> License #

Convert License to License,

This is lossy conversion. We try our best.

>>> licenseFromSPDX . licenseToSPDX $ BSD3
+BSD3
+
>>> licenseFromSPDX . licenseToSPDX $ GPL (Just (mkVersion [3]))
+GPL (Just (mkVersion [3]))
+
>>> licenseFromSPDX . licenseToSPDX $ PublicDomain
+UnknownLicense "LicenseRefPublicDomain"
+
>>> licenseFromSPDX $ SPDX.License $ SPDX.simpleLicenseExpression SPDX.EUPL_1_1
+UnknownLicense "EUPL-1.1"
+
>>> licenseFromSPDX . licenseToSPDX $ AllRightsReserved
+AllRightsReserved
+
>>> licenseFromSPDX <$> simpleParsec "BSD-3-Clause OR GPL-3.0-only"
+Just (UnknownLicense "BSD3ClauseORGPL30only")
+

Since: 2.2.0.0

diff --git a/doc/API/Cabal/Distribution-Make.html b/doc/API/Cabal/Distribution-Make.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Make.html @@ -0,0 +1,43 @@ +Distribution.Make

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightMartin Sj&#xF6;gren 2004
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Make

Description

This is an alternative build system that delegates everything to the make + program. All the commands just end up calling make with appropriate + arguments. The intention was to allow preexisting packages that used + makefiles to be wrapped into Cabal packages. In practice essentially all + such packages were converted over to the "Simple" build system instead. + Consequently this module is not used much and it certainly only sees cursory + maintenance and no testing. Perhaps at some point we should stop pretending + that it works.

Uses the parsed command-line from Distribution.Simple.Setup in order to build + Haskell tools using a back-end build system based on make. Obviously we + assume that there is a configure script, and that after the ConfigCmd has + been run, there is a Makefile. Further assumptions:

ConfigCmd
We assume the configure script accepts + --with-hc, + --with-hc-pkg, + --prefix, + --bindir, + --libdir, + --libexecdir, + --datadir.
BuildCmd
We assume that the default Makefile target will build everything.
InstallCmd
We assume there is an install target. Note that we assume that + this does *not* register the package!
CopyCmd
We assume there is a copy target, and a variable $(destdir). + The copy target should probably just invoke make install + recursively (e.g. $(MAKE) install prefix=$(destdir)/$(prefix) + bindir=$(destdir)/$(bindir). The reason we can't invoke make + install directly here is that we don't know the value of $(prefix).
SDistCmd
We assume there is a dist target.
RegisterCmd
We assume there is a register target and a variable $(user).
UnregisterCmd
We assume there is an unregister target.
HaddockCmd
We assume there is a docs or doc target.
Synopsis

Documentation

module Distribution.Package

data License #

Indicates the license under which a package's source code is released. + Versions of the licenses not listed here will be rejected by Hackage and + cause cabal check to issue a warning.

Constructors

GPL (Maybe Version)

GNU General Public License, + version 2 or + version 3.

AGPL (Maybe Version)

GNU Affero General Public License, version 3.

LGPL (Maybe Version)

GNU Lesser General Public License, + version 2.1 or + version 3.

BSD2

2-clause BSD license.

BSD3

3-clause BSD license.

BSD4

4-clause BSD license. + This license has not been approved by the OSI and is incompatible with + the GNU GPL. It is provided for historical reasons and should be avoided.

MIT

MIT license.

ISC

ISC license

MPL Version

Mozilla Public License, version 2.0.

Apache (Maybe Version)

Apache License, version 2.0.

PublicDomain

The author of a package disclaims any copyright to its source code and + dedicates it to the public domain. This is not a software license. Please + note that it is not possible to dedicate works to the public domain in + every jurisdiction, nor is a work that is in the public domain in one + jurisdiction necessarily in the public domain elsewhere.

AllRightsReserved

Explicitly 'All Rights Reserved', eg for proprietary software. The + package may not be legally modified or redistributed by anyone but the + rightsholder.

UnspecifiedLicense

No license specified which legally defaults to 'All Rights Reserved'. + The package may not be legally modified or redistributed by anyone but + the rightsholder.

OtherLicense

Any other software license.

UnknownLicense String

Indicates an erroneous license name.

Instances
Eq License # 
Instance details

Defined in Distribution.License

Methods

(==) :: License -> License -> Bool #

(/=) :: License -> License -> Bool #

Data License # 
Instance details

Defined in Distribution.License

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> License -> c License #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c License #

toConstr :: License -> Constr #

dataTypeOf :: License -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c License) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c License) #

gmapT :: (forall b. Data b => b -> b) -> License -> License #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> License -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> License -> r #

gmapQ :: (forall d. Data d => d -> u) -> License -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> License -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> License -> m License #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> License -> m License #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> License -> m License #

Read License # 
Instance details

Defined in Distribution.License

Methods

readsPrec :: Int -> ReadS License #

readList :: ReadS [License] #

readPrec :: ReadPrec License #

readListPrec :: ReadPrec [License] #

Show License # 
Instance details

Defined in Distribution.License

Methods

showsPrec :: Int -> License -> ShowS #

show :: License -> String #

showList :: [License] -> ShowS #

Generic License # 
Instance details

Defined in Distribution.License

Associated Types

type Rep License :: * -> * #

Methods

from :: License -> Rep License x #

to :: Rep License x -> License #

Binary License # 
Instance details

Defined in Distribution.License

Methods

put :: License -> Put #

get :: Get License #

putList :: [License] -> Put #

NFData License # 
Instance details

Defined in Distribution.License

Methods

rnf :: License -> () #

Pretty License # 
Instance details

Defined in Distribution.License

Methods

pretty :: License -> Doc #

Parsec License # 
Instance details

Defined in Distribution.License

Methods

parsec :: CabalParsing m => m License #

Text License # 
Instance details

Defined in Distribution.License

Methods

disp :: License -> Doc #

parse :: ReadP r License #

Newtype SpecLicense (Either License License) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: Either License0 License -> SpecLicense #

unpack :: SpecLicense -> Either License0 License #

type Rep License # 
Instance details

Defined in Distribution.License

type Rep License = D1 (MetaData "License" "Distribution.License" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (((C1 (MetaCons "GPL" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Version))) :+: (C1 (MetaCons "AGPL" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Version))) :+: C1 (MetaCons "LGPL" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Version))))) :+: ((C1 (MetaCons "BSD2" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BSD3" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "BSD4" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MIT" PrefixI False) (U1 :: * -> *)))) :+: (((C1 (MetaCons "ISC" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MPL" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version))) :+: (C1 (MetaCons "Apache" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Version))) :+: C1 (MetaCons "PublicDomain" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "AllRightsReserved" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "UnspecifiedLicense" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "OtherLicense" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "UnknownLicense" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))))

data Version #

A Version represents the version of a software entity.

Instances of Eq and Ord are provided, which gives exact + equality and lexicographic ordering of the version number + components (i.e. 2.1 > 2.0, 1.2.3 > 1.2.2, etc.).

This type is opaque and distinct from the Version type in + Data.Version since Cabal-2.0. The difference extends to the + Binary instance using a different (and more compact) encoding.

Since: 2.0.0.2

Instances
Eq Version # 
Instance details

Defined in Distribution.Types.Version

Methods

(==) :: Version -> Version -> Bool #

(/=) :: Version -> Version -> Bool #

Data Version # 
Instance details

Defined in Distribution.Types.Version

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Version -> c Version #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Version #

toConstr :: Version -> Constr #

dataTypeOf :: Version -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Version) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Version) #

gmapT :: (forall b. Data b => b -> b) -> Version -> Version #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r #

gmapQ :: (forall d. Data d => d -> u) -> Version -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Version -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Version -> m Version #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version #

Ord Version # 
Instance details

Defined in Distribution.Types.Version

Methods

compare :: Version -> Version -> Ordering #

(<) :: Version -> Version -> Bool #

(<=) :: Version -> Version -> Bool #

(>) :: Version -> Version -> Bool #

(>=) :: Version -> Version -> Bool #

max :: Version -> Version -> Version #

min :: Version -> Version -> Version #

Read Version # 
Instance details

Defined in Distribution.Types.Version

Methods

readsPrec :: Int -> ReadS Version #

readList :: ReadS [Version] #

readPrec :: ReadPrec Version #

readListPrec :: ReadPrec [Version] #

Show Version # 
Instance details

Defined in Distribution.Types.Version

Methods

showsPrec :: Int -> Version -> ShowS #

show :: Version -> String #

showList :: [Version] -> ShowS #

Generic Version # 
Instance details

Defined in Distribution.Types.Version

Associated Types

type Rep Version :: * -> * #

Methods

from :: Version -> Rep Version x #

to :: Rep Version x -> Version #

Binary Version # 
Instance details

Defined in Distribution.Types.Version

Methods

put :: Version -> Put #

get :: Get Version #

putList :: [Version] -> Put #

NFData Version # 
Instance details

Defined in Distribution.Types.Version

Methods

rnf :: Version -> () #

Pretty Version # 
Instance details

Defined in Distribution.Types.Version

Methods

pretty :: Version -> Doc #

Parsec Version # 
Instance details

Defined in Distribution.Types.Version

Methods

parsec :: CabalParsing m => m Version #

Text Version # 
Instance details

Defined in Distribution.Types.Version

Methods

disp :: Version -> Doc #

parse :: ReadP r Version #

Newtype SpecVersion (Either Version VersionRange) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: Either Version VersionRange -> SpecVersion #

unpack :: SpecVersion -> Either Version VersionRange #

type Rep Version # 
Instance details

Defined in Distribution.Types.Version

type Rep Version = D1 (MetaData "Version" "Distribution.Types.Version" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "PV0" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Word64)) :+: C1 (MetaCons "PV1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Int])))

defaultMain :: IO () #

defaultMainArgs :: [String] -> IO () #

defaultMainNoRead :: PackageDescription -> IO () #

Deprecated: it ignores its PackageDescription arg

diff --git a/doc/API/Cabal/Distribution-ModuleName.html b/doc/API/Cabal/Distribution-ModuleName.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-ModuleName.html @@ -0,0 +1,5 @@ +Distribution.ModuleName

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightDuncan Coutts 2008
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.ModuleName

Contents

Description

Data type for Haskell module names.

Synopsis

Documentation

newtype ModuleName #

A valid Haskell module name.

Constructors

ModuleName ShortTextLst 
Instances
Eq ModuleName # 
Instance details

Defined in Distribution.ModuleName

Methods

(==) :: ModuleName -> ModuleName -> Bool #

(/=) :: ModuleName -> ModuleName -> Bool #

Data ModuleName # 
Instance details

Defined in Distribution.ModuleName

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModuleName -> c ModuleName #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModuleName #

toConstr :: ModuleName -> Constr #

dataTypeOf :: ModuleName -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModuleName) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModuleName) #

gmapT :: (forall b. Data b => b -> b) -> ModuleName -> ModuleName #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModuleName -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModuleName -> r #

gmapQ :: (forall d. Data d => d -> u) -> ModuleName -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModuleName -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName #

Ord ModuleName # 
Instance details

Defined in Distribution.ModuleName

Methods

compare :: ModuleName -> ModuleName -> Ordering #

(<) :: ModuleName -> ModuleName -> Bool #

(<=) :: ModuleName -> ModuleName -> Bool #

(>) :: ModuleName -> ModuleName -> Bool #

(>=) :: ModuleName -> ModuleName -> Bool #

max :: ModuleName -> ModuleName -> ModuleName #

min :: ModuleName -> ModuleName -> ModuleName #

Read ModuleName # 
Instance details

Defined in Distribution.ModuleName

Methods

readsPrec :: Int -> ReadS ModuleName #

readList :: ReadS [ModuleName] #

readPrec :: ReadPrec ModuleName #

readListPrec :: ReadPrec [ModuleName] #

Show ModuleName # 
Instance details

Defined in Distribution.ModuleName

Methods

showsPrec :: Int -> ModuleName -> ShowS #

show :: ModuleName -> String #

showList :: [ModuleName] -> ShowS #

IsString ModuleName #

Construct a ModuleName from a valid module name String.

This is just a convenience function intended for valid module strings. It is + an error if it is used with a string that is not a valid module name. If you + are parsing user input then use simpleParse instead.

Instance details

Defined in Distribution.ModuleName

Methods

fromString :: String -> ModuleName #

Generic ModuleName # 
Instance details

Defined in Distribution.ModuleName

Associated Types

type Rep ModuleName :: * -> * #

Methods

from :: ModuleName -> Rep ModuleName x #

to :: Rep ModuleName x -> ModuleName #

Binary ModuleName # 
Instance details

Defined in Distribution.ModuleName

Methods

put :: ModuleName -> Put #

get :: Get ModuleName #

putList :: [ModuleName] -> Put #

NFData ModuleName # 
Instance details

Defined in Distribution.ModuleName

Methods

rnf :: ModuleName -> () #

Pretty ModuleName # 
Instance details

Defined in Distribution.ModuleName

Methods

pretty :: ModuleName -> Doc #

Parsec ModuleName # 
Instance details

Defined in Distribution.ModuleName

Methods

parsec :: CabalParsing m => m ModuleName #

Text ModuleName # 
Instance details

Defined in Distribution.ModuleName

Methods

disp :: ModuleName -> Doc #

parse :: ReadP r ModuleName #

ModSubst (Set ModuleName) # 
Instance details

Defined in Distribution.Backpack.ModSubst

Methods

modSubst :: OpenModuleSubst -> Set ModuleName -> Set ModuleName #

type Rep ModuleName # 
Instance details

Defined in Distribution.ModuleName

type Rep ModuleName

fromString :: IsString a => String -> a #

fromComponents :: [String] -> ModuleName #

Construct a ModuleName from valid module components, i.e. parts + separated by dots.

components :: ModuleName -> [String] #

The individual components of a hierarchical module name. For example

components (fromString "A.B.C") = ["A", "B", "C"]

toFilePath :: ModuleName -> FilePath #

Convert a module name to a file path, but without any file extension. + For example:

toFilePath (fromString "A.B.C") = "A/B/C"

main :: ModuleName #

The module name Main.

simple :: String -> ModuleName #

Deprecated: use ModuleName.fromString instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

Internal

validModuleComponent :: String -> Bool #

diff --git a/doc/API/Cabal/Distribution-Package.html b/doc/API/Cabal/Distribution-Package.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Package.html @@ -0,0 +1,11 @@ +Distribution.Package

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2004
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Package

Description

Defines a package identifier along with a parser and pretty printer for it. + PackageIdentifiers consist of a name and an exact version. It also defines + a Dependency data type. A dependency is a package name and a version + range, like "foo >= 1.2 && < 2".

Synopsis

Documentation

module Distribution.Types.AbiHash

module Distribution.Types.ComponentId

module Distribution.Types.PackageId

module Distribution.Types.UnitId

module Distribution.Types.Module

module Distribution.Types.PackageName

module Distribution.Types.PkgconfigName

module Distribution.Types.Dependency

class Package pkg where #

Class of things that have a PackageIdentifier

Types in this class are all notions of a package. This allows us to have + different types for the different phases that packages go though, from + simple name/id, package description, configured or installed packages.

Not all kinds of packages can be uniquely identified by a + PackageIdentifier. In particular, installed packages cannot, there may be + many installed instances of the same source package.

Minimal complete definition

packageId

Methods

packageId :: pkg -> PackageIdentifier #

Instances
Package PackageIdentifier # 
Instance details

Defined in Distribution.Package

Methods

packageId :: PackageIdentifier -> PackageIdentifier #

Package PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

packageId :: PackageDescription -> PackageIdentifier #

Package GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

packageId :: GenericPackageDescription -> PackageIdentifier #

Package InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

packageId :: InstalledPackageInfo -> PackageIdentifier #

Package LinkedComponent # 
Instance details

Defined in Distribution.Backpack.LinkedComponent

Methods

packageId :: LinkedComponent -> PackageIdentifier #

Package (AnnotatedId id) # 
Instance details

Defined in Distribution.Types.AnnotatedId

Methods

packageId :: AnnotatedId id -> PackageIdentifier #

packageName :: Package pkg => pkg -> PackageName #

packageVersion :: Package pkg => pkg -> Version #

class HasMungedPackageId pkg where #

Minimal complete definition

mungedId

Methods

mungedId :: pkg -> MungedPackageId #

Instances
HasMungedPackageId MungedPackageId # 
Instance details

Defined in Distribution.Package

Methods

mungedId :: MungedPackageId -> MungedPackageId #

HasMungedPackageId InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

mungedId :: InstalledPackageInfo -> MungedPackageId #

mungedName' :: HasMungedPackageId pkg => pkg -> MungedPackageName #

mungedVersion' :: HasMungedPackageId munged => munged -> Version #

class Package pkg => HasUnitId pkg where #

Packages that have an installed unit ID

Minimal complete definition

installedUnitId

Methods

installedUnitId :: pkg -> UnitId #

Instances
HasUnitId InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

installedUnitId :: InstalledPackageInfo -> UnitId #

installedPackageId :: HasUnitId pkg => pkg -> UnitId #

Deprecated: Use installedUnitId instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

Compatibility wrapper for Cabal pre-1.24.

class HasUnitId pkg => PackageInstalled pkg where #

Class of installed packages.

The primary data type which is an instance of this package is + InstalledPackageInfo, but when we are doing install plans in Cabal install + we may have other, installed package-like things which contain more metadata. + Installed packages have exact dependencies installedDepends.

Minimal complete definition

installedDepends

Methods

installedDepends :: pkg -> [UnitId] #

Instances
PackageInstalled InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

installedDepends :: InstalledPackageInfo -> [UnitId] #

diff --git a/doc/API/Cabal/Distribution-PackageDescription-Check.html b/doc/API/Cabal/Distribution-PackageDescription-Check.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-PackageDescription-Check.html @@ -0,0 +1,36 @@ +Distribution.PackageDescription.Check

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightLennart Kolmodin 2008
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.PackageDescription.Check

Contents

Description

This has code for checking for various problems in packages. There is one + set of checks that just looks at a PackageDescription in isolation and + another set of checks that also looks at files in the package. Some of the + checks are basic sanity checks, others are portability standards that we'd + like to encourage. There is a PackageCheck type that distinguishes the + different kinds of check so we can see which ones are appropriate to report + in different situations. This code gets uses when configuring a package when + we consider only basic problems. The higher standard is uses when when + preparing a source tarball and by Hackage when uploading new packages. The + reason for this is that we want to hold packages that are expected to be + distributed to a higher standard than packages that are only ever expected + to be used on the author's own environment.

Synopsis

Package Checking

data PackageCheck #

Results of some kind of failed package check.

There are a range of severities, from merely dubious to totally insane. + All of them come with a human readable explanation. In future we may augment + them with more machine readable explanations, for example to help an IDE + suggest automatic corrections.

Constructors

PackageBuildImpossible

This package description is no good. There's no way it's going to + build sensibly. This should give an error at configure time.

Fields

PackageBuildWarning

A problem that is likely to affect building the package, or an + issue that we'd like every package author to be aware of, even if + the package is never distributed.

Fields

PackageDistSuspicious

An issue that might not be a problem for the package author but + might be annoying or detrimental when the package is distributed to + users. We should encourage distributed packages to be free from these + issues, but occasionally there are justifiable reasons so we cannot + ban them entirely.

Fields

PackageDistSuspiciousWarn

Like PackageDistSuspicious but will only display warnings + rather than causing abnormal exit when you run 'cabal check'.

Fields

PackageDistInexcusable

An issue that is OK in the author's environment but is almost + certain to be a portability problem for other environments. We can + quite legitimately refuse to publicly distribute packages with these + problems.

Fields

Instances
Eq PackageCheck # 
Instance details

Defined in Distribution.PackageDescription.Check

Methods

(==) :: PackageCheck -> PackageCheck -> Bool #

(/=) :: PackageCheck -> PackageCheck -> Bool #

Ord PackageCheck # 
Instance details

Defined in Distribution.PackageDescription.Check

Methods

compare :: PackageCheck -> PackageCheck -> Ordering #

(<) :: PackageCheck -> PackageCheck -> Bool #

(<=) :: PackageCheck -> PackageCheck -> Bool #

(>) :: PackageCheck -> PackageCheck -> Bool #

(>=) :: PackageCheck -> PackageCheck -> Bool #

max :: PackageCheck -> PackageCheck -> PackageCheck #

min :: PackageCheck -> PackageCheck -> PackageCheck #

Show PackageCheck # 
Instance details

Defined in Distribution.PackageDescription.Check

Methods

showsPrec :: Int -> PackageCheck -> ShowS #

show :: PackageCheck -> String #

showList :: [PackageCheck] -> ShowS #

checkPackage :: GenericPackageDescription -> Maybe PackageDescription -> [PackageCheck] #

Check for common mistakes and problems in package descriptions.

This is the standard collection of checks covering all aspects except + for checks that require looking at files within the package. For those + see checkPackageFiles.

It requires the GenericPackageDescription and optionally a particular + configuration of that package. If you pass Nothing then we just check + a version of the generic description using flattenPackageDescription.

checkConfiguredPackage :: PackageDescription -> [PackageCheck] #

Checking package contents

checkPackageFiles :: Verbosity -> PackageDescription -> FilePath -> NoCallStackIO [PackageCheck] #

Sanity check things that requires IO. It looks at the files in the + package and expects to find the package unpacked in at the given file path.

checkPackageContent :: Monad m => CheckPackageContentOps m -> PackageDescription -> m [PackageCheck] #

Sanity check things that requires looking at files in the package. + This is a generalised version of checkPackageFiles that can work in any + monad for which you can provide CheckPackageContentOps operations.

The point of this extra generality is to allow doing checks in some virtual + file system, for example a tarball in memory.

data CheckPackageContentOps m #

A record of operations needed to check the contents of packages. + Used by checkPackageContent.

Constructors

CheckPackageContentOps 

Fields

checkPackageFileNames :: [FilePath] -> [PackageCheck] #

Check the names of all files in a package for portability problems. This + should be done for example when creating or validating a package tarball.

diff --git a/doc/API/Cabal/Distribution-PackageDescription-Configuration.html b/doc/API/Cabal/Distribution-PackageDescription-Configuration.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-PackageDescription-Configuration.html @@ -0,0 +1,41 @@ +Distribution.PackageDescription.Configuration

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightThomas Schilling 2007
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.PackageDescription.Configuration

Description

This is about the cabal configurations feature. It exports + finalizePD and flattenPackageDescription which are + functions for converting GenericPackageDescriptions down to + PackageDescriptions. It has code for working with the tree of conditions + and resolving or flattening conditions.

Synopsis

Documentation

finalizePD #

Arguments

:: FlagAssignment

Explicitly specified flag assignments

-> ComponentRequestedSpec 
-> (Dependency -> Bool)

Is a given dependency satisfiable from the set of + available packages? If this is unknown then use + True.

-> Platform

The Arch and OS

-> CompilerInfo

Compiler information

-> [Dependency]

Additional constraints

-> GenericPackageDescription 
-> Either [Dependency] (PackageDescription, FlagAssignment)

Either missing dependencies or the resolved package + description along with the flag assignments chosen.

Create a package description with all configurations resolved.

This function takes a GenericPackageDescription and several environment + parameters and tries to generate PackageDescription by finding a flag + assignment that result in satisfiable dependencies.

It takes as inputs a not necessarily complete specifications of flags + assignments, an optional package index as well as platform parameters. If + some flags are not assigned explicitly, this function will try to pick an + assignment that causes this function to succeed. The package index is + optional since on some platforms we cannot determine which packages have + been installed before. When no package index is supplied, every dependency + is assumed to be satisfiable, therefore all not explicitly assigned flags + will get their default values.

This function will fail if it cannot find a flag assignment that leads to + satisfiable dependencies. (It will not try alternative assignments for + explicitly specified flags.) In case of failure it will return the missing + dependencies that it encountered when trying different flag assignments. + On success, it will return the package description and the full flag + assignment chosen.

Note that this drops any stanzas which have buildable: False. While + this is arguably the right thing to do, it means we give bad error + messages in some situations, see #3858.

finalizePackageDescription #

Arguments

:: FlagAssignment

Explicitly specified flag assignments

-> (Dependency -> Bool)

Is a given dependency satisfiable from the set of + available packages? If this is unknown then use + True.

-> Platform

The Arch and OS

-> CompilerInfo

Compiler information

-> [Dependency]

Additional constraints

-> GenericPackageDescription 
-> Either [Dependency] (PackageDescription, FlagAssignment) 

Deprecated: This function now always assumes tests and benchmarks are disabled; use finalizePD with ComponentRequestedSpec to specify something more specific. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

flattenPackageDescription :: GenericPackageDescription -> PackageDescription #

Flatten a generic package description by ignoring all conditions and just + join the field descriptors into on package description. Note, however, + that this may lead to inconsistent field values, since all values are + joined into one field, which may not be possible in the original package + description, due to the use of exclusive choices (if ... else ...).

TODO: One particularly tricky case is defaulting. In the original package + description, e.g., the source directory might either be the default or a + certain, explicitly set path. Since defaults are filled in only after the + package has been resolved and when no explicit value has been set, the + default path will be missing from the package description returned by this + function.

parseCondition :: ReadP r (Condition ConfVar) #

Parse a configuration condition from a string.

freeVars :: CondTree ConfVar c a -> [FlagName] #

extractCondition :: Eq v => (a -> Bool) -> CondTree v c a -> Condition v #

Extract the condition matched by the given predicate from a cond tree.

We use this mainly for extracting buildable conditions (see the Note above), + but the function is in fact more general.

extractConditions :: (BuildInfo -> Bool) -> GenericPackageDescription -> [Condition ConfVar] #

Extract conditions matched by the given predicate from all cond trees in a + GenericPackageDescription.

addBuildableCondition :: (Eq v, Monoid a, Monoid c) => (a -> BuildInfo) -> CondTree v c a -> CondTree v c a #

Transforms a CondTree by putting the input under the "then" branch of a + conditional that is True when Buildable is True. If addBuildableCondition + can determine that Buildable is always True, it returns the input unchanged. + If Buildable is always False, it returns the empty CondTree.

mapCondTree :: (a -> b) -> (c -> d) -> (Condition v -> Condition w) -> CondTree v c a -> CondTree w d b #

mapTreeData :: (a -> b) -> CondTree v c a -> CondTree v c b #

mapTreeConds :: (Condition v -> Condition w) -> CondTree v c a -> CondTree w c a #

mapTreeConstrs :: (c -> d) -> CondTree v c a -> CondTree v d a #

transformAllBuildInfos :: (BuildInfo -> BuildInfo) -> (SetupBuildInfo -> SetupBuildInfo) -> GenericPackageDescription -> GenericPackageDescription #

transformAllBuildDepends :: (Dependency -> Dependency) -> GenericPackageDescription -> GenericPackageDescription #

Walk a GenericPackageDescription and apply f to all nested + build-depends fields.

diff --git a/doc/API/Cabal/Distribution-PackageDescription-FieldGrammar.html b/doc/API/Cabal/Distribution-PackageDescription-FieldGrammar.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-PackageDescription-FieldGrammar.html @@ -0,0 +1,3 @@ +Distribution.PackageDescription.FieldGrammar

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.PackageDescription.FieldGrammar

Contents

Description

GenericPackageDescription Field descriptions

Synopsis

Package description

packageDescriptionFieldGrammar :: (FieldGrammar g, Applicative (g PackageDescription), Applicative (g PackageIdentifier)) => g PackageDescription PackageDescription #

Library

libraryFieldGrammar :: (FieldGrammar g, Applicative (g Library), Applicative (g BuildInfo)) => Maybe UnqualComponentName -> g Library Library #

Foreign library

foreignLibFieldGrammar :: (FieldGrammar g, Applicative (g ForeignLib), Applicative (g BuildInfo)) => UnqualComponentName -> g ForeignLib ForeignLib #

Executable

executableFieldGrammar :: (FieldGrammar g, Applicative (g Executable), Applicative (g BuildInfo)) => UnqualComponentName -> g Executable Executable #

Test suite

data TestSuiteStanza #

An intermediate type just used for parsing the test-suite stanza. + After validation it is converted into the proper TestSuite type.

Constructors

TestSuiteStanza 

Fields

Instances
HasBuildInfo TestSuiteStanza # 
Instance details

Defined in Distribution.PackageDescription.FieldGrammar

Methods

buildInfo :: Lens' TestSuiteStanza BuildInfo #

buildable :: Lens' TestSuiteStanza Bool #

buildTools :: Lens' TestSuiteStanza [LegacyExeDependency] #

buildToolDepends :: Lens' TestSuiteStanza [ExeDependency] #

cppOptions :: Lens' TestSuiteStanza [String] #

asmOptions :: Lens' TestSuiteStanza [String] #

cmmOptions :: Lens' TestSuiteStanza [String] #

ccOptions :: Lens' TestSuiteStanza [String] #

cxxOptions :: Lens' TestSuiteStanza [String] #

ldOptions :: Lens' TestSuiteStanza [String] #

pkgconfigDepends :: Lens' TestSuiteStanza [PkgconfigDependency] #

frameworks :: Lens' TestSuiteStanza [String] #

extraFrameworkDirs :: Lens' TestSuiteStanza [String] #

asmSources :: Lens' TestSuiteStanza [FilePath] #

cmmSources :: Lens' TestSuiteStanza [FilePath] #

cSources :: Lens' TestSuiteStanza [FilePath] #

cxxSources :: Lens' TestSuiteStanza [FilePath] #

jsSources :: Lens' TestSuiteStanza [FilePath] #

hsSourceDirs :: Lens' TestSuiteStanza [FilePath] #

otherModules :: Lens' TestSuiteStanza [ModuleName] #

virtualModules :: Lens' TestSuiteStanza [ModuleName] #

autogenModules :: Lens' TestSuiteStanza [ModuleName] #

defaultLanguage :: Lens' TestSuiteStanza (Maybe Language) #

otherLanguages :: Lens' TestSuiteStanza [Language] #

defaultExtensions :: Lens' TestSuiteStanza [Extension] #

otherExtensions :: Lens' TestSuiteStanza [Extension] #

oldExtensions :: Lens' TestSuiteStanza [Extension] #

extraLibs :: Lens' TestSuiteStanza [String] #

extraGHCiLibs :: Lens' TestSuiteStanza [String] #

extraBundledLibs :: Lens' TestSuiteStanza [String] #

extraLibFlavours :: Lens' TestSuiteStanza [String] #

extraLibDirs :: Lens' TestSuiteStanza [String] #

includeDirs :: Lens' TestSuiteStanza [FilePath] #

includes :: Lens' TestSuiteStanza [FilePath] #

installIncludes :: Lens' TestSuiteStanza [FilePath] #

options :: Lens' TestSuiteStanza [(CompilerFlavor, [String])] #

profOptions :: Lens' TestSuiteStanza [(CompilerFlavor, [String])] #

sharedOptions :: Lens' TestSuiteStanza [(CompilerFlavor, [String])] #

staticOptions :: Lens' TestSuiteStanza [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' TestSuiteStanza [(String, String)] #

targetBuildDepends :: Lens' TestSuiteStanza [Dependency] #

mixins :: Lens' TestSuiteStanza [Mixin] #

testSuiteFieldGrammar :: (FieldGrammar g, Applicative (g TestSuiteStanza), Applicative (g BuildInfo)) => g TestSuiteStanza TestSuiteStanza #

validateTestSuite :: Position -> TestSuiteStanza -> ParseResult TestSuite #

unvalidateTestSuite :: TestSuite -> TestSuiteStanza #

Lenses

testStanzaTestType :: Lens' TestSuiteStanza (Maybe TestType) #

testStanzaMainIs :: Lens' TestSuiteStanza (Maybe FilePath) #

testStanzaTestModule :: Lens' TestSuiteStanza (Maybe ModuleName) #

testStanzaBuildInfo :: Lens' TestSuiteStanza BuildInfo #

Benchmark

data BenchmarkStanza #

An intermediate type just used for parsing the benchmark stanza. + After validation it is converted into the proper Benchmark type.

Constructors

BenchmarkStanza 

Fields

Instances
HasBuildInfo BenchmarkStanza # 
Instance details

Defined in Distribution.PackageDescription.FieldGrammar

Methods

buildInfo :: Lens' BenchmarkStanza BuildInfo #

buildable :: Lens' BenchmarkStanza Bool #

buildTools :: Lens' BenchmarkStanza [LegacyExeDependency] #

buildToolDepends :: Lens' BenchmarkStanza [ExeDependency] #

cppOptions :: Lens' BenchmarkStanza [String] #

asmOptions :: Lens' BenchmarkStanza [String] #

cmmOptions :: Lens' BenchmarkStanza [String] #

ccOptions :: Lens' BenchmarkStanza [String] #

cxxOptions :: Lens' BenchmarkStanza [String] #

ldOptions :: Lens' BenchmarkStanza [String] #

pkgconfigDepends :: Lens' BenchmarkStanza [PkgconfigDependency] #

frameworks :: Lens' BenchmarkStanza [String] #

extraFrameworkDirs :: Lens' BenchmarkStanza [String] #

asmSources :: Lens' BenchmarkStanza [FilePath] #

cmmSources :: Lens' BenchmarkStanza [FilePath] #

cSources :: Lens' BenchmarkStanza [FilePath] #

cxxSources :: Lens' BenchmarkStanza [FilePath] #

jsSources :: Lens' BenchmarkStanza [FilePath] #

hsSourceDirs :: Lens' BenchmarkStanza [FilePath] #

otherModules :: Lens' BenchmarkStanza [ModuleName] #

virtualModules :: Lens' BenchmarkStanza [ModuleName] #

autogenModules :: Lens' BenchmarkStanza [ModuleName] #

defaultLanguage :: Lens' BenchmarkStanza (Maybe Language) #

otherLanguages :: Lens' BenchmarkStanza [Language] #

defaultExtensions :: Lens' BenchmarkStanza [Extension] #

otherExtensions :: Lens' BenchmarkStanza [Extension] #

oldExtensions :: Lens' BenchmarkStanza [Extension] #

extraLibs :: Lens' BenchmarkStanza [String] #

extraGHCiLibs :: Lens' BenchmarkStanza [String] #

extraBundledLibs :: Lens' BenchmarkStanza [String] #

extraLibFlavours :: Lens' BenchmarkStanza [String] #

extraLibDirs :: Lens' BenchmarkStanza [String] #

includeDirs :: Lens' BenchmarkStanza [FilePath] #

includes :: Lens' BenchmarkStanza [FilePath] #

installIncludes :: Lens' BenchmarkStanza [FilePath] #

options :: Lens' BenchmarkStanza [(CompilerFlavor, [String])] #

profOptions :: Lens' BenchmarkStanza [(CompilerFlavor, [String])] #

sharedOptions :: Lens' BenchmarkStanza [(CompilerFlavor, [String])] #

staticOptions :: Lens' BenchmarkStanza [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' BenchmarkStanza [(String, String)] #

targetBuildDepends :: Lens' BenchmarkStanza [Dependency] #

mixins :: Lens' BenchmarkStanza [Mixin] #

benchmarkFieldGrammar :: (FieldGrammar g, Applicative (g BenchmarkStanza), Applicative (g BuildInfo)) => g BenchmarkStanza BenchmarkStanza #

validateBenchmark :: Position -> BenchmarkStanza -> ParseResult Benchmark #

unvalidateBenchmark :: Benchmark -> BenchmarkStanza #

Lenses

benchmarkStanzaBenchmarkType :: Lens' BenchmarkStanza (Maybe BenchmarkType) #

benchmarkStanzaMainIs :: Lens' BenchmarkStanza (Maybe FilePath) #

benchmarkStanzaBenchmarkModule :: Lens' BenchmarkStanza (Maybe ModuleName) #

benchmarkStanzaBuildInfo :: Lens' BenchmarkStanza BuildInfo #

Flag

flagFieldGrammar :: (FieldGrammar g, Applicative (g Flag)) => FlagName -> g Flag Flag #

Source repository

sourceRepoFieldGrammar :: (FieldGrammar g, Applicative (g SourceRepo)) => RepoKind -> g SourceRepo SourceRepo #

Setup build info

setupBInfoFieldGrammar :: (FieldGrammar g, Functor (g SetupBuildInfo)) => Bool -> g SetupBuildInfo SetupBuildInfo #

Component build info

buildInfoFieldGrammar :: (FieldGrammar g, Applicative (g BuildInfo)) => g BuildInfo BuildInfo #

diff --git a/doc/API/Cabal/Distribution-PackageDescription-Parsec.html b/doc/API/Cabal/Distribution-PackageDescription-Parsec.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-PackageDescription-Parsec.html @@ -0,0 +1,14 @@ +Distribution.PackageDescription.Parsec

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2005
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.PackageDescription.Parsec

Contents

Description

This defined parsers and partial pretty printers for the .cabal format.

Synopsis

Package descriptions

readGenericPackageDescription :: Verbosity -> FilePath -> IO GenericPackageDescription #

Parse the given package file.

parseGenericPackageDescription :: ByteString -> ParseResult GenericPackageDescription #

Parses the given file into a GenericPackageDescription.

In Cabal 1.2 the syntax for package descriptions was changed to a format + with sections and possibly indented property descriptions.

parseGenericPackageDescriptionMaybe :: ByteString -> Maybe GenericPackageDescription #

Maybe variant of parseGenericPackageDescription

Parsing

data ParseResult a #

A monad with failure and accumulating errors and warnings.

Instances
Monad ParseResult # 
Instance details

Defined in Distribution.Parsec.ParseResult

Methods

(>>=) :: ParseResult a -> (a -> ParseResult b) -> ParseResult b #

(>>) :: ParseResult a -> ParseResult b -> ParseResult b #

return :: a -> ParseResult a #

fail :: String -> ParseResult a #

Functor ParseResult # 
Instance details

Defined in Distribution.Parsec.ParseResult

Methods

fmap :: (a -> b) -> ParseResult a -> ParseResult b #

(<$) :: a -> ParseResult b -> ParseResult a #

Applicative ParseResult # 
Instance details

Defined in Distribution.Parsec.ParseResult

Methods

pure :: a -> ParseResult a #

(<*>) :: ParseResult (a -> b) -> ParseResult a -> ParseResult b #

liftA2 :: (a -> b -> c) -> ParseResult a -> ParseResult b -> ParseResult c #

(*>) :: ParseResult a -> ParseResult b -> ParseResult b #

(<*) :: ParseResult a -> ParseResult b -> ParseResult a #

runParseResult :: ParseResult a -> ([PWarning], Either (Maybe Version, [PError]) a) #

Destruct a ParseResult into the emitted warnings and either + a successful value or + list of errors and possibly recovered a spec-version declaration.

New-style spec-version

scanSpecVersion :: ByteString -> Maybe Version #

Quickly scan new-style spec-version

A new-style spec-version declaration begins the .cabal file and + follow the following case-insensitive grammar (expressed in + RFC5234 ABNF):

newstyle-spec-version-decl = "cabal-version" *WS ":" *WS newstyle-pec-version *WS
+
+spec-version               = NUM "." NUM [ "." NUM ]
+
+NUM    = DIGIT0 / DIGITP 1*DIGIT0
+DIGIT0 = %x30-39
+DIGITP = %x31-39
+WS = %20
+

Supplementary build information

readHookedBuildInfo :: Verbosity -> FilePath -> IO HookedBuildInfo #

parseHookedBuildInfo :: ByteString -> ParseResult HookedBuildInfo #

diff --git a/doc/API/Cabal/Distribution-PackageDescription-PrettyPrint.html b/doc/API/Cabal/Distribution-PackageDescription-PrettyPrint.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-PackageDescription-PrettyPrint.html @@ -0,0 +1,1 @@ +Distribution.PackageDescription.PrettyPrint

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightJürgen Nicklisch-Franken 2010
LicenseBSD3
Maintainercabal-devel@haskell.org
Stabilityprovisional
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.PackageDescription.PrettyPrint

Contents

Description

Pretty printing for cabal files

Synopsis

Generic package descriptions

writeGenericPackageDescription :: FilePath -> GenericPackageDescription -> NoCallStackIO () #

Writes a .cabal file from a generic package description

showGenericPackageDescription :: GenericPackageDescription -> String #

Writes a generic package description to a string

Package descriptions

writePackageDescription :: FilePath -> PackageDescription -> NoCallStackIO () #

Since: 2.0.0.2

showPackageDescription :: PackageDescription -> String #

Since: 2.0.0.2

Supplementary build information

writeHookedBuildInfo :: FilePath -> HookedBuildInfo -> NoCallStackIO () #

Since: 2.0.0.2

showHookedBuildInfo :: HookedBuildInfo -> String #

Since: 2.0.0.2

diff --git a/doc/API/Cabal/Distribution-PackageDescription-Quirks.html b/doc/API/Cabal/Distribution-PackageDescription-Quirks.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-PackageDescription-Quirks.html @@ -0,0 +1,2 @@ +Distribution.PackageDescription.Quirks

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.PackageDescription.Quirks

Description

Since: 2.2.0.0

Synopsis

Documentation

patchQuirks :: ByteString -> (Bool, ByteString) #

Patch legacy .cabal file contents to allow parsec parser to accept + all of Hackage.

Bool part of the result tells whether the output is modified.

Since: 2.2.0.0

diff --git a/doc/API/Cabal/Distribution-PackageDescription-Utils.html b/doc/API/Cabal/Distribution-PackageDescription-Utils.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-PackageDescription-Utils.html @@ -0,0 +1,1 @@ +Distribution.PackageDescription.Utils

Cabal-2.4.0.1: A framework for packaging Haskell software

Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellSafe
LanguageHaskell2010

Distribution.PackageDescription.Utils

Description

Common utils used by modules under Distribution.PackageDescription.*.

Documentation

cabalBug :: String -> a #

userBug :: String -> a #

diff --git a/doc/API/Cabal/Distribution-PackageDescription.html b/doc/API/Cabal/Distribution-PackageDescription.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-PackageDescription.html @@ -0,0 +1,195 @@ +Distribution.PackageDescription

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2005
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.PackageDescription

Contents

Description

Backwards compatibility reexport of everything you need to know + about .cabal files.

Synopsis

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 

Fields

Instances
Eq PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

(==) :: PackageDescription -> PackageDescription -> Bool #

(/=) :: PackageDescription -> PackageDescription -> Bool #

Data PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PackageDescription -> c PackageDescription #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PackageDescription #

toConstr :: PackageDescription -> Constr #

dataTypeOf :: PackageDescription -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PackageDescription) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PackageDescription) #

gmapT :: (forall b. Data b => b -> b) -> PackageDescription -> PackageDescription #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PackageDescription -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PackageDescription -> r #

gmapQ :: (forall d. Data d => d -> u) -> PackageDescription -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PackageDescription -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PackageDescription -> m PackageDescription #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageDescription -> m PackageDescription #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageDescription -> m PackageDescription #

Read PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

readsPrec :: Int -> ReadS PackageDescription #

readList :: ReadS [PackageDescription] #

readPrec :: ReadPrec PackageDescription #

readListPrec :: ReadPrec [PackageDescription] #

Show PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

showsPrec :: Int -> PackageDescription -> ShowS #

show :: PackageDescription -> String #

showList :: [PackageDescription] -> ShowS #

Generic PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Associated Types

type Rep PackageDescription :: * -> * #

Methods

from :: PackageDescription -> Rep PackageDescription x #

to :: Rep PackageDescription x -> PackageDescription #

Binary PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

put :: PackageDescription -> Put #

get :: Get PackageDescription #

putList :: [PackageDescription] -> Put #

NFData PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

rnf :: PackageDescription -> () #

Package PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

packageId :: PackageDescription -> PackageIdentifier #

HasBuildInfos PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

traverseBuildInfos :: Traversal' PackageDescription BuildInfo #

type Rep PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

type Rep PackageDescription = D1 (MetaData "PackageDescription" "Distribution.Types.PackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "PackageDescription" PrefixI True) ((((S1 (MetaSel (Just "specVersionRaw") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Either Version VersionRange)) :*: (S1 (MetaSel (Just "package") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageIdentifier) :*: S1 (MetaSel (Just "licenseRaw") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Either License License)))) :*: ((S1 (MetaSel (Just "licenseFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "copyright") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :*: (S1 (MetaSel (Just "maintainer") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "author") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))) :*: (((S1 (MetaSel (Just "stability") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "testedWith") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(CompilerFlavor, VersionRange)])) :*: (S1 (MetaSel (Just "homepage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "pkgUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))) :*: ((S1 (MetaSel (Just "bugReports") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "sourceRepos") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [SourceRepo])) :*: (S1 (MetaSel (Just "synopsis") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "description") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))) :*: (((S1 (MetaSel (Just "category") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: (S1 (MetaSel (Just "customFieldsPD") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, String)]) :*: S1 (MetaSel (Just "buildTypeRaw") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe BuildType)))) :*: ((S1 (MetaSel (Just "setupBuildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe SetupBuildInfo)) :*: S1 (MetaSel (Just "library") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Library))) :*: (S1 (MetaSel (Just "subLibraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Library]) :*: S1 (MetaSel (Just "executables") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Executable])))) :*: (((S1 (MetaSel (Just "foreignLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ForeignLib]) :*: S1 (MetaSel (Just "testSuites") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [TestSuite])) :*: (S1 (MetaSel (Just "benchmarks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Benchmark]) :*: S1 (MetaSel (Just "dataFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]))) :*: ((S1 (MetaSel (Just "dataDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "extraSrcFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])) :*: (S1 (MetaSel (Just "extraTmpFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "extraDocFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))))))

emptyPackageDescription :: PackageDescription #

specVersion :: PackageDescription -> Version #

The version of the Cabal spec that this package should be interpreted + against.

Historically we used a version range but we are switching to using a single + version. Currently we accept either. This function converts into a single + version by ignoring upper bounds in the version range.

buildType :: PackageDescription -> BuildType #

The effective build-type after applying defaulting rules.

The original build-type value parsed is stored in the + buildTypeRaw field. However, the build-type field is optional + and can therefore be empty in which case we need to compute the + effective build-type. This function implements the following + defaulting rules:

  • For cabal-version:2.0 and below, default to the Custom + build-type unconditionally.
  • Otherwise, if a custom-setup stanza is defined, default to + the Custom build-type; else default to Simple build-type.

Since: 2.2

license :: PackageDescription -> License #

The SPDX LicenseExpression of the package.

Since: 2.2.0.0

descCabalVersion :: PackageDescription -> VersionRange #

Deprecated: Use specVersion instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

The range of versions of the Cabal tools that this package is intended to + work with.

This function is deprecated and should not be used for new purposes, only to + support old packages that rely on the old interpretation.

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)

Instances
Eq BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

(==) :: BuildType -> BuildType -> Bool #

(/=) :: BuildType -> BuildType -> Bool #

Data BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BuildType -> c BuildType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BuildType #

toConstr :: BuildType -> Constr #

dataTypeOf :: BuildType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BuildType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BuildType) #

gmapT :: (forall b. Data b => b -> b) -> BuildType -> BuildType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BuildType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BuildType -> r #

gmapQ :: (forall d. Data d => d -> u) -> BuildType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BuildType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BuildType -> m BuildType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BuildType -> m BuildType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BuildType -> m BuildType #

Read BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

readsPrec :: Int -> ReadS BuildType #

readList :: ReadS [BuildType] #

readPrec :: ReadPrec BuildType #

readListPrec :: ReadPrec [BuildType] #

Show BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

showsPrec :: Int -> BuildType -> ShowS #

show :: BuildType -> String #

showList :: [BuildType] -> ShowS #

Generic BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Associated Types

type Rep BuildType :: * -> * #

Methods

from :: BuildType -> Rep BuildType x #

to :: Rep BuildType x -> BuildType #

Binary BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

put :: BuildType -> Put #

get :: Get BuildType #

putList :: [BuildType] -> Put #

NFData BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

rnf :: BuildType -> () #

Pretty BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

pretty :: BuildType -> Doc #

Parsec BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

parsec :: CabalParsing m => m BuildType #

Text BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

disp :: BuildType -> Doc #

parse :: ReadP r BuildType #

type Rep BuildType # 
Instance details

Defined in Distribution.Types.BuildType

type Rep BuildType = D1 (MetaData "BuildType" "Distribution.Types.BuildType" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "Simple" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Configure" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Make" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Custom" PrefixI False) (U1 :: * -> *)))

knownBuildTypes :: [BuildType] #

allLibraries :: PackageDescription -> [Library] #

Renaming (syntactic)

data ModuleRenaming #

Renaming applied to the modules provided by a package. + The boolean indicates whether or not to also include all of the + original names of modules. Thus, ModuleRenaming False [] is + "don't expose any modules, and ModuleRenaming True [(Data.Bool, Bool)] + is, "expose all modules, but also expose Data.Bool as Bool". + If a renaming is omitted you get the DefaultRenaming.

(NB: This is a list not a map so that we can preserve order.)

Constructors

ModuleRenaming [(ModuleName, ModuleName)]

A module renaming/thinning; e.g., (A as B, C as C) + brings B and C into scope.

DefaultRenaming

The default renaming, bringing all exported modules + into scope.

HidingRenaming [ModuleName]

Hiding renaming, e.g., hiding (A, B), bringing all + exported modules into scope except the hidden ones.

Instances
Eq ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

(==) :: ModuleRenaming -> ModuleRenaming -> Bool #

(/=) :: ModuleRenaming -> ModuleRenaming -> Bool #

Data ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModuleRenaming -> c ModuleRenaming #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModuleRenaming #

toConstr :: ModuleRenaming -> Constr #

dataTypeOf :: ModuleRenaming -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModuleRenaming) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModuleRenaming) #

gmapT :: (forall b. Data b => b -> b) -> ModuleRenaming -> ModuleRenaming #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModuleRenaming -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModuleRenaming -> r #

gmapQ :: (forall d. Data d => d -> u) -> ModuleRenaming -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModuleRenaming -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModuleRenaming -> m ModuleRenaming #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleRenaming -> m ModuleRenaming #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleRenaming -> m ModuleRenaming #

Ord ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

compare :: ModuleRenaming -> ModuleRenaming -> Ordering #

(<) :: ModuleRenaming -> ModuleRenaming -> Bool #

(<=) :: ModuleRenaming -> ModuleRenaming -> Bool #

(>) :: ModuleRenaming -> ModuleRenaming -> Bool #

(>=) :: ModuleRenaming -> ModuleRenaming -> Bool #

max :: ModuleRenaming -> ModuleRenaming -> ModuleRenaming #

min :: ModuleRenaming -> ModuleRenaming -> ModuleRenaming #

Read ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

readsPrec :: Int -> ReadS ModuleRenaming #

readList :: ReadS [ModuleRenaming] #

readPrec :: ReadPrec ModuleRenaming #

readListPrec :: ReadPrec [ModuleRenaming] #

Show ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

showsPrec :: Int -> ModuleRenaming -> ShowS #

show :: ModuleRenaming -> String #

showList :: [ModuleRenaming] -> ShowS #

Generic ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Associated Types

type Rep ModuleRenaming :: * -> * #

Methods

from :: ModuleRenaming -> Rep ModuleRenaming x #

to :: Rep ModuleRenaming x -> ModuleRenaming #

Binary ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

put :: ModuleRenaming -> Put #

get :: Get ModuleRenaming #

putList :: [ModuleRenaming] -> Put #

NFData ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

rnf :: ModuleRenaming -> () #

Pretty ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

pretty :: ModuleRenaming -> Doc #

Parsec ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

parsec :: CabalParsing m => m ModuleRenaming #

Text ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

disp :: ModuleRenaming -> Doc #

parse :: ReadP r ModuleRenaming #

type Rep ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

type Rep ModuleRenaming = D1 (MetaData "ModuleRenaming" "Distribution.Types.ModuleRenaming" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ModuleRenaming" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(ModuleName, ModuleName)])) :+: (C1 (MetaCons "DefaultRenaming" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "HidingRenaming" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]))))

defaultRenaming :: ModuleRenaming #

The default renaming, if something is specified in build-depends + only.

Libraries

data Library #

Constructors

Library 

Fields

Instances
Eq Library # 
Instance details

Defined in Distribution.Types.Library

Methods

(==) :: Library -> Library -> Bool #

(/=) :: Library -> Library -> Bool #

Data Library # 
Instance details

Defined in Distribution.Types.Library

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Library -> c Library #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Library #

toConstr :: Library -> Constr #

dataTypeOf :: Library -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Library) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Library) #

gmapT :: (forall b. Data b => b -> b) -> Library -> Library #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Library -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Library -> r #

gmapQ :: (forall d. Data d => d -> u) -> Library -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Library -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Library -> m Library #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Library -> m Library #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Library -> m Library #

Read Library # 
Instance details

Defined in Distribution.Types.Library

Methods

readsPrec :: Int -> ReadS Library #

readList :: ReadS [Library] #

readPrec :: ReadPrec Library #

readListPrec :: ReadPrec [Library] #

Show Library # 
Instance details

Defined in Distribution.Types.Library

Methods

showsPrec :: Int -> Library -> ShowS #

show :: Library -> String #

showList :: [Library] -> ShowS #

Generic Library # 
Instance details

Defined in Distribution.Types.Library

Associated Types

type Rep Library :: * -> * #

Methods

from :: Library -> Rep Library x #

to :: Rep Library x -> Library #

Semigroup Library # 
Instance details

Defined in Distribution.Types.Library

Methods

(<>) :: Library -> Library -> Library #

sconcat :: NonEmpty Library -> Library #

stimes :: Integral b => b -> Library -> Library #

Monoid Library # 
Instance details

Defined in Distribution.Types.Library

Methods

mempty :: Library #

mappend :: Library -> Library -> Library #

mconcat :: [Library] -> Library #

Binary Library # 
Instance details

Defined in Distribution.Types.Library

Methods

put :: Library -> Put #

get :: Get Library #

putList :: [Library] -> Put #

NFData Library # 
Instance details

Defined in Distribution.Types.Library

Methods

rnf :: Library -> () #

HasBuildInfo Library # 
Instance details

Defined in Distribution.Types.Library

Methods

buildInfo :: Lens' Library BuildInfo #

buildable :: Lens' Library Bool #

buildTools :: Lens' Library [LegacyExeDependency] #

buildToolDepends :: Lens' Library [ExeDependency] #

cppOptions :: Lens' Library [String] #

asmOptions :: Lens' Library [String] #

cmmOptions :: Lens' Library [String] #

ccOptions :: Lens' Library [String] #

cxxOptions :: Lens' Library [String] #

ldOptions :: Lens' Library [String] #

pkgconfigDepends :: Lens' Library [PkgconfigDependency] #

frameworks :: Lens' Library [String] #

extraFrameworkDirs :: Lens' Library [String] #

asmSources :: Lens' Library [FilePath] #

cmmSources :: Lens' Library [FilePath] #

cSources :: Lens' Library [FilePath] #

cxxSources :: Lens' Library [FilePath] #

jsSources :: Lens' Library [FilePath] #

hsSourceDirs :: Lens' Library [FilePath] #

otherModules :: Lens' Library [ModuleName] #

virtualModules :: Lens' Library [ModuleName] #

autogenModules :: Lens' Library [ModuleName] #

defaultLanguage :: Lens' Library (Maybe Language) #

otherLanguages :: Lens' Library [Language] #

defaultExtensions :: Lens' Library [Extension] #

otherExtensions :: Lens' Library [Extension] #

oldExtensions :: Lens' Library [Extension] #

extraLibs :: Lens' Library [String] #

extraGHCiLibs :: Lens' Library [String] #

extraBundledLibs :: Lens' Library [String] #

extraLibFlavours :: Lens' Library [String] #

extraLibDirs :: Lens' Library [String] #

includeDirs :: Lens' Library [FilePath] #

includes :: Lens' Library [FilePath] #

installIncludes :: Lens' Library [FilePath] #

options :: Lens' Library [(CompilerFlavor, [String])] #

profOptions :: Lens' Library [(CompilerFlavor, [String])] #

sharedOptions :: Lens' Library [(CompilerFlavor, [String])] #

staticOptions :: Lens' Library [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' Library [(String, String)] #

targetBuildDepends :: Lens' Library [Dependency] #

mixins :: Lens' Library [Mixin] #

type Rep Library # 
Instance details

Defined in Distribution.Types.Library

type Rep Library = D1 (MetaData "Library" "Distribution.Types.Library" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Library" PrefixI True) ((S1 (MetaSel (Just "libName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UnqualComponentName)) :*: (S1 (MetaSel (Just "exposedModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]) :*: S1 (MetaSel (Just "reexportedModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleReexport]))) :*: (S1 (MetaSel (Just "signatures") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]) :*: (S1 (MetaSel (Just "libExposed") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "libBuildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BuildInfo)))))

data ModuleReexport #

Constructors

ModuleReexport 

Fields

Instances
Eq ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

(==) :: ModuleReexport -> ModuleReexport -> Bool #

(/=) :: ModuleReexport -> ModuleReexport -> Bool #

Data ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModuleReexport -> c ModuleReexport #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModuleReexport #

toConstr :: ModuleReexport -> Constr #

dataTypeOf :: ModuleReexport -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModuleReexport) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModuleReexport) #

gmapT :: (forall b. Data b => b -> b) -> ModuleReexport -> ModuleReexport #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModuleReexport -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModuleReexport -> r #

gmapQ :: (forall d. Data d => d -> u) -> ModuleReexport -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModuleReexport -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModuleReexport -> m ModuleReexport #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleReexport -> m ModuleReexport #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleReexport -> m ModuleReexport #

Read ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

readsPrec :: Int -> ReadS ModuleReexport #

readList :: ReadS [ModuleReexport] #

readPrec :: ReadPrec ModuleReexport #

readListPrec :: ReadPrec [ModuleReexport] #

Show ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

showsPrec :: Int -> ModuleReexport -> ShowS #

show :: ModuleReexport -> String #

showList :: [ModuleReexport] -> ShowS #

Generic ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Associated Types

type Rep ModuleReexport :: * -> * #

Methods

from :: ModuleReexport -> Rep ModuleReexport x #

to :: Rep ModuleReexport x -> ModuleReexport #

Binary ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

put :: ModuleReexport -> Put #

get :: Get ModuleReexport #

putList :: [ModuleReexport] -> Put #

NFData ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

rnf :: ModuleReexport -> () #

Pretty ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

pretty :: ModuleReexport -> Doc #

Parsec ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

parsec :: CabalParsing m => m ModuleReexport #

Text ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

disp :: ModuleReexport -> Doc #

parse :: ReadP r ModuleReexport #

type Rep ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

type Rep ModuleReexport = D1 (MetaData "ModuleReexport" "Distribution.Types.ModuleReexport" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ModuleReexport" PrefixI True) (S1 (MetaSel (Just "moduleReexportOriginalPackage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe PackageName)) :*: (S1 (MetaSel (Just "moduleReexportOriginalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleName) :*: S1 (MetaSel (Just "moduleReexportName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleName))))

emptyLibrary :: Library #

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

If the package description has a buildable library section, + call the given function with the library build info as argument. + You probably want withLibLBI if you have a LocalBuildInfo, + see the note in + Distribution.Types.ComponentRequestedSpec + for more information.

hasPublicLib :: PackageDescription -> Bool #

Does this package have a buildable PUBLIC library?

hasLibs :: PackageDescription -> Bool #

Does this package have any libraries?

explicitLibModules :: Library -> [ModuleName] #

Get all the module names from the library (exposed and internal modules) + which are explicitly listed in the package description which would + need to be compiled. (This does not include reexports, which + do not need to be compiled.) This may not include all modules for which + GHC generated interface files (i.e., implicit modules.)

libModulesAutogen :: Library -> [ModuleName] #

Get all the auto generated module names from the library, exposed or not. + This are a subset of libModules.

libModules :: Library -> [ModuleName] #

Deprecated: If you want all modules that are built with a library, use allLibModules. Otherwise, use explicitLibModules for ONLY the modules explicitly mentioned in the package description. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

Backwards-compatibility shim for explicitLibModules. In most cases, + you actually want allLibModules, which returns all modules that will + actually be compiled, as opposed to those which are explicitly listed + in the package description (explicitLibModules); unfortunately, the + type signature for allLibModules is incompatible since we need a + ComponentLocalBuildInfo.

Executables

data Executable #

Constructors

Executable 

Fields

Instances
Eq Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

(==) :: Executable -> Executable -> Bool #

(/=) :: Executable -> Executable -> Bool #

Data Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Executable -> c Executable #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Executable #

toConstr :: Executable -> Constr #

dataTypeOf :: Executable -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Executable) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Executable) #

gmapT :: (forall b. Data b => b -> b) -> Executable -> Executable #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Executable -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Executable -> r #

gmapQ :: (forall d. Data d => d -> u) -> Executable -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Executable -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Executable -> m Executable #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Executable -> m Executable #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Executable -> m Executable #

Read Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

readsPrec :: Int -> ReadS Executable #

readList :: ReadS [Executable] #

readPrec :: ReadPrec Executable #

readListPrec :: ReadPrec [Executable] #

Show Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

showsPrec :: Int -> Executable -> ShowS #

show :: Executable -> String #

showList :: [Executable] -> ShowS #

Generic Executable # 
Instance details

Defined in Distribution.Types.Executable

Associated Types

type Rep Executable :: * -> * #

Methods

from :: Executable -> Rep Executable x #

to :: Rep Executable x -> Executable #

Semigroup Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

(<>) :: Executable -> Executable -> Executable #

sconcat :: NonEmpty Executable -> Executable #

stimes :: Integral b => b -> Executable -> Executable #

Monoid Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

mempty :: Executable #

mappend :: Executable -> Executable -> Executable #

mconcat :: [Executable] -> Executable #

Binary Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

put :: Executable -> Put #

get :: Get Executable #

putList :: [Executable] -> Put #

NFData Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

rnf :: Executable -> () #

HasBuildInfo Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

buildInfo :: Lens' Executable BuildInfo #

buildable :: Lens' Executable Bool #

buildTools :: Lens' Executable [LegacyExeDependency] #

buildToolDepends :: Lens' Executable [ExeDependency] #

cppOptions :: Lens' Executable [String] #

asmOptions :: Lens' Executable [String] #

cmmOptions :: Lens' Executable [String] #

ccOptions :: Lens' Executable [String] #

cxxOptions :: Lens' Executable [String] #

ldOptions :: Lens' Executable [String] #

pkgconfigDepends :: Lens' Executable [PkgconfigDependency] #

frameworks :: Lens' Executable [String] #

extraFrameworkDirs :: Lens' Executable [String] #

asmSources :: Lens' Executable [FilePath] #

cmmSources :: Lens' Executable [FilePath] #

cSources :: Lens' Executable [FilePath] #

cxxSources :: Lens' Executable [FilePath] #

jsSources :: Lens' Executable [FilePath] #

hsSourceDirs :: Lens' Executable [FilePath] #

otherModules :: Lens' Executable [ModuleName] #

virtualModules :: Lens' Executable [ModuleName] #

autogenModules :: Lens' Executable [ModuleName] #

defaultLanguage :: Lens' Executable (Maybe Language) #

otherLanguages :: Lens' Executable [Language] #

defaultExtensions :: Lens' Executable [Extension] #

otherExtensions :: Lens' Executable [Extension] #

oldExtensions :: Lens' Executable [Extension] #

extraLibs :: Lens' Executable [String] #

extraGHCiLibs :: Lens' Executable [String] #

extraBundledLibs :: Lens' Executable [String] #

extraLibFlavours :: Lens' Executable [String] #

extraLibDirs :: Lens' Executable [String] #

includeDirs :: Lens' Executable [FilePath] #

includes :: Lens' Executable [FilePath] #

installIncludes :: Lens' Executable [FilePath] #

options :: Lens' Executable [(CompilerFlavor, [String])] #

profOptions :: Lens' Executable [(CompilerFlavor, [String])] #

sharedOptions :: Lens' Executable [(CompilerFlavor, [String])] #

staticOptions :: Lens' Executable [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' Executable [(String, String)] #

targetBuildDepends :: Lens' Executable [Dependency] #

mixins :: Lens' Executable [Mixin] #

type Rep Executable # 
Instance details

Defined in Distribution.Types.Executable

type Rep Executable = D1 (MetaData "Executable" "Distribution.Types.Executable" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Executable" PrefixI True) ((S1 (MetaSel (Just "exeName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName) :*: S1 (MetaSel (Just "modulePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :*: (S1 (MetaSel (Just "exeScope") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ExecutableScope) :*: S1 (MetaSel (Just "buildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BuildInfo))))

emptyExecutable :: Executable #

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

Perform the action on each buildable Executable in the package + description. You probably want withExeLBI if you have a + LocalBuildInfo, see the note in + Distribution.Types.ComponentRequestedSpec + for more information.

hasExes :: PackageDescription -> Bool #

does this package have any executables?

exeModules :: Executable -> [ModuleName] #

Get all the module names from an exe

exeModulesAutogen :: Executable -> [ModuleName] #

Get all the auto generated module names from an exe + This are a subset of exeModules.

Tests

data TestSuite #

A "test-suite" stanza in a cabal file.

Constructors

TestSuite 

Fields

Instances
Eq TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

(==) :: TestSuite -> TestSuite -> Bool #

(/=) :: TestSuite -> TestSuite -> Bool #

Data TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TestSuite -> c TestSuite #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TestSuite #

toConstr :: TestSuite -> Constr #

dataTypeOf :: TestSuite -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TestSuite) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TestSuite) #

gmapT :: (forall b. Data b => b -> b) -> TestSuite -> TestSuite #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TestSuite -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TestSuite -> r #

gmapQ :: (forall d. Data d => d -> u) -> TestSuite -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> TestSuite -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TestSuite -> m TestSuite #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TestSuite -> m TestSuite #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TestSuite -> m TestSuite #

Read TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

readsPrec :: Int -> ReadS TestSuite #

readList :: ReadS [TestSuite] #

readPrec :: ReadPrec TestSuite #

readListPrec :: ReadPrec [TestSuite] #

Show TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

showsPrec :: Int -> TestSuite -> ShowS #

show :: TestSuite -> String #

showList :: [TestSuite] -> ShowS #

Generic TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Associated Types

type Rep TestSuite :: * -> * #

Methods

from :: TestSuite -> Rep TestSuite x #

to :: Rep TestSuite x -> TestSuite #

Semigroup TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

(<>) :: TestSuite -> TestSuite -> TestSuite #

sconcat :: NonEmpty TestSuite -> TestSuite #

stimes :: Integral b => b -> TestSuite -> TestSuite #

Monoid TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

mempty :: TestSuite #

mappend :: TestSuite -> TestSuite -> TestSuite #

mconcat :: [TestSuite] -> TestSuite #

Binary TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

put :: TestSuite -> Put #

get :: Get TestSuite #

putList :: [TestSuite] -> Put #

NFData TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

rnf :: TestSuite -> () #

HasBuildInfo TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

buildInfo :: Lens' TestSuite BuildInfo #

buildable :: Lens' TestSuite Bool #

buildTools :: Lens' TestSuite [LegacyExeDependency] #

buildToolDepends :: Lens' TestSuite [ExeDependency] #

cppOptions :: Lens' TestSuite [String] #

asmOptions :: Lens' TestSuite [String] #

cmmOptions :: Lens' TestSuite [String] #

ccOptions :: Lens' TestSuite [String] #

cxxOptions :: Lens' TestSuite [String] #

ldOptions :: Lens' TestSuite [String] #

pkgconfigDepends :: Lens' TestSuite [PkgconfigDependency] #

frameworks :: Lens' TestSuite [String] #

extraFrameworkDirs :: Lens' TestSuite [String] #

asmSources :: Lens' TestSuite [FilePath] #

cmmSources :: Lens' TestSuite [FilePath] #

cSources :: Lens' TestSuite [FilePath] #

cxxSources :: Lens' TestSuite [FilePath] #

jsSources :: Lens' TestSuite [FilePath] #

hsSourceDirs :: Lens' TestSuite [FilePath] #

otherModules :: Lens' TestSuite [ModuleName] #

virtualModules :: Lens' TestSuite [ModuleName] #

autogenModules :: Lens' TestSuite [ModuleName] #

defaultLanguage :: Lens' TestSuite (Maybe Language) #

otherLanguages :: Lens' TestSuite [Language] #

defaultExtensions :: Lens' TestSuite [Extension] #

otherExtensions :: Lens' TestSuite [Extension] #

oldExtensions :: Lens' TestSuite [Extension] #

extraLibs :: Lens' TestSuite [String] #

extraGHCiLibs :: Lens' TestSuite [String] #

extraBundledLibs :: Lens' TestSuite [String] #

extraLibFlavours :: Lens' TestSuite [String] #

extraLibDirs :: Lens' TestSuite [String] #

includeDirs :: Lens' TestSuite [FilePath] #

includes :: Lens' TestSuite [FilePath] #

installIncludes :: Lens' TestSuite [FilePath] #

options :: Lens' TestSuite [(CompilerFlavor, [String])] #

profOptions :: Lens' TestSuite [(CompilerFlavor, [String])] #

sharedOptions :: Lens' TestSuite [(CompilerFlavor, [String])] #

staticOptions :: Lens' TestSuite [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' TestSuite [(String, String)] #

targetBuildDepends :: Lens' TestSuite [Dependency] #

mixins :: Lens' TestSuite [Mixin] #

type Rep TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

type Rep TestSuite = D1 (MetaData "TestSuite" "Distribution.Types.TestSuite" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "TestSuite" PrefixI True) (S1 (MetaSel (Just "testName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName) :*: (S1 (MetaSel (Just "testInterface") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TestSuiteInterface) :*: S1 (MetaSel (Just "testBuildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BuildInfo))))

data TestSuiteInterface #

The test suite interfaces that are currently defined. Each test suite must + specify which interface it supports.

More interfaces may be defined in future, either new revisions or totally + new interfaces.

Constructors

TestSuiteExeV10 Version FilePath

Test interface "exitcode-stdio-1.0". The test-suite takes the form + of an executable. It returns a zero exit code for success, non-zero for + failure. The stdout and stderr channels may be logged. It takes no + command line parameters and nothing on stdin.

TestSuiteLibV09 Version ModuleName

Test interface "detailed-0.9". The test-suite takes the form of a + library containing a designated module that exports "tests :: [Test]".

TestSuiteUnsupported TestType

A test suite that does not conform to one of the above interfaces for + the given reason (e.g. unknown test type).

Instances
Eq TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

(==) :: TestSuiteInterface -> TestSuiteInterface -> Bool #

(/=) :: TestSuiteInterface -> TestSuiteInterface -> Bool #

Data TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TestSuiteInterface -> c TestSuiteInterface #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TestSuiteInterface #

toConstr :: TestSuiteInterface -> Constr #

dataTypeOf :: TestSuiteInterface -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TestSuiteInterface) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TestSuiteInterface) #

gmapT :: (forall b. Data b => b -> b) -> TestSuiteInterface -> TestSuiteInterface #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TestSuiteInterface -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TestSuiteInterface -> r #

gmapQ :: (forall d. Data d => d -> u) -> TestSuiteInterface -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> TestSuiteInterface -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TestSuiteInterface -> m TestSuiteInterface #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TestSuiteInterface -> m TestSuiteInterface #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TestSuiteInterface -> m TestSuiteInterface #

Read TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

readsPrec :: Int -> ReadS TestSuiteInterface #

readList :: ReadS [TestSuiteInterface] #

readPrec :: ReadPrec TestSuiteInterface #

readListPrec :: ReadPrec [TestSuiteInterface] #

Show TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

showsPrec :: Int -> TestSuiteInterface -> ShowS #

show :: TestSuiteInterface -> String #

showList :: [TestSuiteInterface] -> ShowS #

Generic TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Associated Types

type Rep TestSuiteInterface :: * -> * #

Methods

from :: TestSuiteInterface -> Rep TestSuiteInterface x #

to :: Rep TestSuiteInterface x -> TestSuiteInterface #

Semigroup TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

(<>) :: TestSuiteInterface -> TestSuiteInterface -> TestSuiteInterface #

sconcat :: NonEmpty TestSuiteInterface -> TestSuiteInterface #

stimes :: Integral b => b -> TestSuiteInterface -> TestSuiteInterface #

Monoid TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

mempty :: TestSuiteInterface #

mappend :: TestSuiteInterface -> TestSuiteInterface -> TestSuiteInterface #

mconcat :: [TestSuiteInterface] -> TestSuiteInterface #

Binary TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

put :: TestSuiteInterface -> Put #

get :: Get TestSuiteInterface #

putList :: [TestSuiteInterface] -> Put #

NFData TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

rnf :: TestSuiteInterface -> () #

type Rep TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

type Rep TestSuiteInterface = D1 (MetaData "TestSuiteInterface" "Distribution.Types.TestSuiteInterface" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "TestSuiteExeV10" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :+: (C1 (MetaCons "TestSuiteLibV09" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleName)) :+: C1 (MetaCons "TestSuiteUnsupported" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TestType))))

data TestType #

The "test-type" field in the test suite stanza.

Constructors

TestTypeExe Version

"type: exitcode-stdio-x.y"

TestTypeLib Version

"type: detailed-x.y"

TestTypeUnknown String Version

Some unknown test type e.g. "type: foo"

Instances
Eq TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

(==) :: TestType -> TestType -> Bool #

(/=) :: TestType -> TestType -> Bool #

Data TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TestType -> c TestType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TestType #

toConstr :: TestType -> Constr #

dataTypeOf :: TestType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TestType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TestType) #

gmapT :: (forall b. Data b => b -> b) -> TestType -> TestType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TestType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TestType -> r #

gmapQ :: (forall d. Data d => d -> u) -> TestType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> TestType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TestType -> m TestType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TestType -> m TestType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TestType -> m TestType #

Read TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

readsPrec :: Int -> ReadS TestType #

readList :: ReadS [TestType] #

readPrec :: ReadPrec TestType #

readListPrec :: ReadPrec [TestType] #

Show TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

showsPrec :: Int -> TestType -> ShowS #

show :: TestType -> String #

showList :: [TestType] -> ShowS #

Generic TestType # 
Instance details

Defined in Distribution.Types.TestType

Associated Types

type Rep TestType :: * -> * #

Methods

from :: TestType -> Rep TestType x #

to :: Rep TestType x -> TestType #

Binary TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

put :: TestType -> Put #

get :: Get TestType #

putList :: [TestType] -> Put #

NFData TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

rnf :: TestType -> () #

Pretty TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

pretty :: TestType -> Doc #

Parsec TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

parsec :: CabalParsing m => m TestType #

Text TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

disp :: TestType -> Doc #

parse :: ReadP r TestType #

type Rep TestType # 
Instance details

Defined in Distribution.Types.TestType

type Rep TestType = D1 (MetaData "TestType" "Distribution.Types.TestType" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "TestTypeExe" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: (C1 (MetaCons "TestTypeLib" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: C1 (MetaCons "TestTypeUnknown" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version))))

testType :: TestSuite -> TestType #

knownTestTypes :: [TestType] #

emptyTestSuite :: TestSuite #

hasTests :: PackageDescription -> Bool #

Does this package have any test suites?

withTest :: PackageDescription -> (TestSuite -> IO ()) -> IO () #

Perform an action on each buildable TestSuite in a package. + You probably want withTestLBI if you have a LocalBuildInfo, see the note in + Distribution.Types.ComponentRequestedSpec + for more information.

testModules :: TestSuite -> [ModuleName] #

Get all the module names from a test suite.

testModulesAutogen :: TestSuite -> [ModuleName] #

Get all the auto generated module names from a test suite. + This are a subset of testModules.

Benchmarks

data Benchmark #

A "benchmark" stanza in a cabal file.

Constructors

Benchmark 

Fields

Instances
Eq Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

(==) :: Benchmark -> Benchmark -> Bool #

(/=) :: Benchmark -> Benchmark -> Bool #

Data Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Benchmark -> c Benchmark #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Benchmark #

toConstr :: Benchmark -> Constr #

dataTypeOf :: Benchmark -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Benchmark) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Benchmark) #

gmapT :: (forall b. Data b => b -> b) -> Benchmark -> Benchmark #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Benchmark -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Benchmark -> r #

gmapQ :: (forall d. Data d => d -> u) -> Benchmark -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Benchmark -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Benchmark -> m Benchmark #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Benchmark -> m Benchmark #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Benchmark -> m Benchmark #

Read Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

readsPrec :: Int -> ReadS Benchmark #

readList :: ReadS [Benchmark] #

readPrec :: ReadPrec Benchmark #

readListPrec :: ReadPrec [Benchmark] #

Show Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

showsPrec :: Int -> Benchmark -> ShowS #

show :: Benchmark -> String #

showList :: [Benchmark] -> ShowS #

Generic Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Associated Types

type Rep Benchmark :: * -> * #

Methods

from :: Benchmark -> Rep Benchmark x #

to :: Rep Benchmark x -> Benchmark #

Semigroup Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

(<>) :: Benchmark -> Benchmark -> Benchmark #

sconcat :: NonEmpty Benchmark -> Benchmark #

stimes :: Integral b => b -> Benchmark -> Benchmark #

Monoid Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

mempty :: Benchmark #

mappend :: Benchmark -> Benchmark -> Benchmark #

mconcat :: [Benchmark] -> Benchmark #

Binary Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

put :: Benchmark -> Put #

get :: Get Benchmark #

putList :: [Benchmark] -> Put #

NFData Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

rnf :: Benchmark -> () #

HasBuildInfo Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

buildInfo :: Lens' Benchmark BuildInfo #

buildable :: Lens' Benchmark Bool #

buildTools :: Lens' Benchmark [LegacyExeDependency] #

buildToolDepends :: Lens' Benchmark [ExeDependency] #

cppOptions :: Lens' Benchmark [String] #

asmOptions :: Lens' Benchmark [String] #

cmmOptions :: Lens' Benchmark [String] #

ccOptions :: Lens' Benchmark [String] #

cxxOptions :: Lens' Benchmark [String] #

ldOptions :: Lens' Benchmark [String] #

pkgconfigDepends :: Lens' Benchmark [PkgconfigDependency] #

frameworks :: Lens' Benchmark [String] #

extraFrameworkDirs :: Lens' Benchmark [String] #

asmSources :: Lens' Benchmark [FilePath] #

cmmSources :: Lens' Benchmark [FilePath] #

cSources :: Lens' Benchmark [FilePath] #

cxxSources :: Lens' Benchmark [FilePath] #

jsSources :: Lens' Benchmark [FilePath] #

hsSourceDirs :: Lens' Benchmark [FilePath] #

otherModules :: Lens' Benchmark [ModuleName] #

virtualModules :: Lens' Benchmark [ModuleName] #

autogenModules :: Lens' Benchmark [ModuleName] #

defaultLanguage :: Lens' Benchmark (Maybe Language) #

otherLanguages :: Lens' Benchmark [Language] #

defaultExtensions :: Lens' Benchmark [Extension] #

otherExtensions :: Lens' Benchmark [Extension] #

oldExtensions :: Lens' Benchmark [Extension] #

extraLibs :: Lens' Benchmark [String] #

extraGHCiLibs :: Lens' Benchmark [String] #

extraBundledLibs :: Lens' Benchmark [String] #

extraLibFlavours :: Lens' Benchmark [String] #

extraLibDirs :: Lens' Benchmark [String] #

includeDirs :: Lens' Benchmark [FilePath] #

includes :: Lens' Benchmark [FilePath] #

installIncludes :: Lens' Benchmark [FilePath] #

options :: Lens' Benchmark [(CompilerFlavor, [String])] #

profOptions :: Lens' Benchmark [(CompilerFlavor, [String])] #

sharedOptions :: Lens' Benchmark [(CompilerFlavor, [String])] #

staticOptions :: Lens' Benchmark [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' Benchmark [(String, String)] #

targetBuildDepends :: Lens' Benchmark [Dependency] #

mixins :: Lens' Benchmark [Mixin] #

type Rep Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

type Rep Benchmark = D1 (MetaData "Benchmark" "Distribution.Types.Benchmark" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Benchmark" PrefixI True) (S1 (MetaSel (Just "benchmarkName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName) :*: (S1 (MetaSel (Just "benchmarkInterface") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BenchmarkInterface) :*: S1 (MetaSel (Just "benchmarkBuildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BuildInfo))))

data BenchmarkInterface #

The benchmark interfaces that are currently defined. Each + benchmark must specify which interface it supports.

More interfaces may be defined in future, either new revisions or + totally new interfaces.

Constructors

BenchmarkExeV10 Version FilePath

Benchmark interface "exitcode-stdio-1.0". The benchmark + takes the form of an executable. It returns a zero exit code + for success, non-zero for failure. The stdout and stderr + channels may be logged. It takes no command line parameters + and nothing on stdin.

BenchmarkUnsupported BenchmarkType

A benchmark that does not conform to one of the above + interfaces for the given reason (e.g. unknown benchmark type).

Instances
Eq BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

(==) :: BenchmarkInterface -> BenchmarkInterface -> Bool #

(/=) :: BenchmarkInterface -> BenchmarkInterface -> Bool #

Data BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BenchmarkInterface -> c BenchmarkInterface #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BenchmarkInterface #

toConstr :: BenchmarkInterface -> Constr #

dataTypeOf :: BenchmarkInterface -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BenchmarkInterface) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BenchmarkInterface) #

gmapT :: (forall b. Data b => b -> b) -> BenchmarkInterface -> BenchmarkInterface #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BenchmarkInterface -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BenchmarkInterface -> r #

gmapQ :: (forall d. Data d => d -> u) -> BenchmarkInterface -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BenchmarkInterface -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BenchmarkInterface -> m BenchmarkInterface #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BenchmarkInterface -> m BenchmarkInterface #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BenchmarkInterface -> m BenchmarkInterface #

Read BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

readsPrec :: Int -> ReadS BenchmarkInterface #

readList :: ReadS [BenchmarkInterface] #

readPrec :: ReadPrec BenchmarkInterface #

readListPrec :: ReadPrec [BenchmarkInterface] #

Show BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

showsPrec :: Int -> BenchmarkInterface -> ShowS #

show :: BenchmarkInterface -> String #

showList :: [BenchmarkInterface] -> ShowS #

Generic BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Associated Types

type Rep BenchmarkInterface :: * -> * #

Methods

from :: BenchmarkInterface -> Rep BenchmarkInterface x #

to :: Rep BenchmarkInterface x -> BenchmarkInterface #

Semigroup BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

(<>) :: BenchmarkInterface -> BenchmarkInterface -> BenchmarkInterface #

sconcat :: NonEmpty BenchmarkInterface -> BenchmarkInterface #

stimes :: Integral b => b -> BenchmarkInterface -> BenchmarkInterface #

Monoid BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

mempty :: BenchmarkInterface #

mappend :: BenchmarkInterface -> BenchmarkInterface -> BenchmarkInterface #

mconcat :: [BenchmarkInterface] -> BenchmarkInterface #

Binary BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

put :: BenchmarkInterface -> Put #

get :: Get BenchmarkInterface #

putList :: [BenchmarkInterface] -> Put #

NFData BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

rnf :: BenchmarkInterface -> () #

type Rep BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

type Rep BenchmarkInterface = D1 (MetaData "BenchmarkInterface" "Distribution.Types.BenchmarkInterface" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "BenchmarkExeV10" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :+: C1 (MetaCons "BenchmarkUnsupported" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BenchmarkType)))

data BenchmarkType #

The "benchmark-type" field in the benchmark stanza.

Constructors

BenchmarkTypeExe Version

"type: exitcode-stdio-x.y"

BenchmarkTypeUnknown String Version

Some unknown benchmark type e.g. "type: foo"

Instances
Eq BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

(==) :: BenchmarkType -> BenchmarkType -> Bool #

(/=) :: BenchmarkType -> BenchmarkType -> Bool #

Data BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BenchmarkType -> c BenchmarkType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BenchmarkType #

toConstr :: BenchmarkType -> Constr #

dataTypeOf :: BenchmarkType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BenchmarkType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BenchmarkType) #

gmapT :: (forall b. Data b => b -> b) -> BenchmarkType -> BenchmarkType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BenchmarkType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BenchmarkType -> r #

gmapQ :: (forall d. Data d => d -> u) -> BenchmarkType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BenchmarkType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BenchmarkType -> m BenchmarkType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BenchmarkType -> m BenchmarkType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BenchmarkType -> m BenchmarkType #

Read BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

readsPrec :: Int -> ReadS BenchmarkType #

readList :: ReadS [BenchmarkType] #

readPrec :: ReadPrec BenchmarkType #

readListPrec :: ReadPrec [BenchmarkType] #

Show BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

showsPrec :: Int -> BenchmarkType -> ShowS #

show :: BenchmarkType -> String #

showList :: [BenchmarkType] -> ShowS #

Generic BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Associated Types

type Rep BenchmarkType :: * -> * #

Methods

from :: BenchmarkType -> Rep BenchmarkType x #

to :: Rep BenchmarkType x -> BenchmarkType #

Binary BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

put :: BenchmarkType -> Put #

get :: Get BenchmarkType #

putList :: [BenchmarkType] -> Put #

NFData BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

rnf :: BenchmarkType -> () #

Pretty BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

pretty :: BenchmarkType -> Doc #

Parsec BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

parsec :: CabalParsing m => m BenchmarkType #

Text BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

disp :: BenchmarkType -> Doc #

parse :: ReadP r BenchmarkType #

type Rep BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

type Rep BenchmarkType = D1 (MetaData "BenchmarkType" "Distribution.Types.BenchmarkType" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "BenchmarkTypeExe" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: C1 (MetaCons "BenchmarkTypeUnknown" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)))

benchmarkType :: Benchmark -> BenchmarkType #

knownBenchmarkTypes :: [BenchmarkType] #

emptyBenchmark :: Benchmark #

hasBenchmarks :: PackageDescription -> Bool #

Does this package have any benchmarks?

withBenchmark :: PackageDescription -> (Benchmark -> IO ()) -> IO () #

Perform an action on each buildable Benchmark in a package. + You probably want withBenchLBI if you have a LocalBuildInfo, see the note in + Distribution.Types.ComponentRequestedSpec + for more information.

benchmarkModules :: Benchmark -> [ModuleName] #

Get all the module names from a benchmark.

benchmarkModulesAutogen :: Benchmark -> [ModuleName] #

Get all the auto generated module names from a benchmark. + This are a subset of benchmarkModules.

Build information

data BuildInfo #

Constructors

BuildInfo 

Fields

Instances
Eq BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

(==) :: BuildInfo -> BuildInfo -> Bool #

(/=) :: BuildInfo -> BuildInfo -> Bool #

Data BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BuildInfo -> c BuildInfo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BuildInfo #

toConstr :: BuildInfo -> Constr #

dataTypeOf :: BuildInfo -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BuildInfo) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BuildInfo) #

gmapT :: (forall b. Data b => b -> b) -> BuildInfo -> BuildInfo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BuildInfo -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BuildInfo -> r #

gmapQ :: (forall d. Data d => d -> u) -> BuildInfo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BuildInfo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BuildInfo -> m BuildInfo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BuildInfo -> m BuildInfo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BuildInfo -> m BuildInfo #

Read BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

readsPrec :: Int -> ReadS BuildInfo #

readList :: ReadS [BuildInfo] #

readPrec :: ReadPrec BuildInfo #

readListPrec :: ReadPrec [BuildInfo] #

Show BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

showsPrec :: Int -> BuildInfo -> ShowS #

show :: BuildInfo -> String #

showList :: [BuildInfo] -> ShowS #

Generic BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Associated Types

type Rep BuildInfo :: * -> * #

Methods

from :: BuildInfo -> Rep BuildInfo x #

to :: Rep BuildInfo x -> BuildInfo #

Semigroup BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

(<>) :: BuildInfo -> BuildInfo -> BuildInfo #

sconcat :: NonEmpty BuildInfo -> BuildInfo #

stimes :: Integral b => b -> BuildInfo -> BuildInfo #

Monoid BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

mempty :: BuildInfo #

mappend :: BuildInfo -> BuildInfo -> BuildInfo #

mconcat :: [BuildInfo] -> BuildInfo #

Binary BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

put :: BuildInfo -> Put #

get :: Get BuildInfo #

putList :: [BuildInfo] -> Put #

NFData BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

rnf :: BuildInfo -> () #

HasBuildInfo BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo.Lens

Methods

buildInfo :: Lens' BuildInfo BuildInfo #

buildable :: Lens' BuildInfo Bool #

buildTools :: Lens' BuildInfo [LegacyExeDependency] #

buildToolDepends :: Lens' BuildInfo [ExeDependency] #

cppOptions :: Lens' BuildInfo [String] #

asmOptions :: Lens' BuildInfo [String] #

cmmOptions :: Lens' BuildInfo [String] #

ccOptions :: Lens' BuildInfo [String] #

cxxOptions :: Lens' BuildInfo [String] #

ldOptions :: Lens' BuildInfo [String] #

pkgconfigDepends :: Lens' BuildInfo [PkgconfigDependency] #

frameworks :: Lens' BuildInfo [String] #

extraFrameworkDirs :: Lens' BuildInfo [String] #

asmSources :: Lens' BuildInfo [FilePath] #

cmmSources :: Lens' BuildInfo [FilePath] #

cSources :: Lens' BuildInfo [FilePath] #

cxxSources :: Lens' BuildInfo [FilePath] #

jsSources :: Lens' BuildInfo [FilePath] #

hsSourceDirs :: Lens' BuildInfo [FilePath] #

otherModules :: Lens' BuildInfo [ModuleName] #

virtualModules :: Lens' BuildInfo [ModuleName] #

autogenModules :: Lens' BuildInfo [ModuleName] #

defaultLanguage :: Lens' BuildInfo (Maybe Language) #

otherLanguages :: Lens' BuildInfo [Language] #

defaultExtensions :: Lens' BuildInfo [Extension] #

otherExtensions :: Lens' BuildInfo [Extension] #

oldExtensions :: Lens' BuildInfo [Extension] #

extraLibs :: Lens' BuildInfo [String] #

extraGHCiLibs :: Lens' BuildInfo [String] #

extraBundledLibs :: Lens' BuildInfo [String] #

extraLibFlavours :: Lens' BuildInfo [String] #

extraLibDirs :: Lens' BuildInfo [String] #

includeDirs :: Lens' BuildInfo [FilePath] #

includes :: Lens' BuildInfo [FilePath] #

installIncludes :: Lens' BuildInfo [FilePath] #

options :: Lens' BuildInfo [(CompilerFlavor, [String])] #

profOptions :: Lens' BuildInfo [(CompilerFlavor, [String])] #

sharedOptions :: Lens' BuildInfo [(CompilerFlavor, [String])] #

staticOptions :: Lens' BuildInfo [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' BuildInfo [(String, String)] #

targetBuildDepends :: Lens' BuildInfo [Dependency] #

mixins :: Lens' BuildInfo [Mixin] #

type Rep BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

type Rep BuildInfo = D1 (MetaData "BuildInfo" "Distribution.Types.BuildInfo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "BuildInfo" PrefixI True) (((((S1 (MetaSel (Just "buildable") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "buildTools") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [LegacyExeDependency])) :*: (S1 (MetaSel (Just "buildToolDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ExeDependency]) :*: (S1 (MetaSel (Just "cppOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "asmOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])))) :*: ((S1 (MetaSel (Just "cmmOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "ccOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) :*: (S1 (MetaSel (Just "cxxOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: (S1 (MetaSel (Just "ldOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "pkgconfigDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [PkgconfigDependency]))))) :*: (((S1 (MetaSel (Just "frameworks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "extraFrameworkDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) :*: (S1 (MetaSel (Just "asmSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: (S1 (MetaSel (Just "cmmSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "cSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))) :*: ((S1 (MetaSel (Just "cxxSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "jsSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])) :*: (S1 (MetaSel (Just "hsSourceDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: (S1 (MetaSel (Just "otherModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]) :*: S1 (MetaSel (Just "virtualModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName])))))) :*: ((((S1 (MetaSel (Just "autogenModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]) :*: S1 (MetaSel (Just "defaultLanguage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Language))) :*: (S1 (MetaSel (Just "otherLanguages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Language]) :*: (S1 (MetaSel (Just "defaultExtensions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Extension]) :*: S1 (MetaSel (Just "otherExtensions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Extension])))) :*: ((S1 (MetaSel (Just "oldExtensions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Extension]) :*: S1 (MetaSel (Just "extraLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) :*: (S1 (MetaSel (Just "extraGHCiLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: (S1 (MetaSel (Just "extraBundledLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "extraLibFlavours") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]))))) :*: (((S1 (MetaSel (Just "extraLibDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "includeDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])) :*: (S1 (MetaSel (Just "includes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: (S1 (MetaSel (Just "installIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "options") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(CompilerFlavor, [String])])))) :*: ((S1 (MetaSel (Just "profOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(CompilerFlavor, [String])]) :*: (S1 (MetaSel (Just "sharedOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(CompilerFlavor, [String])]) :*: S1 (MetaSel (Just "staticOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(CompilerFlavor, [String])]))) :*: (S1 (MetaSel (Just "customFieldsBI") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, String)]) :*: (S1 (MetaSel (Just "targetBuildDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Dependency]) :*: S1 (MetaSel (Just "mixins") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Mixin]))))))))

emptyBuildInfo :: BuildInfo #

allBuildInfo :: PackageDescription -> [BuildInfo] #

All BuildInfo in the PackageDescription: + libraries, executables, test-suites and benchmarks.

Useful for implementing package checks.

allLanguages :: BuildInfo -> [Language] #

The Languages used by this component

allExtensions :: BuildInfo -> [Extension] #

The Extensions that are used somewhere by this component

usedExtensions :: BuildInfo -> [Extension] #

The Extensions that are used by all modules in this component

usesTemplateHaskellOrQQ :: BuildInfo -> Bool #

Whether any modules in this component use Template Haskell or + Quasi Quotes

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

Select options for a particular Haskell compiler.

hcProfOptions :: CompilerFlavor -> BuildInfo -> [String] #

hcSharedOptions :: CompilerFlavor -> BuildInfo -> [String] #

hcStaticOptions :: CompilerFlavor -> BuildInfo -> [String] #

Supplementary build information

allBuildDepends :: PackageDescription -> [Dependency] #

Get the combined build-depends entries of all components.

enabledBuildDepends :: PackageDescription -> ComponentRequestedSpec -> [Dependency] #

Get the combined build-depends entries of all enabled components, per the + given request spec.

data ComponentName #

Constructors

CLibName 
CSubLibName UnqualComponentName 
CFLibName UnqualComponentName 
CExeName UnqualComponentName 
CTestName UnqualComponentName 
CBenchName UnqualComponentName 
Instances
Eq ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

(==) :: ComponentName -> ComponentName -> Bool #

(/=) :: ComponentName -> ComponentName -> Bool #

Ord ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

compare :: ComponentName -> ComponentName -> Ordering #

(<) :: ComponentName -> ComponentName -> Bool #

(<=) :: ComponentName -> ComponentName -> Bool #

(>) :: ComponentName -> ComponentName -> Bool #

(>=) :: ComponentName -> ComponentName -> Bool #

max :: ComponentName -> ComponentName -> ComponentName #

min :: ComponentName -> ComponentName -> ComponentName #

Read ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

readsPrec :: Int -> ReadS ComponentName #

readList :: ReadS [ComponentName] #

readPrec :: ReadPrec ComponentName #

readListPrec :: ReadPrec [ComponentName] #

Show ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

showsPrec :: Int -> ComponentName -> ShowS #

show :: ComponentName -> String #

showList :: [ComponentName] -> ShowS #

Generic ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Associated Types

type Rep ComponentName :: * -> * #

Methods

from :: ComponentName -> Rep ComponentName x #

to :: Rep ComponentName x -> ComponentName #

Binary ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

put :: ComponentName -> Put #

get :: Get ComponentName #

putList :: [ComponentName] -> Put #

Pretty ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

pretty :: ComponentName -> Doc #

Text ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

disp :: ComponentName -> Doc #

parse :: ReadP r ComponentName #

type Rep ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

type Rep ComponentName = D1 (MetaData "ComponentName" "Distribution.Types.ComponentName" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "CLibName" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CSubLibName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)) :+: C1 (MetaCons "CFLibName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)))) :+: (C1 (MetaCons "CExeName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)) :+: (C1 (MetaCons "CTestName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)) :+: C1 (MetaCons "CBenchName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)))))

defaultLibName :: ComponentName #

type HookedBuildInfo = (Maybe BuildInfo, [(UnqualComponentName, BuildInfo)]) #

HookedBuildInfo is mechanism that hooks can use to + override the BuildInfos inside packages. One example + use-case (which is used in core libraries today) is as + a way of passing flags which are computed by a configure + script into Cabal. In this case, the autoconf build type adds + hooks to read in a textual HookedBuildInfo format prior + to doing any operations.

Quite honestly, this mechanism is a massive hack since we shouldn't + be editing the PackageDescription data structure (it's easy + to assume that this data structure shouldn't change and + run into bugs, see for example 1c20a6328579af9e37677d507e2e9836ef70ab9d). + But it's a bit convenient, because there isn't another data + structure that allows adding extra BuildInfo style things.

In any case, a lot of care has to be taken to make sure the + HookedBuildInfo is applied to the PackageDescription. In + general this process occurs in Distribution.Simple, which is + responsible for orchestrating the hooks mechanism. The + general strategy:

  1. We run the pre-hook, which produces a HookedBuildInfo + (e.g., in the Autoconf case, it reads it out from a file).
  2. We sanity-check the hooked build info with + sanityCheckHookedBuildInfo.
  3. We update our PackageDescription (either freshly read + or cached from LocalBuildInfo) with updatePackageDescription.

In principle, we are also supposed to update the copy of + the PackageDescription stored in LocalBuildInfo + at localPkgDescr. Unfortunately, in practice, there + are lots of Custom setup scripts which fail to update + localPkgDescr so you really shouldn't rely on it. + It's not DEPRECATED because there are legitimate uses + for it, but... yeah. Sharp knife. See + https://github.com/haskell/cabal/issues/3606 + for more information on the issue.

It is not well-specified whether or not a HookedBuildInfo applied + at configure time is persistent to the LocalBuildInfo. The + fact that HookedBuildInfo is passed to confHook MIGHT SUGGEST + that the HookedBuildInfo is applied at this time, but actually + since 9317b67e6122ab14e53f81b573bd0ecb388eca5a it has been ONLY used + to create a modified package description that we check for problems: + it is never actually saved to the LBI. Since HookedBuildInfo is + applied monoidally to the existing build infos (and it is not an + idempotent monoid), it could break things to save it, since we + are obligated to apply any new HookedBuildInfo and then we'd + get the effect twice. But this does mean we have to re-apply + it every time. Hey, it's more flexibility.

emptyHookedBuildInfo :: HookedBuildInfo #

updatePackageDescription :: HookedBuildInfo -> PackageDescription -> PackageDescription #

package configuration

data GenericPackageDescription #

Constructors

GenericPackageDescription 

Fields

Instances
Eq GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(==) :: GenericPackageDescription -> GenericPackageDescription -> Bool #

(/=) :: GenericPackageDescription -> GenericPackageDescription -> Bool #

Data GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GenericPackageDescription -> c GenericPackageDescription #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GenericPackageDescription #

toConstr :: GenericPackageDescription -> Constr #

dataTypeOf :: GenericPackageDescription -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GenericPackageDescription) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GenericPackageDescription) #

gmapT :: (forall b. Data b => b -> b) -> GenericPackageDescription -> GenericPackageDescription #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GenericPackageDescription -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GenericPackageDescription -> r #

gmapQ :: (forall d. Data d => d -> u) -> GenericPackageDescription -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GenericPackageDescription -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GenericPackageDescription -> m GenericPackageDescription #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GenericPackageDescription -> m GenericPackageDescription #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GenericPackageDescription -> m GenericPackageDescription #

Show GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

showsPrec :: Int -> GenericPackageDescription -> ShowS #

show :: GenericPackageDescription -> String #

showList :: [GenericPackageDescription] -> ShowS #

Generic GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Associated Types

type Rep GenericPackageDescription :: * -> * #

Methods

from :: GenericPackageDescription -> Rep GenericPackageDescription x #

to :: Rep GenericPackageDescription x -> GenericPackageDescription #

Binary GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

put :: GenericPackageDescription -> Put #

get :: Get GenericPackageDescription #

putList :: [GenericPackageDescription] -> Put #

NFData GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

rnf :: GenericPackageDescription -> () #

Package GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

packageId :: GenericPackageDescription -> PackageIdentifier #

HasBuildInfos GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

traverseBuildInfos :: Traversal' GenericPackageDescription BuildInfo #

type Rep GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

type Rep GenericPackageDescription = D1 (MetaData "GenericPackageDescription" "Distribution.Types.GenericPackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "GenericPackageDescription" PrefixI True) (((S1 (MetaSel (Just "packageDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageDescription) :*: S1 (MetaSel (Just "genPackageFlags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Flag])) :*: (S1 (MetaSel (Just "condLibrary") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (CondTree ConfVar [Dependency] Library))) :*: S1 (MetaSel (Just "condSubLibraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnqualComponentName, CondTree ConfVar [Dependency] Library)]))) :*: ((S1 (MetaSel (Just "condForeignLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnqualComponentName, CondTree ConfVar [Dependency] ForeignLib)]) :*: S1 (MetaSel (Just "condExecutables") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnqualComponentName, CondTree ConfVar [Dependency] Executable)])) :*: (S1 (MetaSel (Just "condTestSuites") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnqualComponentName, CondTree ConfVar [Dependency] TestSuite)]) :*: S1 (MetaSel (Just "condBenchmarks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnqualComponentName, CondTree ConfVar [Dependency] Benchmark)])))))

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 

Fields

Instances
Eq Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(==) :: Flag -> Flag -> Bool #

(/=) :: Flag -> Flag -> Bool #

Data Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Flag -> c Flag #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Flag #

toConstr :: Flag -> Constr #

dataTypeOf :: Flag -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Flag) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Flag) #

gmapT :: (forall b. Data b => b -> b) -> Flag -> Flag #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Flag -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Flag -> r #

gmapQ :: (forall d. Data d => d -> u) -> Flag -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Flag -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Flag -> m Flag #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Flag -> m Flag #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Flag -> m Flag #

Show Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

showsPrec :: Int -> Flag -> ShowS #

show :: Flag -> String #

showList :: [Flag] -> ShowS #

Generic Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Associated Types

type Rep Flag :: * -> * #

Methods

from :: Flag -> Rep Flag x #

to :: Rep Flag x -> Flag #

Binary Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

put :: Flag -> Put #

get :: Get Flag #

putList :: [Flag] -> Put #

NFData Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

rnf :: Flag -> () #

type Rep Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

type Rep Flag = D1 (MetaData "Flag" "Distribution.Types.GenericPackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "MkFlag" PrefixI True) ((S1 (MetaSel (Just "flagName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FlagName) :*: S1 (MetaSel (Just "flagDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :*: (S1 (MetaSel (Just "flagDefault") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "flagManual") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))

emptyFlag :: FlagName -> Flag #

A Flag initialized with default parameters.

data FlagName #

A FlagName is the name of a user-defined configuration flag

Use mkFlagName and unFlagName to convert from/to a String.

This type is opaque since Cabal-2.0

Since: 2.0.0.2

Instances
Eq FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(==) :: FlagName -> FlagName -> Bool #

(/=) :: FlagName -> FlagName -> Bool #

Data FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FlagName -> c FlagName #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FlagName #

toConstr :: FlagName -> Constr #

dataTypeOf :: FlagName -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c FlagName) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FlagName) #

gmapT :: (forall b. Data b => b -> b) -> FlagName -> FlagName #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FlagName -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FlagName -> r #

gmapQ :: (forall d. Data d => d -> u) -> FlagName -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> FlagName -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FlagName -> m FlagName #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FlagName -> m FlagName #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FlagName -> m FlagName #

Ord FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

compare :: FlagName -> FlagName -> Ordering #

(<) :: FlagName -> FlagName -> Bool #

(<=) :: FlagName -> FlagName -> Bool #

(>) :: FlagName -> FlagName -> Bool #

(>=) :: FlagName -> FlagName -> Bool #

max :: FlagName -> FlagName -> FlagName #

min :: FlagName -> FlagName -> FlagName #

Read FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

readsPrec :: Int -> ReadS FlagName #

readList :: ReadS [FlagName] #

readPrec :: ReadPrec FlagName #

readListPrec :: ReadPrec [FlagName] #

Show FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

showsPrec :: Int -> FlagName -> ShowS #

show :: FlagName -> String #

showList :: [FlagName] -> ShowS #

IsString FlagName #

mkFlagName

Since: 2.0.0.2

Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

fromString :: String -> FlagName #

Generic FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Associated Types

type Rep FlagName :: * -> * #

Methods

from :: FlagName -> Rep FlagName x #

to :: Rep FlagName x -> FlagName #

Binary FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

put :: FlagName -> Put #

get :: Get FlagName #

putList :: [FlagName] -> Put #

NFData FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

rnf :: FlagName -> () #

Pretty FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

pretty :: FlagName -> Doc #

Parsec FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

parsec :: CabalParsing m => m FlagName #

Text FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

disp :: FlagName -> Doc #

parse :: ReadP r FlagName #

type Rep FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

type Rep FlagName = D1 (MetaData "FlagName" "Distribution.Types.GenericPackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "FlagName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ShortText)))

mkFlagName :: String -> FlagName #

Construct a FlagName from a String

mkFlagName is the inverse to unFlagName

Note: No validations are performed to ensure that the resulting + FlagName is valid

Since: 2.0.0.2

unFlagName :: FlagName -> String #

Convert FlagName to String

Since: 2.0.0.2

data FlagAssignment #

A FlagAssignment is a total or partial mapping of FlagNames to + Bool flag values. It represents the flags chosen by the user or + discovered during configuration. For example --flags=foo --flags=-bar + becomes [("foo", True), ("bar", False)]

Instances
Eq FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(==) :: FlagAssignment -> FlagAssignment -> Bool #

(/=) :: FlagAssignment -> FlagAssignment -> Bool #

Ord FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

compare :: FlagAssignment -> FlagAssignment -> Ordering #

(<) :: FlagAssignment -> FlagAssignment -> Bool #

(<=) :: FlagAssignment -> FlagAssignment -> Bool #

(>) :: FlagAssignment -> FlagAssignment -> Bool #

(>=) :: FlagAssignment -> FlagAssignment -> Bool #

max :: FlagAssignment -> FlagAssignment -> FlagAssignment #

min :: FlagAssignment -> FlagAssignment -> FlagAssignment #

Read FlagAssignment #

Since: 2.2.0

Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

readsPrec :: Int -> ReadS FlagAssignment #

readList :: ReadS [FlagAssignment] #

readPrec :: ReadPrec FlagAssignment #

readListPrec :: ReadPrec [FlagAssignment] #

Show FlagAssignment #

Since: 2.2.0

Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

showsPrec :: Int -> FlagAssignment -> ShowS #

show :: FlagAssignment -> String #

showList :: [FlagAssignment] -> ShowS #

Generic FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Associated Types

type Rep FlagAssignment :: * -> * #

Methods

from :: FlagAssignment -> Rep FlagAssignment x #

to :: Rep FlagAssignment x -> FlagAssignment #

Semigroup FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(<>) :: FlagAssignment -> FlagAssignment -> FlagAssignment #

sconcat :: NonEmpty FlagAssignment -> FlagAssignment #

stimes :: Integral b => b -> FlagAssignment -> FlagAssignment #

Monoid FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

mempty :: FlagAssignment #

mappend :: FlagAssignment -> FlagAssignment -> FlagAssignment #

mconcat :: [FlagAssignment] -> FlagAssignment #

Binary FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

put :: FlagAssignment -> Put #

get :: Get FlagAssignment #

putList :: [FlagAssignment] -> Put #

NFData FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

rnf :: FlagAssignment -> () #

type Rep FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

type Rep FlagAssignment = D1 (MetaData "FlagAssignment" "Distribution.Types.GenericPackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "FlagAssignment" PrefixI True) (S1 (MetaSel (Just "getFlagAssignment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map FlagName (Int, Bool)))))

mkFlagAssignment :: [(FlagName, Bool)] -> FlagAssignment #

Construct a FlagAssignment from a list of flag/value pairs.

If duplicate flags occur in the input list, the later entries + in the list will take precedence.

Since: 2.2.0

unFlagAssignment :: FlagAssignment -> [(FlagName, Bool)] #

Deconstruct a FlagAssignment into a list of flag/value pairs.

 null (findDuplicateFlagAssignments fa) ==> (mkFlagAssignment . unFlagAssignment) fa == fa

Since: 2.2.0

nullFlagAssignment :: FlagAssignment -> Bool #

Test whether FlagAssignment is empty.

Since: 2.2.0

showFlagValue :: (FlagName, Bool) -> String #

String representation of a flag-value pair.

diffFlagAssignment :: FlagAssignment -> FlagAssignment -> FlagAssignment #

Remove all flag-assignments from the first FlagAssignment that + are contained in the second FlagAssignment

NB/TODO: This currently only removes flag assignments which also + match the value assignment! We should review the code which uses + this operation to figure out if this it's not enough to only + compare the flagnames without the values.

Since: 2.2.0

lookupFlagAssignment :: FlagName -> FlagAssignment -> Maybe Bool #

Lookup the value for a flag

Returns Nothing if the flag isn't contained in the FlagAssignment.

Since: 2.2.0

insertFlagAssignment :: FlagName -> Bool -> FlagAssignment -> FlagAssignment #

Insert or update the boolean value of a flag.

If the flag is already present in the FlagAssigment, the + value will be updated and the fact that multiple values have + been provided for that flag will be recorded so that a + warning can be generated later on.

Since: 2.2.0

dispFlagAssignment :: FlagAssignment -> Doc #

Pretty-prints a flag assignment.

parseFlagAssignment :: ReadP r FlagAssignment #

Parses a flag assignment.

parsecFlagAssignment :: ParsecParser FlagAssignment #

Parses a flag assignment.

findDuplicateFlagAssignments :: FlagAssignment -> [FlagName] #

Find the FlagNames that have been listed more than once.

Since: 2.2.0

data CondTree v c a #

A CondTree is used to represent the conditional structure of + a Cabal file, reflecting a syntax element subject to constraints, + and then any number of sub-elements which may be enabled subject + to some condition. Both a and c are usually Monoids.

To be more concrete, consider the following fragment of a Cabal + file:

build-depends: base >= 4.0
+if flag(extra)
+    build-depends: base >= 4.2
+

One way to represent this is to have CondTree ConfVar + [Dependency] BuildInfo. Here, condTreeData represents + the actual fields which are not behind any conditional, while + condTreeComponents recursively records any further fields + which are behind a conditional. condTreeConstraints records + the constraints (in this case, base >= 4.0) which would + be applied if you use this syntax; in general, this is + derived off of targetBuildInfo (perhaps a good refactoring + would be to convert this into an opaque type, with a smart + constructor that pre-computes the dependencies.)

Constructors

CondNode 

Fields

Instances
Functor (CondTree v c) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

fmap :: (a -> b) -> CondTree v c a -> CondTree v c b #

(<$) :: a -> CondTree v c b -> CondTree v c a #

Foldable (CondTree v c) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

fold :: Monoid m => CondTree v c m -> m #

foldMap :: Monoid m => (a -> m) -> CondTree v c a -> m #

foldr :: (a -> b -> b) -> b -> CondTree v c a -> b #

foldr' :: (a -> b -> b) -> b -> CondTree v c a -> b #

foldl :: (b -> a -> b) -> b -> CondTree v c a -> b #

foldl' :: (b -> a -> b) -> b -> CondTree v c a -> b #

foldr1 :: (a -> a -> a) -> CondTree v c a -> a #

foldl1 :: (a -> a -> a) -> CondTree v c a -> a #

toList :: CondTree v c a -> [a] #

null :: CondTree v c a -> Bool #

length :: CondTree v c a -> Int #

elem :: Eq a => a -> CondTree v c a -> Bool #

maximum :: Ord a => CondTree v c a -> a #

minimum :: Ord a => CondTree v c a -> a #

sum :: Num a => CondTree v c a -> a #

product :: Num a => CondTree v c a -> a #

Traversable (CondTree v c) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

traverse :: Applicative f => (a -> f b) -> CondTree v c a -> f (CondTree v c b) #

sequenceA :: Applicative f => CondTree v c (f a) -> f (CondTree v c a) #

mapM :: Monad m => (a -> m b) -> CondTree v c a -> m (CondTree v c b) #

sequence :: Monad m => CondTree v c (m a) -> m (CondTree v c a) #

(Eq a, Eq c, Eq v) => Eq (CondTree v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

(==) :: CondTree v c a -> CondTree v c a -> Bool #

(/=) :: CondTree v c a -> CondTree v c a -> Bool #

(Data v, Data c, Data a) => Data (CondTree v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

gfoldl :: (forall d b. Data d => c0 (d -> b) -> d -> c0 b) -> (forall g. g -> c0 g) -> CondTree v c a -> c0 (CondTree v c a) #

gunfold :: (forall b r. Data b => c0 (b -> r) -> c0 r) -> (forall r. r -> c0 r) -> Constr -> c0 (CondTree v c a) #

toConstr :: CondTree v c a -> Constr #

dataTypeOf :: CondTree v c a -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c0 (t d)) -> Maybe (c0 (CondTree v c a)) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c0 (t d e)) -> Maybe (c0 (CondTree v c a)) #

gmapT :: (forall b. Data b => b -> b) -> CondTree v c a -> CondTree v c a #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CondTree v c a -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CondTree v c a -> r #

gmapQ :: (forall d. Data d => d -> u) -> CondTree v c a -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CondTree v c a -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CondTree v c a -> m (CondTree v c a) #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CondTree v c a -> m (CondTree v c a) #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CondTree v c a -> m (CondTree v c a) #

(Show a, Show c, Show v) => Show (CondTree v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

showsPrec :: Int -> CondTree v c a -> ShowS #

show :: CondTree v c a -> String #

showList :: [CondTree v c a] -> ShowS #

Generic (CondTree v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Associated Types

type Rep (CondTree v c a) :: * -> * #

Methods

from :: CondTree v c a -> Rep (CondTree v c a) x #

to :: Rep (CondTree v c a) x -> CondTree v c a #

(Binary v, Binary c, Binary a) => Binary (CondTree v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

put :: CondTree v c a -> Put #

get :: Get (CondTree v c a) #

putList :: [CondTree v c a] -> Put #

(NFData v, NFData c, NFData a) => NFData (CondTree v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

rnf :: CondTree v c a -> () #

type Rep (CondTree v c a) # 
Instance details

Defined in Distribution.Types.CondTree

type Rep (CondTree v c a) = D1 (MetaData "CondTree" "Distribution.Types.CondTree" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "CondNode" PrefixI True) (S1 (MetaSel (Just "condTreeData") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a) :*: (S1 (MetaSel (Just "condTreeConstraints") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 c) :*: S1 (MetaSel (Just "condTreeComponents") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [CondBranch v c a]))))

data ConfVar #

A ConfVar represents the variable type used.

Constructors

OS OS 
Arch Arch 
Flag FlagName 
Impl CompilerFlavor VersionRange 
Instances
Eq ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(==) :: ConfVar -> ConfVar -> Bool #

(/=) :: ConfVar -> ConfVar -> Bool #

Data ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ConfVar -> c ConfVar #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ConfVar #

toConstr :: ConfVar -> Constr #

dataTypeOf :: ConfVar -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ConfVar) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ConfVar) #

gmapT :: (forall b. Data b => b -> b) -> ConfVar -> ConfVar #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ConfVar -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ConfVar -> r #

gmapQ :: (forall d. Data d => d -> u) -> ConfVar -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ConfVar -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ConfVar -> m ConfVar #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ConfVar -> m ConfVar #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ConfVar -> m ConfVar #

Show ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

showsPrec :: Int -> ConfVar -> ShowS #

show :: ConfVar -> String #

showList :: [ConfVar] -> ShowS #

Generic ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Associated Types

type Rep ConfVar :: * -> * #

Methods

from :: ConfVar -> Rep ConfVar x #

to :: Rep ConfVar x -> ConfVar #

Binary ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

put :: ConfVar -> Put #

get :: Get ConfVar #

putList :: [ConfVar] -> Put #

NFData ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

rnf :: ConfVar -> () #

type Rep ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

type Rep ConfVar = D1 (MetaData "ConfVar" "Distribution.Types.GenericPackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "OS" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OS)) :+: C1 (MetaCons "Arch" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Arch))) :+: (C1 (MetaCons "Flag" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FlagName)) :+: C1 (MetaCons "Impl" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CompilerFlavor) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange))))

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
Monad Condition # 
Instance details

Defined in Distribution.Types.Condition

Methods

(>>=) :: Condition a -> (a -> Condition b) -> Condition b #

(>>) :: Condition a -> Condition b -> Condition b #

return :: a -> Condition a #

fail :: String -> Condition a #

Functor Condition # 
Instance details

Defined in Distribution.Types.Condition

Methods

fmap :: (a -> b) -> Condition a -> Condition b #

(<$) :: a -> Condition b -> Condition a #

Applicative Condition # 
Instance details

Defined in Distribution.Types.Condition

Methods

pure :: a -> Condition a #

(<*>) :: Condition (a -> b) -> Condition a -> Condition b #

liftA2 :: (a -> b -> c) -> Condition a -> Condition b -> Condition c #

(*>) :: Condition a -> Condition b -> Condition b #

(<*) :: Condition a -> Condition b -> Condition a #

Foldable Condition # 
Instance details

Defined in Distribution.Types.Condition

Methods

fold :: Monoid m => Condition m -> m #

foldMap :: Monoid m => (a -> m) -> Condition a -> m #

foldr :: (a -> b -> b) -> b -> Condition a -> b #

foldr' :: (a -> b -> b) -> b -> Condition a -> b #

foldl :: (b -> a -> b) -> b -> Condition a -> b #

foldl' :: (b -> a -> b) -> b -> Condition a -> b #

foldr1 :: (a -> a -> a) -> Condition a -> a #

foldl1 :: (a -> a -> a) -> Condition a -> a #

toList :: Condition a -> [a] #

null :: Condition a -> Bool #

length :: Condition a -> Int #

elem :: Eq a => a -> Condition a -> Bool #

maximum :: Ord a => Condition a -> a #

minimum :: Ord a => Condition a -> a #

sum :: Num a => Condition a -> a #

product :: Num a => Condition a -> a #

Traversable Condition # 
Instance details

Defined in Distribution.Types.Condition

Methods

traverse :: Applicative f => (a -> f b) -> Condition a -> f (Condition b) #

sequenceA :: Applicative f => Condition (f a) -> f (Condition a) #

mapM :: Monad m => (a -> m b) -> Condition a -> m (Condition b) #

sequence :: Monad m => Condition (m a) -> m (Condition a) #

Alternative Condition # 
Instance details

Defined in Distribution.Types.Condition

Methods

empty :: Condition a #

(<|>) :: Condition a -> Condition a -> Condition a #

some :: Condition a -> Condition [a] #

many :: Condition a -> Condition [a] #

MonadPlus Condition # 
Instance details

Defined in Distribution.Types.Condition

Methods

mzero :: Condition a #

mplus :: Condition a -> Condition a -> Condition a #

Eq c => Eq (Condition c) # 
Instance details

Defined in Distribution.Types.Condition

Methods

(==) :: Condition c -> Condition c -> Bool #

(/=) :: Condition c -> Condition c -> Bool #

Data c => Data (Condition c) # 
Instance details

Defined in Distribution.Types.Condition

Methods

gfoldl :: (forall d b. Data d => c0 (d -> b) -> d -> c0 b) -> (forall g. g -> c0 g) -> Condition c -> c0 (Condition c) #

gunfold :: (forall b r. Data b => c0 (b -> r) -> c0 r) -> (forall r. r -> c0 r) -> Constr -> c0 (Condition c) #

toConstr :: Condition c -> Constr #

dataTypeOf :: Condition c -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c0 (t d)) -> Maybe (c0 (Condition c)) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c0 (t d e)) -> Maybe (c0 (Condition c)) #

gmapT :: (forall b. Data b => b -> b) -> Condition c -> Condition c #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Condition c -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Condition c -> r #

gmapQ :: (forall d. Data d => d -> u) -> Condition c -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Condition c -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Condition c -> m (Condition c) #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Condition c -> m (Condition c) #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Condition c -> m (Condition c) #

Show c => Show (Condition c) # 
Instance details

Defined in Distribution.Types.Condition

Methods

showsPrec :: Int -> Condition c -> ShowS #

show :: Condition c -> String #

showList :: [Condition c] -> ShowS #

Generic (Condition c) # 
Instance details

Defined in Distribution.Types.Condition

Associated Types

type Rep (Condition c) :: * -> * #

Methods

from :: Condition c -> Rep (Condition c) x #

to :: Rep (Condition c) x -> Condition c #

Semigroup (Condition a) # 
Instance details

Defined in Distribution.Types.Condition

Methods

(<>) :: Condition a -> Condition a -> Condition a #

sconcat :: NonEmpty (Condition a) -> Condition a #

stimes :: Integral b => b -> Condition a -> Condition a #

Monoid (Condition a) # 
Instance details

Defined in Distribution.Types.Condition

Methods

mempty :: Condition a #

mappend :: Condition a -> Condition a -> Condition a #

mconcat :: [Condition a] -> Condition a #

Binary c => Binary (Condition c) # 
Instance details

Defined in Distribution.Types.Condition

Methods

put :: Condition c -> Put #

get :: Get (Condition c) #

putList :: [Condition c] -> Put #

NFData c => NFData (Condition c) # 
Instance details

Defined in Distribution.Types.Condition

Methods

rnf :: Condition c -> () #

type Rep (Condition c) # 
Instance details

Defined in Distribution.Types.Condition

type Rep (Condition c) = D1 (MetaData "Condition" "Distribution.Types.Condition" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "Var" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 c)) :+: C1 (MetaCons "Lit" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :+: (C1 (MetaCons "CNot" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Condition c))) :+: (C1 (MetaCons "COr" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Condition c)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Condition c))) :+: C1 (MetaCons "CAnd" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Condition c)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Condition c))))))

cNot :: Condition a -> Condition a #

Boolean negation of a Condition value.

cAnd :: Condition a -> Condition a -> Condition a #

Boolean AND of two Condtion values.

cOr :: Eq v => Condition v -> Condition v -> Condition v #

Boolean OR of two Condition values.

Source repositories

data SourceRepo #

Information about the source revision control system for a package.

When specifying a repo it is useful to know the meaning or intention of the + information as doing so enables automation. There are two obvious common + purposes: one is to find the repo for the latest development version, the + other is to find the repo for this specific release. The ReopKind + specifies which one we mean (or another custom one).

A package can specify one or the other kind or both. Most will specify just + a head repo but some may want to specify a repo to reconstruct the sources + for this package release.

The required information is the RepoType which tells us if it's using + Darcs, Git for example. The repoLocation and other details are + interpreted according to the repo type.

Constructors

SourceRepo 

Fields

  • repoKind :: RepoKind

    The kind of repo. This field is required.

  • repoType :: Maybe RepoType

    The type of the source repository system for this repo, eg Darcs or + Git. This field is required.

  • repoLocation :: Maybe String

    The location of the repository. For most RepoTypes this is a URL. + This field is required.

  • repoModule :: Maybe String

    CVS can put multiple "modules" on one server and requires a + module name in addition to the location to identify a particular repo. + Logically this is part of the location but unfortunately has to be + specified separately. This field is required for the CVS RepoType and + should not be given otherwise.

  • repoBranch :: Maybe String

    The name or identifier of the branch, if any. Many source control + systems have the notion of multiple branches in a repo that exist in the + same location. For example Git and CVS use this while systems like + Darcs use different locations for different branches. This field is + optional but should be used if necessary to identify the sources, + especially for the RepoThis repo kind.

  • repoTag :: Maybe String

    The tag identify a particular state of the repository. This should be + given for the RepoThis repo kind and not for RepoHead kind.

  • repoSubdir :: Maybe FilePath

    Some repositories contain multiple projects in different subdirectories + This field specifies the subdirectory where this packages sources can be + found, eg the subdirectory containing the .cabal file. It is interpreted + relative to the root of the repository. This field is optional. If not + given the default is "." ie no subdirectory.

Instances
Eq SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

(==) :: SourceRepo -> SourceRepo -> Bool #

(/=) :: SourceRepo -> SourceRepo -> Bool #

Data SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SourceRepo -> c SourceRepo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SourceRepo #

toConstr :: SourceRepo -> Constr #

dataTypeOf :: SourceRepo -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SourceRepo) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SourceRepo) #

gmapT :: (forall b. Data b => b -> b) -> SourceRepo -> SourceRepo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SourceRepo -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SourceRepo -> r #

gmapQ :: (forall d. Data d => d -> u) -> SourceRepo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SourceRepo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SourceRepo -> m SourceRepo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SourceRepo -> m SourceRepo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SourceRepo -> m SourceRepo #

Ord SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

compare :: SourceRepo -> SourceRepo -> Ordering #

(<) :: SourceRepo -> SourceRepo -> Bool #

(<=) :: SourceRepo -> SourceRepo -> Bool #

(>) :: SourceRepo -> SourceRepo -> Bool #

(>=) :: SourceRepo -> SourceRepo -> Bool #

max :: SourceRepo -> SourceRepo -> SourceRepo #

min :: SourceRepo -> SourceRepo -> SourceRepo #

Read SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

readsPrec :: Int -> ReadS SourceRepo #

readList :: ReadS [SourceRepo] #

readPrec :: ReadPrec SourceRepo #

readListPrec :: ReadPrec [SourceRepo] #

Show SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

showsPrec :: Int -> SourceRepo -> ShowS #

show :: SourceRepo -> String #

showList :: [SourceRepo] -> ShowS #

Generic SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Associated Types

type Rep SourceRepo :: * -> * #

Methods

from :: SourceRepo -> Rep SourceRepo x #

to :: Rep SourceRepo x -> SourceRepo #

Binary SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

put :: SourceRepo -> Put #

get :: Get SourceRepo #

putList :: [SourceRepo] -> Put #

NFData SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

rnf :: SourceRepo -> () #

type Rep SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

type Rep SourceRepo = D1 (MetaData "SourceRepo" "Distribution.Types.SourceRepo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "SourceRepo" PrefixI True) ((S1 (MetaSel (Just "repoKind") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RepoKind) :*: (S1 (MetaSel (Just "repoType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe RepoType)) :*: S1 (MetaSel (Just "repoLocation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)))) :*: ((S1 (MetaSel (Just "repoModule") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :*: S1 (MetaSel (Just "repoBranch") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String))) :*: (S1 (MetaSel (Just "repoTag") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :*: S1 (MetaSel (Just "repoSubdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))))))

data RepoKind #

What this repo info is for, what it represents.

Constructors

RepoHead

The repository for the "head" or development version of the project. + This repo is where we should track the latest development activity or + the usual repo people should get to contribute patches.

RepoThis

The repository containing the sources for this exact package version + or release. For this kind of repo a tag should be given to give enough + information to re-create the exact sources.

RepoKindUnknown String 
Instances
Eq RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

(==) :: RepoKind -> RepoKind -> Bool #

(/=) :: RepoKind -> RepoKind -> Bool #

Data RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RepoKind -> c RepoKind #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RepoKind #

toConstr :: RepoKind -> Constr #

dataTypeOf :: RepoKind -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RepoKind) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RepoKind) #

gmapT :: (forall b. Data b => b -> b) -> RepoKind -> RepoKind #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RepoKind -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RepoKind -> r #

gmapQ :: (forall d. Data d => d -> u) -> RepoKind -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RepoKind -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RepoKind -> m RepoKind #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RepoKind -> m RepoKind #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RepoKind -> m RepoKind #

Ord RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

compare :: RepoKind -> RepoKind -> Ordering #

(<) :: RepoKind -> RepoKind -> Bool #

(<=) :: RepoKind -> RepoKind -> Bool #

(>) :: RepoKind -> RepoKind -> Bool #

(>=) :: RepoKind -> RepoKind -> Bool #

max :: RepoKind -> RepoKind -> RepoKind #

min :: RepoKind -> RepoKind -> RepoKind #

Read RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

readsPrec :: Int -> ReadS RepoKind #

readList :: ReadS [RepoKind] #

readPrec :: ReadPrec RepoKind #

readListPrec :: ReadPrec [RepoKind] #

Show RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

showsPrec :: Int -> RepoKind -> ShowS #

show :: RepoKind -> String #

showList :: [RepoKind] -> ShowS #

Generic RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Associated Types

type Rep RepoKind :: * -> * #

Methods

from :: RepoKind -> Rep RepoKind x #

to :: Rep RepoKind x -> RepoKind #

Binary RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

put :: RepoKind -> Put #

get :: Get RepoKind #

putList :: [RepoKind] -> Put #

NFData RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

rnf :: RepoKind -> () #

Pretty RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

pretty :: RepoKind -> Doc #

Parsec RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

parsec :: CabalParsing m => m RepoKind #

Text RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

disp :: RepoKind -> Doc #

parse :: ReadP r RepoKind #

type Rep RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

type Rep RepoKind = D1 (MetaData "RepoKind" "Distribution.Types.SourceRepo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "RepoHead" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "RepoThis" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "RepoKindUnknown" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))

data RepoType #

An enumeration of common source control systems. The fields used in the + SourceRepo depend on the type of repo. The tools and methods used to + obtain and track the repo depend on the repo type.

Constructors

Darcs 
Git 
SVN 
CVS 
Mercurial 
GnuArch 
Bazaar 
Monotone 
OtherRepoType String 
Instances
Eq RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

(==) :: RepoType -> RepoType -> Bool #

(/=) :: RepoType -> RepoType -> Bool #

Data RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RepoType -> c RepoType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RepoType #

toConstr :: RepoType -> Constr #

dataTypeOf :: RepoType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RepoType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RepoType) #

gmapT :: (forall b. Data b => b -> b) -> RepoType -> RepoType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RepoType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RepoType -> r #

gmapQ :: (forall d. Data d => d -> u) -> RepoType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RepoType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RepoType -> m RepoType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RepoType -> m RepoType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RepoType -> m RepoType #

Ord RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

compare :: RepoType -> RepoType -> Ordering #

(<) :: RepoType -> RepoType -> Bool #

(<=) :: RepoType -> RepoType -> Bool #

(>) :: RepoType -> RepoType -> Bool #

(>=) :: RepoType -> RepoType -> Bool #

max :: RepoType -> RepoType -> RepoType #

min :: RepoType -> RepoType -> RepoType #

Read RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

readsPrec :: Int -> ReadS RepoType #

readList :: ReadS [RepoType] #

readPrec :: ReadPrec RepoType #

readListPrec :: ReadPrec [RepoType] #

Show RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

showsPrec :: Int -> RepoType -> ShowS #

show :: RepoType -> String #

showList :: [RepoType] -> ShowS #

Generic RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Associated Types

type Rep RepoType :: * -> * #

Methods

from :: RepoType -> Rep RepoType x #

to :: Rep RepoType x -> RepoType #

Binary RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

put :: RepoType -> Put #

get :: Get RepoType #

putList :: [RepoType] -> Put #

NFData RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

rnf :: RepoType -> () #

Pretty RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

pretty :: RepoType -> Doc #

Parsec RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

parsec :: CabalParsing m => m RepoType #

Text RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

disp :: RepoType -> Doc #

parse :: ReadP r RepoType #

type Rep RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

type Rep RepoType = D1 (MetaData "RepoType" "Distribution.Types.SourceRepo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (((C1 (MetaCons "Darcs" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Git" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "SVN" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CVS" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "Mercurial" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "GnuArch" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Bazaar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Monotone" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OtherRepoType" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))))

knownRepoTypes :: [RepoType] #

emptySourceRepo :: RepoKind -> SourceRepo #

Custom setup build information

data SetupBuildInfo #

Constructors

SetupBuildInfo 

Fields

  • setupDepends :: [Dependency]
     
  • defaultSetupDepends :: Bool

    Is this a default 'custom-setup' section added by the cabal-install + code (as opposed to user-provided)? This field is only used + internally, and doesn't correspond to anything in the .cabal + file. See #3199.

Instances
Eq SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

(==) :: SetupBuildInfo -> SetupBuildInfo -> Bool #

(/=) :: SetupBuildInfo -> SetupBuildInfo -> Bool #

Data SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetupBuildInfo -> c SetupBuildInfo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetupBuildInfo #

toConstr :: SetupBuildInfo -> Constr #

dataTypeOf :: SetupBuildInfo -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SetupBuildInfo) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetupBuildInfo) #

gmapT :: (forall b. Data b => b -> b) -> SetupBuildInfo -> SetupBuildInfo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetupBuildInfo -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetupBuildInfo -> r #

gmapQ :: (forall d. Data d => d -> u) -> SetupBuildInfo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SetupBuildInfo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetupBuildInfo -> m SetupBuildInfo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetupBuildInfo -> m SetupBuildInfo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetupBuildInfo -> m SetupBuildInfo #

Read SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

readsPrec :: Int -> ReadS SetupBuildInfo #

readList :: ReadS [SetupBuildInfo] #

readPrec :: ReadPrec SetupBuildInfo #

readListPrec :: ReadPrec [SetupBuildInfo] #

Show SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

showsPrec :: Int -> SetupBuildInfo -> ShowS #

show :: SetupBuildInfo -> String #

showList :: [SetupBuildInfo] -> ShowS #

Generic SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Associated Types

type Rep SetupBuildInfo :: * -> * #

Methods

from :: SetupBuildInfo -> Rep SetupBuildInfo x #

to :: Rep SetupBuildInfo x -> SetupBuildInfo #

Semigroup SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

(<>) :: SetupBuildInfo -> SetupBuildInfo -> SetupBuildInfo #

sconcat :: NonEmpty SetupBuildInfo -> SetupBuildInfo #

stimes :: Integral b => b -> SetupBuildInfo -> SetupBuildInfo #

Monoid SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

mempty :: SetupBuildInfo #

mappend :: SetupBuildInfo -> SetupBuildInfo -> SetupBuildInfo #

mconcat :: [SetupBuildInfo] -> SetupBuildInfo #

Binary SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

put :: SetupBuildInfo -> Put #

get :: Get SetupBuildInfo #

putList :: [SetupBuildInfo] -> Put #

NFData SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

rnf :: SetupBuildInfo -> () #

type Rep SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

type Rep SetupBuildInfo = D1 (MetaData "SetupBuildInfo" "Distribution.Types.SetupBuildInfo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "SetupBuildInfo" PrefixI True) (S1 (MetaSel (Just "setupDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Dependency]) :*: S1 (MetaSel (Just "defaultSetupDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))
diff --git a/doc/API/Cabal/Distribution-Parsec-Class.html b/doc/API/Cabal/Distribution-Parsec-Class.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Parsec-Class.html @@ -0,0 +1,19 @@ +Distribution.Parsec.Class

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Parsec.Class

Contents

Synopsis

Documentation

class Parsec a where #

Class for parsing with parsec. Mainly used for .cabal file fields.

Minimal complete definition

parsec

Methods

parsec :: CabalParsing m => m a #

Instances
Parsec Bool # 
Instance details

Defined in Distribution.Parsec.Class

Methods

parsec :: CabalParsing m => m Bool #

Parsec Version # 
Instance details

Defined in Distribution.Types.Version

Methods

parsec :: CabalParsing m => m Version #

Parsec VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

parsec :: CabalParsing m => m VersionRange #

Parsec RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

parsec :: CabalParsing m => m RepoType #

Parsec RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

parsec :: CabalParsing m => m RepoKind #

Parsec PkgconfigName # 
Instance details

Defined in Distribution.Types.PkgconfigName

Methods

parsec :: CabalParsing m => m PkgconfigName #

Parsec ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

parsec :: CabalParsing m => m ForeignLibType #

Parsec ForeignLibOption # 
Instance details

Defined in Distribution.Types.ForeignLibOption

Methods

parsec :: CabalParsing m => m ForeignLibOption #

Parsec ExecutableScope # 
Instance details

Defined in Distribution.Types.ExecutableScope

Methods

parsec :: CabalParsing m => m ExecutableScope #

Parsec ComponentId # 
Instance details

Defined in Distribution.Types.ComponentId

Methods

parsec :: CabalParsing m => m ComponentId #

Parsec BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

parsec :: CabalParsing m => m BuildType #

Parsec AbiHash # 
Instance details

Defined in Distribution.Types.AbiHash

Methods

parsec :: CabalParsing m => m AbiHash #

Parsec Platform # 
Instance details

Defined in Distribution.System

Methods

parsec :: CabalParsing m => m Platform #

Parsec Arch # 
Instance details

Defined in Distribution.System

Methods

parsec :: CabalParsing m => m Arch #

Parsec OS # 
Instance details

Defined in Distribution.System

Methods

parsec :: CabalParsing m => m OS #

Parsec LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

parsec :: CabalParsing m => m LicenseRef #

Parsec LicenseId #
>>> eitherParsec "BSD-3-Clause" :: Either String LicenseId
+Right BSD_3_Clause
+
>>> eitherParsec "BSD3" :: Either String LicenseId
+Left "...Unknown SPDX license identifier: 'BSD3' Do you mean BSD-3-Clause?"
+
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

parsec :: CabalParsing m => m LicenseId #

Parsec LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

parsec :: CabalParsing m => m LicenseExceptionId #

Parsec SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

parsec :: CabalParsing m => m SimpleLicenseExpression #

Parsec LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

parsec :: CabalParsing m => m LicenseExpression #

Parsec License #
>>> eitherParsec "BSD-3-Clause AND MIT" :: Either String License
+Right (License (EAnd (ELicense (ELicenseId BSD_3_Clause) Nothing) (ELicense (ELicenseId MIT) Nothing)))
+
>>> eitherParsec "NONE" :: Either String License
+Right NONE
+
Instance details

Defined in Distribution.SPDX.License

Methods

parsec :: CabalParsing m => m License #

Parsec ModuleName # 
Instance details

Defined in Distribution.ModuleName

Methods

parsec :: CabalParsing m => m ModuleName #

Parsec ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

parsec :: CabalParsing m => m ModuleRenaming #

Parsec IncludeRenaming # 
Instance details

Defined in Distribution.Types.IncludeRenaming

Methods

parsec :: CabalParsing m => m IncludeRenaming #

Parsec TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

parsec :: CabalParsing m => m TestType #

Parsec PkgconfigDependency # 
Instance details

Defined in Distribution.Types.PkgconfigDependency

Methods

parsec :: CabalParsing m => m PkgconfigDependency #

Parsec BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

parsec :: CabalParsing m => m BenchmarkType #

Parsec License # 
Instance details

Defined in Distribution.License

Methods

parsec :: CabalParsing m => m License #

Parsec Extension # 
Instance details

Defined in Language.Haskell.Extension

Methods

parsec :: CabalParsing m => m Extension #

Parsec Language # 
Instance details

Defined in Language.Haskell.Extension

Methods

parsec :: CabalParsing m => m Language #

Parsec CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

parsec :: CabalParsing m => m CompilerFlavor #

Parsec FilePathNT # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m FilePathNT #

Parsec FreeText # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m FreeText #

Parsec TestedWith # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m TestedWith #

Parsec SpecLicense # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m SpecLicense #

Parsec SpecVersion # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m SpecVersion #

Parsec Token' # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m Token' #

Parsec Token # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m Token #

Parsec PackageName # 
Instance details

Defined in Distribution.Types.PackageName

Methods

parsec :: CabalParsing m => m PackageName #

Parsec UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

parsec :: CabalParsing m => m UnqualComponentName #

Parsec PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

parsec :: CabalParsing m => m PackageIdentifier #

Parsec DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

parsec :: CabalParsing m => m DefUnitId #

Parsec UnitId #

The textual format for UnitId coincides with the format + GHC accepts for -package-id.

Instance details

Defined in Distribution.Types.UnitId

Methods

parsec :: CabalParsing m => m UnitId #

Parsec Module # 
Instance details

Defined in Distribution.Types.Module

Methods

parsec :: CabalParsing m => m Module #

Parsec OpenModule #
>>> eitherParsec "Includes2-0.1.0.0-inplace-mysql:Database.MySQL" :: Either String OpenModule
+Right (OpenModule (DefiniteUnitId (DefUnitId {unDefUnitId = UnitId "Includes2-0.1.0.0-inplace-mysql"})) (ModuleName ["Database","MySQL"]))
+
Instance details

Defined in Distribution.Backpack

Methods

parsec :: CabalParsing m => m OpenModule #

Parsec OpenUnitId #
>>> eitherParsec "foobar" :: Either String OpenUnitId
+Right (DefiniteUnitId (DefUnitId {unDefUnitId = UnitId "foobar"}))
+
>>> eitherParsec "foo[Str=text-1.2.3:Data.Text.Text]" :: Either String OpenUnitId
+Right (IndefFullUnitId (ComponentId "foo") (fromList [(ModuleName ["Str"],OpenModule (DefiniteUnitId (DefUnitId {unDefUnitId = UnitId "text-1.2.3"})) (ModuleName ["Data","Text","Text"]))]))
+
Instance details

Defined in Distribution.Backpack

Methods

parsec :: CabalParsing m => m OpenUnitId #

Parsec ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

parsec :: CabalParsing m => m ModuleReexport #

Parsec Mixin # 
Instance details

Defined in Distribution.Types.Mixin

Methods

parsec :: CabalParsing m => m Mixin #

Parsec ExeDependency # 
Instance details

Defined in Distribution.Types.ExeDependency

Methods

parsec :: CabalParsing m => m ExeDependency #

Parsec Dependency # 
Instance details

Defined in Distribution.Types.Dependency

Methods

parsec :: CabalParsing m => m Dependency #

Parsec MungedPackageName # 
Instance details

Defined in Distribution.Types.MungedPackageName

Methods

parsec :: CabalParsing m => m MungedPackageName #

Parsec AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

parsec :: CabalParsing m => m AbiDependency #

Parsec LegacyExeDependency # 
Instance details

Defined in Distribution.Types.LegacyExeDependency

Methods

parsec :: CabalParsing m => m LegacyExeDependency #

Parsec LibVersionInfo # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

parsec :: CabalParsing m => m LibVersionInfo #

Parsec FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

parsec :: CabalParsing m => m FlagName #

Parsec ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

parsec :: CabalParsing m => m ExposedModule #

Parsec TestShowDetails # 
Instance details

Defined in Distribution.Simple.Setup

Methods

parsec :: CabalParsing m => m TestShowDetails #

Parsec a => Parsec (Identity a) # 
Instance details

Defined in Distribution.Parsec.Class

Methods

parsec :: CabalParsing m => m (Identity a) #

Parsec a => Parsec (MQuoted a) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m (MQuoted a) #

(Newtype b a, Sep sep, Parsec b) => Parsec (List sep b a) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m (List sep b a) #

newtype ParsecParser a #

Constructors

PP 

Fields

Instances
Monad ParsecParser # 
Instance details

Defined in Distribution.Parsec.Class

Methods

(>>=) :: ParsecParser a -> (a -> ParsecParser b) -> ParsecParser b #

(>>) :: ParsecParser a -> ParsecParser b -> ParsecParser b #

return :: a -> ParsecParser a #

fail :: String -> ParsecParser a #

Functor ParsecParser # 
Instance details

Defined in Distribution.Parsec.Class

Methods

fmap :: (a -> b) -> ParsecParser a -> ParsecParser b #

(<$) :: a -> ParsecParser b -> ParsecParser a #

MonadFail ParsecParser # 
Instance details

Defined in Distribution.Parsec.Class

Methods

fail :: String -> ParsecParser a #

Applicative ParsecParser # 
Instance details

Defined in Distribution.Parsec.Class

Methods

pure :: a -> ParsecParser a #

(<*>) :: ParsecParser (a -> b) -> ParsecParser a -> ParsecParser b #

liftA2 :: (a -> b -> c) -> ParsecParser a -> ParsecParser b -> ParsecParser c #

(*>) :: ParsecParser a -> ParsecParser b -> ParsecParser b #

(<*) :: ParsecParser a -> ParsecParser b -> ParsecParser a #

Alternative ParsecParser # 
Instance details

Defined in Distribution.Parsec.Class

Methods

empty :: ParsecParser a #

(<|>) :: ParsecParser a -> ParsecParser a -> ParsecParser a #

some :: ParsecParser a -> ParsecParser [a] #

many :: ParsecParser a -> ParsecParser [a] #

MonadPlus ParsecParser # 
Instance details

Defined in Distribution.Parsec.Class

Methods

mzero :: ParsecParser a #

mplus :: ParsecParser a -> ParsecParser a -> ParsecParser a #

Parsing ParsecParser # 
Instance details

Defined in Distribution.Parsec.Class

Methods

try :: ParsecParser a -> ParsecParser a #

(<?>) :: ParsecParser a -> String -> ParsecParser a #

skipMany :: ParsecParser a -> ParsecParser () #

skipSome :: ParsecParser a -> ParsecParser () #

unexpected :: String -> ParsecParser a #

eof :: ParsecParser () #

notFollowedBy :: Show a => ParsecParser a -> ParsecParser () #

CharParsing ParsecParser # 
Instance details

Defined in Distribution.Parsec.Class

Methods

satisfy :: (Char -> Bool) -> ParsecParser Char #

char :: Char -> ParsecParser Char #

notChar :: Char -> ParsecParser Char #

anyChar :: ParsecParser Char #

string :: String -> ParsecParser String #

text :: Text -> ParsecParser Text #

CabalParsing ParsecParser # 
Instance details

Defined in Distribution.Parsec.Class

Methods

parsecWarning :: PWarnType -> String -> ParsecParser () #

parsecHaskellString :: ParsecParser String #

askCabalSpecVersion :: ParsecParser CabalSpecVersion #

runParsecParser :: ParsecParser a -> FilePath -> FieldLineStream -> Either ParseError a #

Run ParsecParser with cabalSpecLatest.

simpleParsec :: Parsec a => String -> Maybe a #

Parse a String with lexemeParsec.

lexemeParsec :: (CabalParsing m, Parsec a) => m a #

parsec could consume trailing spaces, this function will consume.

eitherParsec :: Parsec a => String -> Either String a #

Parse a String with lexemeParsec.

explicitEitherParsec :: ParsecParser a -> String -> Either String a #

Parse a String with given ParsecParser. Trailing whitespace is accepted.

CabalParsing & warnings

class (CharParsing m, MonadPlus m) => CabalParsing m where #

Parsing class which

  • can report Cabal parser warnings.
  • knows cabal-version we work with

Minimal complete definition

parsecWarning, askCabalSpecVersion

Methods

parsecWarning :: PWarnType -> String -> m () #

parsecHaskellString :: m String #

askCabalSpecVersion :: m CabalSpecVersion #

Instances
CabalParsing ParsecParser # 
Instance details

Defined in Distribution.Parsec.Class

Methods

parsecWarning :: PWarnType -> String -> ParsecParser () #

parsecHaskellString :: ParsecParser String #

askCabalSpecVersion :: ParsecParser CabalSpecVersion #

t ~ Char => CabalParsing (Parser r t) # 
Instance details

Defined in Distribution.Parsec.Class

Methods

parsecWarning :: PWarnType -> String -> Parser r t () #

parsecHaskellString :: Parser r t String #

askCabalSpecVersion :: Parser r t CabalSpecVersion #

data PWarnType #

Type of parser warning. We do classify warnings.

Different application may decide not to show some, or have fatal behaviour on others

Constructors

PWTOther

Unclassified warning

PWTUTF

Invalid UTF encoding

PWTBoolCase

true or false, not True or False

PWTVersionTag

there are version with tags

PWTNewSyntax

New syntax used, but no cabal-version: >= 1.2 specified

PWTOldSyntax

Old syntax used, and cabal-version >= 1.2 specified

PWTDeprecatedField 
PWTInvalidSubsection 
PWTUnknownField 
PWTUnknownSection 
PWTTrailingFields 
PWTExtraMainIs

extra main-is field

PWTExtraTestModule

extra test-module field

PWTExtraBenchmarkModule

extra benchmark-module field

PWTLexNBSP 
PWTLexBOM 
PWTLexTab 
PWTQuirkyCabalFile

legacy cabal file that we know how to patch

PWTDoubleDash

Double dash token, most likely it's a mistake - it's not a comment

PWTMultipleSingularField

e.g. name or version should be specified only once.

PWTBuildTypeDefault

Workaround for derive-package having build-type: Default. See https://github.com/haskell/cabal/issues/5020.

PWTVersionLeadingZeros

See https://github.com/haskell-infra/hackage-trustees/issues/128

Instances
Bounded PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Methods

minBound :: PWarnType #

maxBound :: PWarnType #

Enum PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Methods

succ :: PWarnType -> PWarnType #

pred :: PWarnType -> PWarnType #

toEnum :: Int -> PWarnType #

fromEnum :: PWarnType -> Int #

enumFrom :: PWarnType -> [PWarnType] #

enumFromThen :: PWarnType -> PWarnType -> [PWarnType] #

enumFromTo :: PWarnType -> PWarnType -> [PWarnType] #

enumFromThenTo :: PWarnType -> PWarnType -> PWarnType -> [PWarnType] #

Eq PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Methods

(==) :: PWarnType -> PWarnType -> Bool #

(/=) :: PWarnType -> PWarnType -> Bool #

Ord PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Methods

compare :: PWarnType -> PWarnType -> Ordering #

(<) :: PWarnType -> PWarnType -> Bool #

(<=) :: PWarnType -> PWarnType -> Bool #

(>) :: PWarnType -> PWarnType -> Bool #

(>=) :: PWarnType -> PWarnType -> Bool #

max :: PWarnType -> PWarnType -> PWarnType #

min :: PWarnType -> PWarnType -> PWarnType #

Show PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Methods

showsPrec :: Int -> PWarnType -> ShowS #

show :: PWarnType -> String #

showList :: [PWarnType] -> ShowS #

Generic PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Associated Types

type Rep PWarnType :: * -> * #

Methods

from :: PWarnType -> Rep PWarnType x #

to :: Rep PWarnType x -> PWarnType #

Binary PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Methods

put :: PWarnType -> Put #

get :: Get PWarnType #

putList :: [PWarnType] -> Put #

NFData PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Methods

rnf :: PWarnType -> () #

type Rep PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

type Rep PWarnType = D1 (MetaData "PWarnType" "Distribution.Parsec.Common" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((((C1 (MetaCons "PWTOther" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTUTF" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "PWTBoolCase" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "PWTVersionTag" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTNewSyntax" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "PWTOldSyntax" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "PWTDeprecatedField" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTInvalidSubsection" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "PWTUnknownField" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "PWTUnknownSection" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTTrailingFields" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "PWTExtraMainIs" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTExtraTestModule" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "PWTExtraBenchmarkModule" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "PWTLexNBSP" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTLexBOM" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "PWTLexTab" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "PWTQuirkyCabalFile" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTDoubleDash" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "PWTMultipleSingularField" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "PWTBuildTypeDefault" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTVersionLeadingZeros" PrefixI False) (U1 :: * -> *))))))

Utilities

parsecToken :: CabalParsing m => m String #

[^ ,]

parsecToken' :: CabalParsing m => m String #

[^ ]

parsecFilePath :: CabalParsing m => m FilePath #

parsecQuoted :: CabalParsing m => m a -> m a #

Content isn't unquoted

parsecMaybeQuoted :: CabalParsing m => m a -> m a #

parsecMaybeQuoted p = parsecQuoted p | p.

parsecCommaList :: CabalParsing m => m a -> m [a] #

parsecLeadingCommaList :: CabalParsing m => m a -> m [a] #

Like parsecCommaList but accept leading or trailing comma.

p (comma p)*  -- p sepBy comma
+(comma p)*    -- leading comma
+(p comma)*    -- trailing comma
+

parsecOptCommaList :: CabalParsing m => m a -> m [a] #

parsecStandard :: (CabalParsing m, Parsec ver) => (ver -> String -> a) -> m a #

Parse a benchmark/test-suite types.

parsecUnqualComponentName :: CabalParsing m => m String #

diff --git a/doc/API/Cabal/Distribution-Parsec-Common.html b/doc/API/Cabal/Distribution-Parsec-Common.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Parsec-Common.html @@ -0,0 +1,1 @@ +Distribution.Parsec.Common

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Parsec.Common

Contents

Description

Module containing small types

Synopsis

Diagnostics

data PError #

Parser error.

Constructors

PError Position String 
Instances
Show PError # 
Instance details

Defined in Distribution.Parsec.Common

Methods

showsPrec :: Int -> PError -> ShowS #

show :: PError -> String #

showList :: [PError] -> ShowS #

Generic PError # 
Instance details

Defined in Distribution.Parsec.Common

Associated Types

type Rep PError :: * -> * #

Methods

from :: PError -> Rep PError x #

to :: Rep PError x -> PError #

Binary PError # 
Instance details

Defined in Distribution.Parsec.Common

Methods

put :: PError -> Put #

get :: Get PError #

putList :: [PError] -> Put #

NFData PError # 
Instance details

Defined in Distribution.Parsec.Common

Methods

rnf :: PError -> () #

type Rep PError # 
Instance details

Defined in Distribution.Parsec.Common

type Rep PError = D1 (MetaData "PError" "Distribution.Parsec.Common" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "PError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Position) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))

showPError :: FilePath -> PError -> String #

data PWarning #

Parser warning.

Constructors

PWarning !PWarnType !Position String 
Instances
Show PWarning # 
Instance details

Defined in Distribution.Parsec.Common

Methods

showsPrec :: Int -> PWarning -> ShowS #

show :: PWarning -> String #

showList :: [PWarning] -> ShowS #

Generic PWarning # 
Instance details

Defined in Distribution.Parsec.Common

Associated Types

type Rep PWarning :: * -> * #

Methods

from :: PWarning -> Rep PWarning x #

to :: Rep PWarning x -> PWarning #

Binary PWarning # 
Instance details

Defined in Distribution.Parsec.Common

Methods

put :: PWarning -> Put #

get :: Get PWarning #

putList :: [PWarning] -> Put #

NFData PWarning # 
Instance details

Defined in Distribution.Parsec.Common

Methods

rnf :: PWarning -> () #

type Rep PWarning # 
Instance details

Defined in Distribution.Parsec.Common

type Rep PWarning = D1 (MetaData "PWarning" "Distribution.Parsec.Common" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "PWarning" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PWarnType) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Position) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))

data PWarnType #

Type of parser warning. We do classify warnings.

Different application may decide not to show some, or have fatal behaviour on others

Constructors

PWTOther

Unclassified warning

PWTUTF

Invalid UTF encoding

PWTBoolCase

true or false, not True or False

PWTVersionTag

there are version with tags

PWTNewSyntax

New syntax used, but no cabal-version: >= 1.2 specified

PWTOldSyntax

Old syntax used, and cabal-version >= 1.2 specified

PWTDeprecatedField 
PWTInvalidSubsection 
PWTUnknownField 
PWTUnknownSection 
PWTTrailingFields 
PWTExtraMainIs

extra main-is field

PWTExtraTestModule

extra test-module field

PWTExtraBenchmarkModule

extra benchmark-module field

PWTLexNBSP 
PWTLexBOM 
PWTLexTab 
PWTQuirkyCabalFile

legacy cabal file that we know how to patch

PWTDoubleDash

Double dash token, most likely it's a mistake - it's not a comment

PWTMultipleSingularField

e.g. name or version should be specified only once.

PWTBuildTypeDefault

Workaround for derive-package having build-type: Default. See https://github.com/haskell/cabal/issues/5020.

PWTVersionLeadingZeros

See https://github.com/haskell-infra/hackage-trustees/issues/128

Instances
Bounded PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Methods

minBound :: PWarnType #

maxBound :: PWarnType #

Enum PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Methods

succ :: PWarnType -> PWarnType #

pred :: PWarnType -> PWarnType #

toEnum :: Int -> PWarnType #

fromEnum :: PWarnType -> Int #

enumFrom :: PWarnType -> [PWarnType] #

enumFromThen :: PWarnType -> PWarnType -> [PWarnType] #

enumFromTo :: PWarnType -> PWarnType -> [PWarnType] #

enumFromThenTo :: PWarnType -> PWarnType -> PWarnType -> [PWarnType] #

Eq PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Methods

(==) :: PWarnType -> PWarnType -> Bool #

(/=) :: PWarnType -> PWarnType -> Bool #

Ord PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Methods

compare :: PWarnType -> PWarnType -> Ordering #

(<) :: PWarnType -> PWarnType -> Bool #

(<=) :: PWarnType -> PWarnType -> Bool #

(>) :: PWarnType -> PWarnType -> Bool #

(>=) :: PWarnType -> PWarnType -> Bool #

max :: PWarnType -> PWarnType -> PWarnType #

min :: PWarnType -> PWarnType -> PWarnType #

Show PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Methods

showsPrec :: Int -> PWarnType -> ShowS #

show :: PWarnType -> String #

showList :: [PWarnType] -> ShowS #

Generic PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Associated Types

type Rep PWarnType :: * -> * #

Methods

from :: PWarnType -> Rep PWarnType x #

to :: Rep PWarnType x -> PWarnType #

Binary PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Methods

put :: PWarnType -> Put #

get :: Get PWarnType #

putList :: [PWarnType] -> Put #

NFData PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

Methods

rnf :: PWarnType -> () #

type Rep PWarnType # 
Instance details

Defined in Distribution.Parsec.Common

type Rep PWarnType = D1 (MetaData "PWarnType" "Distribution.Parsec.Common" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((((C1 (MetaCons "PWTOther" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTUTF" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "PWTBoolCase" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "PWTVersionTag" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTNewSyntax" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "PWTOldSyntax" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "PWTDeprecatedField" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTInvalidSubsection" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "PWTUnknownField" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "PWTUnknownSection" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTTrailingFields" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "PWTExtraMainIs" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTExtraTestModule" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "PWTExtraBenchmarkModule" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "PWTLexNBSP" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTLexBOM" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "PWTLexTab" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "PWTQuirkyCabalFile" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTDoubleDash" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "PWTMultipleSingularField" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "PWTBuildTypeDefault" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PWTVersionLeadingZeros" PrefixI False) (U1 :: * -> *))))))

showPWarning :: FilePath -> PWarning -> String #

Position

data Position #

1-indexed row and column positions in a file.

Constructors

Position !Int !Int 
Instances
Eq Position # 
Instance details

Defined in Distribution.Parsec.Common

Methods

(==) :: Position -> Position -> Bool #

(/=) :: Position -> Position -> Bool #

Ord Position # 
Instance details

Defined in Distribution.Parsec.Common

Methods

compare :: Position -> Position -> Ordering #

(<) :: Position -> Position -> Bool #

(<=) :: Position -> Position -> Bool #

(>) :: Position -> Position -> Bool #

(>=) :: Position -> Position -> Bool #

max :: Position -> Position -> Position #

min :: Position -> Position -> Position #

Show Position # 
Instance details

Defined in Distribution.Parsec.Common

Methods

showsPrec :: Int -> Position -> ShowS #

show :: Position -> String #

showList :: [Position] -> ShowS #

Generic Position # 
Instance details

Defined in Distribution.Parsec.Common

Associated Types

type Rep Position :: * -> * #

Methods

from :: Position -> Rep Position x #

to :: Rep Position x -> Position #

Binary Position # 
Instance details

Defined in Distribution.Parsec.Common

Methods

put :: Position -> Put #

get :: Get Position #

putList :: [Position] -> Put #

NFData Position # 
Instance details

Defined in Distribution.Parsec.Common

Methods

rnf :: Position -> () #

type Rep Position # 
Instance details

Defined in Distribution.Parsec.Common

type Rep Position = D1 (MetaData "Position" "Distribution.Parsec.Common" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Position" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Int)))

incPos :: Int -> Position -> Position #

Shift position by n columns to the right.

retPos :: Position -> Position #

Shift position to beginning of next row.

showPos :: Position -> String #

zeroPos :: Position #

diff --git a/doc/API/Cabal/Distribution-Parsec-ConfVar.html b/doc/API/Cabal/Distribution-Parsec-ConfVar.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Parsec-ConfVar.html @@ -0,0 +1,2 @@ +Distribution.Parsec.ConfVar

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Parsec.ConfVar

Synopsis

Documentation

parseConditionConfVar :: [SectionArg Position] -> ParseResult (Condition ConfVar) #

Parse Condition ConfVar from section arguments provided by parsec + based outline parser.

diff --git a/doc/API/Cabal/Distribution-Parsec-Field.html b/doc/API/Cabal/Distribution-Parsec-Field.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Parsec-Field.html @@ -0,0 +1,2 @@ +Distribution.Parsec.Field

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Parsec.Field

Contents

Description

Cabal-like file AST types: Field, Section etc

These types are parametrized by an annotation.

Synopsis

Cabal file

data Field ann #

A Cabal-like file consists of a series of fields (foo: bar) and sections (library ...).

Constructors

Field !(Name ann) [FieldLine ann] 
Section !(Name ann) [SectionArg ann] [Field ann] 
Instances
Functor Field # 
Instance details

Defined in Distribution.Parsec.Field

Methods

fmap :: (a -> b) -> Field a -> Field b #

(<$) :: a -> Field b -> Field a #

Eq ann => Eq (Field ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

(==) :: Field ann -> Field ann -> Bool #

(/=) :: Field ann -> Field ann -> Bool #

Show ann => Show (Field ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

showsPrec :: Int -> Field ann -> ShowS #

show :: Field ann -> String #

showList :: [Field ann] -> ShowS #

fieldName :: Field ann -> Name ann #

Section of field name

fieldAnn :: Field ann -> ann #

fieldUniverse :: Field ann -> [Field ann] #

All transitive descendands of Field, including itself.

Note: the resulting list is never empty.

data FieldLine ann #

A line of text representing the value of a field from a Cabal file. + A field may contain multiple lines.

Invariant: ByteString has no newlines.

Constructors

FieldLine !ann !ByteString 
Instances
Functor FieldLine # 
Instance details

Defined in Distribution.Parsec.Field

Methods

fmap :: (a -> b) -> FieldLine a -> FieldLine b #

(<$) :: a -> FieldLine b -> FieldLine a #

Eq ann => Eq (FieldLine ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

(==) :: FieldLine ann -> FieldLine ann -> Bool #

(/=) :: FieldLine ann -> FieldLine ann -> Bool #

Show ann => Show (FieldLine ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

showsPrec :: Int -> FieldLine ann -> ShowS #

show :: FieldLine ann -> String #

showList :: [FieldLine ann] -> ShowS #

data SectionArg ann #

Section arguments, e.g. name of the library

Constructors

SecArgName !ann !ByteString

identifier, or omething which loos like number. Also many dot numbers, i.e. "7.6.3"

SecArgStr !ann !ByteString

quoted string

SecArgOther !ann !ByteString

everything else, mm. operators (e.g. in if-section conditionals)

Instances
Functor SectionArg # 
Instance details

Defined in Distribution.Parsec.Field

Methods

fmap :: (a -> b) -> SectionArg a -> SectionArg b #

(<$) :: a -> SectionArg b -> SectionArg a #

Eq ann => Eq (SectionArg ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

(==) :: SectionArg ann -> SectionArg ann -> Bool #

(/=) :: SectionArg ann -> SectionArg ann -> Bool #

Show ann => Show (SectionArg ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

showsPrec :: Int -> SectionArg ann -> ShowS #

show :: SectionArg ann -> String #

showList :: [SectionArg ann] -> ShowS #

sectionArgAnn :: SectionArg ann -> ann #

Extract annotation from SectionArg.

Name

type FieldName = ByteString #

data Name ann #

A field name.

Invariant: ByteString is lower-case ASCII.

Constructors

Name !ann !FieldName 
Instances
Functor Name # 
Instance details

Defined in Distribution.Parsec.Field

Methods

fmap :: (a -> b) -> Name a -> Name b #

(<$) :: a -> Name b -> Name a #

Eq ann => Eq (Name ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

(==) :: Name ann -> Name ann -> Bool #

(/=) :: Name ann -> Name ann -> Bool #

Show ann => Show (Name ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

showsPrec :: Int -> Name ann -> ShowS #

show :: Name ann -> String #

showList :: [Name ann] -> ShowS #

mkName :: ann -> FieldName -> Name ann #

getName :: Name ann -> FieldName #

nameAnn :: Name ann -> ann #

diff --git a/doc/API/Cabal/Distribution-Parsec-FieldLineStream.html b/doc/API/Cabal/Distribution-Parsec-FieldLineStream.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Parsec-FieldLineStream.html @@ -0,0 +1,1 @@ +Distribution.Parsec.FieldLineStream

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Parsec.FieldLineStream

Synopsis

Documentation

data FieldLineStream #

This is essentially a lazy bytestring, but chunks are glued with newline '\n'.

Constructors

FLSLast !ByteString 
FLSCons !ByteString FieldLineStream 
Instances
Show FieldLineStream # 
Instance details

Defined in Distribution.Parsec.FieldLineStream

Methods

showsPrec :: Int -> FieldLineStream -> ShowS #

show :: FieldLineStream -> String #

showList :: [FieldLineStream] -> ShowS #

Monad m => Stream FieldLineStream m Char # 
Instance details

Defined in Distribution.Parsec.FieldLineStream

Methods

uncons :: FieldLineStream -> m (Maybe (Char, FieldLineStream)) #

fieldLinesToStream :: [FieldLine ann] -> FieldLineStream #

fieldLineStreamFromString :: String -> FieldLineStream #

Convert String to FieldLineStream.

Note: inefficient!

fieldLineStreamFromBS :: ByteString -> FieldLineStream #

diff --git a/doc/API/Cabal/Distribution-Parsec-Lexer.html b/doc/API/Cabal/Distribution-Parsec-Lexer.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Parsec-Lexer.html @@ -0,0 +1,1 @@ +Distribution.Parsec.Lexer

Cabal-2.4.0.1: A framework for packaging Haskell software

LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Parsec.Lexer

Description

Lexer for the cabal files.

Synopsis

Documentation

ltest :: Int -> String -> IO () #

lexToken :: Lex LToken #

data Token #

Tokens of outer cabal file structure. Field values are treated opaquely.

Constructors

TokSym !ByteString

Haskell-like identifier, number or operator

TokStr !ByteString

String in quotes

TokOther !ByteString

Operators and parens

Indent !Int

Indentation token

TokFieldLine !ByteString

Lines after :

Colon 
OpenBrace 
CloseBrace 
EOF 
LexicalError InputStream 
Instances
Show Token # 
Instance details

Defined in Distribution.Parsec.Lexer

Methods

showsPrec :: Int -> Token -> ShowS #

show :: Token -> String #

showList :: [Token] -> ShowS #

data LToken #

Constructors

L !Position !Token 
Instances
Show LToken # 
Instance details

Defined in Distribution.Parsec.Lexer

Methods

showsPrec :: Int -> LToken -> ShowS #

show :: LToken -> String #

showList :: [LToken] -> ShowS #

bol_section :: Int #

in_section :: Int #

in_field_layout :: Int #

in_field_braces :: Int #

mkLexState :: ByteString -> LexState #

diff --git a/doc/API/Cabal/Distribution-Parsec-LexerMonad.html b/doc/API/Cabal/Distribution-Parsec-LexerMonad.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Parsec-LexerMonad.html @@ -0,0 +1,1 @@ +Distribution.Parsec.LexerMonad

Cabal-2.4.0.1: A framework for packaging Haskell software

LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Parsec.LexerMonad

Description

 
Synopsis

Documentation

type InputStream = ByteString #

data LexState #

Constructors

LexState 

Fields

data LexResult a #

Constructors

LexResult !LexState a 

newtype Lex a #

Constructors

Lex 

Fields

Instances
Monad Lex # 
Instance details

Defined in Distribution.Parsec.LexerMonad

Methods

(>>=) :: Lex a -> (a -> Lex b) -> Lex b #

(>>) :: Lex a -> Lex b -> Lex b #

return :: a -> Lex a #

fail :: String -> Lex a #

Functor Lex # 
Instance details

Defined in Distribution.Parsec.LexerMonad

Methods

fmap :: (a -> b) -> Lex a -> Lex b #

(<$) :: a -> Lex b -> Lex a #

Applicative Lex # 
Instance details

Defined in Distribution.Parsec.LexerMonad

Methods

pure :: a -> Lex a #

(<*>) :: Lex (a -> b) -> Lex a -> Lex b #

liftA2 :: (a -> b -> c) -> Lex a -> Lex b -> Lex c #

(*>) :: Lex a -> Lex b -> Lex b #

(<*) :: Lex a -> Lex b -> Lex a #

execLexer :: Lex a -> InputStream -> ([LexWarning], a) #

Execute the given lexer on the supplied input stream.

getPos :: Lex Position #

setPos :: Position -> Lex () #

adjustPos :: (Position -> Position) -> Lex () #

getInput :: Lex InputStream #

setInput :: InputStream -> Lex () #

getStartCode :: Lex Int #

setStartCode :: Int -> Lex () #

data LexWarning #

Constructors

LexWarning !LexWarningType !Position 
Instances
Show LexWarning # 
Instance details

Defined in Distribution.Parsec.LexerMonad

Methods

showsPrec :: Int -> LexWarning -> ShowS #

show :: LexWarning -> String #

showList :: [LexWarning] -> ShowS #

data LexWarningType #

Constructors

LexWarningNBSP

Encountered non breaking space

LexWarningBOM

BOM at the start of the cabal file

LexWarningTab

Leading tags

Instances
Eq LexWarningType # 
Instance details

Defined in Distribution.Parsec.LexerMonad

Methods

(==) :: LexWarningType -> LexWarningType -> Bool #

(/=) :: LexWarningType -> LexWarningType -> Bool #

Ord LexWarningType # 
Instance details

Defined in Distribution.Parsec.LexerMonad

Methods

compare :: LexWarningType -> LexWarningType -> Ordering #

(<) :: LexWarningType -> LexWarningType -> Bool #

(<=) :: LexWarningType -> LexWarningType -> Bool #

(>) :: LexWarningType -> LexWarningType -> Bool #

(>=) :: LexWarningType -> LexWarningType -> Bool #

max :: LexWarningType -> LexWarningType -> LexWarningType #

min :: LexWarningType -> LexWarningType -> LexWarningType #

Show LexWarningType # 
Instance details

Defined in Distribution.Parsec.LexerMonad

Methods

showsPrec :: Int -> LexWarningType -> ShowS #

show :: LexWarningType -> String #

showList :: [LexWarningType] -> ShowS #

addWarning :: LexWarningType -> Lex () #

Add warning at the current position

toPWarnings :: [LexWarning] -> [PWarning] #

diff --git a/doc/API/Cabal/Distribution-Parsec-Newtypes.html b/doc/API/Cabal/Distribution-Parsec-Newtypes.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Parsec-Newtypes.html @@ -0,0 +1,10 @@ +Distribution.Parsec.Newtypes

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Parsec.Newtypes

Contents

Description

This module provides newtype wrappers to be used with Distribution.FieldGrammar.

Synopsis

List

alaList :: sep -> [a] -> List sep (Identity a) a #

alaList and alaList' are simply List, with additional phantom + arguments to constraint the resulting type

>>> :t alaList VCat
+alaList VCat :: [a] -> List VCat (Identity a) a
+
>>> :t alaList' FSep Token
+alaList' FSep Token :: [String] -> List FSep Token String
+

alaList' :: sep -> (a -> b) -> [a] -> List sep b a #

More general version of alaList.

Modifiers

data CommaVCat #

Vertical list with commas. Displayed with vcat

Constructors

CommaVCat 

data CommaFSep #

Paragraph fill list with commas. Displayed with fsep

Constructors

CommaFSep 

data VCat #

Vertical list with optional commas. Displayed with vcat.

Constructors

VCat 

data FSep #

Paragraph fill list with optional commas. Displayed with fsep.

Constructors

FSep 

data NoCommaFSep #

Paragraph fill list without commas. Displayed with fsep.

Constructors

NoCommaFSep 

Type

data List sep b a #

List separated with optional commas. Displayed with sep, arguments of + type a are parsed and pretty-printed as b.

Instances
(Newtype b a, Sep sep, Pretty b) => Pretty (List sep b a) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: List sep b a -> Doc #

(Newtype b a, Sep sep, Parsec b) => Parsec (List sep b a) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m (List sep b a) #

Newtype (List sep wrapper a) [a] # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: [a] -> List sep wrapper a #

unpack :: List sep wrapper a -> [a] #

Version & License

newtype SpecVersion #

Version range or just version, i.e. cabal-version field.

There are few things to consider:

Constructors

SpecVersion 

Fields

Instances
Pretty SpecVersion # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: SpecVersion -> Doc #

Parsec SpecVersion # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m SpecVersion #

Newtype SpecVersion (Either Version VersionRange) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: Either Version VersionRange -> SpecVersion #

unpack :: SpecVersion -> Either Version VersionRange #

newtype TestedWith #

Version range or just version

Constructors

TestedWith 

Fields

Instances
Pretty TestedWith # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: TestedWith -> Doc #

Parsec TestedWith # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m TestedWith #

Newtype TestedWith (CompilerFlavor, VersionRange) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: (CompilerFlavor, VersionRange) -> TestedWith #

unpack :: TestedWith -> (CompilerFlavor, VersionRange) #

newtype SpecLicense #

SPDX License expression or legacy license

Constructors

SpecLicense 

Fields

Instances
Pretty SpecLicense # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: SpecLicense -> Doc #

Parsec SpecLicense # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m SpecLicense #

Newtype SpecLicense (Either License License) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: Either License0 License -> SpecLicense #

unpack :: SpecLicense -> Either License0 License #

Identifiers

newtype Token #

Haskell string or [^ ,]+

Constructors

Token 

Fields

Instances
Pretty Token # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: Token -> Doc #

Parsec Token # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m Token #

Newtype Token String # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: String -> Token #

unpack :: Token -> String #

newtype Token' #

Haskell string or [^ ]+

Constructors

Token' 

Fields

Instances
Pretty Token' # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: Token' -> Doc #

Parsec Token' # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m Token' #

Newtype Token' String # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: String -> Token' #

unpack :: Token' -> String #

newtype MQuoted a #

Either "quoted" or un-quoted.

Constructors

MQuoted 

Fields

Instances
Pretty a => Pretty (MQuoted a) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: MQuoted a -> Doc #

Parsec a => Parsec (MQuoted a) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m (MQuoted a) #

Newtype (MQuoted a) a # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: a -> MQuoted a #

unpack :: MQuoted a -> a #

newtype FreeText #

This is almost many anyChar, but it

  • trims whitespace from ends of the lines,
  • converts lines with only single dot into empty line.

Constructors

FreeText 

Fields

Instances
Pretty FreeText # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: FreeText -> Doc #

Parsec FreeText # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m FreeText #

Newtype FreeText String # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: String -> FreeText #

unpack :: FreeText -> String #

newtype FilePathNT #

Filepath are parsed as Token.

Constructors

FilePathNT 

Fields

Instances
Pretty FilePathNT # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: FilePathNT -> Doc #

Parsec FilePathNT # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

parsec :: CabalParsing m => m FilePathNT #

Newtype FilePathNT String # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: String -> FilePathNT #

unpack :: FilePathNT -> String #

diff --git a/doc/API/Cabal/Distribution-Parsec-ParseResult.html b/doc/API/Cabal/Distribution-Parsec-ParseResult.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Parsec-ParseResult.html @@ -0,0 +1,5 @@ +Distribution.Parsec.ParseResult

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Parsec.ParseResult

Description

A parse result type for parsers from AST to Haskell types.

Synopsis

Documentation

data ParseResult a #

A monad with failure and accumulating errors and warnings.

Instances
Monad ParseResult # 
Instance details

Defined in Distribution.Parsec.ParseResult

Methods

(>>=) :: ParseResult a -> (a -> ParseResult b) -> ParseResult b #

(>>) :: ParseResult a -> ParseResult b -> ParseResult b #

return :: a -> ParseResult a #

fail :: String -> ParseResult a #

Functor ParseResult # 
Instance details

Defined in Distribution.Parsec.ParseResult

Methods

fmap :: (a -> b) -> ParseResult a -> ParseResult b #

(<$) :: a -> ParseResult b -> ParseResult a #

Applicative ParseResult # 
Instance details

Defined in Distribution.Parsec.ParseResult

Methods

pure :: a -> ParseResult a #

(<*>) :: ParseResult (a -> b) -> ParseResult a -> ParseResult b #

liftA2 :: (a -> b -> c) -> ParseResult a -> ParseResult b -> ParseResult c #

(*>) :: ParseResult a -> ParseResult b -> ParseResult b #

(<*) :: ParseResult a -> ParseResult b -> ParseResult a #

runParseResult :: ParseResult a -> ([PWarning], Either (Maybe Version, [PError]) a) #

Destruct a ParseResult into the emitted warnings and either + a successful value or + list of errors and possibly recovered a spec-version declaration.

recoverWith :: ParseResult a -> a -> ParseResult a #

Recover the parse result, so we can proceed parsing. + runParseResult will still result in Nothing, if there are recorded errors.

parseWarning :: Position -> PWarnType -> String -> ParseResult () #

Add a warning. This doesn't fail the parsing process.

parseWarnings :: [PWarning] -> ParseResult () #

Add multiple warnings at once.

parseFailure :: Position -> String -> ParseResult () #

Add an error, but not fail the parser yet.

For fatal failure use parseFatalFailure

parseFatalFailure :: Position -> String -> ParseResult a #

Add an fatal error.

parseFatalFailure' :: ParseResult a #

A mzero.

getCabalSpecVersion :: ParseResult (Maybe Version) #

Get cabal spec version.

setCabalSpecVersion :: Maybe Version -> ParseResult () #

Set cabal spec version.

readAndParseFile #

Arguments

:: (ByteString -> ParseResult a)

File contents to final value parser

-> Verbosity

Verbosity level

-> FilePath

File to read

-> IO a 

Helper combinator to do parsing plumbing for files.

Given a parser and a filename, return the parse of the file, + after checking if the file exists.

Argument order is chosen to encourage partial application.

parseString #

Arguments

:: (ByteString -> ParseResult a)

File contents to final value parser

-> Verbosity

Verbosity level

-> String

File name

-> ByteString 
-> IO a 
diff --git a/doc/API/Cabal/Distribution-Parsec-Parser.html b/doc/API/Cabal/Distribution-Parsec-Parser.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Parsec-Parser.html @@ -0,0 +1,35 @@ +Distribution.Parsec.Parser

Cabal-2.4.0.1: A framework for packaging Haskell software

LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Parsec.Parser

Contents

Description

 
Synopsis

Types

data Field ann #

A Cabal-like file consists of a series of fields (foo: bar) and sections (library ...).

Constructors

Field !(Name ann) [FieldLine ann] 
Section !(Name ann) [SectionArg ann] [Field ann] 
Instances
Functor Field # 
Instance details

Defined in Distribution.Parsec.Field

Methods

fmap :: (a -> b) -> Field a -> Field b #

(<$) :: a -> Field b -> Field a #

Eq ann => Eq (Field ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

(==) :: Field ann -> Field ann -> Bool #

(/=) :: Field ann -> Field ann -> Bool #

Show ann => Show (Field ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

showsPrec :: Int -> Field ann -> ShowS #

show :: Field ann -> String #

showList :: [Field ann] -> ShowS #

data Name ann #

A field name.

Invariant: ByteString is lower-case ASCII.

Constructors

Name !ann !FieldName 
Instances
Functor Name # 
Instance details

Defined in Distribution.Parsec.Field

Methods

fmap :: (a -> b) -> Name a -> Name b #

(<$) :: a -> Name b -> Name a #

Eq ann => Eq (Name ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

(==) :: Name ann -> Name ann -> Bool #

(/=) :: Name ann -> Name ann -> Bool #

Show ann => Show (Name ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

showsPrec :: Int -> Name ann -> ShowS #

show :: Name ann -> String #

showList :: [Name ann] -> ShowS #

data FieldLine ann #

A line of text representing the value of a field from a Cabal file. + A field may contain multiple lines.

Invariant: ByteString has no newlines.

Constructors

FieldLine !ann !ByteString 
Instances
Functor FieldLine # 
Instance details

Defined in Distribution.Parsec.Field

Methods

fmap :: (a -> b) -> FieldLine a -> FieldLine b #

(<$) :: a -> FieldLine b -> FieldLine a #

Eq ann => Eq (FieldLine ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

(==) :: FieldLine ann -> FieldLine ann -> Bool #

(/=) :: FieldLine ann -> FieldLine ann -> Bool #

Show ann => Show (FieldLine ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

showsPrec :: Int -> FieldLine ann -> ShowS #

show :: FieldLine ann -> String #

showList :: [FieldLine ann] -> ShowS #

data SectionArg ann #

Section arguments, e.g. name of the library

Constructors

SecArgName !ann !ByteString

identifier, or omething which loos like number. Also many dot numbers, i.e. "7.6.3"

SecArgStr !ann !ByteString

quoted string

SecArgOther !ann !ByteString

everything else, mm. operators (e.g. in if-section conditionals)

Instances
Functor SectionArg # 
Instance details

Defined in Distribution.Parsec.Field

Methods

fmap :: (a -> b) -> SectionArg a -> SectionArg b #

(<$) :: a -> SectionArg b -> SectionArg a #

Eq ann => Eq (SectionArg ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

(==) :: SectionArg ann -> SectionArg ann -> Bool #

(/=) :: SectionArg ann -> SectionArg ann -> Bool #

Show ann => Show (SectionArg ann) # 
Instance details

Defined in Distribution.Parsec.Field

Methods

showsPrec :: Int -> SectionArg ann -> ShowS #

show :: SectionArg ann -> String #

showList :: [SectionArg ann] -> ShowS #

Grammar and parsing

CabalStyleFile ::= SecElems
+
+SecElems       ::= SecElem* '\n'?
+SecElem        ::= '\n' SecElemLayout | SecElemBraces
+SecElemLayout  ::= FieldLayout | FieldBraces | SectionLayout | SectionBraces
+SecElemBraces  ::= FieldInline | FieldBraces |                 SectionBraces
+FieldLayout    ::= name : line? ('\n' line)*
+FieldBraces    ::= name : '\n'? '{' content '}'
+FieldInline    ::= name : content
+SectionLayout  ::= name arg* SecElems
+SectionBraces  ::= name arg* '\n'? '{' SecElems '}'
+

and the same thing but left factored...

SecElems              ::= SecElem*
+SecElem               ::= '\n' name SecElemLayout
+                        |      name SecElemBraces
+SecElemLayout         ::= :   FieldLayoutOrBraces
+                        | arg*  SectionLayoutOrBraces
+FieldLayoutOrBraces   ::= '\n'? '{' content '}'
+                        | line? ('\n' line)*
+SectionLayoutOrBraces ::= '\n'? '{' SecElems '\n'? '}'
+                        | SecElems
+SecElemBraces         ::= : FieldInlineOrBraces
+                        | arg* '\n'? '{' SecElems '\n'? '}'
+FieldInlineOrBraces   ::= '\n'? '{' content '}'
+                        | content
+

Note how we have several productions with the sequence:

'\n'? '{'

That is, an optional newline (and indent) followed by a { token. + In the SectionLayoutOrBraces case you can see that this makes it + not fully left factored (because SecElems can start with a n). + Fully left factoring here would be ugly, and though we could use a + lookahead of two tokens to resolve the alternatives, we can't + conveniently use Parsec's try here to get a lookahead of only two. + So instead we deal with this case in the lexer by making a line + where the first non-space is { lex as just the { token, without + the usual indent token. Then in the parser we can resolve everything + with just one token of lookahead and so without using try.

readFields :: ByteString -> Either ParseError [Field Position] #

Parse cabal style ByteString into list of Fields, i.e. the cabal AST.

readFields' :: ByteString -> Either ParseError ([Field Position], [LexWarning]) #

Like readFields but also return lexer warnings

diff --git a/doc/API/Cabal/Distribution-Pretty.html b/doc/API/Cabal/Distribution-Pretty.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Pretty.html @@ -0,0 +1,5 @@ +Distribution.Pretty

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Pretty

Contents

Synopsis

Documentation

class Pretty a where #

Minimal complete definition

pretty

Methods

pretty :: a -> Doc #

Instances
Pretty Bool # 
Instance details

Defined in Distribution.Pretty

Methods

pretty :: Bool -> Doc #

Pretty Int # 
Instance details

Defined in Distribution.Pretty

Methods

pretty :: Int -> Doc #

Pretty Version # 
Instance details

Defined in Distribution.Types.Version

Methods

pretty :: Version -> Doc #

Pretty VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

pretty :: VersionRange -> Doc #

Pretty RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

pretty :: RepoType -> Doc #

Pretty RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

pretty :: RepoKind -> Doc #

Pretty PkgconfigName # 
Instance details

Defined in Distribution.Types.PkgconfigName

Methods

pretty :: PkgconfigName -> Doc #

Pretty ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

pretty :: ForeignLibType -> Doc #

Pretty ForeignLibOption # 
Instance details

Defined in Distribution.Types.ForeignLibOption

Methods

pretty :: ForeignLibOption -> Doc #

Pretty ExecutableScope # 
Instance details

Defined in Distribution.Types.ExecutableScope

Methods

pretty :: ExecutableScope -> Doc #

Pretty ComponentId # 
Instance details

Defined in Distribution.Types.ComponentId

Methods

pretty :: ComponentId -> Doc #

Pretty BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

pretty :: BuildType -> Doc #

Pretty AbiHash # 
Instance details

Defined in Distribution.Types.AbiHash

Methods

pretty :: AbiHash -> Doc #

Pretty Platform # 
Instance details

Defined in Distribution.System

Methods

pretty :: Platform -> Doc #

Pretty Arch # 
Instance details

Defined in Distribution.System

Methods

pretty :: Arch -> Doc #

Pretty OS # 
Instance details

Defined in Distribution.System

Methods

pretty :: OS -> Doc #

Pretty LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

pretty :: LicenseRef -> Doc #

Pretty LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

pretty :: LicenseId -> Doc #

Pretty LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

pretty :: LicenseExceptionId -> Doc #

Pretty SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

pretty :: SimpleLicenseExpression -> Doc #

Pretty LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

pretty :: LicenseExpression -> Doc #

Pretty License # 
Instance details

Defined in Distribution.SPDX.License

Methods

pretty :: License -> Doc #

Pretty ModuleName # 
Instance details

Defined in Distribution.ModuleName

Methods

pretty :: ModuleName -> Doc #

Pretty ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

pretty :: ModuleRenaming -> Doc #

Pretty IncludeRenaming # 
Instance details

Defined in Distribution.Types.IncludeRenaming

Methods

pretty :: IncludeRenaming -> Doc #

Pretty TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

pretty :: TestType -> Doc #

Pretty PkgconfigDependency # 
Instance details

Defined in Distribution.Types.PkgconfigDependency

Methods

pretty :: PkgconfigDependency -> Doc #

Pretty BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

pretty :: BenchmarkType -> Doc #

Pretty License # 
Instance details

Defined in Distribution.License

Methods

pretty :: License -> Doc #

Pretty KnownExtension # 
Instance details

Defined in Language.Haskell.Extension

Methods

pretty :: KnownExtension -> Doc #

Pretty Extension # 
Instance details

Defined in Language.Haskell.Extension

Methods

pretty :: Extension -> Doc #

Pretty Language # 
Instance details

Defined in Language.Haskell.Extension

Methods

pretty :: Language -> Doc #

Pretty CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

pretty :: CompilerFlavor -> Doc #

Pretty FilePathNT # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: FilePathNT -> Doc #

Pretty FreeText # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: FreeText -> Doc #

Pretty TestedWith # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: TestedWith -> Doc #

Pretty SpecLicense # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: SpecLicense -> Doc #

Pretty SpecVersion # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: SpecVersion -> Doc #

Pretty Token' # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: Token' -> Doc #

Pretty Token # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: Token -> Doc #

Pretty PackageName # 
Instance details

Defined in Distribution.Types.PackageName

Methods

pretty :: PackageName -> Doc #

Pretty UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

pretty :: UnqualComponentName -> Doc #

Pretty ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

pretty :: ComponentName -> Doc #

Pretty PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

pretty :: PackageIdentifier -> Doc #

Pretty DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

pretty :: DefUnitId -> Doc #

Pretty UnitId #

The textual format for UnitId coincides with the format + GHC accepts for -package-id.

Instance details

Defined in Distribution.Types.UnitId

Methods

pretty :: UnitId -> Doc #

Pretty Module # 
Instance details

Defined in Distribution.Types.Module

Methods

pretty :: Module -> Doc #

Pretty OpenModule # 
Instance details

Defined in Distribution.Backpack

Methods

pretty :: OpenModule -> Doc #

Pretty OpenUnitId # 
Instance details

Defined in Distribution.Backpack

Methods

pretty :: OpenUnitId -> Doc #

Pretty ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

pretty :: ModuleReexport -> Doc #

Pretty Mixin # 
Instance details

Defined in Distribution.Types.Mixin

Methods

pretty :: Mixin -> Doc #

Pretty ExeDependency # 
Instance details

Defined in Distribution.Types.ExeDependency

Methods

pretty :: ExeDependency -> Doc #

Pretty Dependency # 
Instance details

Defined in Distribution.Types.Dependency

Methods

pretty :: Dependency -> Doc #

Pretty MungedPackageName # 
Instance details

Defined in Distribution.Types.MungedPackageName

Methods

pretty :: MungedPackageName -> Doc #

Pretty AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

pretty :: AbiDependency -> Doc #

Pretty LegacyExeDependency # 
Instance details

Defined in Distribution.Types.LegacyExeDependency

Methods

pretty :: LegacyExeDependency -> Doc #

Pretty LibVersionInfo # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

pretty :: LibVersionInfo -> Doc #

Pretty FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

pretty :: FlagName -> Doc #

Pretty ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

pretty :: ExposedModule -> Doc #

Pretty TestShowDetails # 
Instance details

Defined in Distribution.Simple.Setup

Methods

pretty :: TestShowDetails -> Doc #

Pretty a => Pretty (Identity a) # 
Instance details

Defined in Distribution.Pretty

Methods

pretty :: Identity a -> Doc #

Pretty a => Pretty (MQuoted a) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: MQuoted a -> Doc #

(Newtype b a, Sep sep, Pretty b) => Pretty (List sep b a) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pretty :: List sep b a -> Doc #

prettyShow :: Pretty a => a -> String #

defaultStyle :: Style #

The default rendering style used in Cabal for console + output. It has a fixed page width and adds line breaks + automatically.

flatStyle :: Style #

A style for rendering all on one line.

Utilities

showFilePath :: FilePath -> Doc #

showToken :: String -> Doc #

showFreeText :: String -> Doc #

Pretty-print free-format text, ensuring that it is vertically aligned, + and with blank lines replaced by dots for correct re-parsing.

indentWith :: Int #

the indentation used for pretty printing

Deprecated

type Separator = [Doc] -> Doc #

diff --git a/doc/API/Cabal/Distribution-ReadE.html b/doc/API/Cabal/Distribution-ReadE.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-ReadE.html @@ -0,0 +1,1 @@ +Distribution.ReadE

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightJose Iborra 2008
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.ReadE

Contents

Description

Simple parsing with failure

Synopsis

ReadE

newtype ReadE a #

Parser with simple error reporting

Constructors

ReadE 

Fields

Instances
Functor ReadE # 
Instance details

Defined in Distribution.ReadE

Methods

fmap :: (a -> b) -> ReadE a -> ReadE b #

(<$) :: a -> ReadE b -> ReadE a #

succeedReadE :: (String -> a) -> ReadE a #

failReadE :: ErrorMsg -> ReadE a #

Projections

parseReadE :: ReadE a -> ReadP r a #

readEOrFail :: ReadE a -> String -> a #

readP_to_E :: (String -> ErrorMsg) -> ReadP a a -> ReadE a #

parsecToReadE :: (String -> ErrorMsg) -> ParsecParser a -> ReadE a #

diff --git a/doc/API/Cabal/Distribution-SPDX-License.html b/doc/API/Cabal/Distribution-SPDX-License.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-SPDX-License.html @@ -0,0 +1,13 @@ +Distribution.SPDX.License

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.SPDX.License

Synopsis

Documentation

data License #

Declared license. + See section 3.15 of SPDX Specification 2.1

Note: the NOASSERTION case is omitted.

Old License can be migrated using following rules:

  • AllRightsReserved and UnspecifiedLicense to NONE. + No license specified which legally defaults to All Rights Reserved. + The package may not be legally modified or redistributed by anyone but + the rightsholder.
  • OtherLicense can be converted to LicenseRef pointing to the file + in the package.
  • UnknownLicense i.e. other licenses of the form name-x.y, should be + covered by SPDX license list, otherwise use LicenseRef.
  • PublicDomain isn't covered. Consider using CC0. + See https://wiki.spdx.org/view/Legal_Team/Decisions/Dealing_with_Public_Domain_within_SPDX_Files + for more information.

Constructors

NONE

if the package contains no license information whatsoever; or

License LicenseExpression

A valid SPDX License Expression as defined in Appendix IV.

Instances
Eq License # 
Instance details

Defined in Distribution.SPDX.License

Methods

(==) :: License -> License -> Bool #

(/=) :: License -> License -> Bool #

Data License # 
Instance details

Defined in Distribution.SPDX.License

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> License -> c License #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c License #

toConstr :: License -> Constr #

dataTypeOf :: License -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c License) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c License) #

gmapT :: (forall b. Data b => b -> b) -> License -> License #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> License -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> License -> r #

gmapQ :: (forall d. Data d => d -> u) -> License -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> License -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> License -> m License #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> License -> m License #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> License -> m License #

Ord License # 
Instance details

Defined in Distribution.SPDX.License

Methods

compare :: License -> License -> Ordering #

(<) :: License -> License -> Bool #

(<=) :: License -> License -> Bool #

(>) :: License -> License -> Bool #

(>=) :: License -> License -> Bool #

max :: License -> License -> License #

min :: License -> License -> License #

Read License # 
Instance details

Defined in Distribution.SPDX.License

Methods

readsPrec :: Int -> ReadS License #

readList :: ReadS [License] #

readPrec :: ReadPrec License #

readListPrec :: ReadPrec [License] #

Show License # 
Instance details

Defined in Distribution.SPDX.License

Methods

showsPrec :: Int -> License -> ShowS #

show :: License -> String #

showList :: [License] -> ShowS #

Generic License # 
Instance details

Defined in Distribution.SPDX.License

Associated Types

type Rep License :: * -> * #

Methods

from :: License -> Rep License x #

to :: Rep License x -> License #

Binary License # 
Instance details

Defined in Distribution.SPDX.License

Methods

put :: License -> Put #

get :: Get License #

putList :: [License] -> Put #

NFData License # 
Instance details

Defined in Distribution.SPDX.License

Methods

rnf :: License -> () #

Pretty License # 
Instance details

Defined in Distribution.SPDX.License

Methods

pretty :: License -> Doc #

Parsec License #
>>> eitherParsec "BSD-3-Clause AND MIT" :: Either String License
+Right (License (EAnd (ELicense (ELicenseId BSD_3_Clause) Nothing) (ELicense (ELicenseId MIT) Nothing)))
+
>>> eitherParsec "NONE" :: Either String License
+Right NONE
+
Instance details

Defined in Distribution.SPDX.License

Methods

parsec :: CabalParsing m => m License #

Newtype SpecLicense (Either License License) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: Either License0 License -> SpecLicense #

unpack :: SpecLicense -> Either License0 License #

type Rep License # 
Instance details

Defined in Distribution.SPDX.License

type Rep License = D1 (MetaData "License" "Distribution.SPDX.License" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "NONE" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "License" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LicenseExpression)))
diff --git a/doc/API/Cabal/Distribution-SPDX-LicenseExceptionId.html b/doc/API/Cabal/Distribution-SPDX-LicenseExceptionId.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-SPDX-LicenseExceptionId.html @@ -0,0 +1,1 @@ +Distribution.SPDX.LicenseExceptionId

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.SPDX.LicenseExceptionId

Synopsis

Documentation

data LicenseExceptionId #

SPDX License identifier

Constructors

DS389_exception

389-exception, 389 Directory Server Exception

Autoconf_exception_2_0

Autoconf-exception-2.0, Autoconf exception 2.0

Autoconf_exception_3_0

Autoconf-exception-3.0, Autoconf exception 3.0

Bison_exception_2_2

Bison-exception-2.2, Bison exception 2.2

Bootloader_exception

Bootloader-exception, Bootloader Distribution Exception

Classpath_exception_2_0

Classpath-exception-2.0, Classpath exception 2.0

CLISP_exception_2_0

CLISP-exception-2.0, CLISP exception 2.0

DigiRule_FOSS_exception

DigiRule-FOSS-exception, DigiRule FOSS License Exception

ECos_exception_2_0

eCos-exception-2.0, eCos exception 2.0

Fawkes_Runtime_exception

Fawkes-Runtime-exception, Fawkes Runtime Exception

FLTK_exception

FLTK-exception, FLTK exception

Font_exception_2_0

Font-exception-2.0, Font exception 2.0

Freertos_exception_2_0

freertos-exception-2.0, FreeRTOS Exception 2.0

GCC_exception_2_0

GCC-exception-2.0, GCC Runtime Library exception 2.0

GCC_exception_3_1

GCC-exception-3.1, GCC Runtime Library exception 3.1

Gnu_javamail_exception

gnu-javamail-exception, GNU JavaMail exception

I2p_gpl_java_exception

i2p-gpl-java-exception, i2p GPL+Java Exception

Libtool_exception

Libtool-exception, Libtool Exception

Linux_syscall_note

Linux-syscall-note, Linux Syscall Note

LLVM_exception

LLVM-exception, LLVM Exception, SPDX License List 3.2

LZMA_exception

LZMA-exception, LZMA exception

Mif_exception

mif-exception, Macros and Inline Functions Exception

Nokia_Qt_exception_1_1

Nokia-Qt-exception-1.1, Nokia Qt LGPL exception 1.1

OCCT_exception_1_0

OCCT-exception-1.0, Open CASCADE Exception 1.0

OpenJDK_assembly_exception_1_0

OpenJDK-assembly-exception-1.0, OpenJDK Assembly exception 1.0, SPDX License List 3.2

Openvpn_openssl_exception

openvpn-openssl-exception, OpenVPN OpenSSL Exception

PS_or_PDF_font_exception_20170817

PS-or-PDF-font-exception-20170817, PS/PDF font exception (2017-08-17), SPDX License List 3.2

Qt_GPL_exception_1_0

Qt-GPL-exception-1.0, Qt GPL exception 1.0, SPDX License List 3.2

Qt_LGPL_exception_1_1

Qt-LGPL-exception-1.1, Qt LGPL exception 1.1, SPDX License List 3.2

Qwt_exception_1_0

Qwt-exception-1.0, Qwt exception 1.0

U_boot_exception_2_0

u-boot-exception-2.0, U-Boot exception 2.0

WxWindows_exception_3_1

WxWindows-exception-3.1, WxWindows Library Exception 3.1

Instances
Bounded LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

minBound :: LicenseExceptionId #

maxBound :: LicenseExceptionId #

Enum LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

succ :: LicenseExceptionId -> LicenseExceptionId #

pred :: LicenseExceptionId -> LicenseExceptionId #

toEnum :: Int -> LicenseExceptionId #

fromEnum :: LicenseExceptionId -> Int #

enumFrom :: LicenseExceptionId -> [LicenseExceptionId] #

enumFromThen :: LicenseExceptionId -> LicenseExceptionId -> [LicenseExceptionId] #

enumFromTo :: LicenseExceptionId -> LicenseExceptionId -> [LicenseExceptionId] #

enumFromThenTo :: LicenseExceptionId -> LicenseExceptionId -> LicenseExceptionId -> [LicenseExceptionId] #

Eq LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

(==) :: LicenseExceptionId -> LicenseExceptionId -> Bool #

(/=) :: LicenseExceptionId -> LicenseExceptionId -> Bool #

Data LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LicenseExceptionId -> c LicenseExceptionId #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LicenseExceptionId #

toConstr :: LicenseExceptionId -> Constr #

dataTypeOf :: LicenseExceptionId -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LicenseExceptionId) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LicenseExceptionId) #

gmapT :: (forall b. Data b => b -> b) -> LicenseExceptionId -> LicenseExceptionId #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LicenseExceptionId -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LicenseExceptionId -> r #

gmapQ :: (forall d. Data d => d -> u) -> LicenseExceptionId -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LicenseExceptionId -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LicenseExceptionId -> m LicenseExceptionId #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseExceptionId -> m LicenseExceptionId #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseExceptionId -> m LicenseExceptionId #

Ord LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

compare :: LicenseExceptionId -> LicenseExceptionId -> Ordering #

(<) :: LicenseExceptionId -> LicenseExceptionId -> Bool #

(<=) :: LicenseExceptionId -> LicenseExceptionId -> Bool #

(>) :: LicenseExceptionId -> LicenseExceptionId -> Bool #

(>=) :: LicenseExceptionId -> LicenseExceptionId -> Bool #

max :: LicenseExceptionId -> LicenseExceptionId -> LicenseExceptionId #

min :: LicenseExceptionId -> LicenseExceptionId -> LicenseExceptionId #

Read LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

readsPrec :: Int -> ReadS LicenseExceptionId #

readList :: ReadS [LicenseExceptionId] #

readPrec :: ReadPrec LicenseExceptionId #

readListPrec :: ReadPrec [LicenseExceptionId] #

Show LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

showsPrec :: Int -> LicenseExceptionId -> ShowS #

show :: LicenseExceptionId -> String #

showList :: [LicenseExceptionId] -> ShowS #

Generic LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Associated Types

type Rep LicenseExceptionId :: * -> * #

Methods

from :: LicenseExceptionId -> Rep LicenseExceptionId x #

to :: Rep LicenseExceptionId x -> LicenseExceptionId #

Binary LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

put :: LicenseExceptionId -> Put #

get :: Get LicenseExceptionId #

putList :: [LicenseExceptionId] -> Put #

NFData LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

rnf :: LicenseExceptionId -> () #

Pretty LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

pretty :: LicenseExceptionId -> Doc #

Parsec LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

parsec :: CabalParsing m => m LicenseExceptionId #

type Rep LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

type Rep LicenseExceptionId = D1 (MetaData "LicenseExceptionId" "Distribution.SPDX.LicenseExceptionId" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (((((C1 (MetaCons "DS389_exception" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Autoconf_exception_2_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Autoconf_exception_3_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Bison_exception_2_2" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "Bootloader_exception" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Classpath_exception_2_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CLISP_exception_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DigiRule_FOSS_exception" PrefixI False) (U1 :: * -> *)))) :+: (((C1 (MetaCons "ECos_exception_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Fawkes_Runtime_exception" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "FLTK_exception" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Font_exception_2_0" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "Freertos_exception_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "GCC_exception_2_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "GCC_exception_3_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Gnu_javamail_exception" PrefixI False) (U1 :: * -> *))))) :+: ((((C1 (MetaCons "I2p_gpl_java_exception" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Libtool_exception" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Linux_syscall_note" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LLVM_exception" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "LZMA_exception" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Mif_exception" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Nokia_Qt_exception_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OCCT_exception_1_0" PrefixI False) (U1 :: * -> *)))) :+: (((C1 (MetaCons "OpenJDK_assembly_exception_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Openvpn_openssl_exception" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "PS_or_PDF_font_exception_20170817" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Qt_GPL_exception_1_0" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "Qt_LGPL_exception_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Qwt_exception_1_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "U_boot_exception_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "WxWindows_exception_3_1" PrefixI False) (U1 :: * -> *))))))

licenseExceptionId :: LicenseExceptionId -> String #

License SPDX identifier, e.g. "BSD-3-Clause".

licenseExceptionName :: LicenseExceptionId -> String #

License name, e.g. "GNU General Public License v2.0 only"

mkLicenseExceptionId :: LicenseListVersion -> String -> Maybe LicenseExceptionId #

Create a LicenseExceptionId from a String.

licenseExceptionIdList :: LicenseListVersion -> [LicenseExceptionId] #

diff --git a/doc/API/Cabal/Distribution-SPDX-LicenseExpression.html b/doc/API/Cabal/Distribution-SPDX-LicenseExpression.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-SPDX-LicenseExpression.html @@ -0,0 +1,15 @@ +Distribution.SPDX.LicenseExpression

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.SPDX.LicenseExpression

Synopsis

Documentation

data LicenseExpression #

SPDX License Expression.

idstring              = 1*(ALPHA / DIGIT / "-" / "." )
+license id            = <short form license identifier inAppendix I.1>
+license exception id  = <short form license exception identifier inAppendix I.2>
+license ref           = ["DocumentRef-"1*(idstring)":"]"LicenseRef-"1*(idstring)
+
+simple expression     = license id / license id"+" / license ref
+
+compound expression   = 1*1(simple expression /
+                        simple expression "WITH" license exception id /
+                        compound expression "AND" compound expression /
+                        compound expression "OR" compound expression ) /
+                        "(" compound expression ")" )
+
+license expression    = 1*1(simple expression / compound expression)
+

Constructors

ELicense !SimpleLicenseExpression !(Maybe LicenseExceptionId) 
EAnd !LicenseExpression !LicenseExpression 
EOr !LicenseExpression !LicenseExpression 
Instances
Eq LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

(==) :: LicenseExpression -> LicenseExpression -> Bool #

(/=) :: LicenseExpression -> LicenseExpression -> Bool #

Data LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LicenseExpression -> c LicenseExpression #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LicenseExpression #

toConstr :: LicenseExpression -> Constr #

dataTypeOf :: LicenseExpression -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LicenseExpression) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LicenseExpression) #

gmapT :: (forall b. Data b => b -> b) -> LicenseExpression -> LicenseExpression #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LicenseExpression -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LicenseExpression -> r #

gmapQ :: (forall d. Data d => d -> u) -> LicenseExpression -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LicenseExpression -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LicenseExpression -> m LicenseExpression #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseExpression -> m LicenseExpression #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseExpression -> m LicenseExpression #

Ord LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

compare :: LicenseExpression -> LicenseExpression -> Ordering #

(<) :: LicenseExpression -> LicenseExpression -> Bool #

(<=) :: LicenseExpression -> LicenseExpression -> Bool #

(>) :: LicenseExpression -> LicenseExpression -> Bool #

(>=) :: LicenseExpression -> LicenseExpression -> Bool #

max :: LicenseExpression -> LicenseExpression -> LicenseExpression #

min :: LicenseExpression -> LicenseExpression -> LicenseExpression #

Read LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

readsPrec :: Int -> ReadS LicenseExpression #

readList :: ReadS [LicenseExpression] #

readPrec :: ReadPrec LicenseExpression #

readListPrec :: ReadPrec [LicenseExpression] #

Show LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

showsPrec :: Int -> LicenseExpression -> ShowS #

show :: LicenseExpression -> String #

showList :: [LicenseExpression] -> ShowS #

Generic LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Associated Types

type Rep LicenseExpression :: * -> * #

Methods

from :: LicenseExpression -> Rep LicenseExpression x #

to :: Rep LicenseExpression x -> LicenseExpression #

Binary LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

put :: LicenseExpression -> Put #

get :: Get LicenseExpression #

putList :: [LicenseExpression] -> Put #

NFData LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

rnf :: LicenseExpression -> () #

Pretty LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

pretty :: LicenseExpression -> Doc #

Parsec LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

parsec :: CabalParsing m => m LicenseExpression #

type Rep LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

type Rep LicenseExpression = D1 (MetaData "LicenseExpression" "Distribution.SPDX.LicenseExpression" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ELicense" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SimpleLicenseExpression) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LicenseExceptionId))) :+: (C1 (MetaCons "EAnd" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LicenseExpression) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LicenseExpression)) :+: C1 (MetaCons "EOr" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LicenseExpression) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LicenseExpression))))

data SimpleLicenseExpression #

Simple License Expressions.

Constructors

ELicenseId LicenseId

An SPDX License List Short Form Identifier. For example: GPL-2.0-only

ELicenseIdPlus LicenseId

An SPDX License List Short Form Identifier with a unary"+" operator suffix to represent the current version of the license or any later version. For example: GPL-2.0+

ELicenseRef LicenseRef

A SPDX user defined license reference: For example: LicenseRef-23, LicenseRef-MIT-Style-1, or DocumentRef-spdx-tool-1.2:LicenseRef-MIT-Style-2

Instances
Eq SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

(==) :: SimpleLicenseExpression -> SimpleLicenseExpression -> Bool #

(/=) :: SimpleLicenseExpression -> SimpleLicenseExpression -> Bool #

Data SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SimpleLicenseExpression -> c SimpleLicenseExpression #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SimpleLicenseExpression #

toConstr :: SimpleLicenseExpression -> Constr #

dataTypeOf :: SimpleLicenseExpression -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SimpleLicenseExpression) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SimpleLicenseExpression) #

gmapT :: (forall b. Data b => b -> b) -> SimpleLicenseExpression -> SimpleLicenseExpression #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SimpleLicenseExpression -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SimpleLicenseExpression -> r #

gmapQ :: (forall d. Data d => d -> u) -> SimpleLicenseExpression -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SimpleLicenseExpression -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SimpleLicenseExpression -> m SimpleLicenseExpression #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SimpleLicenseExpression -> m SimpleLicenseExpression #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SimpleLicenseExpression -> m SimpleLicenseExpression #

Ord SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

compare :: SimpleLicenseExpression -> SimpleLicenseExpression -> Ordering #

(<) :: SimpleLicenseExpression -> SimpleLicenseExpression -> Bool #

(<=) :: SimpleLicenseExpression -> SimpleLicenseExpression -> Bool #

(>) :: SimpleLicenseExpression -> SimpleLicenseExpression -> Bool #

(>=) :: SimpleLicenseExpression -> SimpleLicenseExpression -> Bool #

max :: SimpleLicenseExpression -> SimpleLicenseExpression -> SimpleLicenseExpression #

min :: SimpleLicenseExpression -> SimpleLicenseExpression -> SimpleLicenseExpression #

Read SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

readsPrec :: Int -> ReadS SimpleLicenseExpression #

readList :: ReadS [SimpleLicenseExpression] #

readPrec :: ReadPrec SimpleLicenseExpression #

readListPrec :: ReadPrec [SimpleLicenseExpression] #

Show SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

showsPrec :: Int -> SimpleLicenseExpression -> ShowS #

show :: SimpleLicenseExpression -> String #

showList :: [SimpleLicenseExpression] -> ShowS #

Generic SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Associated Types

type Rep SimpleLicenseExpression :: * -> * #

Methods

from :: SimpleLicenseExpression -> Rep SimpleLicenseExpression x #

to :: Rep SimpleLicenseExpression x -> SimpleLicenseExpression #

Binary SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

put :: SimpleLicenseExpression -> Put #

get :: Get SimpleLicenseExpression #

putList :: [SimpleLicenseExpression] -> Put #

NFData SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

rnf :: SimpleLicenseExpression -> () #

Pretty SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

pretty :: SimpleLicenseExpression -> Doc #

Parsec SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

parsec :: CabalParsing m => m SimpleLicenseExpression #

type Rep SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

type Rep SimpleLicenseExpression = D1 (MetaData "SimpleLicenseExpression" "Distribution.SPDX.LicenseExpression" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ELicenseId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LicenseId)) :+: (C1 (MetaCons "ELicenseIdPlus" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LicenseId)) :+: C1 (MetaCons "ELicenseRef" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LicenseRef))))

simpleLicenseExpression :: LicenseId -> LicenseExpression #

diff --git a/doc/API/Cabal/Distribution-SPDX-LicenseId.html b/doc/API/Cabal/Distribution-SPDX-LicenseId.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-SPDX-LicenseId.html @@ -0,0 +1,18 @@ +Distribution.SPDX.LicenseId

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.SPDX.LicenseId

Contents

Synopsis

Documentation

data LicenseId #

SPDX License identifier

Constructors

NullBSD

0BSD, BSD Zero Clause License

AAL

AAL, Attribution Assurance License

Abstyles

Abstyles, Abstyles License

Adobe_2006

Adobe-2006, Adobe Systems Incorporated Source Code License Agreement

Adobe_Glyph

Adobe-Glyph, Adobe Glyph List License

ADSL

ADSL, Amazon Digital Services License

AFL_1_1

AFL-1.1, Academic Free License v1.1

AFL_1_2

AFL-1.2, Academic Free License v1.2

AFL_2_0

AFL-2.0, Academic Free License v2.0

AFL_2_1

AFL-2.1, Academic Free License v2.1

AFL_3_0

AFL-3.0, Academic Free License v3.0

Afmparse

Afmparse, Afmparse License

AGPL_1_0

AGPL-1.0, Affero General Public License v1.0, SPDX License List 3.0

AGPL_1_0_only

AGPL-1.0-only, Affero General Public License v1.0 only, SPDX License List 3.2

AGPL_1_0_or_later

AGPL-1.0-or-later, Affero General Public License v1.0 or later, SPDX License List 3.2

AGPL_3_0_only

AGPL-3.0-only, GNU Affero General Public License v3.0 only

AGPL_3_0_or_later

AGPL-3.0-or-later, GNU Affero General Public License v3.0 or later

Aladdin

Aladdin, Aladdin Free Public License

AMDPLPA

AMDPLPA, AMD's plpa_map.c License

AML

AML, Apple MIT License

AMPAS

AMPAS, Academy of Motion Picture Arts and Sciences BSD

ANTLR_PD

ANTLR-PD, ANTLR Software Rights Notice

Apache_1_0

Apache-1.0, Apache License 1.0

Apache_1_1

Apache-1.1, Apache License 1.1

Apache_2_0

Apache-2.0, Apache License 2.0

APAFML

APAFML, Adobe Postscript AFM License

APL_1_0

APL-1.0, Adaptive Public License 1.0

APSL_1_0

APSL-1.0, Apple Public Source License 1.0

APSL_1_1

APSL-1.1, Apple Public Source License 1.1

APSL_1_2

APSL-1.2, Apple Public Source License 1.2

APSL_2_0

APSL-2.0, Apple Public Source License 2.0

Artistic_1_0_cl8

Artistic-1.0-cl8, Artistic License 1.0 w/clause 8

Artistic_1_0_Perl

Artistic-1.0-Perl, Artistic License 1.0 (Perl)

Artistic_1_0

Artistic-1.0, Artistic License 1.0

Artistic_2_0

Artistic-2.0, Artistic License 2.0

Bahyph

Bahyph, Bahyph License

Barr

Barr, Barr License

Beerware

Beerware, Beerware License

BitTorrent_1_0

BitTorrent-1.0, BitTorrent Open Source License v1.0

BitTorrent_1_1

BitTorrent-1.1, BitTorrent Open Source License v1.1

Borceux

Borceux, Borceux license

BSD_1_Clause

BSD-1-Clause, BSD 1-Clause License

BSD_2_Clause_FreeBSD

BSD-2-Clause-FreeBSD, BSD 2-Clause FreeBSD License

BSD_2_Clause_NetBSD

BSD-2-Clause-NetBSD, BSD 2-Clause NetBSD License

BSD_2_Clause_Patent

BSD-2-Clause-Patent, BSD-2-Clause Plus Patent License

BSD_2_Clause

BSD-2-Clause, BSD 2-Clause Simplified License

BSD_3_Clause_Attribution

BSD-3-Clause-Attribution, BSD with attribution

BSD_3_Clause_Clear

BSD-3-Clause-Clear, BSD 3-Clause Clear License

BSD_3_Clause_LBNL

BSD-3-Clause-LBNL, Lawrence Berkeley National Labs BSD variant license

BSD_3_Clause_No_Nuclear_License_2014

BSD-3-Clause-No-Nuclear-License-2014, BSD 3-Clause No Nuclear License 2014

BSD_3_Clause_No_Nuclear_License

BSD-3-Clause-No-Nuclear-License, BSD 3-Clause No Nuclear License

BSD_3_Clause_No_Nuclear_Warranty

BSD-3-Clause-No-Nuclear-Warranty, BSD 3-Clause No Nuclear Warranty

BSD_3_Clause

BSD-3-Clause, BSD 3-Clause New or Revised License

BSD_4_Clause_UC

BSD-4-Clause-UC, BSD-4-Clause (University of California-Specific)

BSD_4_Clause

BSD-4-Clause, BSD 4-Clause Original or Old License

BSD_Protection

BSD-Protection, BSD Protection License

BSD_Source_Code

BSD-Source-Code, BSD Source Code Attribution

BSL_1_0

BSL-1.0, Boost Software License 1.0

Bzip2_1_0_5

bzip2-1.0.5, bzip2 and libbzip2 License v1.0.5

Bzip2_1_0_6

bzip2-1.0.6, bzip2 and libbzip2 License v1.0.6

Caldera

Caldera, Caldera License

CATOSL_1_1

CATOSL-1.1, Computer Associates Trusted Open Source License 1.1

CC_BY_1_0

CC-BY-1.0, Creative Commons Attribution 1.0 Generic

CC_BY_2_0

CC-BY-2.0, Creative Commons Attribution 2.0 Generic

CC_BY_2_5

CC-BY-2.5, Creative Commons Attribution 2.5 Generic

CC_BY_3_0

CC-BY-3.0, Creative Commons Attribution 3.0 Unported

CC_BY_4_0

CC-BY-4.0, Creative Commons Attribution 4.0 International

CC_BY_NC_1_0

CC-BY-NC-1.0, Creative Commons Attribution Non Commercial 1.0 Generic

CC_BY_NC_2_0

CC-BY-NC-2.0, Creative Commons Attribution Non Commercial 2.0 Generic

CC_BY_NC_2_5

CC-BY-NC-2.5, Creative Commons Attribution Non Commercial 2.5 Generic

CC_BY_NC_3_0

CC-BY-NC-3.0, Creative Commons Attribution Non Commercial 3.0 Unported

CC_BY_NC_4_0

CC-BY-NC-4.0, Creative Commons Attribution Non Commercial 4.0 International

CC_BY_NC_ND_1_0

CC-BY-NC-ND-1.0, Creative Commons Attribution Non Commercial No Derivatives 1.0 Generic

CC_BY_NC_ND_2_0

CC-BY-NC-ND-2.0, Creative Commons Attribution Non Commercial No Derivatives 2.0 Generic

CC_BY_NC_ND_2_5

CC-BY-NC-ND-2.5, Creative Commons Attribution Non Commercial No Derivatives 2.5 Generic

CC_BY_NC_ND_3_0

CC-BY-NC-ND-3.0, Creative Commons Attribution Non Commercial No Derivatives 3.0 Unported

CC_BY_NC_ND_4_0

CC-BY-NC-ND-4.0, Creative Commons Attribution Non Commercial No Derivatives 4.0 International

CC_BY_NC_SA_1_0

CC-BY-NC-SA-1.0, Creative Commons Attribution Non Commercial Share Alike 1.0 Generic

CC_BY_NC_SA_2_0

CC-BY-NC-SA-2.0, Creative Commons Attribution Non Commercial Share Alike 2.0 Generic

CC_BY_NC_SA_2_5

CC-BY-NC-SA-2.5, Creative Commons Attribution Non Commercial Share Alike 2.5 Generic

CC_BY_NC_SA_3_0

CC-BY-NC-SA-3.0, Creative Commons Attribution Non Commercial Share Alike 3.0 Unported

CC_BY_NC_SA_4_0

CC-BY-NC-SA-4.0, Creative Commons Attribution Non Commercial Share Alike 4.0 International

CC_BY_ND_1_0

CC-BY-ND-1.0, Creative Commons Attribution No Derivatives 1.0 Generic

CC_BY_ND_2_0

CC-BY-ND-2.0, Creative Commons Attribution No Derivatives 2.0 Generic

CC_BY_ND_2_5

CC-BY-ND-2.5, Creative Commons Attribution No Derivatives 2.5 Generic

CC_BY_ND_3_0

CC-BY-ND-3.0, Creative Commons Attribution No Derivatives 3.0 Unported

CC_BY_ND_4_0

CC-BY-ND-4.0, Creative Commons Attribution No Derivatives 4.0 International

CC_BY_SA_1_0

CC-BY-SA-1.0, Creative Commons Attribution Share Alike 1.0 Generic

CC_BY_SA_2_0

CC-BY-SA-2.0, Creative Commons Attribution Share Alike 2.0 Generic

CC_BY_SA_2_5

CC-BY-SA-2.5, Creative Commons Attribution Share Alike 2.5 Generic

CC_BY_SA_3_0

CC-BY-SA-3.0, Creative Commons Attribution Share Alike 3.0 Unported

CC_BY_SA_4_0

CC-BY-SA-4.0, Creative Commons Attribution Share Alike 4.0 International

CC0_1_0

CC0-1.0, Creative Commons Zero v1.0 Universal

CDDL_1_0

CDDL-1.0, Common Development and Distribution License 1.0

CDDL_1_1

CDDL-1.1, Common Development and Distribution License 1.1

CDLA_Permissive_1_0

CDLA-Permissive-1.0, Community Data License Agreement Permissive 1.0

CDLA_Sharing_1_0

CDLA-Sharing-1.0, Community Data License Agreement Sharing 1.0

CECILL_1_0

CECILL-1.0, CeCILL Free Software License Agreement v1.0

CECILL_1_1

CECILL-1.1, CeCILL Free Software License Agreement v1.1

CECILL_2_0

CECILL-2.0, CeCILL Free Software License Agreement v2.0

CECILL_2_1

CECILL-2.1, CeCILL Free Software License Agreement v2.1

CECILL_B

CECILL-B, CeCILL-B Free Software License Agreement

CECILL_C

CECILL-C, CeCILL-C Free Software License Agreement

ClArtistic

ClArtistic, Clarified Artistic License

CNRI_Jython

CNRI-Jython, CNRI Jython License

CNRI_Python_GPL_Compatible

CNRI-Python-GPL-Compatible, CNRI Python Open Source GPL Compatible License Agreement

CNRI_Python

CNRI-Python, CNRI Python License

Condor_1_1

Condor-1.1, Condor Public License v1.1

CPAL_1_0

CPAL-1.0, Common Public Attribution License 1.0

CPL_1_0

CPL-1.0, Common Public License 1.0

CPOL_1_02

CPOL-1.02, Code Project Open License 1.02

Crossword

Crossword, Crossword License

CrystalStacker

CrystalStacker, CrystalStacker License

CUA_OPL_1_0

CUA-OPL-1.0, CUA Office Public License v1.0

Cube

Cube, Cube License

Curl

curl, curl License

D_FSL_1_0

D-FSL-1.0, Deutsche Freie Software Lizenz

Diffmark

diffmark, diffmark license

DOC

DOC, DOC License

Dotseqn

Dotseqn, Dotseqn License

DSDP

DSDP, DSDP License

Dvipdfm

dvipdfm, dvipdfm License

ECL_1_0

ECL-1.0, Educational Community License v1.0

ECL_2_0

ECL-2.0, Educational Community License v2.0

EFL_1_0

EFL-1.0, Eiffel Forum License v1.0

EFL_2_0

EFL-2.0, Eiffel Forum License v2.0

EGenix

eGenix, eGenix.com Public License 1.1.0

Entessa

Entessa, Entessa Public License v1.0

EPL_1_0

EPL-1.0, Eclipse Public License 1.0

EPL_2_0

EPL-2.0, Eclipse Public License 2.0

ErlPL_1_1

ErlPL-1.1, Erlang Public License v1.1

EUDatagrid

EUDatagrid, EU DataGrid Software License

EUPL_1_0

EUPL-1.0, European Union Public License 1.0

EUPL_1_1

EUPL-1.1, European Union Public License 1.1

EUPL_1_2

EUPL-1.2, European Union Public License 1.2

Eurosym

Eurosym, Eurosym License

Fair

Fair, Fair License

Frameworx_1_0

Frameworx-1.0, Frameworx Open License 1.0

FreeImage

FreeImage, FreeImage Public License v1.0

FSFAP

FSFAP, FSF All Permissive License

FSFUL

FSFUL, FSF Unlimited License

FSFULLR

FSFULLR, FSF Unlimited License (with License Retention)

FTL

FTL, Freetype Project License

GFDL_1_1_only

GFDL-1.1-only, GNU Free Documentation License v1.1 only

GFDL_1_1_or_later

GFDL-1.1-or-later, GNU Free Documentation License v1.1 or later

GFDL_1_2_only

GFDL-1.2-only, GNU Free Documentation License v1.2 only

GFDL_1_2_or_later

GFDL-1.2-or-later, GNU Free Documentation License v1.2 or later

GFDL_1_3_only

GFDL-1.3-only, GNU Free Documentation License v1.3 only

GFDL_1_3_or_later

GFDL-1.3-or-later, GNU Free Documentation License v1.3 or later

Giftware

Giftware, Giftware License

GL2PS

GL2PS, GL2PS License

Glide

Glide, 3dfx Glide License

Glulxe

Glulxe, Glulxe License

Gnuplot

gnuplot, gnuplot License

GPL_1_0_only

GPL-1.0-only, GNU General Public License v1.0 only

GPL_1_0_or_later

GPL-1.0-or-later, GNU General Public License v1.0 or later

GPL_2_0_only

GPL-2.0-only, GNU General Public License v2.0 only

GPL_2_0_or_later

GPL-2.0-or-later, GNU General Public License v2.0 or later

GPL_3_0_only

GPL-3.0-only, GNU General Public License v3.0 only

GPL_3_0_or_later

GPL-3.0-or-later, GNU General Public License v3.0 or later

GSOAP_1_3b

gSOAP-1.3b, gSOAP Public License v1.3b

HaskellReport

HaskellReport, Haskell Language Report License

HPND

HPND, Historical Permission Notice and Disclaimer

IBM_pibs

IBM-pibs, IBM PowerPC Initialization and Boot Software

ICU

ICU, ICU License

IJG

IJG, Independent JPEG Group License

ImageMagick

ImageMagick, ImageMagick License

IMatix

iMatix, iMatix Standard Function Library Agreement

Imlib2

Imlib2, Imlib2 License

Info_ZIP

Info-ZIP, Info-ZIP License

Intel_ACPI

Intel-ACPI, Intel ACPI Software License Agreement

Intel

Intel, Intel Open Source License

Interbase_1_0

Interbase-1.0, Interbase Public License v1.0

IPA

IPA, IPA Font License

IPL_1_0

IPL-1.0, IBM Public License v1.0

ISC

ISC, ISC License

JasPer_2_0

JasPer-2.0, JasPer License

JSON

JSON, JSON License

LAL_1_2

LAL-1.2, Licence Art Libre 1.2

LAL_1_3

LAL-1.3, Licence Art Libre 1.3

Latex2e

Latex2e, Latex2e License

Leptonica

Leptonica, Leptonica License

LGPL_2_0_only

LGPL-2.0-only, GNU Library General Public License v2 only

LGPL_2_0_or_later

LGPL-2.0-or-later, GNU Library General Public License v2 or later

LGPL_2_1_only

LGPL-2.1-only, GNU Lesser General Public License v2.1 only

LGPL_2_1_or_later

LGPL-2.1-or-later, GNU Lesser General Public License v2.1 or later

LGPL_3_0_only

LGPL-3.0-only, GNU Lesser General Public License v3.0 only

LGPL_3_0_or_later

LGPL-3.0-or-later, GNU Lesser General Public License v3.0 or later

LGPLLR

LGPLLR, Lesser General Public License For Linguistic Resources

Libpng

Libpng, libpng License

Libtiff

libtiff, libtiff License

LiLiQ_P_1_1

LiLiQ-P-1.1, Licence Libre du Québec – Permissive version 1.1

LiLiQ_R_1_1

LiLiQ-R-1.1, Licence Libre du Québec – Réciprocité version 1.1

LiLiQ_Rplus_1_1

LiLiQ-Rplus-1.1, Licence Libre du Québec – Réciprocité forte version 1.1

Linux_OpenIB

Linux-OpenIB, Linux Kernel Variant of OpenIB.org license, SPDX License List 3.2

LPL_1_0

LPL-1.0, Lucent Public License Version 1.0

LPL_1_02

LPL-1.02, Lucent Public License v1.02

LPPL_1_0

LPPL-1.0, LaTeX Project Public License v1.0

LPPL_1_1

LPPL-1.1, LaTeX Project Public License v1.1

LPPL_1_2

LPPL-1.2, LaTeX Project Public License v1.2

LPPL_1_3a

LPPL-1.3a, LaTeX Project Public License v1.3a

LPPL_1_3c

LPPL-1.3c, LaTeX Project Public License v1.3c

MakeIndex

MakeIndex, MakeIndex License

MirOS

MirOS, MirOS License

MIT_0

MIT-0, MIT No Attribution, SPDX License List 3.2

MIT_advertising

MIT-advertising, Enlightenment License (e16)

MIT_CMU

MIT-CMU, CMU License

MIT_enna

MIT-enna, enna License

MIT_feh

MIT-feh, feh License

MIT

MIT, MIT License

MITNFA

MITNFA, MIT +no-false-attribs license

Motosoto

Motosoto, Motosoto License

Mpich2

mpich2, mpich2 License

MPL_1_0

MPL-1.0, Mozilla Public License 1.0

MPL_1_1

MPL-1.1, Mozilla Public License 1.1

MPL_2_0_no_copyleft_exception

MPL-2.0-no-copyleft-exception, Mozilla Public License 2.0 (no copyleft exception)

MPL_2_0

MPL-2.0, Mozilla Public License 2.0

MS_PL

MS-PL, Microsoft Public License

MS_RL

MS-RL, Microsoft Reciprocal License

MTLL

MTLL, Matrix Template Library License

Multics

Multics, Multics License

Mup

Mup, Mup License

NASA_1_3

NASA-1.3, NASA Open Source Agreement 1.3

Naumen

Naumen, Naumen Public License

NBPL_1_0

NBPL-1.0, Net Boolean Public License v1

NCSA

NCSA, University of Illinois/NCSA Open Source License

Net_SNMP

Net-SNMP, Net-SNMP License

NetCDF

NetCDF, NetCDF license

Newsletr

Newsletr, Newsletr License

NGPL

NGPL, Nethack General Public License

NLOD_1_0

NLOD-1.0, Norwegian Licence for Open Government Data

NLPL

NLPL, No Limit Public License

Nokia

Nokia, Nokia Open Source License

NOSL

NOSL, Netizen Open Source License

Noweb

Noweb, Noweb License

NPL_1_0

NPL-1.0, Netscape Public License v1.0

NPL_1_1

NPL-1.1, Netscape Public License v1.1

NPOSL_3_0

NPOSL-3.0, Non-Profit Open Software License 3.0

NRL

NRL, NRL License

NTP

NTP, NTP License

OCCT_PL

OCCT-PL, Open CASCADE Technology Public License

OCLC_2_0

OCLC-2.0, OCLC Research Public License 2.0

ODbL_1_0

ODbL-1.0, ODC Open Database License v1.0

ODC_By_1_0

ODC-By-1.0, Open Data Commons Attribution License v1.0, SPDX License List 3.2

OFL_1_0

OFL-1.0, SIL Open Font License 1.0

OFL_1_1

OFL-1.1, SIL Open Font License 1.1

OGTSL

OGTSL, Open Group Test Suite License

OLDAP_1_1

OLDAP-1.1, Open LDAP Public License v1.1

OLDAP_1_2

OLDAP-1.2, Open LDAP Public License v1.2

OLDAP_1_3

OLDAP-1.3, Open LDAP Public License v1.3

OLDAP_1_4

OLDAP-1.4, Open LDAP Public License v1.4

OLDAP_2_0_1

OLDAP-2.0.1, Open LDAP Public License v2.0.1

OLDAP_2_0

OLDAP-2.0, Open LDAP Public License v2.0 (or possibly 2.0A and 2.0B)

OLDAP_2_1

OLDAP-2.1, Open LDAP Public License v2.1

OLDAP_2_2_1

OLDAP-2.2.1, Open LDAP Public License v2.2.1

OLDAP_2_2_2

OLDAP-2.2.2, Open LDAP Public License 2.2.2

OLDAP_2_2

OLDAP-2.2, Open LDAP Public License v2.2

OLDAP_2_3

OLDAP-2.3, Open LDAP Public License v2.3

OLDAP_2_4

OLDAP-2.4, Open LDAP Public License v2.4

OLDAP_2_5

OLDAP-2.5, Open LDAP Public License v2.5

OLDAP_2_6

OLDAP-2.6, Open LDAP Public License v2.6

OLDAP_2_7

OLDAP-2.7, Open LDAP Public License v2.7

OLDAP_2_8

OLDAP-2.8, Open LDAP Public License v2.8

OML

OML, Open Market License

OpenSSL

OpenSSL, OpenSSL License

OPL_1_0

OPL-1.0, Open Public License v1.0

OSET_PL_2_1

OSET-PL-2.1, OSET Public License version 2.1

OSL_1_0

OSL-1.0, Open Software License 1.0

OSL_1_1

OSL-1.1, Open Software License 1.1

OSL_2_0

OSL-2.0, Open Software License 2.0

OSL_2_1

OSL-2.1, Open Software License 2.1

OSL_3_0

OSL-3.0, Open Software License 3.0

PDDL_1_0

PDDL-1.0, ODC Public Domain Dedication & License 1.0

PHP_3_0

PHP-3.0, PHP License v3.0

PHP_3_01

PHP-3.01, PHP License v3.01

Plexus

Plexus, Plexus Classworlds License

PostgreSQL

PostgreSQL, PostgreSQL License

Psfrag

psfrag, psfrag License

Psutils

psutils, psutils License

Python_2_0

Python-2.0, Python License 2.0

Qhull

Qhull, Qhull License

QPL_1_0

QPL-1.0, Q Public License 1.0

Rdisc

Rdisc, Rdisc License

RHeCos_1_1

RHeCos-1.1, Red Hat eCos Public License v1.1

RPL_1_1

RPL-1.1, Reciprocal Public License 1.1

RPL_1_5

RPL-1.5, Reciprocal Public License 1.5

RPSL_1_0

RPSL-1.0, RealNetworks Public Source License v1.0

RSA_MD

RSA-MD, RSA Message-Digest License

RSCPL

RSCPL, Ricoh Source Code Public License

Ruby

Ruby, Ruby License

SAX_PD

SAX-PD, Sax Public Domain Notice

Saxpath

Saxpath, Saxpath License

SCEA

SCEA, SCEA Shared Source License

Sendmail

Sendmail, Sendmail License

SGI_B_1_0

SGI-B-1.0, SGI Free Software License B v1.0

SGI_B_1_1

SGI-B-1.1, SGI Free Software License B v1.1

SGI_B_2_0

SGI-B-2.0, SGI Free Software License B v2.0

SimPL_2_0

SimPL-2.0, Simple Public License 2.0

SISSL_1_2

SISSL-1.2, Sun Industry Standards Source License v1.2

SISSL

SISSL, Sun Industry Standards Source License v1.1

Sleepycat

Sleepycat, Sleepycat License

SMLNJ

SMLNJ, Standard ML of New Jersey License

SMPPL

SMPPL, Secure Messaging Protocol Public License

SNIA

SNIA, SNIA Public License 1.1

Spencer_86

Spencer-86, Spencer License 86

Spencer_94

Spencer-94, Spencer License 94

Spencer_99

Spencer-99, Spencer License 99

SPL_1_0

SPL-1.0, Sun Public License v1.0

SugarCRM_1_1_3

SugarCRM-1.1.3, SugarCRM Public License v1.1.3

SWL

SWL, Scheme Widget Library (SWL) Software License Agreement

TCL

TCL, TCL/TK License

TCP_wrappers

TCP-wrappers, TCP Wrappers License

TMate

TMate, TMate Open Source License

TORQUE_1_1

TORQUE-1.1, TORQUE v2.5+ Software License v1.1

TOSL

TOSL, Trusster Open Source License

TU_Berlin_1_0

TU-Berlin-1.0, Technische Universitaet Berlin License 1.0, SPDX License List 3.2

TU_Berlin_2_0

TU-Berlin-2.0, Technische Universitaet Berlin License 2.0, SPDX License List 3.2

Unicode_DFS_2015

Unicode-DFS-2015, Unicode License Agreement - Data Files and Software (2015)

Unicode_DFS_2016

Unicode-DFS-2016, Unicode License Agreement - Data Files and Software (2016)

Unicode_TOU

Unicode-TOU, Unicode Terms of Use

Unlicense

Unlicense, The Unlicense

UPL_1_0

UPL-1.0, Universal Permissive License v1.0

Vim

Vim, Vim License

VOSTROM

VOSTROM, VOSTROM Public License for Open Source

VSL_1_0

VSL-1.0, Vovida Software License v1.0

W3C_19980720

W3C-19980720, W3C Software Notice and License (1998-07-20)

W3C_20150513

W3C-20150513, W3C Software Notice and Document License (2015-05-13)

W3C

W3C, W3C Software Notice and License (2002-12-31)

Watcom_1_0

Watcom-1.0, Sybase Open Watcom Public License 1.0

Wsuipa

Wsuipa, Wsuipa License

WTFPL

WTFPL, Do What The F*ck You Want To Public License

X11

X11, X11 License

Xerox

Xerox, Xerox License

XFree86_1_1

XFree86-1.1, XFree86 License 1.1

Xinetd

xinetd, xinetd License

Xnet

Xnet, X.Net License

Xpp

xpp, XPP License

XSkat

XSkat, XSkat License

YPL_1_0

YPL-1.0, Yahoo! Public License v1.0

YPL_1_1

YPL-1.1, Yahoo! Public License v1.1

Zed

Zed, Zed License

Zend_2_0

Zend-2.0, Zend License v2.0

Zimbra_1_3

Zimbra-1.3, Zimbra Public License v1.3

Zimbra_1_4

Zimbra-1.4, Zimbra Public License v1.4

Zlib_acknowledgement

zlib-acknowledgement, zlib/libpng License with Acknowledgement

Zlib

Zlib, zlib License

ZPL_1_1

ZPL-1.1, Zope Public License 1.1

ZPL_2_0

ZPL-2.0, Zope Public License 2.0

ZPL_2_1

ZPL-2.1, Zope Public License 2.1

Instances
Bounded LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

minBound :: LicenseId #

maxBound :: LicenseId #

Enum LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

succ :: LicenseId -> LicenseId #

pred :: LicenseId -> LicenseId #

toEnum :: Int -> LicenseId #

fromEnum :: LicenseId -> Int #

enumFrom :: LicenseId -> [LicenseId] #

enumFromThen :: LicenseId -> LicenseId -> [LicenseId] #

enumFromTo :: LicenseId -> LicenseId -> [LicenseId] #

enumFromThenTo :: LicenseId -> LicenseId -> LicenseId -> [LicenseId] #

Eq LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

(==) :: LicenseId -> LicenseId -> Bool #

(/=) :: LicenseId -> LicenseId -> Bool #

Data LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LicenseId -> c LicenseId #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LicenseId #

toConstr :: LicenseId -> Constr #

dataTypeOf :: LicenseId -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LicenseId) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LicenseId) #

gmapT :: (forall b. Data b => b -> b) -> LicenseId -> LicenseId #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LicenseId -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LicenseId -> r #

gmapQ :: (forall d. Data d => d -> u) -> LicenseId -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LicenseId -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LicenseId -> m LicenseId #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseId -> m LicenseId #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseId -> m LicenseId #

Ord LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

compare :: LicenseId -> LicenseId -> Ordering #

(<) :: LicenseId -> LicenseId -> Bool #

(<=) :: LicenseId -> LicenseId -> Bool #

(>) :: LicenseId -> LicenseId -> Bool #

(>=) :: LicenseId -> LicenseId -> Bool #

max :: LicenseId -> LicenseId -> LicenseId #

min :: LicenseId -> LicenseId -> LicenseId #

Read LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

readsPrec :: Int -> ReadS LicenseId #

readList :: ReadS [LicenseId] #

readPrec :: ReadPrec LicenseId #

readListPrec :: ReadPrec [LicenseId] #

Show LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

showsPrec :: Int -> LicenseId -> ShowS #

show :: LicenseId -> String #

showList :: [LicenseId] -> ShowS #

Generic LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Associated Types

type Rep LicenseId :: * -> * #

Methods

from :: LicenseId -> Rep LicenseId x #

to :: Rep LicenseId x -> LicenseId #

Binary LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

put :: LicenseId -> Put #

get :: Get LicenseId #

putList :: [LicenseId] -> Put #

NFData LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

rnf :: LicenseId -> () #

Pretty LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

pretty :: LicenseId -> Doc #

Parsec LicenseId #
>>> eitherParsec "BSD-3-Clause" :: Either String LicenseId
+Right BSD_3_Clause
+
>>> eitherParsec "BSD3" :: Either String LicenseId
+Left "...Unknown SPDX license identifier: 'BSD3' Do you mean BSD-3-Clause?"
+
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

parsec :: CabalParsing m => m LicenseId #

type Rep LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

type Rep LicenseId = D1 (MetaData "LicenseId" "Distribution.SPDX.LicenseId" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((((((((C1 (MetaCons "NullBSD" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "AAL" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Abstyles" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Adobe_2006" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Adobe_Glyph" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "ADSL" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "AFL_1_1" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "AFL_1_2" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "AFL_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "AFL_2_1" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "AFL_3_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Afmparse" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "AGPL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "AGPL_1_0_only" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "AGPL_1_0_or_later" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "AGPL_3_0_only" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "AGPL_3_0_or_later" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Aladdin" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "AMDPLPA" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "AML" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "AMPAS" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "ANTLR_PD" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Apache_1_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Apache_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Apache_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "APAFML" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "APL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "APSL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "APSL_1_1" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "APSL_1_2" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "APSL_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Artistic_1_0_cl8" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "Artistic_1_0_Perl" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Artistic_1_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Artistic_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Bahyph" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Barr" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Beerware" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "BitTorrent_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BitTorrent_1_1" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "Borceux" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "BSD_1_Clause" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BSD_2_Clause_FreeBSD" PrefixI False) (U1 :: * -> *))))))) :+: (((((C1 (MetaCons "BSD_2_Clause_NetBSD" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BSD_2_Clause_Patent" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "BSD_2_Clause" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "BSD_3_Clause_Attribution" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BSD_3_Clause_Clear" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "BSD_3_Clause_LBNL" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "BSD_3_Clause_No_Nuclear_License_2014" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BSD_3_Clause_No_Nuclear_License" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "BSD_3_Clause_No_Nuclear_Warranty" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "BSD_3_Clause" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BSD_4_Clause_UC" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "BSD_4_Clause" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BSD_Protection" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "BSD_Source_Code" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "BSL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Bzip2_1_0_5" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Bzip2_1_0_6" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Caldera" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CATOSL_1_1" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "CC_BY_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_2_5" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "CC_BY_3_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_4_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CC_BY_NC_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_NC_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_NC_2_5" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "CC_BY_NC_3_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_NC_4_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_NC_ND_1_0" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "CC_BY_NC_ND_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_NC_ND_2_5" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_NC_ND_3_0" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "CC_BY_NC_ND_4_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_NC_SA_1_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CC_BY_NC_SA_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_NC_SA_2_5" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_NC_SA_3_0" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "CC_BY_NC_SA_4_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_ND_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_ND_2_0" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "CC_BY_ND_2_5" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_ND_3_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_ND_4_0" PrefixI False) (U1 :: * -> *)))))))) :+: ((((((C1 (MetaCons "CC_BY_SA_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_SA_2_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CC_BY_SA_2_5" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_SA_3_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_SA_4_0" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "CC0_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CDDL_1_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CDDL_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CDLA_Permissive_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CDLA_Sharing_1_0" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "CECILL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CECILL_1_1" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CECILL_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CECILL_2_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CECILL_B" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "CECILL_C" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ClArtistic" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CNRI_Jython" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "CNRI_Python_GPL_Compatible" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CNRI_Python" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Condor_1_1" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "CPAL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CPL_1_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CPOL_1_02" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Crossword" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CrystalStacker" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "CUA_OPL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Cube" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Curl" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "D_FSL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Diffmark" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DOC" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "Dotseqn" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DSDP" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Dvipdfm" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ECL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ECL_2_0" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "EFL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "EFL_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "EGenix" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "Entessa" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "EPL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "EPL_2_0" PrefixI False) (U1 :: * -> *))))))) :+: (((((C1 (MetaCons "ErlPL_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "EUDatagrid" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "EUPL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "EUPL_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "EUPL_1_2" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Eurosym" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Fair" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Frameworx_1_0" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "FreeImage" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "FSFAP" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "FSFUL" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "FSFULLR" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "FTL" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "GFDL_1_1_only" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "GFDL_1_1_or_later" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "GFDL_1_2_only" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "GFDL_1_2_or_later" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "GFDL_1_3_only" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "GFDL_1_3_or_later" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "Giftware" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "GL2PS" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Glide" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "Glulxe" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Gnuplot" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "GPL_1_0_only" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "GPL_1_0_or_later" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "GPL_2_0_only" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "GPL_2_0_or_later" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "GPL_3_0_only" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "GPL_3_0_or_later" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "GSOAP_1_3b" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "HaskellReport" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "HPND" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "IBM_pibs" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ICU" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "IJG" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ImageMagick" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "IMatix" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Imlib2" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Info_ZIP" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Intel_ACPI" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "Intel" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Interbase_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "IPA" PrefixI False) (U1 :: * -> *))))))))) :+: (((((((C1 (MetaCons "IPL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ISC" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "JasPer_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "JSON" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LAL_1_2" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "LAL_1_3" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Latex2e" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Leptonica" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "LGPL_2_0_only" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LGPL_2_0_or_later" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "LGPL_2_1_only" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LGPL_2_1_or_later" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "LGPL_3_0_only" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "LGPL_3_0_or_later" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LGPLLR" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Libpng" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Libtiff" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LiLiQ_P_1_1" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "LiLiQ_R_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "LiLiQ_Rplus_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Linux_OpenIB" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "LPL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LPL_1_02" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "LPPL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "LPPL_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LPPL_1_2" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "LPPL_1_3a" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "LPPL_1_3c" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MakeIndex" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "MirOS" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "MIT_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MIT_advertising" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "MIT_CMU" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MIT_enna" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "MIT_feh" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "MIT" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MITNFA" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Motosoto" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Mpich2" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MPL_1_0" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "MPL_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "MPL_2_0_no_copyleft_exception" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MPL_2_0" PrefixI False) (U1 :: * -> *))))))) :+: (((((C1 (MetaCons "MS_PL" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MS_RL" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "MTLL" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Multics" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Mup" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "NASA_1_3" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Naumen" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NBPL_1_0" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "NCSA" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Net_SNMP" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NetCDF" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "Newsletr" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NGPL" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "NLOD_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "NLPL" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Nokia" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "NOSL" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Noweb" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NPL_1_0" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "NPL_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "NPOSL_3_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NRL" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "NTP" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OCCT_PL" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "OCLC_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ODbL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ODC_By_1_0" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "OFL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OFL_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OGTSL" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "OLDAP_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OLDAP_1_2" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OLDAP_1_3" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "OLDAP_1_4" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OLDAP_2_0_1" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "OLDAP_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OLDAP_2_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OLDAP_2_2_1" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "OLDAP_2_2_2" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OLDAP_2_2" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OLDAP_2_3" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "OLDAP_2_4" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OLDAP_2_5" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OLDAP_2_6" PrefixI False) (U1 :: * -> *)))))))) :+: ((((((C1 (MetaCons "OLDAP_2_7" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OLDAP_2_8" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "OML" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OpenSSL" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OPL_1_0" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "OSET_PL_2_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OSL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OSL_1_1" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "OSL_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OSL_2_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OSL_3_0" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "PDDL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PHP_3_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "PHP_3_01" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Plexus" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PostgreSQL" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Psfrag" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Psutils" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Python_2_0" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "Qhull" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "QPL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Rdisc" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "RHeCos_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "RPL_1_1" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "RPL_1_5" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "RPSL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "RSA_MD" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "RSCPL" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Ruby" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SAX_PD" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "Saxpath" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "SCEA" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Sendmail" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "SGI_B_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SGI_B_1_1" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "SGI_B_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "SimPL_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SISSL_1_2" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "SISSL" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Sleepycat" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SMLNJ" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "SMPPL" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "SNIA" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Spencer_86" PrefixI False) (U1 :: * -> *))))))) :+: (((((C1 (MetaCons "Spencer_94" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Spencer_99" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "SPL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "SugarCRM_1_1_3" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SWL" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "TCL" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "TCP_wrappers" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "TMate" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "TORQUE_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "TOSL" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "TU_Berlin_1_0" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "TU_Berlin_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Unicode_DFS_2015" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Unicode_DFS_2016" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Unicode_TOU" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Unlicense" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "UPL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Vim" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "VOSTROM" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "VSL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "W3C_19980720" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "W3C_20150513" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "W3C" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Watcom_1_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Wsuipa" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "WTFPL" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "X11" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Xerox" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "XFree86_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Xinetd" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "Xnet" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Xpp" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "XSkat" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "YPL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "YPL_1_1" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Zed" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Zend_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Zimbra_1_3" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Zimbra_1_4" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Zlib_acknowledgement" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Zlib" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "ZPL_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ZPL_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ZPL_2_1" PrefixI False) (U1 :: * -> *))))))))))

licenseId :: LicenseId -> String #

License SPDX identifier, e.g. "BSD-3-Clause".

licenseName :: LicenseId -> String #

License name, e.g. "GNU General Public License v2.0 only"

licenseIsOsiApproved :: LicenseId -> Bool #

Whether the license is approved by Open Source Initiative (OSI).

See https://opensource.org/licenses/alphabetical.

mkLicenseId :: LicenseListVersion -> String -> Maybe LicenseId #

Create a LicenseId from a String.

licenseIdList :: LicenseListVersion -> [LicenseId] #

Helpers

licenseIdMigrationMessage :: String -> String #

Help message for migrating from non-SPDX license identifiers.

Old License is almost SPDX, except for BSD2, BSD3. This function + suggests SPDX variant:

>>> licenseIdMigrationMessage "BSD3"
+"Do you mean BSD-3-Clause?"
+

Also OtherLicense, AllRightsReserved, and PublicDomain aren't + valid SPDX identifiers

>>> traverse_ (print . licenseIdMigrationMessage) [ "OtherLicense", "AllRightsReserved", "PublicDomain" ]
+"SPDX license list contains plenty of licenses. See https://spdx.org/licenses/. Also they can be combined into complex expressions with AND and OR."
+"You can use NONE as a value of license field."
+"Public Domain is a complex matter. See https://wiki.spdx.org/view/Legal_Team/Decisions/Dealing_with_Public_Domain_within_SPDX_Files. Consider using a proper license."
+

SPDX License list version 3.0 introduced "-only" and "-or-later" variants for GNU family of licenses. + See https://spdx.org/news/news/2018/01/license-list-30-released + >>> licenseIdMigrationMessage "GPL-2.0" + "SPDX license list 3.0 deprecated suffixless variants of GNU family of licenses. Use GPL-2.0-only or GPL-2.0-or-later."

For other common licenses their old license format coincides with the SPDX identifiers:

>>> traverse eitherParsec ["GPL-2.0-only", "GPL-3.0-only", "LGPL-2.1-only", "MIT", "ISC", "MPL-2.0", "Apache-2.0"] :: Either String [LicenseId]
+Right [GPL_2_0_only,GPL_3_0_only,LGPL_2_1_only,MIT,ISC,MPL_2_0,Apache_2_0]
+
diff --git a/doc/API/Cabal/Distribution-SPDX-LicenseListVersion.html b/doc/API/Cabal/Distribution-SPDX-LicenseListVersion.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-SPDX-LicenseListVersion.html @@ -0,0 +1,1 @@ +Distribution.SPDX.LicenseListVersion

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.SPDX.LicenseListVersion

Synopsis

Documentation

data LicenseListVersion #

SPDX License List version Cabal is aware of.

Constructors

LicenseListVersion_3_0 
LicenseListVersion_3_2 
Instances
Bounded LicenseListVersion # 
Instance details

Defined in Distribution.SPDX.LicenseListVersion

Methods

minBound :: LicenseListVersion #

maxBound :: LicenseListVersion #

Enum LicenseListVersion # 
Instance details

Defined in Distribution.SPDX.LicenseListVersion

Methods

succ :: LicenseListVersion -> LicenseListVersion #

pred :: LicenseListVersion -> LicenseListVersion #

toEnum :: Int -> LicenseListVersion #

fromEnum :: LicenseListVersion -> Int #

enumFrom :: LicenseListVersion -> [LicenseListVersion] #

enumFromThen :: LicenseListVersion -> LicenseListVersion -> [LicenseListVersion] #

enumFromTo :: LicenseListVersion -> LicenseListVersion -> [LicenseListVersion] #

enumFromThenTo :: LicenseListVersion -> LicenseListVersion -> LicenseListVersion -> [LicenseListVersion] #

Eq LicenseListVersion # 
Instance details

Defined in Distribution.SPDX.LicenseListVersion

Methods

(==) :: LicenseListVersion -> LicenseListVersion -> Bool #

(/=) :: LicenseListVersion -> LicenseListVersion -> Bool #

Ord LicenseListVersion # 
Instance details

Defined in Distribution.SPDX.LicenseListVersion

Methods

compare :: LicenseListVersion -> LicenseListVersion -> Ordering #

(<) :: LicenseListVersion -> LicenseListVersion -> Bool #

(<=) :: LicenseListVersion -> LicenseListVersion -> Bool #

(>) :: LicenseListVersion -> LicenseListVersion -> Bool #

(>=) :: LicenseListVersion -> LicenseListVersion -> Bool #

max :: LicenseListVersion -> LicenseListVersion -> LicenseListVersion #

min :: LicenseListVersion -> LicenseListVersion -> LicenseListVersion #

Show LicenseListVersion # 
Instance details

Defined in Distribution.SPDX.LicenseListVersion

Methods

showsPrec :: Int -> LicenseListVersion -> ShowS #

show :: LicenseListVersion -> String #

showList :: [LicenseListVersion] -> ShowS #

cabalSpecVersionToSPDXListVersion :: CabalSpecVersion -> LicenseListVersion #

diff --git a/doc/API/Cabal/Distribution-SPDX-LicenseReference.html b/doc/API/Cabal/Distribution-SPDX-LicenseReference.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-SPDX-LicenseReference.html @@ -0,0 +1,1 @@ +Distribution.SPDX.LicenseReference

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.SPDX.LicenseReference

Synopsis

Documentation

data LicenseRef #

A user defined license reference denoted by LicenseRef-[idstring] (for a license not on the SPDX License List);

Instances
Eq LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

(==) :: LicenseRef -> LicenseRef -> Bool #

(/=) :: LicenseRef -> LicenseRef -> Bool #

Data LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LicenseRef -> c LicenseRef #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LicenseRef #

toConstr :: LicenseRef -> Constr #

dataTypeOf :: LicenseRef -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LicenseRef) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LicenseRef) #

gmapT :: (forall b. Data b => b -> b) -> LicenseRef -> LicenseRef #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LicenseRef -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LicenseRef -> r #

gmapQ :: (forall d. Data d => d -> u) -> LicenseRef -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LicenseRef -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LicenseRef -> m LicenseRef #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseRef -> m LicenseRef #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseRef -> m LicenseRef #

Ord LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

compare :: LicenseRef -> LicenseRef -> Ordering #

(<) :: LicenseRef -> LicenseRef -> Bool #

(<=) :: LicenseRef -> LicenseRef -> Bool #

(>) :: LicenseRef -> LicenseRef -> Bool #

(>=) :: LicenseRef -> LicenseRef -> Bool #

max :: LicenseRef -> LicenseRef -> LicenseRef #

min :: LicenseRef -> LicenseRef -> LicenseRef #

Read LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

readsPrec :: Int -> ReadS LicenseRef #

readList :: ReadS [LicenseRef] #

readPrec :: ReadPrec LicenseRef #

readListPrec :: ReadPrec [LicenseRef] #

Show LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

showsPrec :: Int -> LicenseRef -> ShowS #

show :: LicenseRef -> String #

showList :: [LicenseRef] -> ShowS #

Generic LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Associated Types

type Rep LicenseRef :: * -> * #

Methods

from :: LicenseRef -> Rep LicenseRef x #

to :: Rep LicenseRef x -> LicenseRef #

Binary LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

put :: LicenseRef -> Put #

get :: Get LicenseRef #

putList :: [LicenseRef] -> Put #

NFData LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

rnf :: LicenseRef -> () #

Pretty LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

pretty :: LicenseRef -> Doc #

Parsec LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

parsec :: CabalParsing m => m LicenseRef #

type Rep LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

type Rep LicenseRef = D1 (MetaData "LicenseRef" "Distribution.SPDX.LicenseReference" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "LicenseRef" PrefixI True) (S1 (MetaSel (Just "_lrDocument") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe String)) :*: S1 (MetaSel (Just "_lrLicense") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String)))

licenseRef :: LicenseRef -> String #

License reference.

licenseDocumentRef :: LicenseRef -> Maybe String #

Document reference.

mkLicenseRef :: Maybe String -> String -> Maybe LicenseRef #

Create LicenseRef from optional document ref and name.

mkLicenseRef' :: Maybe String -> String -> LicenseRef #

Like mkLicenseRef but convert invalid characters into -.

diff --git a/doc/API/Cabal/Distribution-SPDX.html b/doc/API/Cabal/Distribution-SPDX.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-SPDX.html @@ -0,0 +1,31 @@ +Distribution.SPDX

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.SPDX

Contents

Description

This module implements SPDX specification version 2.1 with a version 3.0 license list.

Specification is available on https://spdx.org/specifications

Synopsis

License

data License #

Declared license. + See section 3.15 of SPDX Specification 2.1

Note: the NOASSERTION case is omitted.

Old License can be migrated using following rules:

  • AllRightsReserved and UnspecifiedLicense to NONE. + No license specified which legally defaults to All Rights Reserved. + The package may not be legally modified or redistributed by anyone but + the rightsholder.
  • OtherLicense can be converted to LicenseRef pointing to the file + in the package.
  • UnknownLicense i.e. other licenses of the form name-x.y, should be + covered by SPDX license list, otherwise use LicenseRef.
  • PublicDomain isn't covered. Consider using CC0. + See https://wiki.spdx.org/view/Legal_Team/Decisions/Dealing_with_Public_Domain_within_SPDX_Files + for more information.

Constructors

NONE

if the package contains no license information whatsoever; or

License LicenseExpression

A valid SPDX License Expression as defined in Appendix IV.

Instances
Eq License # 
Instance details

Defined in Distribution.SPDX.License

Methods

(==) :: License -> License -> Bool #

(/=) :: License -> License -> Bool #

Data License # 
Instance details

Defined in Distribution.SPDX.License

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> License -> c License #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c License #

toConstr :: License -> Constr #

dataTypeOf :: License -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c License) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c License) #

gmapT :: (forall b. Data b => b -> b) -> License -> License #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> License -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> License -> r #

gmapQ :: (forall d. Data d => d -> u) -> License -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> License -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> License -> m License #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> License -> m License #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> License -> m License #

Ord License # 
Instance details

Defined in Distribution.SPDX.License

Methods

compare :: License -> License -> Ordering #

(<) :: License -> License -> Bool #

(<=) :: License -> License -> Bool #

(>) :: License -> License -> Bool #

(>=) :: License -> License -> Bool #

max :: License -> License -> License #

min :: License -> License -> License #

Read License # 
Instance details

Defined in Distribution.SPDX.License

Methods

readsPrec :: Int -> ReadS License #

readList :: ReadS [License] #

readPrec :: ReadPrec License #

readListPrec :: ReadPrec [License] #

Show License # 
Instance details

Defined in Distribution.SPDX.License

Methods

showsPrec :: Int -> License -> ShowS #

show :: License -> String #

showList :: [License] -> ShowS #

Generic License # 
Instance details

Defined in Distribution.SPDX.License

Associated Types

type Rep License :: * -> * #

Methods

from :: License -> Rep License x #

to :: Rep License x -> License #

Binary License # 
Instance details

Defined in Distribution.SPDX.License

Methods

put :: License -> Put #

get :: Get License #

putList :: [License] -> Put #

NFData License # 
Instance details

Defined in Distribution.SPDX.License

Methods

rnf :: License -> () #

Pretty License # 
Instance details

Defined in Distribution.SPDX.License

Methods

pretty :: License -> Doc #

Parsec License #
>>> eitherParsec "BSD-3-Clause AND MIT" :: Either String License
+Right (License (EAnd (ELicense (ELicenseId BSD_3_Clause) Nothing) (ELicense (ELicenseId MIT) Nothing)))
+
>>> eitherParsec "NONE" :: Either String License
+Right NONE
+
Instance details

Defined in Distribution.SPDX.License

Methods

parsec :: CabalParsing m => m License #

Newtype SpecLicense (Either License License) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: Either License0 License -> SpecLicense #

unpack :: SpecLicense -> Either License0 License #

type Rep License # 
Instance details

Defined in Distribution.SPDX.License

type Rep License = D1 (MetaData "License" "Distribution.SPDX.License" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "NONE" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "License" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LicenseExpression)))

License expression

data LicenseExpression #

SPDX License Expression.

idstring              = 1*(ALPHA / DIGIT / "-" / "." )
+license id            = <short form license identifier inAppendix I.1>
+license exception id  = <short form license exception identifier inAppendix I.2>
+license ref           = ["DocumentRef-"1*(idstring)":"]"LicenseRef-"1*(idstring)
+
+simple expression     = license id / license id"+" / license ref
+
+compound expression   = 1*1(simple expression /
+                        simple expression "WITH" license exception id /
+                        compound expression "AND" compound expression /
+                        compound expression "OR" compound expression ) /
+                        "(" compound expression ")" )
+
+license expression    = 1*1(simple expression / compound expression)
+

Constructors

ELicense !SimpleLicenseExpression !(Maybe LicenseExceptionId) 
EAnd !LicenseExpression !LicenseExpression 
EOr !LicenseExpression !LicenseExpression 
Instances
Eq LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

(==) :: LicenseExpression -> LicenseExpression -> Bool #

(/=) :: LicenseExpression -> LicenseExpression -> Bool #

Data LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LicenseExpression -> c LicenseExpression #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LicenseExpression #

toConstr :: LicenseExpression -> Constr #

dataTypeOf :: LicenseExpression -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LicenseExpression) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LicenseExpression) #

gmapT :: (forall b. Data b => b -> b) -> LicenseExpression -> LicenseExpression #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LicenseExpression -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LicenseExpression -> r #

gmapQ :: (forall d. Data d => d -> u) -> LicenseExpression -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LicenseExpression -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LicenseExpression -> m LicenseExpression #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseExpression -> m LicenseExpression #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseExpression -> m LicenseExpression #

Ord LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

compare :: LicenseExpression -> LicenseExpression -> Ordering #

(<) :: LicenseExpression -> LicenseExpression -> Bool #

(<=) :: LicenseExpression -> LicenseExpression -> Bool #

(>) :: LicenseExpression -> LicenseExpression -> Bool #

(>=) :: LicenseExpression -> LicenseExpression -> Bool #

max :: LicenseExpression -> LicenseExpression -> LicenseExpression #

min :: LicenseExpression -> LicenseExpression -> LicenseExpression #

Read LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

readsPrec :: Int -> ReadS LicenseExpression #

readList :: ReadS [LicenseExpression] #

readPrec :: ReadPrec LicenseExpression #

readListPrec :: ReadPrec [LicenseExpression] #

Show LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

showsPrec :: Int -> LicenseExpression -> ShowS #

show :: LicenseExpression -> String #

showList :: [LicenseExpression] -> ShowS #

Generic LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Associated Types

type Rep LicenseExpression :: * -> * #

Methods

from :: LicenseExpression -> Rep LicenseExpression x #

to :: Rep LicenseExpression x -> LicenseExpression #

Binary LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

put :: LicenseExpression -> Put #

get :: Get LicenseExpression #

putList :: [LicenseExpression] -> Put #

NFData LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

rnf :: LicenseExpression -> () #

Pretty LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

pretty :: LicenseExpression -> Doc #

Parsec LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

parsec :: CabalParsing m => m LicenseExpression #

type Rep LicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

type Rep LicenseExpression = D1 (MetaData "LicenseExpression" "Distribution.SPDX.LicenseExpression" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ELicense" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SimpleLicenseExpression) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LicenseExceptionId))) :+: (C1 (MetaCons "EAnd" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LicenseExpression) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LicenseExpression)) :+: C1 (MetaCons "EOr" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LicenseExpression) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LicenseExpression))))

data SimpleLicenseExpression #

Simple License Expressions.

Constructors

ELicenseId LicenseId

An SPDX License List Short Form Identifier. For example: GPL-2.0-only

ELicenseIdPlus LicenseId

An SPDX License List Short Form Identifier with a unary"+" operator suffix to represent the current version of the license or any later version. For example: GPL-2.0+

ELicenseRef LicenseRef

A SPDX user defined license reference: For example: LicenseRef-23, LicenseRef-MIT-Style-1, or DocumentRef-spdx-tool-1.2:LicenseRef-MIT-Style-2

Instances
Eq SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

(==) :: SimpleLicenseExpression -> SimpleLicenseExpression -> Bool #

(/=) :: SimpleLicenseExpression -> SimpleLicenseExpression -> Bool #

Data SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SimpleLicenseExpression -> c SimpleLicenseExpression #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SimpleLicenseExpression #

toConstr :: SimpleLicenseExpression -> Constr #

dataTypeOf :: SimpleLicenseExpression -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SimpleLicenseExpression) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SimpleLicenseExpression) #

gmapT :: (forall b. Data b => b -> b) -> SimpleLicenseExpression -> SimpleLicenseExpression #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SimpleLicenseExpression -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SimpleLicenseExpression -> r #

gmapQ :: (forall d. Data d => d -> u) -> SimpleLicenseExpression -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SimpleLicenseExpression -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SimpleLicenseExpression -> m SimpleLicenseExpression #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SimpleLicenseExpression -> m SimpleLicenseExpression #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SimpleLicenseExpression -> m SimpleLicenseExpression #

Ord SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

compare :: SimpleLicenseExpression -> SimpleLicenseExpression -> Ordering #

(<) :: SimpleLicenseExpression -> SimpleLicenseExpression -> Bool #

(<=) :: SimpleLicenseExpression -> SimpleLicenseExpression -> Bool #

(>) :: SimpleLicenseExpression -> SimpleLicenseExpression -> Bool #

(>=) :: SimpleLicenseExpression -> SimpleLicenseExpression -> Bool #

max :: SimpleLicenseExpression -> SimpleLicenseExpression -> SimpleLicenseExpression #

min :: SimpleLicenseExpression -> SimpleLicenseExpression -> SimpleLicenseExpression #

Read SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

readsPrec :: Int -> ReadS SimpleLicenseExpression #

readList :: ReadS [SimpleLicenseExpression] #

readPrec :: ReadPrec SimpleLicenseExpression #

readListPrec :: ReadPrec [SimpleLicenseExpression] #

Show SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

showsPrec :: Int -> SimpleLicenseExpression -> ShowS #

show :: SimpleLicenseExpression -> String #

showList :: [SimpleLicenseExpression] -> ShowS #

Generic SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Associated Types

type Rep SimpleLicenseExpression :: * -> * #

Methods

from :: SimpleLicenseExpression -> Rep SimpleLicenseExpression x #

to :: Rep SimpleLicenseExpression x -> SimpleLicenseExpression #

Binary SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

put :: SimpleLicenseExpression -> Put #

get :: Get SimpleLicenseExpression #

putList :: [SimpleLicenseExpression] -> Put #

NFData SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

rnf :: SimpleLicenseExpression -> () #

Pretty SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

pretty :: SimpleLicenseExpression -> Doc #

Parsec SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

parsec :: CabalParsing m => m SimpleLicenseExpression #

type Rep SimpleLicenseExpression # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

type Rep SimpleLicenseExpression = D1 (MetaData "SimpleLicenseExpression" "Distribution.SPDX.LicenseExpression" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ELicenseId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LicenseId)) :+: (C1 (MetaCons "ELicenseIdPlus" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LicenseId)) :+: C1 (MetaCons "ELicenseRef" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LicenseRef))))

simpleLicenseExpression :: LicenseId -> LicenseExpression #

License identifier

data LicenseId #

SPDX License identifier

Constructors

NullBSD

0BSD, BSD Zero Clause License

AAL

AAL, Attribution Assurance License

Abstyles

Abstyles, Abstyles License

Adobe_2006

Adobe-2006, Adobe Systems Incorporated Source Code License Agreement

Adobe_Glyph

Adobe-Glyph, Adobe Glyph List License

ADSL

ADSL, Amazon Digital Services License

AFL_1_1

AFL-1.1, Academic Free License v1.1

AFL_1_2

AFL-1.2, Academic Free License v1.2

AFL_2_0

AFL-2.0, Academic Free License v2.0

AFL_2_1

AFL-2.1, Academic Free License v2.1

AFL_3_0

AFL-3.0, Academic Free License v3.0

Afmparse

Afmparse, Afmparse License

AGPL_1_0

AGPL-1.0, Affero General Public License v1.0, SPDX License List 3.0

AGPL_1_0_only

AGPL-1.0-only, Affero General Public License v1.0 only, SPDX License List 3.2

AGPL_1_0_or_later

AGPL-1.0-or-later, Affero General Public License v1.0 or later, SPDX License List 3.2

AGPL_3_0_only

AGPL-3.0-only, GNU Affero General Public License v3.0 only

AGPL_3_0_or_later

AGPL-3.0-or-later, GNU Affero General Public License v3.0 or later

Aladdin

Aladdin, Aladdin Free Public License

AMDPLPA

AMDPLPA, AMD's plpa_map.c License

AML

AML, Apple MIT License

AMPAS

AMPAS, Academy of Motion Picture Arts and Sciences BSD

ANTLR_PD

ANTLR-PD, ANTLR Software Rights Notice

Apache_1_0

Apache-1.0, Apache License 1.0

Apache_1_1

Apache-1.1, Apache License 1.1

Apache_2_0

Apache-2.0, Apache License 2.0

APAFML

APAFML, Adobe Postscript AFM License

APL_1_0

APL-1.0, Adaptive Public License 1.0

APSL_1_0

APSL-1.0, Apple Public Source License 1.0

APSL_1_1

APSL-1.1, Apple Public Source License 1.1

APSL_1_2

APSL-1.2, Apple Public Source License 1.2

APSL_2_0

APSL-2.0, Apple Public Source License 2.0

Artistic_1_0_cl8

Artistic-1.0-cl8, Artistic License 1.0 w/clause 8

Artistic_1_0_Perl

Artistic-1.0-Perl, Artistic License 1.0 (Perl)

Artistic_1_0

Artistic-1.0, Artistic License 1.0

Artistic_2_0

Artistic-2.0, Artistic License 2.0

Bahyph

Bahyph, Bahyph License

Barr

Barr, Barr License

Beerware

Beerware, Beerware License

BitTorrent_1_0

BitTorrent-1.0, BitTorrent Open Source License v1.0

BitTorrent_1_1

BitTorrent-1.1, BitTorrent Open Source License v1.1

Borceux

Borceux, Borceux license

BSD_1_Clause

BSD-1-Clause, BSD 1-Clause License

BSD_2_Clause_FreeBSD

BSD-2-Clause-FreeBSD, BSD 2-Clause FreeBSD License

BSD_2_Clause_NetBSD

BSD-2-Clause-NetBSD, BSD 2-Clause NetBSD License

BSD_2_Clause_Patent

BSD-2-Clause-Patent, BSD-2-Clause Plus Patent License

BSD_2_Clause

BSD-2-Clause, BSD 2-Clause Simplified License

BSD_3_Clause_Attribution

BSD-3-Clause-Attribution, BSD with attribution

BSD_3_Clause_Clear

BSD-3-Clause-Clear, BSD 3-Clause Clear License

BSD_3_Clause_LBNL

BSD-3-Clause-LBNL, Lawrence Berkeley National Labs BSD variant license

BSD_3_Clause_No_Nuclear_License_2014

BSD-3-Clause-No-Nuclear-License-2014, BSD 3-Clause No Nuclear License 2014

BSD_3_Clause_No_Nuclear_License

BSD-3-Clause-No-Nuclear-License, BSD 3-Clause No Nuclear License

BSD_3_Clause_No_Nuclear_Warranty

BSD-3-Clause-No-Nuclear-Warranty, BSD 3-Clause No Nuclear Warranty

BSD_3_Clause

BSD-3-Clause, BSD 3-Clause New or Revised License

BSD_4_Clause_UC

BSD-4-Clause-UC, BSD-4-Clause (University of California-Specific)

BSD_4_Clause

BSD-4-Clause, BSD 4-Clause Original or Old License

BSD_Protection

BSD-Protection, BSD Protection License

BSD_Source_Code

BSD-Source-Code, BSD Source Code Attribution

BSL_1_0

BSL-1.0, Boost Software License 1.0

Bzip2_1_0_5

bzip2-1.0.5, bzip2 and libbzip2 License v1.0.5

Bzip2_1_0_6

bzip2-1.0.6, bzip2 and libbzip2 License v1.0.6

Caldera

Caldera, Caldera License

CATOSL_1_1

CATOSL-1.1, Computer Associates Trusted Open Source License 1.1

CC_BY_1_0

CC-BY-1.0, Creative Commons Attribution 1.0 Generic

CC_BY_2_0

CC-BY-2.0, Creative Commons Attribution 2.0 Generic

CC_BY_2_5

CC-BY-2.5, Creative Commons Attribution 2.5 Generic

CC_BY_3_0

CC-BY-3.0, Creative Commons Attribution 3.0 Unported

CC_BY_4_0

CC-BY-4.0, Creative Commons Attribution 4.0 International

CC_BY_NC_1_0

CC-BY-NC-1.0, Creative Commons Attribution Non Commercial 1.0 Generic

CC_BY_NC_2_0

CC-BY-NC-2.0, Creative Commons Attribution Non Commercial 2.0 Generic

CC_BY_NC_2_5

CC-BY-NC-2.5, Creative Commons Attribution Non Commercial 2.5 Generic

CC_BY_NC_3_0

CC-BY-NC-3.0, Creative Commons Attribution Non Commercial 3.0 Unported

CC_BY_NC_4_0

CC-BY-NC-4.0, Creative Commons Attribution Non Commercial 4.0 International

CC_BY_NC_ND_1_0

CC-BY-NC-ND-1.0, Creative Commons Attribution Non Commercial No Derivatives 1.0 Generic

CC_BY_NC_ND_2_0

CC-BY-NC-ND-2.0, Creative Commons Attribution Non Commercial No Derivatives 2.0 Generic

CC_BY_NC_ND_2_5

CC-BY-NC-ND-2.5, Creative Commons Attribution Non Commercial No Derivatives 2.5 Generic

CC_BY_NC_ND_3_0

CC-BY-NC-ND-3.0, Creative Commons Attribution Non Commercial No Derivatives 3.0 Unported

CC_BY_NC_ND_4_0

CC-BY-NC-ND-4.0, Creative Commons Attribution Non Commercial No Derivatives 4.0 International

CC_BY_NC_SA_1_0

CC-BY-NC-SA-1.0, Creative Commons Attribution Non Commercial Share Alike 1.0 Generic

CC_BY_NC_SA_2_0

CC-BY-NC-SA-2.0, Creative Commons Attribution Non Commercial Share Alike 2.0 Generic

CC_BY_NC_SA_2_5

CC-BY-NC-SA-2.5, Creative Commons Attribution Non Commercial Share Alike 2.5 Generic

CC_BY_NC_SA_3_0

CC-BY-NC-SA-3.0, Creative Commons Attribution Non Commercial Share Alike 3.0 Unported

CC_BY_NC_SA_4_0

CC-BY-NC-SA-4.0, Creative Commons Attribution Non Commercial Share Alike 4.0 International

CC_BY_ND_1_0

CC-BY-ND-1.0, Creative Commons Attribution No Derivatives 1.0 Generic

CC_BY_ND_2_0

CC-BY-ND-2.0, Creative Commons Attribution No Derivatives 2.0 Generic

CC_BY_ND_2_5

CC-BY-ND-2.5, Creative Commons Attribution No Derivatives 2.5 Generic

CC_BY_ND_3_0

CC-BY-ND-3.0, Creative Commons Attribution No Derivatives 3.0 Unported

CC_BY_ND_4_0

CC-BY-ND-4.0, Creative Commons Attribution No Derivatives 4.0 International

CC_BY_SA_1_0

CC-BY-SA-1.0, Creative Commons Attribution Share Alike 1.0 Generic

CC_BY_SA_2_0

CC-BY-SA-2.0, Creative Commons Attribution Share Alike 2.0 Generic

CC_BY_SA_2_5

CC-BY-SA-2.5, Creative Commons Attribution Share Alike 2.5 Generic

CC_BY_SA_3_0

CC-BY-SA-3.0, Creative Commons Attribution Share Alike 3.0 Unported

CC_BY_SA_4_0

CC-BY-SA-4.0, Creative Commons Attribution Share Alike 4.0 International

CC0_1_0

CC0-1.0, Creative Commons Zero v1.0 Universal

CDDL_1_0

CDDL-1.0, Common Development and Distribution License 1.0

CDDL_1_1

CDDL-1.1, Common Development and Distribution License 1.1

CDLA_Permissive_1_0

CDLA-Permissive-1.0, Community Data License Agreement Permissive 1.0

CDLA_Sharing_1_0

CDLA-Sharing-1.0, Community Data License Agreement Sharing 1.0

CECILL_1_0

CECILL-1.0, CeCILL Free Software License Agreement v1.0

CECILL_1_1

CECILL-1.1, CeCILL Free Software License Agreement v1.1

CECILL_2_0

CECILL-2.0, CeCILL Free Software License Agreement v2.0

CECILL_2_1

CECILL-2.1, CeCILL Free Software License Agreement v2.1

CECILL_B

CECILL-B, CeCILL-B Free Software License Agreement

CECILL_C

CECILL-C, CeCILL-C Free Software License Agreement

ClArtistic

ClArtistic, Clarified Artistic License

CNRI_Jython

CNRI-Jython, CNRI Jython License

CNRI_Python_GPL_Compatible

CNRI-Python-GPL-Compatible, CNRI Python Open Source GPL Compatible License Agreement

CNRI_Python

CNRI-Python, CNRI Python License

Condor_1_1

Condor-1.1, Condor Public License v1.1

CPAL_1_0

CPAL-1.0, Common Public Attribution License 1.0

CPL_1_0

CPL-1.0, Common Public License 1.0

CPOL_1_02

CPOL-1.02, Code Project Open License 1.02

Crossword

Crossword, Crossword License

CrystalStacker

CrystalStacker, CrystalStacker License

CUA_OPL_1_0

CUA-OPL-1.0, CUA Office Public License v1.0

Cube

Cube, Cube License

Curl

curl, curl License

D_FSL_1_0

D-FSL-1.0, Deutsche Freie Software Lizenz

Diffmark

diffmark, diffmark license

DOC

DOC, DOC License

Dotseqn

Dotseqn, Dotseqn License

DSDP

DSDP, DSDP License

Dvipdfm

dvipdfm, dvipdfm License

ECL_1_0

ECL-1.0, Educational Community License v1.0

ECL_2_0

ECL-2.0, Educational Community License v2.0

EFL_1_0

EFL-1.0, Eiffel Forum License v1.0

EFL_2_0

EFL-2.0, Eiffel Forum License v2.0

EGenix

eGenix, eGenix.com Public License 1.1.0

Entessa

Entessa, Entessa Public License v1.0

EPL_1_0

EPL-1.0, Eclipse Public License 1.0

EPL_2_0

EPL-2.0, Eclipse Public License 2.0

ErlPL_1_1

ErlPL-1.1, Erlang Public License v1.1

EUDatagrid

EUDatagrid, EU DataGrid Software License

EUPL_1_0

EUPL-1.0, European Union Public License 1.0

EUPL_1_1

EUPL-1.1, European Union Public License 1.1

EUPL_1_2

EUPL-1.2, European Union Public License 1.2

Eurosym

Eurosym, Eurosym License

Fair

Fair, Fair License

Frameworx_1_0

Frameworx-1.0, Frameworx Open License 1.0

FreeImage

FreeImage, FreeImage Public License v1.0

FSFAP

FSFAP, FSF All Permissive License

FSFUL

FSFUL, FSF Unlimited License

FSFULLR

FSFULLR, FSF Unlimited License (with License Retention)

FTL

FTL, Freetype Project License

GFDL_1_1_only

GFDL-1.1-only, GNU Free Documentation License v1.1 only

GFDL_1_1_or_later

GFDL-1.1-or-later, GNU Free Documentation License v1.1 or later

GFDL_1_2_only

GFDL-1.2-only, GNU Free Documentation License v1.2 only

GFDL_1_2_or_later

GFDL-1.2-or-later, GNU Free Documentation License v1.2 or later

GFDL_1_3_only

GFDL-1.3-only, GNU Free Documentation License v1.3 only

GFDL_1_3_or_later

GFDL-1.3-or-later, GNU Free Documentation License v1.3 or later

Giftware

Giftware, Giftware License

GL2PS

GL2PS, GL2PS License

Glide

Glide, 3dfx Glide License

Glulxe

Glulxe, Glulxe License

Gnuplot

gnuplot, gnuplot License

GPL_1_0_only

GPL-1.0-only, GNU General Public License v1.0 only

GPL_1_0_or_later

GPL-1.0-or-later, GNU General Public License v1.0 or later

GPL_2_0_only

GPL-2.0-only, GNU General Public License v2.0 only

GPL_2_0_or_later

GPL-2.0-or-later, GNU General Public License v2.0 or later

GPL_3_0_only

GPL-3.0-only, GNU General Public License v3.0 only

GPL_3_0_or_later

GPL-3.0-or-later, GNU General Public License v3.0 or later

GSOAP_1_3b

gSOAP-1.3b, gSOAP Public License v1.3b

HaskellReport

HaskellReport, Haskell Language Report License

HPND

HPND, Historical Permission Notice and Disclaimer

IBM_pibs

IBM-pibs, IBM PowerPC Initialization and Boot Software

ICU

ICU, ICU License

IJG

IJG, Independent JPEG Group License

ImageMagick

ImageMagick, ImageMagick License

IMatix

iMatix, iMatix Standard Function Library Agreement

Imlib2

Imlib2, Imlib2 License

Info_ZIP

Info-ZIP, Info-ZIP License

Intel_ACPI

Intel-ACPI, Intel ACPI Software License Agreement

Intel

Intel, Intel Open Source License

Interbase_1_0

Interbase-1.0, Interbase Public License v1.0

IPA

IPA, IPA Font License

IPL_1_0

IPL-1.0, IBM Public License v1.0

ISC

ISC, ISC License

JasPer_2_0

JasPer-2.0, JasPer License

JSON

JSON, JSON License

LAL_1_2

LAL-1.2, Licence Art Libre 1.2

LAL_1_3

LAL-1.3, Licence Art Libre 1.3

Latex2e

Latex2e, Latex2e License

Leptonica

Leptonica, Leptonica License

LGPL_2_0_only

LGPL-2.0-only, GNU Library General Public License v2 only

LGPL_2_0_or_later

LGPL-2.0-or-later, GNU Library General Public License v2 or later

LGPL_2_1_only

LGPL-2.1-only, GNU Lesser General Public License v2.1 only

LGPL_2_1_or_later

LGPL-2.1-or-later, GNU Lesser General Public License v2.1 or later

LGPL_3_0_only

LGPL-3.0-only, GNU Lesser General Public License v3.0 only

LGPL_3_0_or_later

LGPL-3.0-or-later, GNU Lesser General Public License v3.0 or later

LGPLLR

LGPLLR, Lesser General Public License For Linguistic Resources

Libpng

Libpng, libpng License

Libtiff

libtiff, libtiff License

LiLiQ_P_1_1

LiLiQ-P-1.1, Licence Libre du Québec – Permissive version 1.1

LiLiQ_R_1_1

LiLiQ-R-1.1, Licence Libre du Québec – Réciprocité version 1.1

LiLiQ_Rplus_1_1

LiLiQ-Rplus-1.1, Licence Libre du Québec – Réciprocité forte version 1.1

Linux_OpenIB

Linux-OpenIB, Linux Kernel Variant of OpenIB.org license, SPDX License List 3.2

LPL_1_0

LPL-1.0, Lucent Public License Version 1.0

LPL_1_02

LPL-1.02, Lucent Public License v1.02

LPPL_1_0

LPPL-1.0, LaTeX Project Public License v1.0

LPPL_1_1

LPPL-1.1, LaTeX Project Public License v1.1

LPPL_1_2

LPPL-1.2, LaTeX Project Public License v1.2

LPPL_1_3a

LPPL-1.3a, LaTeX Project Public License v1.3a

LPPL_1_3c

LPPL-1.3c, LaTeX Project Public License v1.3c

MakeIndex

MakeIndex, MakeIndex License

MirOS

MirOS, MirOS License

MIT_0

MIT-0, MIT No Attribution, SPDX License List 3.2

MIT_advertising

MIT-advertising, Enlightenment License (e16)

MIT_CMU

MIT-CMU, CMU License

MIT_enna

MIT-enna, enna License

MIT_feh

MIT-feh, feh License

MIT

MIT, MIT License

MITNFA

MITNFA, MIT +no-false-attribs license

Motosoto

Motosoto, Motosoto License

Mpich2

mpich2, mpich2 License

MPL_1_0

MPL-1.0, Mozilla Public License 1.0

MPL_1_1

MPL-1.1, Mozilla Public License 1.1

MPL_2_0_no_copyleft_exception

MPL-2.0-no-copyleft-exception, Mozilla Public License 2.0 (no copyleft exception)

MPL_2_0

MPL-2.0, Mozilla Public License 2.0

MS_PL

MS-PL, Microsoft Public License

MS_RL

MS-RL, Microsoft Reciprocal License

MTLL

MTLL, Matrix Template Library License

Multics

Multics, Multics License

Mup

Mup, Mup License

NASA_1_3

NASA-1.3, NASA Open Source Agreement 1.3

Naumen

Naumen, Naumen Public License

NBPL_1_0

NBPL-1.0, Net Boolean Public License v1

NCSA

NCSA, University of Illinois/NCSA Open Source License

Net_SNMP

Net-SNMP, Net-SNMP License

NetCDF

NetCDF, NetCDF license

Newsletr

Newsletr, Newsletr License

NGPL

NGPL, Nethack General Public License

NLOD_1_0

NLOD-1.0, Norwegian Licence for Open Government Data

NLPL

NLPL, No Limit Public License

Nokia

Nokia, Nokia Open Source License

NOSL

NOSL, Netizen Open Source License

Noweb

Noweb, Noweb License

NPL_1_0

NPL-1.0, Netscape Public License v1.0

NPL_1_1

NPL-1.1, Netscape Public License v1.1

NPOSL_3_0

NPOSL-3.0, Non-Profit Open Software License 3.0

NRL

NRL, NRL License

NTP

NTP, NTP License

OCCT_PL

OCCT-PL, Open CASCADE Technology Public License

OCLC_2_0

OCLC-2.0, OCLC Research Public License 2.0

ODbL_1_0

ODbL-1.0, ODC Open Database License v1.0

ODC_By_1_0

ODC-By-1.0, Open Data Commons Attribution License v1.0, SPDX License List 3.2

OFL_1_0

OFL-1.0, SIL Open Font License 1.0

OFL_1_1

OFL-1.1, SIL Open Font License 1.1

OGTSL

OGTSL, Open Group Test Suite License

OLDAP_1_1

OLDAP-1.1, Open LDAP Public License v1.1

OLDAP_1_2

OLDAP-1.2, Open LDAP Public License v1.2

OLDAP_1_3

OLDAP-1.3, Open LDAP Public License v1.3

OLDAP_1_4

OLDAP-1.4, Open LDAP Public License v1.4

OLDAP_2_0_1

OLDAP-2.0.1, Open LDAP Public License v2.0.1

OLDAP_2_0

OLDAP-2.0, Open LDAP Public License v2.0 (or possibly 2.0A and 2.0B)

OLDAP_2_1

OLDAP-2.1, Open LDAP Public License v2.1

OLDAP_2_2_1

OLDAP-2.2.1, Open LDAP Public License v2.2.1

OLDAP_2_2_2

OLDAP-2.2.2, Open LDAP Public License 2.2.2

OLDAP_2_2

OLDAP-2.2, Open LDAP Public License v2.2

OLDAP_2_3

OLDAP-2.3, Open LDAP Public License v2.3

OLDAP_2_4

OLDAP-2.4, Open LDAP Public License v2.4

OLDAP_2_5

OLDAP-2.5, Open LDAP Public License v2.5

OLDAP_2_6

OLDAP-2.6, Open LDAP Public License v2.6

OLDAP_2_7

OLDAP-2.7, Open LDAP Public License v2.7

OLDAP_2_8

OLDAP-2.8, Open LDAP Public License v2.8

OML

OML, Open Market License

OpenSSL

OpenSSL, OpenSSL License

OPL_1_0

OPL-1.0, Open Public License v1.0

OSET_PL_2_1

OSET-PL-2.1, OSET Public License version 2.1

OSL_1_0

OSL-1.0, Open Software License 1.0

OSL_1_1

OSL-1.1, Open Software License 1.1

OSL_2_0

OSL-2.0, Open Software License 2.0

OSL_2_1

OSL-2.1, Open Software License 2.1

OSL_3_0

OSL-3.0, Open Software License 3.0

PDDL_1_0

PDDL-1.0, ODC Public Domain Dedication & License 1.0

PHP_3_0

PHP-3.0, PHP License v3.0

PHP_3_01

PHP-3.01, PHP License v3.01

Plexus

Plexus, Plexus Classworlds License

PostgreSQL

PostgreSQL, PostgreSQL License

Psfrag

psfrag, psfrag License

Psutils

psutils, psutils License

Python_2_0

Python-2.0, Python License 2.0

Qhull

Qhull, Qhull License

QPL_1_0

QPL-1.0, Q Public License 1.0

Rdisc

Rdisc, Rdisc License

RHeCos_1_1

RHeCos-1.1, Red Hat eCos Public License v1.1

RPL_1_1

RPL-1.1, Reciprocal Public License 1.1

RPL_1_5

RPL-1.5, Reciprocal Public License 1.5

RPSL_1_0

RPSL-1.0, RealNetworks Public Source License v1.0

RSA_MD

RSA-MD, RSA Message-Digest License

RSCPL

RSCPL, Ricoh Source Code Public License

Ruby

Ruby, Ruby License

SAX_PD

SAX-PD, Sax Public Domain Notice

Saxpath

Saxpath, Saxpath License

SCEA

SCEA, SCEA Shared Source License

Sendmail

Sendmail, Sendmail License

SGI_B_1_0

SGI-B-1.0, SGI Free Software License B v1.0

SGI_B_1_1

SGI-B-1.1, SGI Free Software License B v1.1

SGI_B_2_0

SGI-B-2.0, SGI Free Software License B v2.0

SimPL_2_0

SimPL-2.0, Simple Public License 2.0

SISSL_1_2

SISSL-1.2, Sun Industry Standards Source License v1.2

SISSL

SISSL, Sun Industry Standards Source License v1.1

Sleepycat

Sleepycat, Sleepycat License

SMLNJ

SMLNJ, Standard ML of New Jersey License

SMPPL

SMPPL, Secure Messaging Protocol Public License

SNIA

SNIA, SNIA Public License 1.1

Spencer_86

Spencer-86, Spencer License 86

Spencer_94

Spencer-94, Spencer License 94

Spencer_99

Spencer-99, Spencer License 99

SPL_1_0

SPL-1.0, Sun Public License v1.0

SugarCRM_1_1_3

SugarCRM-1.1.3, SugarCRM Public License v1.1.3

SWL

SWL, Scheme Widget Library (SWL) Software License Agreement

TCL

TCL, TCL/TK License

TCP_wrappers

TCP-wrappers, TCP Wrappers License

TMate

TMate, TMate Open Source License

TORQUE_1_1

TORQUE-1.1, TORQUE v2.5+ Software License v1.1

TOSL

TOSL, Trusster Open Source License

TU_Berlin_1_0

TU-Berlin-1.0, Technische Universitaet Berlin License 1.0, SPDX License List 3.2

TU_Berlin_2_0

TU-Berlin-2.0, Technische Universitaet Berlin License 2.0, SPDX License List 3.2

Unicode_DFS_2015

Unicode-DFS-2015, Unicode License Agreement - Data Files and Software (2015)

Unicode_DFS_2016

Unicode-DFS-2016, Unicode License Agreement - Data Files and Software (2016)

Unicode_TOU

Unicode-TOU, Unicode Terms of Use

Unlicense

Unlicense, The Unlicense

UPL_1_0

UPL-1.0, Universal Permissive License v1.0

Vim

Vim, Vim License

VOSTROM

VOSTROM, VOSTROM Public License for Open Source

VSL_1_0

VSL-1.0, Vovida Software License v1.0

W3C_19980720

W3C-19980720, W3C Software Notice and License (1998-07-20)

W3C_20150513

W3C-20150513, W3C Software Notice and Document License (2015-05-13)

W3C

W3C, W3C Software Notice and License (2002-12-31)

Watcom_1_0

Watcom-1.0, Sybase Open Watcom Public License 1.0

Wsuipa

Wsuipa, Wsuipa License

WTFPL

WTFPL, Do What The F*ck You Want To Public License

X11

X11, X11 License

Xerox

Xerox, Xerox License

XFree86_1_1

XFree86-1.1, XFree86 License 1.1

Xinetd

xinetd, xinetd License

Xnet

Xnet, X.Net License

Xpp

xpp, XPP License

XSkat

XSkat, XSkat License

YPL_1_0

YPL-1.0, Yahoo! Public License v1.0

YPL_1_1

YPL-1.1, Yahoo! Public License v1.1

Zed

Zed, Zed License

Zend_2_0

Zend-2.0, Zend License v2.0

Zimbra_1_3

Zimbra-1.3, Zimbra Public License v1.3

Zimbra_1_4

Zimbra-1.4, Zimbra Public License v1.4

Zlib_acknowledgement

zlib-acknowledgement, zlib/libpng License with Acknowledgement

Zlib

Zlib, zlib License

ZPL_1_1

ZPL-1.1, Zope Public License 1.1

ZPL_2_0

ZPL-2.0, Zope Public License 2.0

ZPL_2_1

ZPL-2.1, Zope Public License 2.1

Instances
Bounded LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

minBound :: LicenseId #

maxBound :: LicenseId #

Enum LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

succ :: LicenseId -> LicenseId #

pred :: LicenseId -> LicenseId #

toEnum :: Int -> LicenseId #

fromEnum :: LicenseId -> Int #

enumFrom :: LicenseId -> [LicenseId] #

enumFromThen :: LicenseId -> LicenseId -> [LicenseId] #

enumFromTo :: LicenseId -> LicenseId -> [LicenseId] #

enumFromThenTo :: LicenseId -> LicenseId -> LicenseId -> [LicenseId] #

Eq LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

(==) :: LicenseId -> LicenseId -> Bool #

(/=) :: LicenseId -> LicenseId -> Bool #

Data LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LicenseId -> c LicenseId #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LicenseId #

toConstr :: LicenseId -> Constr #

dataTypeOf :: LicenseId -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LicenseId) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LicenseId) #

gmapT :: (forall b. Data b => b -> b) -> LicenseId -> LicenseId #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LicenseId -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LicenseId -> r #

gmapQ :: (forall d. Data d => d -> u) -> LicenseId -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LicenseId -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LicenseId -> m LicenseId #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseId -> m LicenseId #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseId -> m LicenseId #

Ord LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

compare :: LicenseId -> LicenseId -> Ordering #

(<) :: LicenseId -> LicenseId -> Bool #

(<=) :: LicenseId -> LicenseId -> Bool #

(>) :: LicenseId -> LicenseId -> Bool #

(>=) :: LicenseId -> LicenseId -> Bool #

max :: LicenseId -> LicenseId -> LicenseId #

min :: LicenseId -> LicenseId -> LicenseId #

Read LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

readsPrec :: Int -> ReadS LicenseId #

readList :: ReadS [LicenseId] #

readPrec :: ReadPrec LicenseId #

readListPrec :: ReadPrec [LicenseId] #

Show LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

showsPrec :: Int -> LicenseId -> ShowS #

show :: LicenseId -> String #

showList :: [LicenseId] -> ShowS #

Generic LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Associated Types

type Rep LicenseId :: * -> * #

Methods

from :: LicenseId -> Rep LicenseId x #

to :: Rep LicenseId x -> LicenseId #

Binary LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

put :: LicenseId -> Put #

get :: Get LicenseId #

putList :: [LicenseId] -> Put #

NFData LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

rnf :: LicenseId -> () #

Pretty LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

pretty :: LicenseId -> Doc #

Parsec LicenseId #
>>> eitherParsec "BSD-3-Clause" :: Either String LicenseId
+Right BSD_3_Clause
+
>>> eitherParsec "BSD3" :: Either String LicenseId
+Left "...Unknown SPDX license identifier: 'BSD3' Do you mean BSD-3-Clause?"
+
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

parsec :: CabalParsing m => m LicenseId #

type Rep LicenseId # 
Instance details

Defined in Distribution.SPDX.LicenseId

type Rep LicenseId = D1 (MetaData "LicenseId" "Distribution.SPDX.LicenseId" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((((((((C1 (MetaCons "NullBSD" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "AAL" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Abstyles" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Adobe_2006" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Adobe_Glyph" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "ADSL" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "AFL_1_1" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "AFL_1_2" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "AFL_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "AFL_2_1" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "AFL_3_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Afmparse" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "AGPL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "AGPL_1_0_only" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "AGPL_1_0_or_later" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "AGPL_3_0_only" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "AGPL_3_0_or_later" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Aladdin" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "AMDPLPA" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "AML" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "AMPAS" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "ANTLR_PD" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Apache_1_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Apache_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Apache_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "APAFML" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "APL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "APSL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "APSL_1_1" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "APSL_1_2" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "APSL_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Artistic_1_0_cl8" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "Artistic_1_0_Perl" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Artistic_1_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Artistic_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Bahyph" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Barr" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Beerware" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "BitTorrent_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BitTorrent_1_1" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "Borceux" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "BSD_1_Clause" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BSD_2_Clause_FreeBSD" PrefixI False) (U1 :: * -> *))))))) :+: (((((C1 (MetaCons "BSD_2_Clause_NetBSD" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BSD_2_Clause_Patent" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "BSD_2_Clause" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "BSD_3_Clause_Attribution" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BSD_3_Clause_Clear" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "BSD_3_Clause_LBNL" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "BSD_3_Clause_No_Nuclear_License_2014" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BSD_3_Clause_No_Nuclear_License" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "BSD_3_Clause_No_Nuclear_Warranty" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "BSD_3_Clause" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BSD_4_Clause_UC" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "BSD_4_Clause" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BSD_Protection" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "BSD_Source_Code" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "BSL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Bzip2_1_0_5" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Bzip2_1_0_6" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Caldera" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CATOSL_1_1" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "CC_BY_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_2_5" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "CC_BY_3_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_4_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CC_BY_NC_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_NC_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_NC_2_5" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "CC_BY_NC_3_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_NC_4_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_NC_ND_1_0" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "CC_BY_NC_ND_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_NC_ND_2_5" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_NC_ND_3_0" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "CC_BY_NC_ND_4_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_NC_SA_1_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CC_BY_NC_SA_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_NC_SA_2_5" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_NC_SA_3_0" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "CC_BY_NC_SA_4_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_ND_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_ND_2_0" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "CC_BY_ND_2_5" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_ND_3_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_ND_4_0" PrefixI False) (U1 :: * -> *)))))))) :+: ((((((C1 (MetaCons "CC_BY_SA_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_SA_2_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CC_BY_SA_2_5" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CC_BY_SA_3_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CC_BY_SA_4_0" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "CC0_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CDDL_1_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CDDL_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CDLA_Permissive_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CDLA_Sharing_1_0" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "CECILL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CECILL_1_1" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CECILL_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CECILL_2_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CECILL_B" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "CECILL_C" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ClArtistic" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CNRI_Jython" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "CNRI_Python_GPL_Compatible" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CNRI_Python" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Condor_1_1" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "CPAL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CPL_1_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CPOL_1_02" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Crossword" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CrystalStacker" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "CUA_OPL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Cube" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Curl" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "D_FSL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Diffmark" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DOC" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "Dotseqn" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DSDP" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Dvipdfm" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ECL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ECL_2_0" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "EFL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "EFL_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "EGenix" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "Entessa" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "EPL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "EPL_2_0" PrefixI False) (U1 :: * -> *))))))) :+: (((((C1 (MetaCons "ErlPL_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "EUDatagrid" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "EUPL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "EUPL_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "EUPL_1_2" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Eurosym" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Fair" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Frameworx_1_0" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "FreeImage" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "FSFAP" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "FSFUL" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "FSFULLR" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "FTL" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "GFDL_1_1_only" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "GFDL_1_1_or_later" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "GFDL_1_2_only" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "GFDL_1_2_or_later" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "GFDL_1_3_only" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "GFDL_1_3_or_later" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "Giftware" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "GL2PS" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Glide" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "Glulxe" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Gnuplot" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "GPL_1_0_only" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "GPL_1_0_or_later" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "GPL_2_0_only" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "GPL_2_0_or_later" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "GPL_3_0_only" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "GPL_3_0_or_later" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "GSOAP_1_3b" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "HaskellReport" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "HPND" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "IBM_pibs" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ICU" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "IJG" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ImageMagick" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "IMatix" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Imlib2" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Info_ZIP" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Intel_ACPI" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "Intel" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Interbase_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "IPA" PrefixI False) (U1 :: * -> *))))))))) :+: (((((((C1 (MetaCons "IPL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ISC" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "JasPer_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "JSON" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LAL_1_2" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "LAL_1_3" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Latex2e" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Leptonica" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "LGPL_2_0_only" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LGPL_2_0_or_later" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "LGPL_2_1_only" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LGPL_2_1_or_later" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "LGPL_3_0_only" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "LGPL_3_0_or_later" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LGPLLR" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Libpng" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Libtiff" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LiLiQ_P_1_1" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "LiLiQ_R_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "LiLiQ_Rplus_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Linux_OpenIB" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "LPL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LPL_1_02" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "LPPL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "LPPL_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LPPL_1_2" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "LPPL_1_3a" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "LPPL_1_3c" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MakeIndex" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "MirOS" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "MIT_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MIT_advertising" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "MIT_CMU" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MIT_enna" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "MIT_feh" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "MIT" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MITNFA" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Motosoto" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Mpich2" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MPL_1_0" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "MPL_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "MPL_2_0_no_copyleft_exception" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MPL_2_0" PrefixI False) (U1 :: * -> *))))))) :+: (((((C1 (MetaCons "MS_PL" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MS_RL" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "MTLL" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Multics" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Mup" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "NASA_1_3" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Naumen" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NBPL_1_0" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "NCSA" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Net_SNMP" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NetCDF" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "Newsletr" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NGPL" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "NLOD_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "NLPL" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Nokia" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "NOSL" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Noweb" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NPL_1_0" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "NPL_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "NPOSL_3_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NRL" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "NTP" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OCCT_PL" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "OCLC_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ODbL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ODC_By_1_0" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "OFL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OFL_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OGTSL" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "OLDAP_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OLDAP_1_2" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OLDAP_1_3" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "OLDAP_1_4" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OLDAP_2_0_1" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "OLDAP_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OLDAP_2_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OLDAP_2_2_1" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "OLDAP_2_2_2" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OLDAP_2_2" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OLDAP_2_3" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "OLDAP_2_4" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OLDAP_2_5" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OLDAP_2_6" PrefixI False) (U1 :: * -> *)))))))) :+: ((((((C1 (MetaCons "OLDAP_2_7" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OLDAP_2_8" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "OML" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OpenSSL" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OPL_1_0" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "OSET_PL_2_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OSL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OSL_1_1" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "OSL_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OSL_2_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OSL_3_0" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "PDDL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PHP_3_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "PHP_3_01" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Plexus" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PostgreSQL" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Psfrag" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Psutils" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Python_2_0" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "Qhull" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "QPL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Rdisc" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "RHeCos_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "RPL_1_1" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "RPL_1_5" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "RPSL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "RSA_MD" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "RSCPL" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Ruby" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SAX_PD" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "Saxpath" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "SCEA" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Sendmail" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "SGI_B_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SGI_B_1_1" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "SGI_B_2_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "SimPL_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SISSL_1_2" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "SISSL" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Sleepycat" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SMLNJ" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "SMPPL" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "SNIA" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Spencer_86" PrefixI False) (U1 :: * -> *))))))) :+: (((((C1 (MetaCons "Spencer_94" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Spencer_99" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "SPL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "SugarCRM_1_1_3" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SWL" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "TCL" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "TCP_wrappers" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "TMate" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "TORQUE_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "TOSL" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "TU_Berlin_1_0" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "TU_Berlin_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Unicode_DFS_2015" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Unicode_DFS_2016" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Unicode_TOU" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Unlicense" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "UPL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Vim" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "VOSTROM" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "VSL_1_0" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "W3C_19980720" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "W3C_20150513" PrefixI False) (U1 :: * -> *)))))) :+: ((((C1 (MetaCons "W3C" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Watcom_1_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Wsuipa" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "WTFPL" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "X11" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Xerox" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "XFree86_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Xinetd" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "Xnet" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Xpp" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "XSkat" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "YPL_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "YPL_1_1" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Zed" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Zend_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Zimbra_1_3" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Zimbra_1_4" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Zlib_acknowledgement" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Zlib" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "ZPL_1_1" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ZPL_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ZPL_2_1" PrefixI False) (U1 :: * -> *))))))))))

licenseId :: LicenseId -> String #

License SPDX identifier, e.g. "BSD-3-Clause".

licenseName :: LicenseId -> String #

License name, e.g. "GNU General Public License v2.0 only"

licenseIsOsiApproved :: LicenseId -> Bool #

Whether the license is approved by Open Source Initiative (OSI).

See https://opensource.org/licenses/alphabetical.

mkLicenseId :: LicenseListVersion -> String -> Maybe LicenseId #

Create a LicenseId from a String.

licenseIdList :: LicenseListVersion -> [LicenseId] #

License exception

data LicenseExceptionId #

SPDX License identifier

Constructors

DS389_exception

389-exception, 389 Directory Server Exception

Autoconf_exception_2_0

Autoconf-exception-2.0, Autoconf exception 2.0

Autoconf_exception_3_0

Autoconf-exception-3.0, Autoconf exception 3.0

Bison_exception_2_2

Bison-exception-2.2, Bison exception 2.2

Bootloader_exception

Bootloader-exception, Bootloader Distribution Exception

Classpath_exception_2_0

Classpath-exception-2.0, Classpath exception 2.0

CLISP_exception_2_0

CLISP-exception-2.0, CLISP exception 2.0

DigiRule_FOSS_exception

DigiRule-FOSS-exception, DigiRule FOSS License Exception

ECos_exception_2_0

eCos-exception-2.0, eCos exception 2.0

Fawkes_Runtime_exception

Fawkes-Runtime-exception, Fawkes Runtime Exception

FLTK_exception

FLTK-exception, FLTK exception

Font_exception_2_0

Font-exception-2.0, Font exception 2.0

Freertos_exception_2_0

freertos-exception-2.0, FreeRTOS Exception 2.0

GCC_exception_2_0

GCC-exception-2.0, GCC Runtime Library exception 2.0

GCC_exception_3_1

GCC-exception-3.1, GCC Runtime Library exception 3.1

Gnu_javamail_exception

gnu-javamail-exception, GNU JavaMail exception

I2p_gpl_java_exception

i2p-gpl-java-exception, i2p GPL+Java Exception

Libtool_exception

Libtool-exception, Libtool Exception

Linux_syscall_note

Linux-syscall-note, Linux Syscall Note

LLVM_exception

LLVM-exception, LLVM Exception, SPDX License List 3.2

LZMA_exception

LZMA-exception, LZMA exception

Mif_exception

mif-exception, Macros and Inline Functions Exception

Nokia_Qt_exception_1_1

Nokia-Qt-exception-1.1, Nokia Qt LGPL exception 1.1

OCCT_exception_1_0

OCCT-exception-1.0, Open CASCADE Exception 1.0

OpenJDK_assembly_exception_1_0

OpenJDK-assembly-exception-1.0, OpenJDK Assembly exception 1.0, SPDX License List 3.2

Openvpn_openssl_exception

openvpn-openssl-exception, OpenVPN OpenSSL Exception

PS_or_PDF_font_exception_20170817

PS-or-PDF-font-exception-20170817, PS/PDF font exception (2017-08-17), SPDX License List 3.2

Qt_GPL_exception_1_0

Qt-GPL-exception-1.0, Qt GPL exception 1.0, SPDX License List 3.2

Qt_LGPL_exception_1_1

Qt-LGPL-exception-1.1, Qt LGPL exception 1.1, SPDX License List 3.2

Qwt_exception_1_0

Qwt-exception-1.0, Qwt exception 1.0

U_boot_exception_2_0

u-boot-exception-2.0, U-Boot exception 2.0

WxWindows_exception_3_1

WxWindows-exception-3.1, WxWindows Library Exception 3.1

Instances
Bounded LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

minBound :: LicenseExceptionId #

maxBound :: LicenseExceptionId #

Enum LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

succ :: LicenseExceptionId -> LicenseExceptionId #

pred :: LicenseExceptionId -> LicenseExceptionId #

toEnum :: Int -> LicenseExceptionId #

fromEnum :: LicenseExceptionId -> Int #

enumFrom :: LicenseExceptionId -> [LicenseExceptionId] #

enumFromThen :: LicenseExceptionId -> LicenseExceptionId -> [LicenseExceptionId] #

enumFromTo :: LicenseExceptionId -> LicenseExceptionId -> [LicenseExceptionId] #

enumFromThenTo :: LicenseExceptionId -> LicenseExceptionId -> LicenseExceptionId -> [LicenseExceptionId] #

Eq LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

(==) :: LicenseExceptionId -> LicenseExceptionId -> Bool #

(/=) :: LicenseExceptionId -> LicenseExceptionId -> Bool #

Data LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LicenseExceptionId -> c LicenseExceptionId #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LicenseExceptionId #

toConstr :: LicenseExceptionId -> Constr #

dataTypeOf :: LicenseExceptionId -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LicenseExceptionId) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LicenseExceptionId) #

gmapT :: (forall b. Data b => b -> b) -> LicenseExceptionId -> LicenseExceptionId #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LicenseExceptionId -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LicenseExceptionId -> r #

gmapQ :: (forall d. Data d => d -> u) -> LicenseExceptionId -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LicenseExceptionId -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LicenseExceptionId -> m LicenseExceptionId #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseExceptionId -> m LicenseExceptionId #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseExceptionId -> m LicenseExceptionId #

Ord LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

compare :: LicenseExceptionId -> LicenseExceptionId -> Ordering #

(<) :: LicenseExceptionId -> LicenseExceptionId -> Bool #

(<=) :: LicenseExceptionId -> LicenseExceptionId -> Bool #

(>) :: LicenseExceptionId -> LicenseExceptionId -> Bool #

(>=) :: LicenseExceptionId -> LicenseExceptionId -> Bool #

max :: LicenseExceptionId -> LicenseExceptionId -> LicenseExceptionId #

min :: LicenseExceptionId -> LicenseExceptionId -> LicenseExceptionId #

Read LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

readsPrec :: Int -> ReadS LicenseExceptionId #

readList :: ReadS [LicenseExceptionId] #

readPrec :: ReadPrec LicenseExceptionId #

readListPrec :: ReadPrec [LicenseExceptionId] #

Show LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

showsPrec :: Int -> LicenseExceptionId -> ShowS #

show :: LicenseExceptionId -> String #

showList :: [LicenseExceptionId] -> ShowS #

Generic LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Associated Types

type Rep LicenseExceptionId :: * -> * #

Methods

from :: LicenseExceptionId -> Rep LicenseExceptionId x #

to :: Rep LicenseExceptionId x -> LicenseExceptionId #

Binary LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

put :: LicenseExceptionId -> Put #

get :: Get LicenseExceptionId #

putList :: [LicenseExceptionId] -> Put #

NFData LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

rnf :: LicenseExceptionId -> () #

Pretty LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

pretty :: LicenseExceptionId -> Doc #

Parsec LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

parsec :: CabalParsing m => m LicenseExceptionId #

type Rep LicenseExceptionId # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

type Rep LicenseExceptionId = D1 (MetaData "LicenseExceptionId" "Distribution.SPDX.LicenseExceptionId" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (((((C1 (MetaCons "DS389_exception" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Autoconf_exception_2_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Autoconf_exception_3_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Bison_exception_2_2" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "Bootloader_exception" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Classpath_exception_2_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CLISP_exception_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DigiRule_FOSS_exception" PrefixI False) (U1 :: * -> *)))) :+: (((C1 (MetaCons "ECos_exception_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Fawkes_Runtime_exception" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "FLTK_exception" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Font_exception_2_0" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "Freertos_exception_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "GCC_exception_2_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "GCC_exception_3_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Gnu_javamail_exception" PrefixI False) (U1 :: * -> *))))) :+: ((((C1 (MetaCons "I2p_gpl_java_exception" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Libtool_exception" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Linux_syscall_note" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LLVM_exception" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "LZMA_exception" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Mif_exception" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Nokia_Qt_exception_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OCCT_exception_1_0" PrefixI False) (U1 :: * -> *)))) :+: (((C1 (MetaCons "OpenJDK_assembly_exception_1_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Openvpn_openssl_exception" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "PS_or_PDF_font_exception_20170817" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Qt_GPL_exception_1_0" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "Qt_LGPL_exception_1_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Qwt_exception_1_0" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "U_boot_exception_2_0" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "WxWindows_exception_3_1" PrefixI False) (U1 :: * -> *))))))

licenseExceptionId :: LicenseExceptionId -> String #

License SPDX identifier, e.g. "BSD-3-Clause".

licenseExceptionName :: LicenseExceptionId -> String #

License name, e.g. "GNU General Public License v2.0 only"

mkLicenseExceptionId :: LicenseListVersion -> String -> Maybe LicenseExceptionId #

Create a LicenseExceptionId from a String.

licenseExceptionIdList :: LicenseListVersion -> [LicenseExceptionId] #

License reference

data LicenseRef #

A user defined license reference denoted by LicenseRef-[idstring] (for a license not on the SPDX License List);

Instances
Eq LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

(==) :: LicenseRef -> LicenseRef -> Bool #

(/=) :: LicenseRef -> LicenseRef -> Bool #

Data LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LicenseRef -> c LicenseRef #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LicenseRef #

toConstr :: LicenseRef -> Constr #

dataTypeOf :: LicenseRef -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LicenseRef) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LicenseRef) #

gmapT :: (forall b. Data b => b -> b) -> LicenseRef -> LicenseRef #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LicenseRef -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LicenseRef -> r #

gmapQ :: (forall d. Data d => d -> u) -> LicenseRef -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LicenseRef -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LicenseRef -> m LicenseRef #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseRef -> m LicenseRef #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LicenseRef -> m LicenseRef #

Ord LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

compare :: LicenseRef -> LicenseRef -> Ordering #

(<) :: LicenseRef -> LicenseRef -> Bool #

(<=) :: LicenseRef -> LicenseRef -> Bool #

(>) :: LicenseRef -> LicenseRef -> Bool #

(>=) :: LicenseRef -> LicenseRef -> Bool #

max :: LicenseRef -> LicenseRef -> LicenseRef #

min :: LicenseRef -> LicenseRef -> LicenseRef #

Read LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

readsPrec :: Int -> ReadS LicenseRef #

readList :: ReadS [LicenseRef] #

readPrec :: ReadPrec LicenseRef #

readListPrec :: ReadPrec [LicenseRef] #

Show LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

showsPrec :: Int -> LicenseRef -> ShowS #

show :: LicenseRef -> String #

showList :: [LicenseRef] -> ShowS #

Generic LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Associated Types

type Rep LicenseRef :: * -> * #

Methods

from :: LicenseRef -> Rep LicenseRef x #

to :: Rep LicenseRef x -> LicenseRef #

Binary LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

put :: LicenseRef -> Put #

get :: Get LicenseRef #

putList :: [LicenseRef] -> Put #

NFData LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

rnf :: LicenseRef -> () #

Pretty LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

pretty :: LicenseRef -> Doc #

Parsec LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

parsec :: CabalParsing m => m LicenseRef #

type Rep LicenseRef # 
Instance details

Defined in Distribution.SPDX.LicenseReference

type Rep LicenseRef = D1 (MetaData "LicenseRef" "Distribution.SPDX.LicenseReference" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "LicenseRef" PrefixI True) (S1 (MetaSel (Just "_lrDocument") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe String)) :*: S1 (MetaSel (Just "_lrLicense") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String)))

licenseRef :: LicenseRef -> String #

License reference.

licenseDocumentRef :: LicenseRef -> Maybe String #

Document reference.

mkLicenseRef :: Maybe String -> String -> Maybe LicenseRef #

Create LicenseRef from optional document ref and name.

mkLicenseRef' :: Maybe String -> String -> LicenseRef #

Like mkLicenseRef but convert invalid characters into -.

License list version

data LicenseListVersion #

SPDX License List version Cabal is aware of.

Constructors

LicenseListVersion_3_0 
LicenseListVersion_3_2 
Instances
Bounded LicenseListVersion # 
Instance details

Defined in Distribution.SPDX.LicenseListVersion

Methods

minBound :: LicenseListVersion #

maxBound :: LicenseListVersion #

Enum LicenseListVersion # 
Instance details

Defined in Distribution.SPDX.LicenseListVersion

Methods

succ :: LicenseListVersion -> LicenseListVersion #

pred :: LicenseListVersion -> LicenseListVersion #

toEnum :: Int -> LicenseListVersion #

fromEnum :: LicenseListVersion -> Int #

enumFrom :: LicenseListVersion -> [LicenseListVersion] #

enumFromThen :: LicenseListVersion -> LicenseListVersion -> [LicenseListVersion] #

enumFromTo :: LicenseListVersion -> LicenseListVersion -> [LicenseListVersion] #

enumFromThenTo :: LicenseListVersion -> LicenseListVersion -> LicenseListVersion -> [LicenseListVersion] #

Eq LicenseListVersion # 
Instance details

Defined in Distribution.SPDX.LicenseListVersion

Methods

(==) :: LicenseListVersion -> LicenseListVersion -> Bool #

(/=) :: LicenseListVersion -> LicenseListVersion -> Bool #

Ord LicenseListVersion # 
Instance details

Defined in Distribution.SPDX.LicenseListVersion

Methods

compare :: LicenseListVersion -> LicenseListVersion -> Ordering #

(<) :: LicenseListVersion -> LicenseListVersion -> Bool #

(<=) :: LicenseListVersion -> LicenseListVersion -> Bool #

(>) :: LicenseListVersion -> LicenseListVersion -> Bool #

(>=) :: LicenseListVersion -> LicenseListVersion -> Bool #

max :: LicenseListVersion -> LicenseListVersion -> LicenseListVersion #

min :: LicenseListVersion -> LicenseListVersion -> LicenseListVersion #

Show LicenseListVersion # 
Instance details

Defined in Distribution.SPDX.LicenseListVersion

Methods

showsPrec :: Int -> LicenseListVersion -> ShowS #

show :: LicenseListVersion -> String #

showList :: [LicenseListVersion] -> ShowS #

cabalSpecVersionToSPDXListVersion :: CabalSpecVersion -> LicenseListVersion #

diff --git a/doc/API/Cabal/Distribution-Simple-Bench.html b/doc/API/Cabal/Distribution-Simple-Bench.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Bench.html @@ -0,0 +1,3 @@ +Distribution.Simple.Bench

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightJohan Tibell 2011
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Bench

Description

This is the entry point into running the benchmarks in a built + package. It performs the "./setup bench" action. It runs + benchmarks designated in the package description.

Synopsis

Documentation

bench #

Arguments

:: Args

positional command-line arguments

-> PackageDescription

information from the .cabal file

-> LocalBuildInfo

information from the configure step

-> BenchmarkFlags

flags sent to benchmark

-> IO () 

Perform the "./setup bench" action.

diff --git a/doc/API/Cabal/Distribution-Simple-Build-Macros.html b/doc/API/Cabal/Distribution-Simple-Build-Macros.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Build-Macros.html @@ -0,0 +1,7 @@ +Distribution.Simple.Build.Macros

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightSimon Marlow 2008
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Build.Macros

Description

Generate cabal_macros.h - CPP macros for package version testing

When using CPP you get

VERSION_<package>
+MIN_VERSION_<package>(A,B,C)

for each package in build-depends, which is true if the version of + package in use is >= A.B.C, using the normal ordering on version + numbers.

TODO Figure out what to do about backpack and internal libraries. It is very + suspecious that this stuff works with munged package identifiers

Synopsis

Documentation

generate :: PackageDescription -> LocalBuildInfo -> ComponentLocalBuildInfo -> String #

The contents of the cabal_macros.h for the given configured package.

generatePackageVersionMacros :: [PackageId] -> String #

Helper function that generates just the VERSION_pkg and MIN_VERSION_pkg + macros for a list of package ids (usually used with the specific deps of + a configured package).

diff --git a/doc/API/Cabal/Distribution-Simple-Build-PathsModule.html b/doc/API/Cabal/Distribution-Simple-Build-PathsModule.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Build-PathsModule.html @@ -0,0 +1,6 @@ +Distribution.Simple.Build.PathsModule

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2005
Ross Paterson 2006
Duncan Coutts 2007-2008
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Build.PathsModule

Description

Generating the Paths_pkgname module.

This is a module that Cabal generates for the benefit of packages. It + enables them to find their version number and find any installed data files + at runtime. This code should probably be split off into another module.

Synopsis

Documentation

generate :: PackageDescription -> LocalBuildInfo -> ComponentLocalBuildInfo -> String #

pkgPathEnvVar #

Arguments

:: PackageDescription 
-> String

path component; one of "bindir", "libdir", + "datadir", "libexecdir", or "sysconfdir"

-> String

environment variable name

Generates the name of the environment variable controlling the path + component of interest.

Note: The format of these strings is part of Cabal's public API; + changing this function constitutes a *backwards-compatibility* break.

diff --git a/doc/API/Cabal/Distribution-Simple-Build.html b/doc/API/Cabal/Distribution-Simple-Build.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Build.html @@ -0,0 +1,5 @@ +Distribution.Simple.Build

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2005
Ross Paterson 2006
Duncan Coutts 2007-2008 2012
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Build

Description

This is the entry point to actually building the modules in a package. It + doesn't actually do much itself, most of the work is delegated to + compiler-specific actions. It does do some non-compiler specific bits like + running pre-processors.

Synopsis

Documentation

build #

Arguments

:: PackageDescription

Mostly information from the .cabal file

-> LocalBuildInfo

Configuration information

-> BuildFlags

Flags that the user passed to build

-> [PPSuffixHandler]

preprocessors to run before compiling

-> IO () 

Build the libraries and executables in this package.

repl #

Arguments

:: PackageDescription

Mostly information from the .cabal file

-> LocalBuildInfo

Configuration information

-> ReplFlags

Flags that the user passed to build

-> [PPSuffixHandler]

preprocessors to run before compiling

-> [String] 
-> IO () 

startInterpreter :: Verbosity -> ProgramDb -> Compiler -> Platform -> PackageDBStack -> IO () #

Start an interpreter without loading any package files.

initialBuildSteps #

Arguments

:: FilePath

"dist" prefix

-> PackageDescription

mostly information from the .cabal file

-> LocalBuildInfo

Configuration information

-> Verbosity

The verbosity to use

-> IO () 

Runs componentInitialBuildSteps on every configured component.

createInternalPackageDB :: Verbosity -> LocalBuildInfo -> FilePath -> IO PackageDB #

Initialize a new package db file for libraries defined + internally to the package.

componentInitialBuildSteps #

Arguments

:: FilePath

"dist" prefix

-> PackageDescription

mostly information from the .cabal file

-> LocalBuildInfo

Configuration information

-> ComponentLocalBuildInfo 
-> Verbosity

The verbosity to use

-> IO () 

Creates the autogenerated files for a particular configured component.

writeAutogenFiles :: Verbosity -> PackageDescription -> LocalBuildInfo -> ComponentLocalBuildInfo -> IO () #

Generate and write out the Paths_pkg.hs and cabal_macros.h files

diff --git a/doc/API/Cabal/Distribution-Simple-BuildPaths.html b/doc/API/Cabal/Distribution-Simple-BuildPaths.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-BuildPaths.html @@ -0,0 +1,11 @@ +Distribution.Simple.BuildPaths

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2004
Duncan Coutts 2008
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.BuildPaths

Contents

Description

A bunch of dirs, paths and file names used for intermediate build steps.

Synopsis

Documentation

defaultDistPref :: FilePath #

srcPref :: FilePath -> FilePath #

haddockDirName :: HaddockTarget -> PackageDescription -> FilePath #

This is the name of the directory in which the generated haddocks + should be stored. It does not include the distdochtml prefix.

hscolourPref :: HaddockTarget -> FilePath -> PackageDescription -> FilePath #

haddockPref :: HaddockTarget -> FilePath -> PackageDescription -> FilePath #

The directory to which generated haddock documentation should be written.

autogenModulesDir :: LocalBuildInfo -> String #

Deprecated: If you can, use autogenComponentModulesDir instead, but if you really wanted package-global generated modules, use autogenPackageModulesDir. In Cabal 2.0, we avoid using autogenerated files which apply to all components, because the information you often want in these files, e.g., dependency information, is best specified per component, so that reconfiguring a different component (e.g., enabling tests) doesn't force the entire to be rebuilt. autogenPackageModulesDir still provides a place to put files you want to apply to the entire package, but most users of autogenModulesDir should seriously consider autogenComponentModulesDir if you really wanted the module to apply to one component.

The directory in which we put auto-generated modules for EVERY + component in the package. See deprecation notice.

autogenPackageModulesDir :: LocalBuildInfo -> String #

The directory in which we put auto-generated modules for EVERY + component in the package.

autogenComponentModulesDir :: LocalBuildInfo -> ComponentLocalBuildInfo -> String #

The directory in which we put auto-generated modules for a + particular component.

autogenModuleName :: PackageDescription -> ModuleName #

Deprecated: Use autogenPathsModuleName instead

The name of the auto-generated module associated with a package

autogenPathsModuleName :: PackageDescription -> ModuleName #

The name of the auto-generated Paths_* module associated with a package

cppHeaderName :: String #

haddockName :: PackageDescription -> FilePath #

mkGenericStaticLibName :: String -> String #

Create a library name for a static library from a given name. + Prepends lib and appends the static library extension ('.a').

mkLibName :: UnitId -> String #

mkProfLibName :: UnitId -> String #

mkGenericSharedLibName :: Platform -> CompilerId -> String -> String #

Create a library name for a shared lirbary from a given name. + Prepends lib and appends the '-<compilerFlavour><compilerVersion>' + as well as the shared library extension.

mkSharedLibName :: Platform -> CompilerId -> UnitId -> String #

mkStaticLibName :: Platform -> CompilerId -> UnitId -> String #

exeExtension :: Platform -> String #

Default extension for executable files on the current platform. + (typically "" on Unix and "exe" on Windows or OS/2)

objExtension :: String #

Extension for object files. For GHC the extension is "o".

dllExtension :: Platform -> String #

Extension for dynamically linked (or shared) libraries + (typically "so" on Unix and "dll" on Windows)

staticLibExtension :: Platform -> String #

Extension for static libraries

TODO: Here, as well as in dllExtension, it's really the target OS that we're + interested in, not the build OS.

Source files & build directories

getSourceFiles :: Verbosity -> [FilePath] -> [ModuleName] -> IO [(ModuleName, FilePath)] #

getLibSourceFiles :: Verbosity -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO [(ModuleName, FilePath)] #

getExeSourceFiles :: Verbosity -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO [(ModuleName, FilePath)] #

getFLibSourceFiles :: Verbosity -> LocalBuildInfo -> ForeignLib -> ComponentLocalBuildInfo -> IO [(ModuleName, FilePath)] #

exeBuildDir :: LocalBuildInfo -> Executable -> FilePath #

The directory where we put build results for an executable

flibBuildDir :: LocalBuildInfo -> ForeignLib -> FilePath #

The directory where we put build results for a foreign library

diff --git a/doc/API/Cabal/Distribution-Simple-BuildTarget.html b/doc/API/Cabal/Distribution-Simple-BuildTarget.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-BuildTarget.html @@ -0,0 +1,7 @@ +Distribution.Simple.BuildTarget

Cabal-2.4.0.1: A framework for packaging Haskell software

Copyright(c) Duncan Coutts 2012
LicenseBSD-like
Maintainerduncan@community.haskell.org
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.BuildTarget

Contents

Description

Handling for user-specified build targets

Synopsis

Main interface

readTargetInfos :: Verbosity -> PackageDescription -> LocalBuildInfo -> [String] -> IO [TargetInfo] #

Take a list of String build targets, and parse and validate them + into actual TargetInfos to be builtregisteredwhatever.

readBuildTargets :: Verbosity -> PackageDescription -> [String] -> IO [BuildTarget] #

Read a list of user-supplied build target strings and resolve them to + BuildTargets according to a PackageDescription. If there are problems + with any of the targets e.g. they don't exist or are misformatted, throw an + IOException.

Build targets

data BuildTarget #

A fully resolved build target.

Constructors

BuildTargetComponent ComponentName

A specific component

BuildTargetModule ComponentName ModuleName

A specific module within a specific component.

BuildTargetFile ComponentName FilePath

A specific file within a specific component.

Instances
Eq BuildTarget # 
Instance details

Defined in Distribution.Simple.BuildTarget

Methods

(==) :: BuildTarget -> BuildTarget -> Bool #

(/=) :: BuildTarget -> BuildTarget -> Bool #

Show BuildTarget # 
Instance details

Defined in Distribution.Simple.BuildTarget

Methods

showsPrec :: Int -> BuildTarget -> ShowS #

show :: BuildTarget -> String #

showList :: [BuildTarget] -> ShowS #

Generic BuildTarget # 
Instance details

Defined in Distribution.Simple.BuildTarget

Associated Types

type Rep BuildTarget :: * -> * #

Methods

from :: BuildTarget -> Rep BuildTarget x #

to :: Rep BuildTarget x -> BuildTarget #

Binary BuildTarget # 
Instance details

Defined in Distribution.Simple.BuildTarget

Methods

put :: BuildTarget -> Put #

get :: Get BuildTarget #

putList :: [BuildTarget] -> Put #

type Rep BuildTarget # 
Instance details

Defined in Distribution.Simple.BuildTarget

type Rep BuildTarget = D1 (MetaData "BuildTarget" "Distribution.Simple.BuildTarget" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "BuildTargetComponent" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName)) :+: (C1 (MetaCons "BuildTargetModule" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleName)) :+: C1 (MetaCons "BuildTargetFile" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath))))

showBuildTarget :: PackageId -> BuildTarget -> String #

Unambiguously render a BuildTarget, so that it can + be parsed in all situations.

data QualLevel #

Constructors

QL1 
QL2 
QL3 
Instances
Enum QualLevel # 
Instance details

Defined in Distribution.Simple.BuildTarget

Methods

succ :: QualLevel -> QualLevel #

pred :: QualLevel -> QualLevel #

toEnum :: Int -> QualLevel #

fromEnum :: QualLevel -> Int #

enumFrom :: QualLevel -> [QualLevel] #

enumFromThen :: QualLevel -> QualLevel -> [QualLevel] #

enumFromTo :: QualLevel -> QualLevel -> [QualLevel] #

enumFromThenTo :: QualLevel -> QualLevel -> QualLevel -> [QualLevel] #

Show QualLevel # 
Instance details

Defined in Distribution.Simple.BuildTarget

Methods

showsPrec :: Int -> QualLevel -> ShowS #

show :: QualLevel -> String #

showList :: [QualLevel] -> ShowS #

buildTargetComponentName :: BuildTarget -> ComponentName #

Parsing user build targets

data UserBuildTarget #

Various ways that a user may specify a build target.

Instances
Eq UserBuildTarget # 
Instance details

Defined in Distribution.Simple.BuildTarget

Methods

(==) :: UserBuildTarget -> UserBuildTarget -> Bool #

(/=) :: UserBuildTarget -> UserBuildTarget -> Bool #

Ord UserBuildTarget # 
Instance details

Defined in Distribution.Simple.BuildTarget

Methods

compare :: UserBuildTarget -> UserBuildTarget -> Ordering #

(<) :: UserBuildTarget -> UserBuildTarget -> Bool #

(<=) :: UserBuildTarget -> UserBuildTarget -> Bool #

(>) :: UserBuildTarget -> UserBuildTarget -> Bool #

(>=) :: UserBuildTarget -> UserBuildTarget -> Bool #

max :: UserBuildTarget -> UserBuildTarget -> UserBuildTarget #

min :: UserBuildTarget -> UserBuildTarget -> UserBuildTarget #

Show UserBuildTarget # 
Instance details

Defined in Distribution.Simple.BuildTarget

Methods

showsPrec :: Int -> UserBuildTarget -> ShowS #

show :: UserBuildTarget -> String #

showList :: [UserBuildTarget] -> ShowS #

readUserBuildTargets :: [String] -> ([UserBuildTargetProblem], [UserBuildTarget]) #

showUserBuildTarget :: UserBuildTarget -> String #

data UserBuildTargetProblem #

Constructors

UserBuildTargetUnrecognised String 
Instances
Show UserBuildTargetProblem # 
Instance details

Defined in Distribution.Simple.BuildTarget

Methods

showsPrec :: Int -> UserBuildTargetProblem -> ShowS #

show :: UserBuildTargetProblem -> String #

showList :: [UserBuildTargetProblem] -> ShowS #

reportUserBuildTargetProblems :: Verbosity -> [UserBuildTargetProblem] -> IO () #

Resolving build targets

resolveBuildTargets :: PackageDescription -> [(UserBuildTarget, Bool)] -> ([BuildTargetProblem], [BuildTarget]) #

Given a bunch of user-specified targets, try to resolve what it is they + refer to.

data BuildTargetProblem #

Constructors

BuildTargetExpected UserBuildTarget [String] String
expected thing
(actually got)
BuildTargetNoSuch UserBuildTarget [(String, String)]
(no such thing, actually got)
BuildTargetAmbiguous UserBuildTarget [(UserBuildTarget, BuildTarget)] 
Instances
Show BuildTargetProblem # 
Instance details

Defined in Distribution.Simple.BuildTarget

Methods

showsPrec :: Int -> BuildTargetProblem -> ShowS #

show :: BuildTargetProblem -> String #

showList :: [BuildTargetProblem] -> ShowS #

reportBuildTargetProblems :: Verbosity -> [BuildTargetProblem] -> IO () #

diff --git a/doc/API/Cabal/Distribution-Simple-BuildToolDepends.html b/doc/API/Cabal/Distribution-Simple-BuildToolDepends.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-BuildToolDepends.html @@ -0,0 +1,22 @@ +Distribution.Simple.BuildToolDepends

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.BuildToolDepends

Description

This modules provides functions for working with both the legacy + "build-tools" field, and its replacement, "build-tool-depends". Prefer using + the functions contained to access those fields directly.

Synopsis

Documentation

desugarBuildTool :: PackageDescription -> LegacyExeDependency -> Maybe ExeDependency #

Desugar a "build-tools" entry into proper a executable dependency if + possible.

An entry can be so desguared in two cases:

  1. The name in build-tools matches a locally defined executable. The + executable dependency produced is on that exe in the current package.
  2. The name in build-tools matches a hard-coded set of known tools. For now, + the executable dependency produced is one an executable in a package of + the same, but the hard-coding could just as well be per-key.

The first cases matches first.

getAllToolDependencies :: PackageDescription -> BuildInfo -> [ExeDependency] #

Get everything from "build-tool-depends", along with entries from + "build-tools" that we know how to desugar.

This should almost always be used instead of just accessing the + buildToolDepends field directly.

isInternal :: PackageDescription -> ExeDependency -> Bool #

Does the given executable dependency map to this current package?

This is a tiny function, but used in a number of places.

This function is only sound to call on BuildInfos from the given package + description. This is because it just filters the package names of each + dependency, and does not check whether version bounds in fact exclude the + current package, or the referenced components in fact exist in the current + package.

This is OK because when a package is loaded, it is checked (in + Check) that dependencies matching internal components + do indeed have version bounds accepting the current package, and any + depended-on component in the current package actually exists. In fact this + check is performed by gathering the internal tool dependencies of each + component of the package according to this module, and ensuring those + properties on each so-gathered dependency.

version bounds and components of the package are unchecked. This is because + we sanitize exe deps so that the matching name implies these other + conditions.

getAllInternalToolDependencies :: PackageDescription -> BuildInfo -> [UnqualComponentName] #

Get internal "build-tool-depends", along with internal "build-tools"

This is a tiny function, but used in a number of places. The same + restrictions that apply to isInternal also apply to this function.

diff --git a/doc/API/Cabal/Distribution-Simple-CCompiler.html b/doc/API/Cabal/Distribution-Simple-CCompiler.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-CCompiler.html @@ -0,0 +1,10 @@ +Distribution.Simple.CCompiler

Cabal-2.4.0.1: A framework for packaging Haskell software

Copyright2011 Dan Knapp
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.CCompiler

Description

This simple package provides types and functions for interacting with + C compilers. Currently it's just a type enumerating extant C-like + languages, which we call dialects.

Synopsis

Documentation

data CDialect #

Represents a dialect of C. The Monoid instance expresses backward + compatibility, in the sense that 'mappend a b' is the least inclusive + dialect which both a and b can be correctly interpreted as.

Constructors

C 
ObjectiveC 
CPlusPlus 
ObjectiveCPlusPlus 
Instances
Eq CDialect # 
Instance details

Defined in Distribution.Simple.CCompiler

Methods

(==) :: CDialect -> CDialect -> Bool #

(/=) :: CDialect -> CDialect -> Bool #

Show CDialect # 
Instance details

Defined in Distribution.Simple.CCompiler

Methods

showsPrec :: Int -> CDialect -> ShowS #

show :: CDialect -> String #

showList :: [CDialect] -> ShowS #

Semigroup CDialect # 
Instance details

Defined in Distribution.Simple.CCompiler

Methods

(<>) :: CDialect -> CDialect -> CDialect #

sconcat :: NonEmpty CDialect -> CDialect #

stimes :: Integral b => b -> CDialect -> CDialect #

Monoid CDialect # 
Instance details

Defined in Distribution.Simple.CCompiler

Methods

mempty :: CDialect #

mappend :: CDialect -> CDialect -> CDialect #

mconcat :: [CDialect] -> CDialect #

cSourceExtensions :: [String] #

A list of all file extensions which are recognized as possibly containing + some dialect of C code. Note that this list is only for source files, + not for header files.

cDialectFilenameExtension :: CDialect -> Bool -> String #

Takes a dialect of C and whether code is intended to be passed through + the preprocessor, and returns a filename extension for containing that + code.

filenameCDialect :: String -> Maybe (CDialect, Bool) #

Infers from a filename's extension the dialect of C which it contains, + and whether it is intended to be passed through the preprocessor.

diff --git a/doc/API/Cabal/Distribution-Simple-Command.html b/doc/API/Cabal/Distribution-Simple-Command.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Command.html @@ -0,0 +1,27 @@ +Distribution.Simple.Command

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightDuncan Coutts 2007
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilitynon-portable (ExistentialQuantification)
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Command

Contents

Description

This is to do with command line handling. The Cabal command line is + organised into a number of named sub-commands (much like darcs). The + CommandUI abstraction represents one of these sub-commands, with a name, + description, a set of flags. Commands can be associated with actions and + run. It handles some common stuff automatically, like the --help and + command line completion flags. It is designed to allow other tools make + derived commands. This feature is used heavily in cabal-install.

Synopsis

Command interface

data CommandUI flags #

Constructors

CommandUI 

Fields

commandShowOptions :: CommandUI flags -> flags -> [String] #

Show flags in the standard long option command line format

data CommandParse flags #

Constructors

CommandHelp (String -> String) 
CommandList [String] 
CommandErrors [String] 
CommandReadyToGo flags 
Instances
Functor CommandParse # 
Instance details

Defined in Distribution.Simple.Command

Methods

fmap :: (a -> b) -> CommandParse a -> CommandParse b #

(<$) :: a -> CommandParse b -> CommandParse a #

commandParseArgs #

Arguments

:: CommandUI flags 
-> Bool

Is the command a global or subcommand?

-> [String] 
-> CommandParse (flags -> flags, [String]) 

Parse a bunch of command line arguments

getNormalCommandDescriptions :: [Command action] -> [(String, String)] #

Helper function for creating globalCommand description

helpCommandUI :: CommandUI () #

Constructing commands

data ShowOrParseArgs #

Constructors

ShowArgs 
ParseArgs 

usageDefault :: String -> String -> String #

Default "usage" documentation text for commands.

usageAlternatives :: String -> [String] -> String -> String #

Create "usage" documentation from a list of parameter + configurations.

mkCommandUI #

Arguments

:: String

name

-> String

synopsis

-> [String]

usage alternatives

-> flags

initial/empty flags

-> (ShowOrParseArgs -> [OptionField flags])

options

-> CommandUI flags 

Make a Command from standard GetOpt options.

hiddenCommand :: Command action -> Command action #

Mark command as hidden. Hidden commands don't show up in the 'progname + help' or 'progname --help' output.

Associating actions with commands

data Command action #

commandAddAction :: CommandUI flags -> (flags -> [String] -> action) -> Command action #

noExtraFlags :: [String] -> IO () #

Utility function, many commands do not accept additional flags. This + action fails with a helpful error message if the user supplies any extra.

Building lists of commands

data CommandType #

Constructors

NormalCommand 
HiddenCommand 

data CommandSpec action #

wraps a CommandUI together with a function that turns it into a Command. + By hiding the type of flags for the UI allows construction of a list of all UIs at the + top level of the program. That list can then be used for generation of manual page + as well as for executing the selected command.

Constructors

CommandSpec (CommandUI flags) (CommandUI flags -> Command action) CommandType 

commandFromSpec :: CommandSpec a -> Command a #

Running commands

commandsRun :: CommandUI a -> [Command action] -> [String] -> CommandParse (a, CommandParse action) #

Option Fields

data OptionField a #

We usually have a data type for storing configuration values, where + every field stores a configuration option, and the user sets + the value either via command line flags or a configuration file. + An individual OptionField models such a field, and we usually + build a list of options associated to a configuration data type.

Constructors

OptionField 

Fields

type Name = String #

Constructing Option Fields

option :: SFlags -> LFlags -> Description -> get -> set -> MkOptDescr get set a -> OptionField a #

Create an option taking a single OptDescr. + No explicit Name is given for the Option, the name is the first LFlag given.

multiOption #

Arguments

:: Name 
-> get 
-> set 
-> [get -> set -> OptDescr a]

MkOptDescr constructors partially + applied to flags and description.

-> OptionField a 

Create an option taking several OptDescrs. + You will have to give the flags and description individually to the + OptDescr constructor.

Liftings & Projections

liftOption :: (b -> a) -> (a -> b -> b) -> OptionField a -> OptionField b #

viewAsFieldDescr :: OptionField a -> FieldDescr a #

to view as a FieldDescr, we sort the list of interfaces (Req > Bool > + Choice > Opt) and consider only the first one.

Option Descriptions

data OptDescr a #

An OptionField takes one or more OptDescrs, describing the command line + interface for the field.

Constructors

ReqArg Description OptFlags ArgPlaceHolder (ReadE (a -> a)) (a -> [String]) 
OptArg Description OptFlags ArgPlaceHolder (ReadE (a -> a)) (a -> a) (a -> [Maybe String]) 
ChoiceOpt [(Description, OptFlags, a -> a, a -> Bool)] 
BoolOpt Description OptFlags OptFlags (Bool -> a -> a) (a -> Maybe Bool) 

type Description = String #

type SFlags = [Char] #

Short command line option strings

type LFlags = [String] #

Long command line option strings

type OptFlags = (SFlags, LFlags) #

type ArgPlaceHolder = String #

OptDescr smart constructors

type MkOptDescr get set a = SFlags -> LFlags -> Description -> get -> set -> OptDescr a #

reqArg :: Monoid b => ArgPlaceHolder -> ReadE b -> (b -> [String]) -> MkOptDescr (a -> b) (b -> a -> a) a #

Create a string-valued command line interface.

reqArg' :: Monoid b => ArgPlaceHolder -> (String -> b) -> (b -> [String]) -> MkOptDescr (a -> b) (b -> a -> a) a #

(String -> a) variant of "reqArg"

optArg :: Monoid b => ArgPlaceHolder -> ReadE b -> b -> (b -> [Maybe String]) -> MkOptDescr (a -> b) (b -> a -> a) a #

Create a string-valued command line interface with a default value.

optArg' :: Monoid b => ArgPlaceHolder -> (Maybe String -> b) -> (b -> [Maybe String]) -> MkOptDescr (a -> b) (b -> a -> a) a #

(String -> a) variant of "optArg"

noArg :: Eq b => b -> MkOptDescr (a -> b) (b -> a -> a) a #

boolOpt :: (b -> Maybe Bool) -> (Bool -> b) -> SFlags -> SFlags -> MkOptDescr (a -> b) (b -> a -> a) a #

boolOpt' :: (b -> Maybe Bool) -> (Bool -> b) -> OptFlags -> OptFlags -> MkOptDescr (a -> b) (b -> a -> a) a #

choiceOpt :: Eq b => [(b, OptFlags, Description)] -> MkOptDescr (a -> b) (b -> a -> a) a #

create a Choice option

choiceOptFromEnum :: (Bounded b, Enum b, Show b, Eq b) => MkOptDescr (a -> b) (b -> a -> a) a #

create a Choice option out of an enumeration type. + As long flags, the Show output is used. As short flags, the first character + which does not conflict with a previous one is used.

diff --git a/doc/API/Cabal/Distribution-Simple-Compiler.html b/doc/API/Cabal/Distribution-Simple-Compiler.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Compiler.html @@ -0,0 +1,40 @@ +Distribution.Simple.Compiler

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2004
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Compiler

Contents

Description

This should be a much more sophisticated abstraction than it is. Currently + it's just a bit of data about the compiler, like its flavour and name and + version. The reason it's just data is because currently it has to be in + Read and Show so it can be saved along with the LocalBuildInfo. The + only interesting bit of info it contains is a mapping between language + extensions and compiler command line flags. This module also defines a + PackageDB type which is used to refer to package databases. Most compilers + only know about a single global package collection but GHC has a global and + per-user one and it lets you create arbitrary other package databases. We do + not yet fully support this latter feature.

Synopsis

Haskell implementations

module Distribution.Compiler

data Compiler #

Constructors

Compiler 

Fields

Instances
Eq Compiler # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

(==) :: Compiler -> Compiler -> Bool #

(/=) :: Compiler -> Compiler -> Bool #

Read Compiler # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

readsPrec :: Int -> ReadS Compiler #

readList :: ReadS [Compiler] #

readPrec :: ReadPrec Compiler #

readListPrec :: ReadPrec [Compiler] #

Show Compiler # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

showsPrec :: Int -> Compiler -> ShowS #

show :: Compiler -> String #

showList :: [Compiler] -> ShowS #

Generic Compiler # 
Instance details

Defined in Distribution.Simple.Compiler

Associated Types

type Rep Compiler :: * -> * #

Methods

from :: Compiler -> Rep Compiler x #

to :: Rep Compiler x -> Compiler #

Binary Compiler # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

put :: Compiler -> Put #

get :: Get Compiler #

putList :: [Compiler] -> Put #

type Rep Compiler # 
Instance details

Defined in Distribution.Simple.Compiler

type Rep Compiler = D1 (MetaData "Compiler" "Distribution.Simple.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Compiler" PrefixI True) ((S1 (MetaSel (Just "compilerId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CompilerId) :*: (S1 (MetaSel (Just "compilerAbiTag") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AbiTag) :*: S1 (MetaSel (Just "compilerCompat") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [CompilerId]))) :*: (S1 (MetaSel (Just "compilerLanguages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Language, Flag)]) :*: (S1 (MetaSel (Just "compilerExtensions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Extension, Maybe Flag)]) :*: S1 (MetaSel (Just "compilerProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map String String))))))

showCompilerId :: Compiler -> String #

showCompilerIdWithAbi :: Compiler -> String #

compilerFlavor :: Compiler -> CompilerFlavor #

compilerVersion :: Compiler -> Version #

compilerCompatFlavor :: CompilerFlavor -> Compiler -> Bool #

Is this compiler compatible with the compiler flavour we're interested in?

For example this checks if the compiler is actually GHC or is another + compiler that claims to be compatible with some version of GHC, e.g. GHCJS.

if compilerCompatFlavor GHC compiler then ... else ...

compilerCompatVersion :: CompilerFlavor -> Compiler -> Maybe Version #

Is this compiler compatible with the compiler flavour we're interested in, + and if so what version does it claim to be compatible with.

For example this checks if the compiler is actually GHC-7.x or is another + compiler that claims to be compatible with some GHC-7.x version.

case compilerCompatVersion GHC compiler of
+  Just (Version (7:_)) -> ...
+  _                    -> ...

compilerInfo :: Compiler -> CompilerInfo #

Support for package databases

data PackageDB #

Some compilers have a notion of a database of available packages. + For some there is just one global db of packages, other compilers + support a per-user or an arbitrary db specified at some location in + the file system. This can be used to build isloated environments of + packages, for example to build a collection of related packages + without installing them globally.

Constructors

GlobalPackageDB 
UserPackageDB 
SpecificPackageDB FilePath 
Instances
Eq PackageDB # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

(==) :: PackageDB -> PackageDB -> Bool #

(/=) :: PackageDB -> PackageDB -> Bool #

Ord PackageDB # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

compare :: PackageDB -> PackageDB -> Ordering #

(<) :: PackageDB -> PackageDB -> Bool #

(<=) :: PackageDB -> PackageDB -> Bool #

(>) :: PackageDB -> PackageDB -> Bool #

(>=) :: PackageDB -> PackageDB -> Bool #

max :: PackageDB -> PackageDB -> PackageDB #

min :: PackageDB -> PackageDB -> PackageDB #

Read PackageDB # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

readsPrec :: Int -> ReadS PackageDB #

readList :: ReadS [PackageDB] #

readPrec :: ReadPrec PackageDB #

readListPrec :: ReadPrec [PackageDB] #

Show PackageDB # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

showsPrec :: Int -> PackageDB -> ShowS #

show :: PackageDB -> String #

showList :: [PackageDB] -> ShowS #

Generic PackageDB # 
Instance details

Defined in Distribution.Simple.Compiler

Associated Types

type Rep PackageDB :: * -> * #

Methods

from :: PackageDB -> Rep PackageDB x #

to :: Rep PackageDB x -> PackageDB #

Binary PackageDB # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

put :: PackageDB -> Put #

get :: Get PackageDB #

putList :: [PackageDB] -> Put #

type Rep PackageDB # 
Instance details

Defined in Distribution.Simple.Compiler

type Rep PackageDB = D1 (MetaData "PackageDB" "Distribution.Simple.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "GlobalPackageDB" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "UserPackageDB" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SpecificPackageDB" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath))))

type PackageDBStack = [PackageDB] #

We typically get packages from several databases, and stack them + together. This type lets us be explicit about that stacking. For example + typical stacks include:

[GlobalPackageDB]
+[GlobalPackageDB, UserPackageDB]
+[GlobalPackageDB, SpecificPackageDB "package.conf.inplace"]

Note that the GlobalPackageDB is invariably at the bottom since it + contains the rts, base and other special compiler-specific packages.

We are not restricted to using just the above combinations. In particular + we can use several custom package dbs and the user package db together.

When it comes to writing, the top most (last) package is used.

registrationPackageDB :: PackageDBStack -> PackageDB #

Return the package that we should register into. This is the package db at + the top of the stack.

absolutePackageDBPaths :: PackageDBStack -> NoCallStackIO PackageDBStack #

Make package paths absolute

absolutePackageDBPath :: PackageDB -> NoCallStackIO PackageDB #

Support for optimisation levels

data OptimisationLevel #

Some compilers support optimising. Some have different levels. + For compilers that do not the level is just capped to the level + they do support.

Constructors

NoOptimisation 
NormalOptimisation 
MaximumOptimisation 
Instances
Bounded OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

minBound :: OptimisationLevel #

maxBound :: OptimisationLevel #

Enum OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

succ :: OptimisationLevel -> OptimisationLevel #

pred :: OptimisationLevel -> OptimisationLevel #

toEnum :: Int -> OptimisationLevel #

fromEnum :: OptimisationLevel -> Int #

enumFrom :: OptimisationLevel -> [OptimisationLevel] #

enumFromThen :: OptimisationLevel -> OptimisationLevel -> [OptimisationLevel] #

enumFromTo :: OptimisationLevel -> OptimisationLevel -> [OptimisationLevel] #

enumFromThenTo :: OptimisationLevel -> OptimisationLevel -> OptimisationLevel -> [OptimisationLevel] #

Eq OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

(==) :: OptimisationLevel -> OptimisationLevel -> Bool #

(/=) :: OptimisationLevel -> OptimisationLevel -> Bool #

Read OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

readsPrec :: Int -> ReadS OptimisationLevel #

readList :: ReadS [OptimisationLevel] #

readPrec :: ReadPrec OptimisationLevel #

readListPrec :: ReadPrec [OptimisationLevel] #

Show OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

showsPrec :: Int -> OptimisationLevel -> ShowS #

show :: OptimisationLevel -> String #

showList :: [OptimisationLevel] -> ShowS #

Generic OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Associated Types

type Rep OptimisationLevel :: * -> * #

Methods

from :: OptimisationLevel -> Rep OptimisationLevel x #

to :: Rep OptimisationLevel x -> OptimisationLevel #

Binary OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

put :: OptimisationLevel -> Put #

get :: Get OptimisationLevel #

putList :: [OptimisationLevel] -> Put #

type Rep OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

type Rep OptimisationLevel = D1 (MetaData "OptimisationLevel" "Distribution.Simple.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "NoOptimisation" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "NormalOptimisation" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MaximumOptimisation" PrefixI False) (U1 :: * -> *)))

flagToOptimisationLevel :: Maybe String -> OptimisationLevel #

Support for debug info levels

data DebugInfoLevel #

Some compilers support emitting debug info. Some have different + levels. For compilers that do not the level is just capped to the + level they do support.

Constructors

NoDebugInfo 
MinimalDebugInfo 
NormalDebugInfo 
MaximalDebugInfo 
Instances
Bounded DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

minBound :: DebugInfoLevel #

maxBound :: DebugInfoLevel #

Enum DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

succ :: DebugInfoLevel -> DebugInfoLevel #

pred :: DebugInfoLevel -> DebugInfoLevel #

toEnum :: Int -> DebugInfoLevel #

fromEnum :: DebugInfoLevel -> Int #

enumFrom :: DebugInfoLevel -> [DebugInfoLevel] #

enumFromThen :: DebugInfoLevel -> DebugInfoLevel -> [DebugInfoLevel] #

enumFromTo :: DebugInfoLevel -> DebugInfoLevel -> [DebugInfoLevel] #

enumFromThenTo :: DebugInfoLevel -> DebugInfoLevel -> DebugInfoLevel -> [DebugInfoLevel] #

Eq DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

(==) :: DebugInfoLevel -> DebugInfoLevel -> Bool #

(/=) :: DebugInfoLevel -> DebugInfoLevel -> Bool #

Read DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

readsPrec :: Int -> ReadS DebugInfoLevel #

readList :: ReadS [DebugInfoLevel] #

readPrec :: ReadPrec DebugInfoLevel #

readListPrec :: ReadPrec [DebugInfoLevel] #

Show DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

showsPrec :: Int -> DebugInfoLevel -> ShowS #

show :: DebugInfoLevel -> String #

showList :: [DebugInfoLevel] -> ShowS #

Generic DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Associated Types

type Rep DebugInfoLevel :: * -> * #

Methods

from :: DebugInfoLevel -> Rep DebugInfoLevel x #

to :: Rep DebugInfoLevel x -> DebugInfoLevel #

Binary DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

put :: DebugInfoLevel -> Put #

get :: Get DebugInfoLevel #

putList :: [DebugInfoLevel] -> Put #

type Rep DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

type Rep DebugInfoLevel = D1 (MetaData "DebugInfoLevel" "Distribution.Simple.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "NoDebugInfo" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MinimalDebugInfo" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "NormalDebugInfo" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MaximalDebugInfo" PrefixI False) (U1 :: * -> *)))

flagToDebugInfoLevel :: Maybe String -> DebugInfoLevel #

Support for language extensions

type Flag = String #

languageToFlags :: Compiler -> Maybe Language -> [Flag] #

unsupportedLanguages :: Compiler -> [Language] -> [Language] #

extensionsToFlags :: Compiler -> [Extension] -> [Flag] #

For the given compiler, return the flags for the supported extensions.

unsupportedExtensions :: Compiler -> [Extension] -> [Extension] #

For the given compiler, return the extensions it does not support.

parmakeSupported :: Compiler -> Bool #

Does this compiler support parallel --make mode?

reexportedModulesSupported :: Compiler -> Bool #

Does this compiler support reexported-modules?

renamingPackageFlagsSupported :: Compiler -> Bool #

Does this compiler support thinning/renaming on package flags?

unifiedIPIDRequired :: Compiler -> Bool #

Does this compiler have unified IPIDs (so no package keys)

packageKeySupported :: Compiler -> Bool #

Does this compiler support package keys?

unitIdSupported :: Compiler -> Bool #

Does this compiler support unit IDs?

coverageSupported :: Compiler -> Bool #

Does this compiler support Haskell program coverage?

profilingSupported :: Compiler -> Bool #

Does this compiler support profiling?

backpackSupported :: Compiler -> Bool #

Does this compiler support Backpack?

arResponseFilesSupported :: Compiler -> Bool #

Does this compiler's "ar" command supports response file + arguments (i.e. @file-style arguments).

libraryDynDirSupported :: Compiler -> Bool #

Does this compiler support a package database entry with: + "dynamic-library-dirs"?

Support for profiling detail levels

data ProfDetailLevel #

Some compilers (notably GHC) support profiling and can instrument + programs so the system can account costs to different functions. There are + different levels of detail that can be used for this accounting. + For compilers that do not support this notion or the particular detail + levels, this is either ignored or just capped to some similar level + they do support.

Constructors

ProfDetailNone 
ProfDetailDefault 
ProfDetailExportedFunctions 
ProfDetailToplevelFunctions 
ProfDetailAllFunctions 
ProfDetailOther String 
Instances
Eq ProfDetailLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

(==) :: ProfDetailLevel -> ProfDetailLevel -> Bool #

(/=) :: ProfDetailLevel -> ProfDetailLevel -> Bool #

Read ProfDetailLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

readsPrec :: Int -> ReadS ProfDetailLevel #

readList :: ReadS [ProfDetailLevel] #

readPrec :: ReadPrec ProfDetailLevel #

readListPrec :: ReadPrec [ProfDetailLevel] #

Show ProfDetailLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

showsPrec :: Int -> ProfDetailLevel -> ShowS #

show :: ProfDetailLevel -> String #

showList :: [ProfDetailLevel] -> ShowS #

Generic ProfDetailLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Associated Types

type Rep ProfDetailLevel :: * -> * #

Methods

from :: ProfDetailLevel -> Rep ProfDetailLevel x #

to :: Rep ProfDetailLevel x -> ProfDetailLevel #

Binary ProfDetailLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

put :: ProfDetailLevel -> Put #

get :: Get ProfDetailLevel #

putList :: [ProfDetailLevel] -> Put #

type Rep ProfDetailLevel # 
Instance details

Defined in Distribution.Simple.Compiler

type Rep ProfDetailLevel = D1 (MetaData "ProfDetailLevel" "Distribution.Simple.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "ProfDetailNone" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ProfDetailDefault" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ProfDetailExportedFunctions" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "ProfDetailToplevelFunctions" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ProfDetailAllFunctions" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ProfDetailOther" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))))

knownProfDetailLevels :: [(String, [String], ProfDetailLevel)] #

flagToProfDetailLevel :: String -> ProfDetailLevel #

showProfDetailLevel :: ProfDetailLevel -> String #

diff --git a/doc/API/Cabal/Distribution-Simple-Configure.html b/doc/API/Cabal/Distribution-Simple-Configure.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Configure.html @@ -0,0 +1,94 @@ +Distribution.Simple.Configure

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2005
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Configure

Description

This deals with the configure phase. It provides the configure action + which is given the package description and configure flags. It then tries + to: configure the compiler; resolves any conditionals in the package + description; resolve the package dependencies; check if all the extensions + used by this package are supported by the compiler; check that all the build + tools are available (including version checks if appropriate); checks for + any required pkg-config packages (updating the BuildInfo with the + results)

Then based on all this it saves the info in the LocalBuildInfo and writes + it out to the dist/setup-config file. It also displays various details to + the user, the amount of information displayed depending on the verbosity + level.

Synopsis

Documentation

configure :: (GenericPackageDescription, HookedBuildInfo) -> ConfigFlags -> IO LocalBuildInfo #

Perform the "./setup configure" action. + Returns the .setup-config file.

writePersistBuildConfig #

Arguments

:: FilePath

The dist directory path.

-> LocalBuildInfo

The LocalBuildInfo to write.

-> NoCallStackIO () 

After running configure, output the LocalBuildInfo to the + localBuildInfoFile.

getConfigStateFile #

Arguments

:: FilePath

The file path of the setup-config file.

-> IO LocalBuildInfo 

Read the localBuildInfoFile. Throw an exception if the file is + missing, if the file cannot be read, or if the file was created by an older + version of Cabal.

getPersistBuildConfig #

Arguments

:: FilePath

The dist directory path.

-> IO LocalBuildInfo 

Read the localBuildInfoFile. Throw an exception if the file is + missing, if the file cannot be read, or if the file was created by an older + version of Cabal.

checkPersistBuildConfigOutdated :: FilePath -> FilePath -> NoCallStackIO Bool #

Check that localBuildInfoFile is up-to-date with respect to the + .cabal file.

tryGetPersistBuildConfig #

Arguments

:: FilePath

The dist directory path.

-> IO (Either ConfigStateFileError LocalBuildInfo) 

Try to read the localBuildInfoFile.

maybeGetPersistBuildConfig #

Arguments

:: FilePath

The dist directory path.

-> IO (Maybe LocalBuildInfo) 

Try to read the localBuildInfoFile.

findDistPref #

Arguments

:: FilePath

default "dist" prefix

-> Flag FilePath

override "dist" prefix

-> NoCallStackIO FilePath 

Return the "dist/" prefix, or the default prefix. The prefix is taken + from (in order of highest to lowest preference) the override prefix, the + "CABAL_BUILDDIR" environment variable, or the default prefix.

findDistPrefOrDefault #

Arguments

:: Flag FilePath

override "dist" prefix

-> NoCallStackIO FilePath 

Return the "dist/" prefix, or the default prefix. The prefix is taken + from (in order of highest to lowest preference) the override prefix, the + "CABAL_BUILDDIR" environment variable, or defaultDistPref is used. Call + this function to resolve a *DistPref flag whenever it is not known to be + set. (The *DistPref flags are always set to a definite value before + invoking UserHooks.)

getInternalPackages :: GenericPackageDescription -> Map PackageName (Maybe UnqualComponentName) #

Create a PackageIndex that makes *any libraries that might be* + defined internally to this package look like installed packages, in + case an executable should refer to any of them as dependencies.

It must be *any libraries that might be* defined rather than the + actual definitions, because these depend on conditionals in the .cabal + file, and we haven't resolved them yet. finalizePD + does the resolution of conditionals, and it takes internalPackageSet + as part of its input.

computeComponentId :: Bool -> Flag String -> Flag ComponentId -> PackageIdentifier -> ComponentName -> Maybe ([ComponentId], FlagAssignment) -> ComponentId #

This method computes a default, "good enough" ComponentId + for a package. The intent is that cabal-install (or the user) will + specify a more detailed IPID via the --ipid flag if necessary.

computeCompatPackageKey :: Compiler -> MungedPackageName -> Version -> UnitId -> String #

In GHC 8.0, the string we pass to GHC to use for symbol + names for a package can be an arbitrary, IPID-compatible string. + However, prior to GHC 8.0 there are some restrictions on what + format this string can be (due to how ghc-pkg parsed the key):

  1. In GHC 7.10, the string had either be of the form + foo_ABCD, where foo is a non-semantic alphanumeric/hyphenated + prefix and ABCD is two base-64 encoded 64-bit integers, + or a GHC 7.8 style identifier.
  2. In GHC 7.8, the string had to be a valid package identifier + like foo-0.1.

So, the problem is that Cabal, in general, has a general IPID, + but needs to figure out a package key / package ID that the + old ghc-pkg will actually accept. But there's an EVERY WORSE + problem: if ghc-pkg decides to parse an identifier foo-0.1-xxx + as if it were a package identifier, which means it will SILENTLY + DROP the "xxx" (because it's a tag, and Cabal does not allow tags.) + So we must CONNIVE to ensure that we don't pick something that + looks like this.

So this function attempts to define a mapping into the old formats.

The mapping for GHC 7.8 and before:

  • We use the *compatibility* package name and version. For + public libraries this is just the package identifier; for + internal libraries, it's something like "z-pkgname-z-libname-0.1". + See computeCompatPackageName for more details.

The mapping for GHC 7.10:

  • For CLibName: + If the IPID is of the form foo-0.1-ABCDEF where foo_ABCDEF would + validly parse as a package key, we pass ABCDEF. (NB: not + all hashes parse this way, because GHC 7.10 mandated that + these hashes be two base-62 encoded 64 bit integers), + but hashes that Cabal generated using computeComponentId + are guaranteed to have this form.

    If it is not of this form, we rehash the IPID into the +correct form and pass that.

  • For sub-components, we rehash the IPID into the correct format + and pass that.

computeCompatPackageName :: PackageName -> Maybe UnqualComponentName -> MungedPackageName #

Computes the package name for a library. If this is the public + library, it will just be the original package name; otherwise, + it will be a munged package name recording the original package + name as well as the name of the internal library.

A lot of tooling in the Haskell ecosystem assumes that if something + is installed to the package database with the package name foo, + then it actually is an entry for the (only public) library in package + foo. With internal packages, this is not necessarily true: + a public library as well as arbitrarily many internal libraries may + come from the same package. To prevent tools from getting confused + in this case, the package name of these internal libraries is munged + so that they do not conflict the public library proper. A particular + case where this matters is ghc-pkg: if we don't munge the package + name, the inplace registration will OVERRIDE a different internal + library.

We munge into a reserved namespace, "z-", and encode both the + component name and the package name of an internal library using the + following format:

compat-pkg-name ::= "z-" package-name "-z-" library-name

where package-name and library-name have "-" ( "z" + ) "-" + segments encoded by adding an extra "z".

When we have the public library, the compat-pkg-name is just the + package-name, no surprises there!

localBuildInfoFile #

Arguments

:: FilePath

The dist directory path.

-> FilePath 

Get the path of dist/setup-config.

getInstalledPackages #

Arguments

:: Verbosity 
-> Compiler 
-> PackageDBStack

The stack of package databases.

-> ProgramDb 
-> IO InstalledPackageIndex 

List all installed packages in the given package databases.

getInstalledPackagesMonitorFiles :: Verbosity -> Compiler -> PackageDBStack -> ProgramDb -> Platform -> IO [FilePath] #

A set of files (or directories) that can be monitored to detect when + there might have been a change in the installed packages.

getPackageDBContents :: Verbosity -> Compiler -> PackageDB -> ProgramDb -> IO InstalledPackageIndex #

Like getInstalledPackages, but for a single package DB.

NB: Why isn't this always a fall through to getInstalledPackages? + That is because getInstalledPackages performs some sanity checks + on the package database stack in question. However, when sandboxes + are involved these sanity checks are not desirable.

configCompiler :: Maybe CompilerFlavor -> Maybe FilePath -> Maybe FilePath -> ProgramDb -> Verbosity -> IO (Compiler, ProgramDb) #

Deprecated: configCompiler is deprecated. Use configCompilerEx instead.

configCompilerAux :: ConfigFlags -> IO (Compiler, ProgramDb) #

Deprecated: configCompilerAux is deprecated. Use configCompilerAuxEx instead.

configCompilerEx :: Maybe CompilerFlavor -> Maybe FilePath -> Maybe FilePath -> ProgramDb -> Verbosity -> IO (Compiler, Platform, ProgramDb) #

configCompilerAuxEx :: ConfigFlags -> IO (Compiler, Platform, ProgramDb) #

computeEffectiveProfiling :: ConfigFlags -> (Bool, Bool) #

Compute the effective value of the profiling flags + --enable-library-profiling and --enable-executable-profiling + from the specified ConfigFlags. This may be useful for + external Cabal tools which need to interact with Setup in + a backwards-compatible way: the most predictable mechanism + for enabling profiling across many legacy versions is to + NOT use --enable-profiling and use those two flags instead.

Note that --enable-executable-profiling also affects profiling + of benchmarks and (non-detailed) test suites.

ccLdOptionsBuildInfo :: [String] -> [String] -> BuildInfo #

Makes a BuildInfo from C compiler and linker flags.

This can be used with the output from configuration programs like pkg-config + and similar package-specific programs like mysql-config, freealut-config etc. + For example:

ccflags <- getDbProgramOutput verbosity prog progdb ["--cflags"]
+ldflags <- getDbProgramOutput verbosity prog progdb ["--libs"]
+return (ccldOptionsBuildInfo (words ccflags) (words ldflags))

checkForeignDeps :: PackageDescription -> LocalBuildInfo -> Verbosity -> IO () #

interpretPackageDbFlags :: Bool -> [Maybe PackageDB] -> PackageDBStack #

The user interface specifies the package dbs to use with a combination of + --global, --user and --package-db=global|user|clear|$file. + This function combines the global/user flag and interprets the package-db + flag into a single package db stack.

data ConfigStateFileError #

The errors that can be thrown when reading the setup-config file.

Constructors

ConfigStateFileNoHeader

No header found.

ConfigStateFileBadHeader

Incorrect header.

ConfigStateFileNoParse

Cannot parse file contents.

ConfigStateFileMissing

No file!

ConfigStateFileBadVersion PackageIdentifier PackageIdentifier (Either ConfigStateFileError LocalBuildInfo)

Mismatched version.

Instances
Show ConfigStateFileError # 
Instance details

Defined in Distribution.Simple.Configure

Methods

showsPrec :: Int -> ConfigStateFileError -> ShowS #

show :: ConfigStateFileError -> String #

showList :: [ConfigStateFileError] -> ShowS #

Exception ConfigStateFileError # 
Instance details

Defined in Distribution.Simple.Configure

Methods

toException :: ConfigStateFileError -> SomeException #

fromException :: SomeException -> Maybe ConfigStateFileError #

displayException :: ConfigStateFileError -> String #

tryGetConfigStateFile #

Arguments

:: FilePath

The file path of the setup-config file.

-> IO (Either ConfigStateFileError LocalBuildInfo) 

Read the localBuildInfoFile, returning either an error or the local build + info.

platformDefines :: LocalBuildInfo -> [String] #

diff --git a/doc/API/Cabal/Distribution-Simple-Doctest.html b/doc/API/Cabal/Distribution-Simple-Doctest.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Doctest.html @@ -0,0 +1,1 @@ +Distribution.Simple.Doctest

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightMoritz Angermann 2017
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Doctest

Description

This module deals with the doctest command.

Documentation

doctest :: PackageDescription -> LocalBuildInfo -> [PPSuffixHandler] -> DoctestFlags -> IO () #

diff --git a/doc/API/Cabal/Distribution-Simple-Flag.html b/doc/API/Cabal/Distribution-Simple-Flag.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Flag.html @@ -0,0 +1,6 @@ +Distribution.Simple.Flag

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2004
Duncan Coutts 2007
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Flag

Description

Defines the Flag type and it's Monoid instance, see + http://www.haskell.org/pipermail/cabal-devel/2007-December/001509.html + for an explanation.

Split off from Distribution.Simple.Setup to break import cycles.

Synopsis

Documentation

data Flag a #

All flags are monoids, they come in two flavours:

  1. list flags eg
--ghc-option=foo --ghc-option=bar

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

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

Constructors

Flag a 
NoFlag 
Instances
Functor Flag # 
Instance details

Defined in Distribution.Simple.Flag

Methods

fmap :: (a -> b) -> Flag a -> Flag b #

(<$) :: a -> Flag b -> Flag a #

Applicative Flag # 
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 #

Bounded a => Bounded (Flag a) # 
Instance details

Defined in Distribution.Simple.Flag

Methods

minBound :: Flag a #

maxBound :: Flag a #

Enum a => Enum (Flag a) # 
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] #

Eq a => Eq (Flag a) # 
Instance details

Defined in Distribution.Simple.Flag

Methods

(==) :: Flag a -> Flag a -> Bool #

(/=) :: Flag a -> Flag a -> Bool #

Read a => Read (Flag a) # 
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) # 
Instance details

Defined in Distribution.Simple.Flag

Methods

showsPrec :: Int -> Flag a -> ShowS #

show :: Flag a -> String #

showList :: [Flag a] -> ShowS #

Generic (Flag a) # 
Instance details

Defined in Distribution.Simple.Flag

Associated Types

type Rep (Flag a) :: * -> * #

Methods

from :: Flag a -> Rep (Flag a) x #

to :: Rep (Flag a) x -> Flag a #

Semigroup (Flag a) # 
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 #

Monoid (Flag a) # 
Instance details

Defined in Distribution.Simple.Flag

Methods

mempty :: Flag a #

mappend :: Flag a -> Flag a -> Flag a #

mconcat :: [Flag a] -> Flag a #

Binary a => Binary (Flag a) # 
Instance details

Defined in Distribution.Simple.Flag

Methods

put :: Flag a -> Put #

get :: Get (Flag a) #

putList :: [Flag a] -> Put #

type Rep (Flag a) # 
Instance details

Defined in Distribution.Simple.Flag

type Rep (Flag a) = D1 (MetaData "Flag" "Distribution.Simple.Flag" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Flag" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)) :+: C1 (MetaCons "NoFlag" PrefixI False) (U1 :: * -> *))

allFlags :: [Flag Bool] -> Flag Bool #

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 #

Types that represent boolean flags.

Minimal complete definition

asBool

Methods

asBool :: a -> Bool #

Instances
BooleanFlag Bool # 
Instance details

Defined in Distribution.Simple.Flag

Methods

asBool :: Bool -> Bool #

diff --git a/doc/API/Cabal/Distribution-Simple-GHC.html b/doc/API/Cabal/Distribution-Simple-GHC.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-GHC.html @@ -0,0 +1,28 @@ +Distribution.Simple.GHC

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2007
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.GHC

Contents

Description

This is a fairly large module. It contains most of the GHC-specific code for + configuring, building and installing packages. It also exports a function + for finding out what packages are already installed. Configuring involves + finding the ghc and ghc-pkg programs, finding what language extensions + this version of ghc supports and returning a Compiler value.

getInstalledPackages involves calling the ghc-pkg program to find out + what packages are installed.

Building is somewhat complex as there is quite a bit of information to take + into account. We have to build libs and programs, possibly for profiling and + shared libs. We have to support building libraries that will be usable by + GHCi and also ghc's -split-objs feature. We have to compile any C files + using ghc. Linking, especially for split-objs is remarkably complex, + partly because there tend to be 1,000's of .o files and this can often be + more than we can pass to the ld or ar programs in one go.

Installing for libs and exes involves finding the right files and copying + them to the right places. One of the more tricky things about this module is + remembering the layout of files in the build directory (which is not + explicitly documented) and thus what search dirs are used for various kinds + of files.

Synopsis

Documentation

getGhcInfo :: Verbosity -> ConfiguredProgram -> IO [(String, String)] #

configure :: Verbosity -> Maybe FilePath -> Maybe FilePath -> ProgramDb -> IO (Compiler, Maybe Platform, ProgramDb) #

getInstalledPackages :: Verbosity -> Compiler -> PackageDBStack -> ProgramDb -> IO InstalledPackageIndex #

Given a package DB stack, return all installed packages.

getInstalledPackagesMonitorFiles :: Verbosity -> Platform -> ProgramDb -> [PackageDB] -> IO [FilePath] #

getPackageDBContents :: Verbosity -> PackageDB -> ProgramDb -> IO InstalledPackageIndex #

Given a single package DB, return all installed packages.

buildLib :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO () #

buildFLib :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> ForeignLib -> ComponentLocalBuildInfo -> IO () #

Build a foreign library

buildExe :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO () #

Build an executable with GHC.

replLib :: [String] -> Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO () #

replFLib :: [String] -> Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> ForeignLib -> ComponentLocalBuildInfo -> IO () #

replExe :: [String] -> Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO () #

startInterpreter :: Verbosity -> ProgramDb -> Compiler -> Platform -> PackageDBStack -> IO () #

Start a REPL without loading any source files.

installLib #

Arguments

:: Verbosity 
-> LocalBuildInfo 
-> FilePath

install location

-> FilePath

install location for dynamic libraries

-> FilePath

Build location

-> PackageDescription 
-> Library 
-> ComponentLocalBuildInfo 
-> IO () 

Install for ghc, .hi, .a and, if --with-ghci given, .o

installFLib #

Arguments

:: Verbosity 
-> LocalBuildInfo 
-> FilePath

install location

-> FilePath

Build location

-> PackageDescription 
-> ForeignLib 
-> IO () 

Install foreign library for GHC.

installExe #

Arguments

:: Verbosity 
-> LocalBuildInfo 
-> FilePath

Where to copy the files to

-> FilePath

Build location

-> (FilePath, FilePath)

Executable (prefix,suffix)

-> PackageDescription 
-> Executable 
-> IO () 

Install executables for GHC.

libAbiHash :: Verbosity -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO String #

Extracts a String representing a hash of the ABI of a built + library. It can fail if the library has not yet been built.

hcPkgInfo :: ProgramDb -> HcPkgInfo #

registerPackage :: Verbosity -> ProgramDb -> PackageDBStack -> InstalledPackageInfo -> RegisterOptions -> IO () #

componentGhcOptions :: Verbosity -> LocalBuildInfo -> BuildInfo -> ComponentLocalBuildInfo -> FilePath -> GhcOptions #

componentCcGhcOptions :: Verbosity -> LocalBuildInfo -> BuildInfo -> ComponentLocalBuildInfo -> FilePath -> FilePath -> GhcOptions #

getLibDir :: Verbosity -> LocalBuildInfo -> IO FilePath #

isDynamic :: Compiler -> Bool #

getGlobalPackageDB :: Verbosity -> ConfiguredProgram -> IO FilePath #

Return the FilePath to the global GHC package database.

pkgRoot :: Verbosity -> LocalBuildInfo -> PackageDB -> IO FilePath #

Constructing and deconstructing GHC environment files

data GhcEnvironmentFileEntry #

The kinds of entries we can stick in a .ghc.environment file.

Constructors

GhcEnvFileComment String
-- a comment
GhcEnvFilePackageId UnitId
package-id foo-1.0-4fe301a...
GhcEnvFilePackageDb PackageDB

global-package-db, + user-package-db or + package-db blahpackage.conf.d

GhcEnvFileClearPackageDbStack
clear-package-db
Instances
Eq GhcEnvironmentFileEntry # 
Instance details

Defined in Distribution.Simple.GHC.Internal

Methods

(==) :: GhcEnvironmentFileEntry -> GhcEnvironmentFileEntry -> Bool #

(/=) :: GhcEnvironmentFileEntry -> GhcEnvironmentFileEntry -> Bool #

Ord GhcEnvironmentFileEntry # 
Instance details

Defined in Distribution.Simple.GHC.Internal

Methods

compare :: GhcEnvironmentFileEntry -> GhcEnvironmentFileEntry -> Ordering #

(<) :: GhcEnvironmentFileEntry -> GhcEnvironmentFileEntry -> Bool #

(<=) :: GhcEnvironmentFileEntry -> GhcEnvironmentFileEntry -> Bool #

(>) :: GhcEnvironmentFileEntry -> GhcEnvironmentFileEntry -> Bool #

(>=) :: GhcEnvironmentFileEntry -> GhcEnvironmentFileEntry -> Bool #

max :: GhcEnvironmentFileEntry -> GhcEnvironmentFileEntry -> GhcEnvironmentFileEntry #

min :: GhcEnvironmentFileEntry -> GhcEnvironmentFileEntry -> GhcEnvironmentFileEntry #

Show GhcEnvironmentFileEntry # 
Instance details

Defined in Distribution.Simple.GHC.Internal

Methods

showsPrec :: Int -> GhcEnvironmentFileEntry -> ShowS #

show :: GhcEnvironmentFileEntry -> String #

showList :: [GhcEnvironmentFileEntry] -> ShowS #

simpleGhcEnvironmentFile :: PackageDBStack -> [UnitId] -> [GhcEnvironmentFileEntry] #

Make entries for a GHC environment file based on a PackageDBStack and + a bunch of package (unit) ids.

If you need to do anything more complicated then either use this as a basis + and add more entries, or just make all the entries directly.

renderGhcEnvironmentFile :: [GhcEnvironmentFileEntry] -> String #

Render a bunch of GHC environment file entries

writeGhcEnvironmentFile #

Arguments

:: FilePath

directory in which to put it

-> Platform

the GHC target platform

-> Version

the GHC version

-> [GhcEnvironmentFileEntry]

the content

-> NoCallStackIO FilePath 

Write a .ghc.environment-$arch-$os-$ver file in the given directory.

The Platform and GHC Version are needed as part of the file name.

Returns the name of the file written.

ghcPlatformAndVersionString :: Platform -> Version -> String #

GHC's rendering of its platform and compiler version string as used in + certain file locations (such as user package db location). + For example x86_64-linux-7.10.4

readGhcEnvironmentFile :: FilePath -> IO [GhcEnvironmentFileEntry] #

parseGhcEnvironmentFile :: Parser [GhcEnvironmentFileEntry] #

newtype ParseErrorExc #

Constructors

ParseErrorExc ParseError 
Instances
Show ParseErrorExc # 
Instance details

Defined in Distribution.Simple.GHC.EnvironmentParser

Methods

showsPrec :: Int -> ParseErrorExc -> ShowS #

show :: ParseErrorExc -> String #

showList :: [ParseErrorExc] -> ShowS #

Exception ParseErrorExc # 
Instance details

Defined in Distribution.Simple.GHC.EnvironmentParser

Methods

toException :: ParseErrorExc -> SomeException #

fromException :: SomeException -> Maybe ParseErrorExc #

displayException :: ParseErrorExc -> String #

Version-specific implementation quirks

getImplInfo :: Compiler -> GhcImplInfo #

data GhcImplInfo #

Information about features and quirks of a GHC-based implementation.

Compiler flavors based on GHC behave similarly enough that some of + the support code for them is shared. Every implementation has its + own peculiarities, that may or may not be a direct result of the + underlying GHC version. This record keeps track of these differences.

All shared code (i.e. everything not in the Distribution.Simple.FLAVOR + module) should use implementation info rather than version numbers + to test for supported features.

Constructors

GhcImplInfo 

Fields

diff --git a/doc/API/Cabal/Distribution-Simple-GHCJS.html b/doc/API/Cabal/Distribution-Simple-GHCJS.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-GHCJS.html @@ -0,0 +1,3 @@ +Distribution.Simple.GHCJS

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.GHCJS

Synopsis

Documentation

configure :: Verbosity -> Maybe FilePath -> Maybe FilePath -> ProgramDb -> IO (Compiler, Maybe Platform, ProgramDb) #

getInstalledPackages :: Verbosity -> PackageDBStack -> ProgramDb -> IO InstalledPackageIndex #

Given a package DB stack, return all installed packages.

getPackageDBContents :: Verbosity -> PackageDB -> ProgramDb -> IO InstalledPackageIndex #

Given a single package DB, return all installed packages.

buildLib :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO () #

buildExe :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO () #

replLib :: [String] -> Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO () #

replExe :: [String] -> Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO () #

startInterpreter :: Verbosity -> ProgramDb -> Compiler -> Platform -> PackageDBStack -> IO () #

Start a REPL without loading any source files.

installLib #

Arguments

:: Verbosity 
-> LocalBuildInfo 
-> FilePath

install location

-> FilePath

install location for dynamic libraries

-> FilePath

Build location

-> PackageDescription 
-> Library 
-> ComponentLocalBuildInfo 
-> IO () 

Install for ghc, .hi, .a and, if --with-ghci given, .o

installExe #

Arguments

:: Verbosity 
-> LocalBuildInfo 
-> FilePath

Where to copy the files to

-> FilePath

Build location

-> (FilePath, FilePath)

Executable (prefix,suffix)

-> PackageDescription 
-> Executable 
-> IO () 

libAbiHash :: Verbosity -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO String #

hcPkgInfo :: ProgramDb -> HcPkgInfo #

registerPackage :: Verbosity -> ProgramDb -> PackageDBStack -> InstalledPackageInfo -> RegisterOptions -> IO () #

componentGhcOptions :: Verbosity -> LocalBuildInfo -> BuildInfo -> ComponentLocalBuildInfo -> FilePath -> GhcOptions #

getLibDir :: Verbosity -> LocalBuildInfo -> IO FilePath #

isDynamic :: Compiler -> Bool #

getGlobalPackageDB :: Verbosity -> ConfiguredProgram -> IO FilePath #

Return the FilePath to the global GHC package database.

runCmd :: ProgramDb -> FilePath -> (FilePath, FilePath, [String]) #

Get the JavaScript file name and command and arguments to run a + program compiled by GHCJS + the exe should be the base program name without exe extension

diff --git a/doc/API/Cabal/Distribution-Simple-Glob.html b/doc/API/Cabal/Distribution-Simple-Glob.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Glob.html @@ -0,0 +1,16 @@ +Distribution.Simple.Glob

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones Simon Marlow 2003-2004
LicenseBSD3 + portions Copyright (c) 2007, Galois Inc.
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Glob

Description

Simple file globbing.

Synopsis

Documentation

data GlobSyntaxError #

Constructors

StarInDirectory 
StarInFileName 
StarInExtension 
NoExtensionOnStar 
EmptyGlob 
LiteralFileNameGlobStar 
VersionDoesNotSupportGlobStar 
VersionDoesNotSupportGlob 
Instances
Eq GlobSyntaxError # 
Instance details

Defined in Distribution.Simple.Glob

Methods

(==) :: GlobSyntaxError -> GlobSyntaxError -> Bool #

(/=) :: GlobSyntaxError -> GlobSyntaxError -> Bool #

Show GlobSyntaxError # 
Instance details

Defined in Distribution.Simple.Glob

Methods

showsPrec :: Int -> GlobSyntaxError -> ShowS #

show :: GlobSyntaxError -> String #

showList :: [GlobSyntaxError] -> ShowS #

data GlobResult a #

Constructors

GlobMatch a

The glob matched the value supplied.

GlobWarnMultiDot a

The glob did not match the value supplied because the + cabal-version is too low and the extensions on the file did + not precisely match the glob's extensions, but rather the + glob was a proper suffix of the file's extensions; i.e., if + not for the low cabal-version, it would have matched.

GlobMissingDirectory FilePath

The glob couldn't match because the directory named doesn't + exist. The directory will be as it appears in the glob (i.e., + relative to the directory passed to matchDirFileGlob, and, + for 'data-files', relative to 'data-dir').

Instances
Functor GlobResult # 
Instance details

Defined in Distribution.Simple.Glob

Methods

fmap :: (a -> b) -> GlobResult a -> GlobResult b #

(<$) :: a -> GlobResult b -> GlobResult a #

Eq a => Eq (GlobResult a) # 
Instance details

Defined in Distribution.Simple.Glob

Methods

(==) :: GlobResult a -> GlobResult a -> Bool #

(/=) :: GlobResult a -> GlobResult a -> Bool #

Ord a => Ord (GlobResult a) # 
Instance details

Defined in Distribution.Simple.Glob

Methods

compare :: GlobResult a -> GlobResult a -> Ordering #

(<) :: GlobResult a -> GlobResult a -> Bool #

(<=) :: GlobResult a -> GlobResult a -> Bool #

(>) :: GlobResult a -> GlobResult a -> Bool #

(>=) :: GlobResult a -> GlobResult a -> Bool #

max :: GlobResult a -> GlobResult a -> GlobResult a #

min :: GlobResult a -> GlobResult a -> GlobResult a #

Show a => Show (GlobResult a) # 
Instance details

Defined in Distribution.Simple.Glob

Methods

showsPrec :: Int -> GlobResult a -> ShowS #

show :: GlobResult a -> String #

showList :: [GlobResult a] -> ShowS #

matchDirFileGlob :: Verbosity -> Version -> FilePath -> FilePath -> IO [FilePath] #

This will die' when the glob matches no files, or if the glob + refers to a missing directory, or if the glob fails to parse.

The returned values do not include the supplied dir prefix, which + must itself be a valid directory (hence, it can't be the empty + string).

runDirFileGlob :: Verbosity -> FilePath -> Glob -> IO [GlobResult FilePath] #

Match files against a pre-parsed glob, starting in a directory.

The returned values do not include the supplied dir prefix, which + must itself be a valid directory (hence, it can't be the empty + string).

fileGlobMatches :: Glob -> FilePath -> Maybe (GlobResult FilePath) #

Returns Nothing if the glob didn't match at all, or Just the + result if the glob matched (or would have matched with a higher + cabal-version).

parseFileGlob :: Version -> FilePath -> Either GlobSyntaxError Glob #

explainGlobSyntaxError :: FilePath -> GlobSyntaxError -> String #

data Glob #

diff --git a/doc/API/Cabal/Distribution-Simple-Haddock.html b/doc/API/Cabal/Distribution-Simple-Haddock.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Haddock.html @@ -0,0 +1,5 @@ +Distribution.Simple.Haddock

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2005
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Haddock

Description

This module deals with the haddock and hscolour commands. + It uses information about installed packages (from ghc-pkg) to find the + locations of documentation for dependent packages, so it can create links.

The hscolour support allows generating HTML versions of the original + source, with coloured syntax highlighting.

Synopsis

Documentation

haddock :: PackageDescription -> LocalBuildInfo -> [PPSuffixHandler] -> HaddockFlags -> IO () #

hscolour :: PackageDescription -> LocalBuildInfo -> [PPSuffixHandler] -> HscolourFlags -> IO () #

haddockPackagePaths :: [InstalledPackageInfo] -> Maybe (InstalledPackageInfo -> FilePath) -> NoCallStackIO ([(FilePath, Maybe FilePath, Maybe FilePath)], Maybe String) #

Given a list of InstalledPackageInfos, return a list of interfaces and + HTML paths, and an optional warning for packages with missing documentation.

diff --git a/doc/API/Cabal/Distribution-Simple-HaskellSuite.html b/doc/API/Cabal/Distribution-Simple-HaskellSuite.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-HaskellSuite.html @@ -0,0 +1,1 @@ +Distribution.Simple.HaskellSuite

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.HaskellSuite

Documentation

configure :: Verbosity -> Maybe FilePath -> Maybe FilePath -> ProgramDb -> IO (Compiler, Maybe Platform, ProgramDb) #

hstoolVersion :: Verbosity -> FilePath -> IO (Maybe Version) #

numericVersion :: Verbosity -> FilePath -> IO (Maybe Version) #

getCompilerVersion :: Verbosity -> ConfiguredProgram -> IO (String, Version) #

getExtensions :: Verbosity -> ConfiguredProgram -> IO [(Extension, Maybe Flag)] #

getLanguages :: Verbosity -> ConfiguredProgram -> IO [(Language, Flag)] #

getInstalledPackages :: Verbosity -> PackageDBStack -> ProgramDb -> IO InstalledPackageIndex #

buildLib :: Verbosity -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO () #

installLib #

Arguments

:: Verbosity 
-> LocalBuildInfo 
-> FilePath

install location

-> FilePath

install location for dynamic libraries

-> FilePath

Build location

-> PackageDescription 
-> Library 
-> ComponentLocalBuildInfo 
-> IO () 

registerPackage :: Verbosity -> ProgramDb -> PackageDBStack -> InstalledPackageInfo -> IO () #

initPackageDB :: Verbosity -> ProgramDb -> FilePath -> IO () #

packageDbOpt :: PackageDB -> String #

diff --git a/doc/API/Cabal/Distribution-Simple-Hpc.html b/doc/API/Cabal/Distribution-Simple-Hpc.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Hpc.html @@ -0,0 +1,4 @@ +Distribution.Simple.Hpc

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightThomas Tuegel 2011
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Hpc

Description

This module provides functions for locating various HPC-related paths and + a function for adding the necessary options to a PackageDescription to + build test suites with HPC enabled.

Synopsis

Documentation

data Way #

Constructors

Vanilla 
Prof 
Dyn 
Instances
Bounded Way # 
Instance details

Defined in Distribution.Simple.Hpc

Methods

minBound :: Way #

maxBound :: Way #

Enum Way # 
Instance details

Defined in Distribution.Simple.Hpc

Methods

succ :: Way -> Way #

pred :: Way -> Way #

toEnum :: Int -> Way #

fromEnum :: Way -> Int #

enumFrom :: Way -> [Way] #

enumFromThen :: Way -> Way -> [Way] #

enumFromTo :: Way -> Way -> [Way] #

enumFromThenTo :: Way -> Way -> Way -> [Way] #

Eq Way # 
Instance details

Defined in Distribution.Simple.Hpc

Methods

(==) :: Way -> Way -> Bool #

(/=) :: Way -> Way -> Bool #

Read Way # 
Instance details

Defined in Distribution.Simple.Hpc

Methods

readsPrec :: Int -> ReadS Way #

readList :: ReadS [Way] #

readPrec :: ReadPrec Way #

readListPrec :: ReadPrec [Way] #

Show Way # 
Instance details

Defined in Distribution.Simple.Hpc

Methods

showsPrec :: Int -> Way -> ShowS #

show :: Way -> String #

showList :: [Way] -> ShowS #

guessWay :: LocalBuildInfo -> Way #

Attempt to guess the way the test suites in this package were compiled + and linked with the library so the correct module interfaces are found.

htmlDir #

Arguments

:: FilePath

"dist/" prefix

-> Way 
-> FilePath

Component name

-> FilePath

Path to test suite's HTML markup directory

mixDir #

Arguments

:: FilePath

"dist/" prefix

-> Way 
-> FilePath

Component name

-> FilePath

Directory containing test suite's .mix files

tixDir #

Arguments

:: FilePath

"dist/" prefix

-> Way 
-> FilePath

Component name

-> FilePath

Directory containing test suite's .tix files

tixFilePath #

Arguments

:: FilePath

"dist/" prefix

-> Way 
-> FilePath

Component name

-> FilePath

Path to test suite's .tix file

Path to the .tix file containing a test suite's sum statistics.

markupPackage #

Arguments

:: Verbosity 
-> LocalBuildInfo 
-> FilePath

"dist/" prefix

-> String

Library name

-> [TestSuite] 
-> IO () 

Generate the HTML markup for all of a package's test suites.

markupTest #

Arguments

:: Verbosity 
-> LocalBuildInfo 
-> FilePath

"dist/" prefix

-> String

Library name

-> TestSuite 
-> IO () 

Generate the HTML markup for a test suite.

diff --git a/doc/API/Cabal/Distribution-Simple-Install.html b/doc/API/Cabal/Distribution-Simple-Install.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Install.html @@ -0,0 +1,6 @@ +Distribution.Simple.Install

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2004
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Install

Description

This is the entry point into installing a built package. Performs the + "./setup install" and "./setup copy" actions. It moves files into + place based on the prefix argument. It does the generic bits and then calls + compiler-specific functions to do the rest.

Synopsis

Documentation

install #

Arguments

:: PackageDescription

information from the .cabal file

-> LocalBuildInfo

information from the configure step

-> CopyFlags

flags sent to copy or install

-> IO () 

Perform the "./setup install" and "./setup copy" + actions. Move files into place based on the prefix argument.

This does NOT register libraries, you should call register + to do that.

diff --git a/doc/API/Cabal/Distribution-Simple-InstallDirs.html b/doc/API/Cabal/Distribution-Simple-InstallDirs.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-InstallDirs.html @@ -0,0 +1,39 @@ +Distribution.Simple.InstallDirs

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2004
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.InstallDirs

Description

This manages everything to do with where files get installed (though does + not get involved with actually doing any installation). It provides an + InstallDirs type which is a set of directories for where to install + things. It also handles the fact that we use templates in these install + dirs. For example most install dirs are relative to some $prefix and by + changing the prefix all other dirs still end up changed appropriately. So it + provides a PathTemplate type and functions for substituting for these + templates.

Synopsis

Documentation

data InstallDirs dir #

The directories where we will install files for packages.

We have several different directories for different types of files since + many systems have conventions whereby different types of files in a package + are installed in different directories. This is particularly the case on + Unix style systems.

Constructors

InstallDirs 

Fields

Instances
Functor InstallDirs # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

fmap :: (a -> b) -> InstallDirs a -> InstallDirs b #

(<$) :: a -> InstallDirs b -> InstallDirs a #

Eq dir => Eq (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

(==) :: InstallDirs dir -> InstallDirs dir -> Bool #

(/=) :: InstallDirs dir -> InstallDirs dir -> Bool #

Read dir => Read (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

readsPrec :: Int -> ReadS (InstallDirs dir) #

readList :: ReadS [InstallDirs dir] #

readPrec :: ReadPrec (InstallDirs dir) #

readListPrec :: ReadPrec [InstallDirs dir] #

Show dir => Show (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

showsPrec :: Int -> InstallDirs dir -> ShowS #

show :: InstallDirs dir -> String #

showList :: [InstallDirs dir] -> ShowS #

Generic (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Associated Types

type Rep (InstallDirs dir) :: * -> * #

Methods

from :: InstallDirs dir -> Rep (InstallDirs dir) x #

to :: Rep (InstallDirs dir) x -> InstallDirs dir #

Semigroup dir => Semigroup (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

(<>) :: InstallDirs dir -> InstallDirs dir -> InstallDirs dir #

sconcat :: NonEmpty (InstallDirs dir) -> InstallDirs dir #

stimes :: Integral b => b -> InstallDirs dir -> InstallDirs dir #

(Semigroup dir, Monoid dir) => Monoid (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

mempty :: InstallDirs dir #

mappend :: InstallDirs dir -> InstallDirs dir -> InstallDirs dir #

mconcat :: [InstallDirs dir] -> InstallDirs dir #

Binary dir => Binary (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

put :: InstallDirs dir -> Put #

get :: Get (InstallDirs dir) #

putList :: [InstallDirs dir] -> Put #

type Rep (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

type Rep (InstallDirs dir) = D1 (MetaData "InstallDirs" "Distribution.Simple.InstallDirs" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "InstallDirs" PrefixI True) ((((S1 (MetaSel (Just "prefix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "bindir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir)) :*: (S1 (MetaSel (Just "libdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "libsubdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir))) :*: ((S1 (MetaSel (Just "dynlibdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "flibdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir)) :*: (S1 (MetaSel (Just "libexecdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "libexecsubdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir)))) :*: (((S1 (MetaSel (Just "includedir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "datadir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir)) :*: (S1 (MetaSel (Just "datasubdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "docdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir))) :*: ((S1 (MetaSel (Just "mandir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "htmldir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir)) :*: (S1 (MetaSel (Just "haddockdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "sysconfdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir))))))

type InstallDirTemplates = InstallDirs PathTemplate #

The installation directories in terms of PathTemplates that contain + variables.

The defaults for most of the directories are relative to each other, in + particular they are all relative to a single prefix. This makes it + convenient for the user to override the default installation directory + by only having to specify --prefix=... rather than overriding each + individually. This is done by allowing $-style variables in the dirs. + These are expanded by textual substitution (see substPathTemplate).

A few of these installation directories are split into two components, the + dir and subdir. The full installation path is formed by combining the two + together with /. The reason for this is compatibility with other Unix + build systems which also support --libdir and --datadir. We would like + users to be able to configure --libdir=/usr/lib64 for example but + because by default we want to support installing multiple versions of + packages and building the same package for multiple compilers we append the + libsubdir to get: /usr/lib64/$libname/$compiler.

An additional complication is the need to support relocatable packages on + systems which support such things, like Windows.

defaultInstallDirs :: CompilerFlavor -> Bool -> Bool -> IO InstallDirTemplates #

defaultInstallDirs' :: Bool -> CompilerFlavor -> Bool -> Bool -> IO InstallDirTemplates #

combineInstallDirs :: (a -> b -> c) -> InstallDirs a -> InstallDirs b -> InstallDirs c #

absoluteInstallDirs :: PackageIdentifier -> UnitId -> CompilerInfo -> CopyDest -> Platform -> InstallDirs PathTemplate -> InstallDirs FilePath #

Convert from abstract install directories to actual absolute ones by + substituting for all the variables in the abstract paths, to get real + absolute path.

data CopyDest #

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
Eq CopyDest # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

(==) :: CopyDest -> CopyDest -> Bool #

(/=) :: CopyDest -> CopyDest -> Bool #

Show CopyDest # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

showsPrec :: Int -> CopyDest -> ShowS #

show :: CopyDest -> String #

showList :: [CopyDest] -> ShowS #

Generic CopyDest # 
Instance details

Defined in Distribution.Simple.InstallDirs

Associated Types

type Rep CopyDest :: * -> * #

Methods

from :: CopyDest -> Rep CopyDest x #

to :: Rep CopyDest x -> CopyDest #

Binary CopyDest # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

put :: CopyDest -> Put #

get :: Get CopyDest #

putList :: [CopyDest] -> Put #

type Rep CopyDest # 
Instance details

Defined in Distribution.Simple.InstallDirs

type Rep CopyDest = D1 (MetaData "CopyDest" "Distribution.Simple.InstallDirs" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "NoCopyDest" PrefixI False) (U1 :: * -> *) :+: (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))))

prefixRelativeInstallDirs :: PackageIdentifier -> UnitId -> CompilerInfo -> Platform -> InstallDirTemplates -> InstallDirs (Maybe FilePath) #

Check which of the paths are relative to the installation $prefix.

If any of the paths are not relative, ie they are absolute paths, then it + prevents us from making a relocatable package (also known as a "prefix + independent" package).

substituteInstallDirTemplates :: PathTemplateEnv -> InstallDirTemplates -> InstallDirTemplates #

Substitute the install dir templates into each other.

To prevent cyclic substitutions, only some variables are allowed in + particular dir templates. If out of scope vars are present, they are not + substituted for. Checking for any remaining unsubstituted vars can be done + as a subsequent operation.

The reason it is done this way is so that in prefixRelativeInstallDirs we + can replace prefix with the PrefixVar and get resulting + PathTemplates that still have the PrefixVar in them. Doing this makes it + each to check which paths are relative to the $prefix.

data PathTemplate #

An abstract path, possibly containing variables that need to be + substituted for to get a real FilePath.

Instances
Eq PathTemplate # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

(==) :: PathTemplate -> PathTemplate -> Bool #

(/=) :: PathTemplate -> PathTemplate -> Bool #

Ord PathTemplate # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

compare :: PathTemplate -> PathTemplate -> Ordering #

(<) :: PathTemplate -> PathTemplate -> Bool #

(<=) :: PathTemplate -> PathTemplate -> Bool #

(>) :: PathTemplate -> PathTemplate -> Bool #

(>=) :: PathTemplate -> PathTemplate -> Bool #

max :: PathTemplate -> PathTemplate -> PathTemplate #

min :: PathTemplate -> PathTemplate -> PathTemplate #

Read PathTemplate # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

readsPrec :: Int -> ReadS PathTemplate #

readList :: ReadS [PathTemplate] #

readPrec :: ReadPrec PathTemplate #

readListPrec :: ReadPrec [PathTemplate] #

Show PathTemplate # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

showsPrec :: Int -> PathTemplate -> ShowS #

show :: PathTemplate -> String #

showList :: [PathTemplate] -> ShowS #

Generic PathTemplate # 
Instance details

Defined in Distribution.Simple.InstallDirs

Associated Types

type Rep PathTemplate :: * -> * #

Methods

from :: PathTemplate -> Rep PathTemplate x #

to :: Rep PathTemplate x -> PathTemplate #

Binary PathTemplate # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

put :: PathTemplate -> Put #

get :: Get PathTemplate #

putList :: [PathTemplate] -> Put #

type Rep PathTemplate # 
Instance details

Defined in Distribution.Simple.InstallDirs

type Rep PathTemplate

data PathTemplateVariable #

Constructors

PrefixVar

The $prefix path variable

BindirVar

The $bindir path variable

LibdirVar

The $libdir path variable

LibsubdirVar

The $libsubdir path variable

DynlibdirVar

The $dynlibdir path variable

DatadirVar

The $datadir path variable

DatasubdirVar

The $datasubdir path variable

DocdirVar

The $docdir path variable

HtmldirVar

The $htmldir path variable

PkgNameVar

The $pkg package name path variable

PkgVerVar

The $version package version path variable

PkgIdVar

The $pkgid package Id path variable, eg foo-1.0

LibNameVar

The $libname path variable

CompilerVar

The compiler name and version, eg ghc-6.6.1

OSVar

The operating system name, eg windows or linux

ArchVar

The CPU architecture name, eg i386 or x86_64

AbiVar

The Compiler's ABI identifier, $arch-$os-$compiler-$abitag

AbiTagVar

The optional ABI tag for the compiler

ExecutableNameVar

The executable name; used in shell wrappers

TestSuiteNameVar

The name of the test suite being run

TestSuiteResultVar

The result of the test suite being run, eg + pass, fail, or error.

BenchmarkNameVar

The name of the benchmark being run

Instances
Eq PathTemplateVariable # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

(==) :: PathTemplateVariable -> PathTemplateVariable -> Bool #

(/=) :: PathTemplateVariable -> PathTemplateVariable -> Bool #

Ord PathTemplateVariable # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

compare :: PathTemplateVariable -> PathTemplateVariable -> Ordering #

(<) :: PathTemplateVariable -> PathTemplateVariable -> Bool #

(<=) :: PathTemplateVariable -> PathTemplateVariable -> Bool #

(>) :: PathTemplateVariable -> PathTemplateVariable -> Bool #

(>=) :: PathTemplateVariable -> PathTemplateVariable -> Bool #

max :: PathTemplateVariable -> PathTemplateVariable -> PathTemplateVariable #

min :: PathTemplateVariable -> PathTemplateVariable -> PathTemplateVariable #

Read PathTemplateVariable # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

readsPrec :: Int -> ReadS PathTemplateVariable #

readList :: ReadS [PathTemplateVariable] #

readPrec :: ReadPrec PathTemplateVariable #

readListPrec :: ReadPrec [PathTemplateVariable] #

Show PathTemplateVariable # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

showsPrec :: Int -> PathTemplateVariable -> ShowS #

show :: PathTemplateVariable -> String #

showList :: [PathTemplateVariable] -> ShowS #

Generic PathTemplateVariable # 
Instance details

Defined in Distribution.Simple.InstallDirs

Associated Types

type Rep PathTemplateVariable :: * -> * #

Methods

from :: PathTemplateVariable -> Rep PathTemplateVariable x #

to :: Rep PathTemplateVariable x -> PathTemplateVariable #

Binary PathTemplateVariable # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

put :: PathTemplateVariable -> Put #

get :: Get PathTemplateVariable #

putList :: [PathTemplateVariable] -> Put #

type Rep PathTemplateVariable # 
Instance details

Defined in Distribution.Simple.InstallDirs

type Rep PathTemplateVariable = D1 (MetaData "PathTemplateVariable" "Distribution.Simple.InstallDirs" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((((C1 (MetaCons "PrefixVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BindirVar" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "LibdirVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "LibsubdirVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DynlibdirVar" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "DatadirVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "DatasubdirVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DocdirVar" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "HtmldirVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "PkgNameVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PkgVerVar" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "PkgIdVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LibNameVar" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CompilerVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OSVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ArchVar" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "AbiVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "AbiTagVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ExecutableNameVar" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "TestSuiteNameVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "TestSuiteResultVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BenchmarkNameVar" PrefixI False) (U1 :: * -> *))))))

type PathTemplateEnv = [(PathTemplateVariable, PathTemplate)] #

toPathTemplate :: FilePath -> PathTemplate #

Convert a FilePath to a PathTemplate including any template vars.

fromPathTemplate :: PathTemplate -> FilePath #

Convert back to a path, any remaining vars are included

combinePathTemplate :: PathTemplate -> PathTemplate -> PathTemplate #

substPathTemplate :: PathTemplateEnv -> PathTemplate -> PathTemplate #

initialPathTemplateEnv :: PackageIdentifier -> UnitId -> CompilerInfo -> Platform -> PathTemplateEnv #

The initial environment has all the static stuff but no paths

platformTemplateEnv :: Platform -> PathTemplateEnv #

compilerTemplateEnv :: CompilerInfo -> PathTemplateEnv #

packageTemplateEnv :: PackageIdentifier -> UnitId -> PathTemplateEnv #

abiTemplateEnv :: CompilerInfo -> Platform -> PathTemplateEnv #

installDirsTemplateEnv :: InstallDirs PathTemplate -> PathTemplateEnv #

diff --git a/doc/API/Cabal/Distribution-Simple-LocalBuildInfo.html b/doc/API/Cabal/Distribution-Simple-LocalBuildInfo.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-LocalBuildInfo.html @@ -0,0 +1,178 @@ +Distribution.Simple.LocalBuildInfo

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2004
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.LocalBuildInfo

Contents

Description

Once a package has been configured we have resolved conditionals and + dependencies, configured the compiler and other needed external programs. + The LocalBuildInfo is used to hold all this information. It holds the + install dirs, the compiler, the exact package dependencies, the configured + programs, the package database to use and a bunch of miscellaneous configure + flags. It gets saved and reloaded from a file (dist/setup-config). It gets + passed in to very many subsequent build actions.

Synopsis

Documentation

data LocalBuildInfo #

Data cached after configuration step. See also + ConfigFlags.

Constructors

LocalBuildInfo 

Fields

Instances
Read LocalBuildInfo # 
Instance details

Defined in Distribution.Types.LocalBuildInfo

Methods

readsPrec :: Int -> ReadS LocalBuildInfo #

readList :: ReadS [LocalBuildInfo] #

readPrec :: ReadPrec LocalBuildInfo #

readListPrec :: ReadPrec [LocalBuildInfo] #

Show LocalBuildInfo # 
Instance details

Defined in Distribution.Types.LocalBuildInfo

Methods

showsPrec :: Int -> LocalBuildInfo -> ShowS #

show :: LocalBuildInfo -> String #

showList :: [LocalBuildInfo] -> ShowS #

Generic LocalBuildInfo # 
Instance details

Defined in Distribution.Types.LocalBuildInfo

Associated Types

type Rep LocalBuildInfo :: * -> * #

Methods

from :: LocalBuildInfo -> Rep LocalBuildInfo x #

to :: Rep LocalBuildInfo x -> LocalBuildInfo #

Binary LocalBuildInfo # 
Instance details

Defined in Distribution.Types.LocalBuildInfo

Methods

put :: LocalBuildInfo -> Put #

get :: Get LocalBuildInfo #

putList :: [LocalBuildInfo] -> Put #

type Rep LocalBuildInfo # 
Instance details

Defined in Distribution.Types.LocalBuildInfo

type Rep LocalBuildInfo = D1 (MetaData "LocalBuildInfo" "Distribution.Types.LocalBuildInfo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "LocalBuildInfo" PrefixI True) (((((S1 (MetaSel (Just "configFlags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ConfigFlags) :*: S1 (MetaSel (Just "flagAssignment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FlagAssignment)) :*: (S1 (MetaSel (Just "componentEnabledSpec") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentRequestedSpec) :*: S1 (MetaSel (Just "extraConfigArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]))) :*: ((S1 (MetaSel (Just "installDirTemplates") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 InstallDirTemplates) :*: S1 (MetaSel (Just "compiler") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Compiler)) :*: (S1 (MetaSel (Just "hostPlatform") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Platform) :*: (S1 (MetaSel (Just "buildDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "cabalFilePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)))))) :*: (((S1 (MetaSel (Just "componentGraph") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Graph ComponentLocalBuildInfo)) :*: S1 (MetaSel (Just "componentNameMap") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map ComponentName [ComponentLocalBuildInfo]))) :*: (S1 (MetaSel (Just "installedPkgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 InstalledPackageIndex) :*: S1 (MetaSel (Just "pkgDescrFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)))) :*: ((S1 (MetaSel (Just "localPkgDescr") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageDescription) :*: S1 (MetaSel (Just "withPrograms") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ProgramDb)) :*: (S1 (MetaSel (Just "withPackageDB") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageDBStack) :*: (S1 (MetaSel (Just "withVanillaLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "withProfLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))))) :*: ((((S1 (MetaSel (Just "withSharedLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "withStaticLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "withDynExe") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "withProfExe") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :*: ((S1 (MetaSel (Just "withProfLibDetail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ProfDetailLevel) :*: S1 (MetaSel (Just "withProfExeDetail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ProfDetailLevel)) :*: (S1 (MetaSel (Just "withOptimization") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OptimisationLevel) :*: (S1 (MetaSel (Just "withDebugInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 DebugInfoLevel) :*: S1 (MetaSel (Just "withGHCiLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))) :*: (((S1 (MetaSel (Just "splitSections") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "splitObjs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "stripExes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "stripLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :*: ((S1 (MetaSel (Just "exeCoverage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "libCoverage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "progPrefix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PathTemplate) :*: (S1 (MetaSel (Just "progSuffix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PathTemplate) :*: S1 (MetaSel (Just "relocatable") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))))))

externalPackageDeps :: LocalBuildInfo -> [(UnitId, MungedPackageId)] #

Deprecated: You almost certainly don't want this function, which agglomerates the dependencies of ALL enabled components. If you're using this to write out information on your dependencies, read off the dependencies directly from the actual component in question. To be removed in Cabal 3.0

External package dependencies for the package as a whole. This is the + union of the individual componentPackageDeps, less any internal deps.

localComponentId :: LocalBuildInfo -> ComponentId #

Extract the ComponentId from the public library component of a + LocalBuildInfo if it exists, or make a fake component ID based + on the package ID.

localUnitId :: LocalBuildInfo -> UnitId #

Extract the UnitId from the library component of a + LocalBuildInfo if it exists, or make a fake unit ID based on + the package ID.

localCompatPackageKey :: LocalBuildInfo -> String #

Extract the compatibility package key from the public library component of a + LocalBuildInfo if it exists, or make a fake package key based + on the package ID.

Buildable package components

data Component #

Constructors

CLib Library 
CFLib ForeignLib 
CExe Executable 
CTest TestSuite 
CBench Benchmark 
Instances
Eq Component # 
Instance details

Defined in Distribution.Types.Component

Methods

(==) :: Component -> Component -> Bool #

(/=) :: Component -> Component -> Bool #

Read Component # 
Instance details

Defined in Distribution.Types.Component

Methods

readsPrec :: Int -> ReadS Component #

readList :: ReadS [Component] #

readPrec :: ReadPrec Component #

readListPrec :: ReadPrec [Component] #

Show Component # 
Instance details

Defined in Distribution.Types.Component

Methods

showsPrec :: Int -> Component -> ShowS #

show :: Component -> String #

showList :: [Component] -> ShowS #

Semigroup Component # 
Instance details

Defined in Distribution.Types.Component

Methods

(<>) :: Component -> Component -> Component #

sconcat :: NonEmpty Component -> Component #

stimes :: Integral b => b -> Component -> Component #

HasBuildInfo Component # 
Instance details

Defined in Distribution.Types.Component

Methods

buildInfo :: Lens' Component BuildInfo #

buildable :: Lens' Component Bool #

buildTools :: Lens' Component [LegacyExeDependency] #

buildToolDepends :: Lens' Component [ExeDependency] #

cppOptions :: Lens' Component [String] #

asmOptions :: Lens' Component [String] #

cmmOptions :: Lens' Component [String] #

ccOptions :: Lens' Component [String] #

cxxOptions :: Lens' Component [String] #

ldOptions :: Lens' Component [String] #

pkgconfigDepends :: Lens' Component [PkgconfigDependency] #

frameworks :: Lens' Component [String] #

extraFrameworkDirs :: Lens' Component [String] #

asmSources :: Lens' Component [FilePath] #

cmmSources :: Lens' Component [FilePath] #

cSources :: Lens' Component [FilePath] #

cxxSources :: Lens' Component [FilePath] #

jsSources :: Lens' Component [FilePath] #

hsSourceDirs :: Lens' Component [FilePath] #

otherModules :: Lens' Component [ModuleName] #

virtualModules :: Lens' Component [ModuleName] #

autogenModules :: Lens' Component [ModuleName] #

defaultLanguage :: Lens' Component (Maybe Language) #

otherLanguages :: Lens' Component [Language] #

defaultExtensions :: Lens' Component [Extension] #

otherExtensions :: Lens' Component [Extension] #

oldExtensions :: Lens' Component [Extension] #

extraLibs :: Lens' Component [String] #

extraGHCiLibs :: Lens' Component [String] #

extraBundledLibs :: Lens' Component [String] #

extraLibFlavours :: Lens' Component [String] #

extraLibDirs :: Lens' Component [String] #

includeDirs :: Lens' Component [FilePath] #

includes :: Lens' Component [FilePath] #

installIncludes :: Lens' Component [FilePath] #

options :: Lens' Component [(CompilerFlavor, [String])] #

profOptions :: Lens' Component [(CompilerFlavor, [String])] #

sharedOptions :: Lens' Component [(CompilerFlavor, [String])] #

staticOptions :: Lens' Component [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' Component [(String, String)] #

targetBuildDepends :: Lens' Component [Dependency] #

mixins :: Lens' Component [Mixin] #

data ComponentName #

Constructors

CLibName 
CSubLibName UnqualComponentName 
CFLibName UnqualComponentName 
CExeName UnqualComponentName 
CTestName UnqualComponentName 
CBenchName UnqualComponentName 
Instances
Eq ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

(==) :: ComponentName -> ComponentName -> Bool #

(/=) :: ComponentName -> ComponentName -> Bool #

Ord ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

compare :: ComponentName -> ComponentName -> Ordering #

(<) :: ComponentName -> ComponentName -> Bool #

(<=) :: ComponentName -> ComponentName -> Bool #

(>) :: ComponentName -> ComponentName -> Bool #

(>=) :: ComponentName -> ComponentName -> Bool #

max :: ComponentName -> ComponentName -> ComponentName #

min :: ComponentName -> ComponentName -> ComponentName #

Read ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

readsPrec :: Int -> ReadS ComponentName #

readList :: ReadS [ComponentName] #

readPrec :: ReadPrec ComponentName #

readListPrec :: ReadPrec [ComponentName] #

Show ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

showsPrec :: Int -> ComponentName -> ShowS #

show :: ComponentName -> String #

showList :: [ComponentName] -> ShowS #

Generic ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Associated Types

type Rep ComponentName :: * -> * #

Methods

from :: ComponentName -> Rep ComponentName x #

to :: Rep ComponentName x -> ComponentName #

Binary ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

put :: ComponentName -> Put #

get :: Get ComponentName #

putList :: [ComponentName] -> Put #

Pretty ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

pretty :: ComponentName -> Doc #

Text ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

disp :: ComponentName -> Doc #

parse :: ReadP r ComponentName #

type Rep ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

type Rep ComponentName = D1 (MetaData "ComponentName" "Distribution.Types.ComponentName" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "CLibName" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CSubLibName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)) :+: C1 (MetaCons "CFLibName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)))) :+: (C1 (MetaCons "CExeName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)) :+: (C1 (MetaCons "CTestName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)) :+: C1 (MetaCons "CBenchName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)))))

defaultLibName :: ComponentName #

showComponentName :: ComponentName -> String #

componentNameString :: ComponentName -> Maybe UnqualComponentName #

This gets the underlying unqualified component name. In fact, it is + guaranteed to uniquely identify a component, returning + Nothing if the ComponentName was for the public + library.

data ComponentLocalBuildInfo #

The first five fields are common across all algebraic variants.

Constructors

LibComponentLocalBuildInfo 

Fields

FLibComponentLocalBuildInfo 

Fields

ExeComponentLocalBuildInfo 

Fields

TestComponentLocalBuildInfo 

Fields

BenchComponentLocalBuildInfo 

Fields

Instances
Read ComponentLocalBuildInfo # 
Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Methods

readsPrec :: Int -> ReadS ComponentLocalBuildInfo #

readList :: ReadS [ComponentLocalBuildInfo] #

readPrec :: ReadPrec ComponentLocalBuildInfo #

readListPrec :: ReadPrec [ComponentLocalBuildInfo] #

Show ComponentLocalBuildInfo # 
Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Methods

showsPrec :: Int -> ComponentLocalBuildInfo -> ShowS #

show :: ComponentLocalBuildInfo -> String #

showList :: [ComponentLocalBuildInfo] -> ShowS #

Generic ComponentLocalBuildInfo # 
Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Associated Types

type Rep ComponentLocalBuildInfo :: * -> * #

Methods

from :: ComponentLocalBuildInfo -> Rep ComponentLocalBuildInfo x #

to :: Rep ComponentLocalBuildInfo x -> ComponentLocalBuildInfo #

Binary ComponentLocalBuildInfo # 
Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Methods

put :: ComponentLocalBuildInfo -> Put #

get :: Get ComponentLocalBuildInfo #

putList :: [ComponentLocalBuildInfo] -> Put #

IsNode ComponentLocalBuildInfo # 
Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Associated Types

type Key ComponentLocalBuildInfo :: * #

Methods

nodeKey :: ComponentLocalBuildInfo -> Key ComponentLocalBuildInfo #

nodeNeighbors :: ComponentLocalBuildInfo -> [Key ComponentLocalBuildInfo] #

type Rep ComponentLocalBuildInfo # 
Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

type Rep ComponentLocalBuildInfo = D1 (MetaData "ComponentLocalBuildInfo" "Distribution.Types.ComponentLocalBuildInfo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "LibComponentLocalBuildInfo" PrefixI True) (((S1 (MetaSel (Just "componentLocalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: (S1 (MetaSel (Just "componentComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Just "componentUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId))) :*: (S1 (MetaSel (Just "componentIsIndefinite_") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: (S1 (MetaSel (Just "componentInstantiatedWith") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(ModuleName, OpenModule)]) :*: S1 (MetaSel (Just "componentPackageDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnitId, MungedPackageId)])))) :*: ((S1 (MetaSel (Just "componentIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)]) :*: (S1 (MetaSel (Just "componentExeDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]) :*: S1 (MetaSel (Just "componentInternalDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]))) :*: ((S1 (MetaSel (Just "componentCompatPackageKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "componentCompatPackageName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MungedPackageName)) :*: (S1 (MetaSel (Just "componentExposedModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ExposedModule]) :*: S1 (MetaSel (Just "componentIsPublic") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))) :+: C1 (MetaCons "FLibComponentLocalBuildInfo" PrefixI True) ((S1 (MetaSel (Just "componentLocalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: (S1 (MetaSel (Just "componentComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Just "componentUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId))) :*: ((S1 (MetaSel (Just "componentPackageDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 (MetaSel (Just "componentIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 (MetaSel (Just "componentExeDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]) :*: S1 (MetaSel (Just "componentInternalDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]))))) :+: (C1 (MetaCons "ExeComponentLocalBuildInfo" PrefixI True) ((S1 (MetaSel (Just "componentLocalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: (S1 (MetaSel (Just "componentComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Just "componentUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId))) :*: ((S1 (MetaSel (Just "componentPackageDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 (MetaSel (Just "componentIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 (MetaSel (Just "componentExeDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]) :*: S1 (MetaSel (Just "componentInternalDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId])))) :+: (C1 (MetaCons "TestComponentLocalBuildInfo" PrefixI True) ((S1 (MetaSel (Just "componentLocalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: (S1 (MetaSel (Just "componentComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Just "componentUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId))) :*: ((S1 (MetaSel (Just "componentPackageDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 (MetaSel (Just "componentIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 (MetaSel (Just "componentExeDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]) :*: S1 (MetaSel (Just "componentInternalDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId])))) :+: C1 (MetaCons "BenchComponentLocalBuildInfo" PrefixI True) ((S1 (MetaSel (Just "componentLocalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: (S1 (MetaSel (Just "componentComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Just "componentUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId))) :*: ((S1 (MetaSel (Just "componentPackageDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 (MetaSel (Just "componentIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 (MetaSel (Just "componentExeDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]) :*: S1 (MetaSel (Just "componentInternalDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId])))))))
type Key ComponentLocalBuildInfo # 
Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

type Key ComponentLocalBuildInfo = UnitId

componentBuildDir :: LocalBuildInfo -> ComponentLocalBuildInfo -> FilePath #

foldComponent :: (Library -> a) -> (ForeignLib -> a) -> (Executable -> a) -> (TestSuite -> a) -> (Benchmark -> a) -> Component -> a #

componentName :: Component -> ComponentName #

componentBuildInfo :: Component -> BuildInfo #

componentBuildable :: Component -> Bool #

Is a component buildable (i.e., not marked with buildable: False)? + See also this note in + Distribution.Types.ComponentRequestedSpec.

Since: 2.0.0.2

pkgComponents :: PackageDescription -> [Component] #

All the components in the package.

pkgBuildableComponents :: PackageDescription -> [Component] #

A list of all components in the package that are buildable, + i.e., were not marked with buildable: False. This does NOT + indicate if we are actually going to build the component, + see enabledComponents instead.

Since: 2.0.0.2

lookupComponent :: PackageDescription -> ComponentName -> Maybe Component #

getComponent :: PackageDescription -> ComponentName -> Component #

getComponentLocalBuildInfo :: LocalBuildInfo -> ComponentName -> ComponentLocalBuildInfo #

Deprecated: This function is not well-defined, because a ComponentName does not uniquely identify a ComponentLocalBuildInfo. If you have a TargetInfo, you should use targetCLBI to get the ComponentLocalBuildInfo. Otherwise, use componentNameTargets to get all possible ComponentLocalBuildInfos. This will be removed in Cabal 2.2.

allComponentsInBuildOrder :: LocalBuildInfo -> [ComponentLocalBuildInfo] #

componentsInBuildOrder :: LocalBuildInfo -> [ComponentName] -> [ComponentLocalBuildInfo] #

Deprecated: You've got TargetInfo right? Use neededTargetsInBuildOrder on the UnitIds you can nodeKey out.

depLibraryPaths #

Arguments

:: Bool

Building for inplace?

-> Bool

Generate prefix-relative library paths

-> LocalBuildInfo 
-> ComponentLocalBuildInfo

Component that is being built

-> NoCallStackIO [FilePath] 

Determine the directories containing the dynamic libraries of the + transitive dependencies of the component we are building.

When wanted, and possible, returns paths relative to the installDirs prefix

allLibModules :: Library -> ComponentLocalBuildInfo -> [ModuleName] #

Get all module names that needed to be built by GHC; i.e., all + of these ModuleNames have interface files associated with them + that need to be installed.

withAllComponentsInBuildOrder :: PackageDescription -> LocalBuildInfo -> (Component -> ComponentLocalBuildInfo -> IO ()) -> IO () #

Perform the action on each buildable Library or Executable (Component) + in the PackageDescription, subject to the build order specified by the + compBuildOrder field of the given LocalBuildInfo

withComponentsInBuildOrder :: PackageDescription -> LocalBuildInfo -> [ComponentName] -> (Component -> ComponentLocalBuildInfo -> IO ()) -> IO () #

Deprecated: You have got a TargetInfo right? Use withNeededTargetsInBuildOrder on the UnitIds you can nodeKey out.

withComponentsLBI :: PackageDescription -> LocalBuildInfo -> (Component -> ComponentLocalBuildInfo -> IO ()) -> IO () #

Deprecated: Use withAllComponentsInBuildOrder

withLibLBI :: PackageDescription -> LocalBuildInfo -> (Library -> ComponentLocalBuildInfo -> IO ()) -> IO () #

Perform the action on each enabled library in the package + description with the ComponentLocalBuildInfo.

withExeLBI :: PackageDescription -> LocalBuildInfo -> (Executable -> ComponentLocalBuildInfo -> IO ()) -> IO () #

Perform the action on each enabled Executable in the package + description. Extended version of withExe that also gives corresponding + build info.

withBenchLBI :: PackageDescription -> LocalBuildInfo -> (Benchmark -> ComponentLocalBuildInfo -> IO ()) -> IO () #

Perform the action on each enabled Benchmark in the package + description.

withTestLBI :: PackageDescription -> LocalBuildInfo -> (TestSuite -> ComponentLocalBuildInfo -> IO ()) -> IO () #

enabledTestLBIs :: PackageDescription -> LocalBuildInfo -> [(TestSuite, ComponentLocalBuildInfo)] #

enabledBenchLBIs :: PackageDescription -> LocalBuildInfo -> [(Benchmark, ComponentLocalBuildInfo)] #

Installation directories

type PathTemplateEnv = [(PathTemplateVariable, PathTemplate)] #

data PathTemplateVariable #

Constructors

PrefixVar

The $prefix path variable

BindirVar

The $bindir path variable

LibdirVar

The $libdir path variable

LibsubdirVar

The $libsubdir path variable

DynlibdirVar

The $dynlibdir path variable

DatadirVar

The $datadir path variable

DatasubdirVar

The $datasubdir path variable

DocdirVar

The $docdir path variable

HtmldirVar

The $htmldir path variable

PkgNameVar

The $pkg package name path variable

PkgVerVar

The $version package version path variable

PkgIdVar

The $pkgid package Id path variable, eg foo-1.0

LibNameVar

The $libname path variable

CompilerVar

The compiler name and version, eg ghc-6.6.1

OSVar

The operating system name, eg windows or linux

ArchVar

The CPU architecture name, eg i386 or x86_64

AbiVar

The Compiler's ABI identifier, $arch-$os-$compiler-$abitag

AbiTagVar

The optional ABI tag for the compiler

ExecutableNameVar

The executable name; used in shell wrappers

TestSuiteNameVar

The name of the test suite being run

TestSuiteResultVar

The result of the test suite being run, eg + pass, fail, or error.

BenchmarkNameVar

The name of the benchmark being run

Instances
Eq PathTemplateVariable # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

(==) :: PathTemplateVariable -> PathTemplateVariable -> Bool #

(/=) :: PathTemplateVariable -> PathTemplateVariable -> Bool #

Ord PathTemplateVariable # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

compare :: PathTemplateVariable -> PathTemplateVariable -> Ordering #

(<) :: PathTemplateVariable -> PathTemplateVariable -> Bool #

(<=) :: PathTemplateVariable -> PathTemplateVariable -> Bool #

(>) :: PathTemplateVariable -> PathTemplateVariable -> Bool #

(>=) :: PathTemplateVariable -> PathTemplateVariable -> Bool #

max :: PathTemplateVariable -> PathTemplateVariable -> PathTemplateVariable #

min :: PathTemplateVariable -> PathTemplateVariable -> PathTemplateVariable #

Read PathTemplateVariable # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

readsPrec :: Int -> ReadS PathTemplateVariable #

readList :: ReadS [PathTemplateVariable] #

readPrec :: ReadPrec PathTemplateVariable #

readListPrec :: ReadPrec [PathTemplateVariable] #

Show PathTemplateVariable # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

showsPrec :: Int -> PathTemplateVariable -> ShowS #

show :: PathTemplateVariable -> String #

showList :: [PathTemplateVariable] -> ShowS #

Generic PathTemplateVariable # 
Instance details

Defined in Distribution.Simple.InstallDirs

Associated Types

type Rep PathTemplateVariable :: * -> * #

Methods

from :: PathTemplateVariable -> Rep PathTemplateVariable x #

to :: Rep PathTemplateVariable x -> PathTemplateVariable #

Binary PathTemplateVariable # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

put :: PathTemplateVariable -> Put #

get :: Get PathTemplateVariable #

putList :: [PathTemplateVariable] -> Put #

type Rep PathTemplateVariable # 
Instance details

Defined in Distribution.Simple.InstallDirs

type Rep PathTemplateVariable = D1 (MetaData "PathTemplateVariable" "Distribution.Simple.InstallDirs" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((((C1 (MetaCons "PrefixVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BindirVar" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "LibdirVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "LibsubdirVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DynlibdirVar" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "DatadirVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "DatasubdirVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DocdirVar" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "HtmldirVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "PkgNameVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PkgVerVar" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "PkgIdVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LibNameVar" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CompilerVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OSVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ArchVar" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "AbiVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "AbiTagVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ExecutableNameVar" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "TestSuiteNameVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "TestSuiteResultVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BenchmarkNameVar" PrefixI False) (U1 :: * -> *))))))

data PathTemplate #

An abstract path, possibly containing variables that need to be + substituted for to get a real FilePath.

Instances
Eq PathTemplate # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

(==) :: PathTemplate -> PathTemplate -> Bool #

(/=) :: PathTemplate -> PathTemplate -> Bool #

Ord PathTemplate # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

compare :: PathTemplate -> PathTemplate -> Ordering #

(<) :: PathTemplate -> PathTemplate -> Bool #

(<=) :: PathTemplate -> PathTemplate -> Bool #

(>) :: PathTemplate -> PathTemplate -> Bool #

(>=) :: PathTemplate -> PathTemplate -> Bool #

max :: PathTemplate -> PathTemplate -> PathTemplate #

min :: PathTemplate -> PathTemplate -> PathTemplate #

Read PathTemplate # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

readsPrec :: Int -> ReadS PathTemplate #

readList :: ReadS [PathTemplate] #

readPrec :: ReadPrec PathTemplate #

readListPrec :: ReadPrec [PathTemplate] #

Show PathTemplate # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

showsPrec :: Int -> PathTemplate -> ShowS #

show :: PathTemplate -> String #

showList :: [PathTemplate] -> ShowS #

Generic PathTemplate # 
Instance details

Defined in Distribution.Simple.InstallDirs

Associated Types

type Rep PathTemplate :: * -> * #

Methods

from :: PathTemplate -> Rep PathTemplate x #

to :: Rep PathTemplate x -> PathTemplate #

Binary PathTemplate # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

put :: PathTemplate -> Put #

get :: Get PathTemplate #

putList :: [PathTemplate] -> Put #

type Rep PathTemplate # 
Instance details

Defined in Distribution.Simple.InstallDirs

type Rep PathTemplate

data CopyDest #

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
Eq CopyDest # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

(==) :: CopyDest -> CopyDest -> Bool #

(/=) :: CopyDest -> CopyDest -> Bool #

Show CopyDest # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

showsPrec :: Int -> CopyDest -> ShowS #

show :: CopyDest -> String #

showList :: [CopyDest] -> ShowS #

Generic CopyDest # 
Instance details

Defined in Distribution.Simple.InstallDirs

Associated Types

type Rep CopyDest :: * -> * #

Methods

from :: CopyDest -> Rep CopyDest x #

to :: Rep CopyDest x -> CopyDest #

Binary CopyDest # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

put :: CopyDest -> Put #

get :: Get CopyDest #

putList :: [CopyDest] -> Put #

type Rep CopyDest # 
Instance details

Defined in Distribution.Simple.InstallDirs

type Rep CopyDest = D1 (MetaData "CopyDest" "Distribution.Simple.InstallDirs" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "NoCopyDest" PrefixI False) (U1 :: * -> *) :+: (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))))

type InstallDirTemplates = InstallDirs PathTemplate #

The installation directories in terms of PathTemplates that contain + variables.

The defaults for most of the directories are relative to each other, in + particular they are all relative to a single prefix. This makes it + convenient for the user to override the default installation directory + by only having to specify --prefix=... rather than overriding each + individually. This is done by allowing $-style variables in the dirs. + These are expanded by textual substitution (see substPathTemplate).

A few of these installation directories are split into two components, the + dir and subdir. The full installation path is formed by combining the two + together with /. The reason for this is compatibility with other Unix + build systems which also support --libdir and --datadir. We would like + users to be able to configure --libdir=/usr/lib64 for example but + because by default we want to support installing multiple versions of + packages and building the same package for multiple compilers we append the + libsubdir to get: /usr/lib64/$libname/$compiler.

An additional complication is the need to support relocatable packages on + systems which support such things, like Windows.

data InstallDirs dir #

The directories where we will install files for packages.

We have several different directories for different types of files since + many systems have conventions whereby different types of files in a package + are installed in different directories. This is particularly the case on + Unix style systems.

Constructors

InstallDirs 

Fields

Instances
Functor InstallDirs # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

fmap :: (a -> b) -> InstallDirs a -> InstallDirs b #

(<$) :: a -> InstallDirs b -> InstallDirs a #

Eq dir => Eq (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

(==) :: InstallDirs dir -> InstallDirs dir -> Bool #

(/=) :: InstallDirs dir -> InstallDirs dir -> Bool #

Read dir => Read (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

readsPrec :: Int -> ReadS (InstallDirs dir) #

readList :: ReadS [InstallDirs dir] #

readPrec :: ReadPrec (InstallDirs dir) #

readListPrec :: ReadPrec [InstallDirs dir] #

Show dir => Show (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

showsPrec :: Int -> InstallDirs dir -> ShowS #

show :: InstallDirs dir -> String #

showList :: [InstallDirs dir] -> ShowS #

Generic (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Associated Types

type Rep (InstallDirs dir) :: * -> * #

Methods

from :: InstallDirs dir -> Rep (InstallDirs dir) x #

to :: Rep (InstallDirs dir) x -> InstallDirs dir #

Semigroup dir => Semigroup (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

(<>) :: InstallDirs dir -> InstallDirs dir -> InstallDirs dir #

sconcat :: NonEmpty (InstallDirs dir) -> InstallDirs dir #

stimes :: Integral b => b -> InstallDirs dir -> InstallDirs dir #

(Semigroup dir, Monoid dir) => Monoid (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

mempty :: InstallDirs dir #

mappend :: InstallDirs dir -> InstallDirs dir -> InstallDirs dir #

mconcat :: [InstallDirs dir] -> InstallDirs dir #

Binary dir => Binary (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

put :: InstallDirs dir -> Put #

get :: Get (InstallDirs dir) #

putList :: [InstallDirs dir] -> Put #

type Rep (InstallDirs dir) # 
Instance details

Defined in Distribution.Simple.InstallDirs

type Rep (InstallDirs dir) = D1 (MetaData "InstallDirs" "Distribution.Simple.InstallDirs" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "InstallDirs" PrefixI True) ((((S1 (MetaSel (Just "prefix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "bindir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir)) :*: (S1 (MetaSel (Just "libdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "libsubdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir))) :*: ((S1 (MetaSel (Just "dynlibdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "flibdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir)) :*: (S1 (MetaSel (Just "libexecdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "libexecsubdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir)))) :*: (((S1 (MetaSel (Just "includedir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "datadir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir)) :*: (S1 (MetaSel (Just "datasubdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "docdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir))) :*: ((S1 (MetaSel (Just "mandir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "htmldir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir)) :*: (S1 (MetaSel (Just "haddockdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "sysconfdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir))))))

combineInstallDirs :: (a -> b -> c) -> InstallDirs a -> InstallDirs b -> InstallDirs c #

defaultInstallDirs :: CompilerFlavor -> Bool -> Bool -> IO InstallDirTemplates #

defaultInstallDirs' :: Bool -> CompilerFlavor -> Bool -> Bool -> IO InstallDirTemplates #

substituteInstallDirTemplates :: PathTemplateEnv -> InstallDirTemplates -> InstallDirTemplates #

Substitute the install dir templates into each other.

To prevent cyclic substitutions, only some variables are allowed in + particular dir templates. If out of scope vars are present, they are not + substituted for. Checking for any remaining unsubstituted vars can be done + as a subsequent operation.

The reason it is done this way is so that in prefixRelativeInstallDirs we + can replace prefix with the PrefixVar and get resulting + PathTemplates that still have the PrefixVar in them. Doing this makes it + each to check which paths are relative to the $prefix.

toPathTemplate :: FilePath -> PathTemplate #

Convert a FilePath to a PathTemplate including any template vars.

fromPathTemplate :: PathTemplate -> FilePath #

Convert back to a path, any remaining vars are included

combinePathTemplate :: PathTemplate -> PathTemplate -> PathTemplate #

initialPathTemplateEnv :: PackageIdentifier -> UnitId -> CompilerInfo -> Platform -> PathTemplateEnv #

The initial environment has all the static stuff but no paths

packageTemplateEnv :: PackageIdentifier -> UnitId -> PathTemplateEnv #

compilerTemplateEnv :: CompilerInfo -> PathTemplateEnv #

platformTemplateEnv :: Platform -> PathTemplateEnv #

abiTemplateEnv :: CompilerInfo -> Platform -> PathTemplateEnv #

installDirsTemplateEnv :: InstallDirs PathTemplate -> PathTemplateEnv #

absoluteInstallDirs :: PackageDescription -> LocalBuildInfo -> CopyDest -> InstallDirs FilePath #

Backwards compatibility function which computes the InstallDirs + assuming that $libname points to the public library (or some fake + package identifier if there is no public library.) IF AT ALL + POSSIBLE, please use absoluteComponentInstallDirs instead.

prefixRelativeInstallDirs :: PackageId -> LocalBuildInfo -> InstallDirs (Maybe FilePath) #

Backwards compatibility function which computes the InstallDirs + assuming that $libname points to the public library (or some fake + package identifier if there is no public library.) IF AT ALL + POSSIBLE, please use prefixRelativeComponentInstallDirs instead.

absoluteComponentInstallDirs :: PackageDescription -> LocalBuildInfo -> UnitId -> CopyDest -> InstallDirs FilePath #

See absoluteInstallDirs.

prefixRelativeComponentInstallDirs :: PackageId -> LocalBuildInfo -> UnitId -> InstallDirs (Maybe FilePath) #

See prefixRelativeInstallDirs

substPathTemplate :: PackageId -> LocalBuildInfo -> UnitId -> PathTemplate -> FilePath #

diff --git a/doc/API/Cabal/Distribution-Simple-PackageIndex.html b/doc/API/Cabal/Distribution-Simple-PackageIndex.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-PackageIndex.html @@ -0,0 +1,60 @@ +Distribution.Simple.PackageIndex

Cabal-2.4.0.1: A framework for packaging Haskell software

Copyright(c) David Himmelstrup 2005
Bjorn Bringert 2007
Duncan Coutts 2008-2009
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.PackageIndex

Contents

Description

An index of packages whose primary key is UnitId. Public libraries + are additionally indexed by PackageName and Version. + Technically, these are an index of *units* (so we should eventually + rename it to UnitIndex); but in the absence of internal libraries + or Backpack each unit is equivalent to a package.

While PackageIndex is parametric over what it actually records, + it is in fact only ever instantiated with a single element: + The InstalledPackageIndex (defined here) contains a graph of + InstalledPackageInfos representing the packages in a + package database stack. It is used in a variety of ways:

  • The primary use to let Cabal access the same installed + package database which is used by GHC during compilation. + For example, this data structure is used by 'ghc-pkg' + and Cabal to do consistency checks on the database + (are the references closed).
  • Given a set of dependencies, we can compute the transitive + closure of dependencies. This is to check if the versions + of packages are consistent, and also needed by multiple + tools (Haddock must be explicitly told about the every + transitive package to do cross-package linking; + preprocessors must know about the include paths of all + transitive dependencies.)

This PackageIndex is NOT to be confused with + PackageIndex, which indexes packages only by + PackageName (this makes it suitable for indexing source packages, + for which we don't know UnitIds.)

Synopsis

Package index data type

type InstalledPackageIndex = PackageIndex InstalledPackageInfo #

The default package index which contains InstalledPackageInfo. Normally + use this.

data PackageIndex a #

The collection of information about packages from one or more PackageDBs. + These packages generally should have an instance of PackageInstalled

Packages are uniquely identified in by their UnitId, they can + also be efficiently looked up by package name or by name and version.

Instances
Eq a => Eq (PackageIndex a) # 
Instance details

Defined in Distribution.Simple.PackageIndex

Methods

(==) :: PackageIndex a -> PackageIndex a -> Bool #

(/=) :: PackageIndex a -> PackageIndex a -> Bool #

Read a => Read (PackageIndex a) # 
Instance details

Defined in Distribution.Simple.PackageIndex

Methods

readsPrec :: Int -> ReadS (PackageIndex a) #

readList :: ReadS [PackageIndex a] #

readPrec :: ReadPrec (PackageIndex a) #

readListPrec :: ReadPrec [PackageIndex a] #

Show a => Show (PackageIndex a) # 
Instance details

Defined in Distribution.Simple.PackageIndex

Methods

showsPrec :: Int -> PackageIndex a -> ShowS #

show :: PackageIndex a -> String #

showList :: [PackageIndex a] -> ShowS #

Generic (PackageIndex a) # 
Instance details

Defined in Distribution.Simple.PackageIndex

Associated Types

type Rep (PackageIndex a) :: * -> * #

Methods

from :: PackageIndex a -> Rep (PackageIndex a) x #

to :: Rep (PackageIndex a) x -> PackageIndex a #

Semigroup (PackageIndex InstalledPackageInfo) # 
Instance details

Defined in Distribution.Simple.PackageIndex

Methods

(<>) :: PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo #

sconcat :: NonEmpty (PackageIndex InstalledPackageInfo) -> PackageIndex InstalledPackageInfo #

stimes :: Integral b => b -> PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo #

Monoid (PackageIndex InstalledPackageInfo) # 
Instance details

Defined in Distribution.Simple.PackageIndex

Methods

mempty :: PackageIndex InstalledPackageInfo #

mappend :: PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo #

mconcat :: [PackageIndex InstalledPackageInfo] -> PackageIndex InstalledPackageInfo #

Binary a => Binary (PackageIndex a) # 
Instance details

Defined in Distribution.Simple.PackageIndex

Methods

put :: PackageIndex a -> Put #

get :: Get (PackageIndex a) #

putList :: [PackageIndex a] -> Put #

type Rep (PackageIndex a) # 
Instance details

Defined in Distribution.Simple.PackageIndex

type Rep (PackageIndex a) = D1 (MetaData "PackageIndex" "Distribution.Simple.PackageIndex" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "PackageIndex" PrefixI True) (S1 (MetaSel (Just "unitIdIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Map UnitId a)) :*: S1 (MetaSel (Just "packageIdIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Map (PackageName, Maybe UnqualComponentName) (Map Version [a])))))

Creating an index

fromList :: [InstalledPackageInfo] -> InstalledPackageIndex #

Build an index out of a bunch of packages.

If there are duplicates by UnitId then later ones mask earlier + ones.

Updates

merge :: InstalledPackageIndex -> InstalledPackageIndex -> InstalledPackageIndex #

Merge two indexes.

Packages from the second mask packages from the first if they have the exact + same UnitId.

For packages with the same source PackageId, packages from the second are + "preferred" over those from the first. Being preferred means they are top + result when we do a lookup by source PackageId. This is the mechanism we + use to prefer user packages over global packages.

insert :: InstalledPackageInfo -> InstalledPackageIndex -> InstalledPackageIndex #

Inserts a single package into the index.

This is equivalent to (but slightly quicker than) using mappend or + merge with a singleton index.

deleteUnitId :: UnitId -> InstalledPackageIndex -> InstalledPackageIndex #

Removes a single installed package from the index.

deleteSourcePackageId :: PackageId -> InstalledPackageIndex -> InstalledPackageIndex #

Removes all packages with this source PackageId from the index.

deletePackageName :: PackageName -> InstalledPackageIndex -> InstalledPackageIndex #

Removes all packages with this (case-sensitive) name from the index.

NB: Does NOT delete internal libraries from this package.

Queries

Precise lookups

lookupUnitId :: PackageIndex a -> UnitId -> Maybe a #

Does a lookup by unit identifier.

Since multiple package DBs mask each other by UnitId, + then we get back at most one package.

lookupComponentId :: PackageIndex a -> ComponentId -> Maybe a #

Does a lookup by component identifier. In the absence + of Backpack, this is just a lookupUnitId.

lookupSourcePackageId :: PackageIndex a -> PackageId -> [a] #

Does a lookup by source package id (name & version).

There can be multiple installed packages with the same source PackageId + but different UnitId. They are returned in order of + preference, with the most preferred first.

lookupPackageId :: PackageIndex a -> PackageId -> Maybe a #

Convenient alias of lookupSourcePackageId, but assuming only + one package per package ID.

lookupPackageName :: PackageIndex a -> PackageName -> [(Version, [a])] #

Does a lookup by source package name.

lookupDependency :: InstalledPackageIndex -> Dependency -> [(Version, [InstalledPackageInfo])] #

Does a lookup by source package name and a range of versions.

We get back any number of versions of the specified package name, all + satisfying the version range constraint.

This does NOT work for internal dependencies, DO NOT use this + function on those; use lookupInternalDependency instead.

INVARIANT: List of eligible InstalledPackageInfo is non-empty.

lookupInternalDependency :: InstalledPackageIndex -> Dependency -> Maybe UnqualComponentName -> [(Version, [InstalledPackageInfo])] #

Does a lookup by source package name and a range of versions.

We get back any number of versions of the specified package name, all + satisfying the version range constraint.

INVARIANT: List of eligible InstalledPackageInfo is non-empty.

Case-insensitive searches

searchByName :: PackageIndex a -> String -> SearchResult [a] #

Does a case-insensitive search by package name.

If there is only one package that compares case-insensitively to this name + then the search is unambiguous and we get back all versions of that package. + If several match case-insensitively but one matches exactly then it is also + unambiguous.

If however several match case-insensitively and none match exactly then we + have an ambiguous result, and we get back all the versions of all the + packages. The list of ambiguous results is split by exact package name. So + it is a non-empty list of non-empty lists.

data SearchResult a #

Constructors

None 
Unambiguous a 
Ambiguous [a] 

searchByNameSubstring :: PackageIndex a -> String -> [a] #

Does a case-insensitive substring search by package name.

That is, all packages that contain the given string in their name.

Bulk queries

allPackages :: PackageIndex a -> [a] #

Get all the packages from the index.

allPackagesByName :: PackageIndex a -> [(PackageName, [a])] #

Get all the packages from the index.

They are grouped by package name (case-sensitively).

(Doesn't include private libraries.)

allPackagesBySourcePackageId :: HasUnitId a => PackageIndex a -> [(PackageId, [a])] #

Get all the packages from the index.

They are grouped by source package id (package name and version).

(Doesn't include private libraries)

allPackagesBySourcePackageIdAndLibName :: HasUnitId a => PackageIndex a -> [((PackageId, Maybe UnqualComponentName), [a])] #

Get all the packages from the index.

They are grouped by source package id and library name.

This DOES include internal libraries.

Special queries

brokenPackages :: PackageInstalled a => PackageIndex a -> [(a, [UnitId])] #

All packages that have immediate dependencies that are not in the index.

Returns such packages along with the dependencies that they're missing.

dependencyClosure :: InstalledPackageIndex -> [UnitId] -> Either InstalledPackageIndex [(InstalledPackageInfo, [UnitId])] #

Tries to take the transitive closure of the package dependencies.

If the transitive closure is complete then it returns that subset of the + index. Otherwise it returns the broken packages as in brokenPackages.

  • Note that if the result is Right [] it is because at least one of + the original given PackageIds do not occur in the index.

reverseDependencyClosure :: PackageInstalled a => PackageIndex a -> [UnitId] -> [a] #

Takes the transitive closure of the packages reverse dependencies.

topologicalOrder :: PackageInstalled a => PackageIndex a -> [a] #

reverseTopologicalOrder :: PackageInstalled a => PackageIndex a -> [a] #

dependencyInconsistencies :: InstalledPackageIndex -> [(DepUniqueKey, [(UnitId, [InstalledPackageInfo])])] #

Given a package index where we assume we want to use all the packages + (use dependencyClosure if you need to get such a index subset) find out + if the dependencies within it use consistent versions of each package. + Return all cases where multiple packages depend on different versions of + some other package.

Each element in the result is a package name along with the packages that + depend on it and the versions they require. These are guaranteed to be + distinct.

dependencyCycles :: PackageInstalled a => PackageIndex a -> [[a]] #

Find if there are any cycles in the dependency graph. If there are no + cycles the result is [].

This actually computes the strongly connected components. So it gives us a + list of groups of packages where within each group they all depend on each + other, directly or indirectly.

dependencyGraph :: PackageInstalled a => PackageIndex a -> (Graph, Vertex -> a, UnitId -> Maybe Vertex) #

Builds a graph of the package dependencies.

Dependencies on other packages that are not in the index are discarded. + You can check if there are any such dependencies with brokenPackages.

moduleNameIndex :: InstalledPackageIndex -> Map ModuleName [InstalledPackageInfo] #

A rough approximation of GHC's module finder, takes a + InstalledPackageIndex and turns it into a map from module names to their + source packages. It's used to initialize the build-deps field in cabal + init.

Backwards compatibility

deleteInstalledPackageId :: UnitId -> InstalledPackageIndex -> InstalledPackageIndex #

Deprecated: Use deleteUnitId instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

Backwards compatibility wrapper for Cabal pre-1.24.

lookupInstalledPackageId :: PackageIndex a -> UnitId -> Maybe a #

Deprecated: Use lookupUnitId instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

Backwards compatibility for Cabal pre-1.24.

diff --git a/doc/API/Cabal/Distribution-Simple-PreProcess-Unlit.html b/doc/API/Cabal/Distribution-Simple-PreProcess-Unlit.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-PreProcess-Unlit.html @@ -0,0 +1,3 @@ +Distribution.Simple.PreProcess.Unlit

Cabal-2.4.0.1: A framework for packaging Haskell software

Copyright...
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.PreProcess.Unlit

Description

Remove the "literal" markups from a Haskell source file, including + ">", "\begin{code}", "\end{code}", and "#"

Synopsis

Documentation

unlit :: FilePath -> String -> Either String String #

unlit takes a filename (for error reports), and transforms the + given string, to eliminate the literate comments from the program text.

plain :: String -> String -> String #

No unliteration.

diff --git a/doc/API/Cabal/Distribution-Simple-PreProcess.html b/doc/API/Cabal/Distribution-Simple-PreProcess.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-PreProcess.html @@ -0,0 +1,38 @@ +Distribution.Simple.PreProcess

Cabal-2.4.0.1: A framework for packaging Haskell software

Copyright(c) 2003-2005 Isaac Jones Malcolm Wallace
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.PreProcess

Description

This defines a PreProcessor abstraction which represents a pre-processor + that can transform one kind of file into another. There is also a + PPSuffixHandler which is a combination of a file extension and a function + for configuring a PreProcessor. It defines a bunch of known built-in + preprocessors like cpp, cpphs, c2hs, hsc2hs, happy, alex etc and + lists them in knownSuffixHandlers. On top of this it provides a function + for actually preprocessing some sources given a bunch of known suffix + handlers. This module is not as good as it could be, it could really do with + a rewrite to address some of the problems we have with pre-processors.

Synopsis

Documentation

preprocessComponent :: PackageDescription -> Component -> LocalBuildInfo -> ComponentLocalBuildInfo -> Bool -> Verbosity -> [PPSuffixHandler] -> IO () #

Apply preprocessors to the sources from hsSourceDirs for a given + component (lib, exe, or test suite).

preprocessExtras :: Verbosity -> Component -> LocalBuildInfo -> IO [FilePath] #

Find any extra C sources generated by preprocessing that need to + be added to the component (addresses issue #238).

knownSuffixHandlers :: [PPSuffixHandler] #

Standard preprocessors: GreenCard, c2hs, hsc2hs, happy, alex and cpphs.

ppSuffixes :: [PPSuffixHandler] -> [String] #

Convenience function; get the suffixes of these preprocessors.

type PPSuffixHandler = (String, BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor) #

A preprocessor for turning non-Haskell files with the given extension + into plain Haskell source files.

data PreProcessor #

The interface to a preprocessor, which may be implemented using an + external program, but need not be. The arguments are the name of + the input file, the name of the output file and a verbosity level. + Here is a simple example that merely prepends a comment to the given + source file:

ppTestHandler :: PreProcessor
+ppTestHandler =
+  PreProcessor {
+    platformIndependent = True,
+    runPreProcessor = mkSimplePreProcessor $ \inFile outFile verbosity ->
+      do info verbosity (inFile++" has been preprocessed to "++outFile)
+         stuff <- readFile inFile
+         writeFile outFile ("-- preprocessed as a test\n\n" ++ stuff)
+         return ExitSuccess

We split the input and output file names into a base directory and the + rest of the file name. The input base dir is the path in the list of search + dirs that this file was found in. The output base dir is the build dir where + all the generated source files are put.

The reason for splitting it up this way is that some pre-processors don't + simply generate one output .hs file from one input file but have + dependencies on other generated files (notably c2hs, where building one + .hs file may require reading other .chi files, and then compiling the .hs + file may require reading a generated .h file). In these cases the generated + files need to embed relative path names to each other (eg the generated .hs + file mentions the .h file in the FFI imports). This path must be relative to + the base directory where the generated files are located, it cannot be + relative to the top level of the build tree because the compilers do not + look for .h files relative to there, ie we do not use "-I .", instead we + use "-I dist/build" (or whatever dist dir has been set by the user)

Most pre-processors do not care of course, so mkSimplePreProcessor and + runSimplePreProcessor functions handle the simple case.

Constructors

PreProcessor 

Fields

mkSimplePreProcessor :: (FilePath -> FilePath -> Verbosity -> IO ()) -> (FilePath, FilePath) -> (FilePath, FilePath) -> Verbosity -> IO () #

runSimplePreProcessor :: PreProcessor -> FilePath -> FilePath -> Verbosity -> IO () #

ppCpp :: BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor #

ppCpp' :: [String] -> BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor #

ppGreenCard :: BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor #

ppC2hs :: BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor #

ppHsc2hs :: BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor #

ppHappy :: BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor #

ppAlex :: BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor #

ppUnlit :: PreProcessor #

platformDefines :: LocalBuildInfo -> [String] #

diff --git a/doc/API/Cabal/Distribution-Simple-Program-Ar.html b/doc/API/Cabal/Distribution-Simple-Program-Ar.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Program-Ar.html @@ -0,0 +1,11 @@ +Distribution.Simple.Program.Ar

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightDuncan Coutts 2009
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Program.Ar

Description

This module provides an library interface to the ar program.

Synopsis

Documentation

createArLibArchive :: Verbosity -> LocalBuildInfo -> FilePath -> [FilePath] -> IO () #

Call ar to create a library archive from a bunch of object files.

multiStageProgramInvocation :: ProgramInvocation -> (ProgramInvocation, ProgramInvocation, ProgramInvocation) -> [String] -> [ProgramInvocation] #

Like the unix xargs program. Useful for when we've got very long command + lines that might overflow an OS limit on command line length and so you + need to invoke a command multiple times to get all the args in.

It takes four template invocations corresponding to the simple, initial, + middle and last invocations. If the number of args given is small enough + that we can get away with just a single invocation then the simple one is + used:

$ simple args

If the number of args given means that we need to use multiple invocations + then the templates for the initial, middle and last invocations are used:

$ initial args_0
+$ middle  args_1
+$ middle  args_2
+  ...
+$ final   args_n
diff --git a/doc/API/Cabal/Distribution-Simple-Program-Builtin.html b/doc/API/Cabal/Distribution-Simple-Program-Builtin.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Program-Builtin.html @@ -0,0 +1,2 @@ +Distribution.Simple.Program.Builtin

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2006 Duncan Coutts 2007-2009
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Program.Builtin

Contents

Description

The module defines all the known built-in Programs.

Where possible we try to find their version numbers.

Synopsis

The collection of unconfigured and configured programs

builtinPrograms :: [Program] #

The default list of programs. + These programs are typically used internally to Cabal.

Programs that Cabal knows about

ghcProgram :: Program #

ghcPkgProgram :: Program #

runghcProgram :: Program #

ghcjsProgram :: Program #

ghcjsPkgProgram :: Program #

hmakeProgram :: Program #

jhcProgram :: Program #

haskellSuiteProgram :: Program #

haskellSuitePkgProgram :: Program #

uhcProgram :: Program #

gccProgram :: Program #

arProgram :: Program #

stripProgram :: Program #

happyProgram :: Program #

alexProgram :: Program #

hsc2hsProgram :: Program #

c2hsProgram :: Program #

cpphsProgram :: Program #

hscolourProgram :: Program #

doctestProgram :: Program #

haddockProgram :: Program #

greencardProgram :: Program #

ldProgram :: Program #

tarProgram :: Program #

cppProgram :: Program #

pkgConfigProgram :: Program #

hpcProgram :: Program #

diff --git a/doc/API/Cabal/Distribution-Simple-Program-Db.html b/doc/API/Cabal/Distribution-Simple-Program-Db.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Program-Db.html @@ -0,0 +1,51 @@ +Distribution.Simple.Program.Db

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2006 Duncan Coutts 2007-2009
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Program.Db

Contents

Description

This provides a ProgramDb type which holds configured and not-yet + configured programs. It is the parameter to lots of actions elsewhere in + Cabal that need to look up and run programs. If we had a Cabal monad, + the ProgramDb would probably be a reader or state component of it.

One nice thing about using it is that any program that is + registered with Cabal will get some "configure" and ".cabal" + helpers like --with-foo-args --foo-path= and extra-foo-args.

There's also a hook for adding programs in a Setup.lhs script. See + hookedPrograms in UserHooks. This gives a + hook user the ability to get the above flags and such so that they + don't have to write all the PATH logic inside Setup.lhs.

Synopsis

The collection of configured programs we can run

data ProgramDb #

The configuration is a collection of information about programs. It + contains information both about configured programs and also about programs + that we are yet to configure.

The idea is that we start from a collection of unconfigured programs and one + by one we try to configure them at which point we move them into the + configured collection. For unconfigured programs we record not just the + Program but also any user-provided arguments and location for the program.

Instances
Read ProgramDb #

Note that this instance does not preserve the known Programs. + See restoreProgramDb for details.

Instance details

Defined in Distribution.Simple.Program.Db

Methods

readsPrec :: Int -> ReadS ProgramDb #

readList :: ReadS [ProgramDb] #

readPrec :: ReadPrec ProgramDb #

readListPrec :: ReadPrec [ProgramDb] #

Show ProgramDb #

Note that this instance does not preserve the known Programs. + See restoreProgramDb for details.

Instance details

Defined in Distribution.Simple.Program.Db

Methods

showsPrec :: Int -> ProgramDb -> ShowS #

show :: ProgramDb -> String #

showList :: [ProgramDb] -> ShowS #

Binary ProgramDb #

Note that this instance does not preserve the known Programs. + See restoreProgramDb for details.

Instance details

Defined in Distribution.Simple.Program.Db

Methods

put :: ProgramDb -> Put #

get :: Get ProgramDb #

putList :: [ProgramDb] -> Put #

emptyProgramDb :: ProgramDb #

defaultProgramDb :: ProgramDb #

restoreProgramDb :: [Program] -> ProgramDb -> ProgramDb #

The 'Read'\/'Show' and Binary instances do not preserve all the + unconfigured Programs because Program is not in 'Read'\/'Show' because + it contains functions. So to fully restore a deserialised ProgramDb use + this function to add back all the known Programs.

  • It does not add the default programs, but you probably want them, use + builtinPrograms in addition to any extra you might need.

Query and manipulate the program db

addKnownProgram :: Program -> ProgramDb -> ProgramDb #

Add a known program that we may configure later

addKnownPrograms :: [Program] -> ProgramDb -> ProgramDb #

lookupKnownProgram :: String -> ProgramDb -> Maybe Program #

knownPrograms :: ProgramDb -> [(Program, Maybe ConfiguredProgram)] #

getProgramSearchPath :: ProgramDb -> ProgramSearchPath #

Get the current ProgramSearchPath used by the ProgramDb. + This is the default list of locations where programs are looked for when + configuring them. This can be overridden for specific programs (with + userSpecifyPath), and specific known programs can modify or ignore this + search path in their own configuration code.

setProgramSearchPath :: ProgramSearchPath -> ProgramDb -> ProgramDb #

Change the current ProgramSearchPath used by the ProgramDb. + This will affect programs that are configured from here on, so you + should usually set it before configuring any programs.

modifyProgramSearchPath :: (ProgramSearchPath -> ProgramSearchPath) -> ProgramDb -> ProgramDb #

Modify the current ProgramSearchPath used by the ProgramDb. + This will affect programs that are configured from here on, so you + should usually modify it before configuring any programs.

userSpecifyPath #

Arguments

:: String

Program name

-> FilePath

user-specified path to the program

-> ProgramDb 
-> ProgramDb 

User-specify this path. Basically override any path information + for this program in the configuration. If it's not a known + program ignore it.

userSpecifyPaths :: [(String, FilePath)] -> ProgramDb -> ProgramDb #

Like userSpecifyPath but for a list of progs and their paths.

userMaybeSpecifyPath :: String -> Maybe FilePath -> ProgramDb -> ProgramDb #

userSpecifyArgs #

Arguments

:: String

Program name

-> [ProgArg]

user-specified args

-> ProgramDb 
-> ProgramDb 

User-specify the arguments for this program. Basically override + any args information for this program in the configuration. If it's + not a known program, ignore it..

userSpecifyArgss :: [(String, [ProgArg])] -> ProgramDb -> ProgramDb #

Like userSpecifyPath but for a list of progs and their args.

userSpecifiedArgs :: Program -> ProgramDb -> [ProgArg] #

Get any extra args that have been previously specified for a program.

lookupProgram :: Program -> ProgramDb -> Maybe ConfiguredProgram #

Try to find a configured program

updateProgram :: ConfiguredProgram -> ProgramDb -> ProgramDb #

Update a configured program in the database.

configuredPrograms :: ProgramDb -> [ConfiguredProgram] #

List all configured programs.

Query and manipulate the program db

configureProgram :: Verbosity -> Program -> ProgramDb -> IO ProgramDb #

Try to configure a specific program. If the program is already included in + the collection of unconfigured programs then we use any user-supplied + location and arguments. If the program gets configured successfully it gets + added to the configured collection.

Note that it is not a failure if the program cannot be configured. It's only + a failure if the user supplied a location and the program could not be found + at that location.

The reason for it not being a failure at this stage is that we don't know up + front all the programs we will need, so we try to configure them all. + To verify that a program was actually successfully configured use + requireProgram.

configureAllKnownPrograms :: Verbosity -> ProgramDb -> IO ProgramDb #

Try to configure all the known programs that have not yet been configured.

unconfigureProgram :: String -> ProgramDb -> ProgramDb #

Unconfigure a program. This is basically a hack and you shouldn't + use it, but it can be handy for making sure a requireProgram + actually reconfigures.

lookupProgramVersion :: Verbosity -> Program -> VersionRange -> ProgramDb -> IO (Either String (ConfiguredProgram, Version, ProgramDb)) #

Check that a program is configured and available to be run.

Additionally check that the program version number is suitable and return + it. For example you could require AnyVersion or orLaterVersion + (Version [1,0] [])

It returns the configured program, its version number and a possibly updated + ProgramDb. If the program could not be configured or the version is + unsuitable, it returns an error value.

reconfigurePrograms :: Verbosity -> [(String, FilePath)] -> [(String, [ProgArg])] -> ProgramDb -> IO ProgramDb #

reconfigure a bunch of programs given new user-specified args. It takes + the same inputs as userSpecifyPath and userSpecifyArgs and for all progs + with a new path it calls configureProgram.

requireProgram :: Verbosity -> Program -> ProgramDb -> IO (ConfiguredProgram, ProgramDb) #

Check that a program is configured and available to be run.

It raises an exception if the program could not be configured, otherwise + it returns the configured program.

requireProgramVersion :: Verbosity -> Program -> VersionRange -> ProgramDb -> IO (ConfiguredProgram, Version, ProgramDb) #

Like lookupProgramVersion, but raises an exception in case of error + instead of returning 'Left errMsg'.

diff --git a/doc/API/Cabal/Distribution-Simple-Program-Find.html b/doc/API/Cabal/Distribution-Simple-Program-Find.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Program-Find.html @@ -0,0 +1,17 @@ +Distribution.Simple.Program.Find

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightDuncan Coutts 2013
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Program.Find

Contents

Description

A somewhat extended notion of the normal program search path concept.

Usually when finding executables we just want to look in the usual places + using the OS's usual method for doing so. In Haskell the normal OS-specific + method is captured by findExecutable. On all common OSs that makes use of + a PATH environment variable, (though on Windows it is not just the PATH).

However it is sometimes useful to be able to look in additional locations + without having to change the process-global PATH environment variable. + So we need an extension of the usual findExecutable that can look in + additional locations, either before, after or instead of the normal OS + locations.

Synopsis

Program search path

type ProgramSearchPath = [ProgramSearchPathEntry] #

A search path to use when locating executables. This is analogous + to the unix $PATH or win32 %PATH% but with the ability to use + the system default method for finding executables (findExecutable which + on unix is simply looking on the $PATH but on win32 is a bit more + complicated).

The default to use is [ProgSearchPathDefault] but you can add extra dirs + either before, after or instead of the default, e.g. here we add an extra + dir to search after the usual ones.

['ProgramSearchPathDefault', 'ProgramSearchPathDir' dir]

data ProgramSearchPathEntry #

Constructors

ProgramSearchPathDir FilePath

A specific dir

ProgramSearchPathDefault

The system default

Instances
Eq ProgramSearchPathEntry # 
Instance details

Defined in Distribution.Simple.Program.Find

Methods

(==) :: ProgramSearchPathEntry -> ProgramSearchPathEntry -> Bool #

(/=) :: ProgramSearchPathEntry -> ProgramSearchPathEntry -> Bool #

Generic ProgramSearchPathEntry # 
Instance details

Defined in Distribution.Simple.Program.Find

Associated Types

type Rep ProgramSearchPathEntry :: * -> * #

Methods

from :: ProgramSearchPathEntry -> Rep ProgramSearchPathEntry x #

to :: Rep ProgramSearchPathEntry x -> ProgramSearchPathEntry #

Binary ProgramSearchPathEntry # 
Instance details

Defined in Distribution.Simple.Program.Find

Methods

put :: ProgramSearchPathEntry -> Put #

get :: Get ProgramSearchPathEntry #

putList :: [ProgramSearchPathEntry] -> Put #

type Rep ProgramSearchPathEntry # 
Instance details

Defined in Distribution.Simple.Program.Find

type Rep ProgramSearchPathEntry = D1 (MetaData "ProgramSearchPathEntry" "Distribution.Simple.Program.Find" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ProgramSearchPathDir" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :+: C1 (MetaCons "ProgramSearchPathDefault" PrefixI False) (U1 :: * -> *))

defaultProgramSearchPath :: ProgramSearchPath #

findProgramOnSearchPath :: Verbosity -> ProgramSearchPath -> FilePath -> IO (Maybe (FilePath, [FilePath])) #

programSearchPathAsPATHVar :: ProgramSearchPath -> NoCallStackIO String #

Interpret a ProgramSearchPath to construct a new $PATH env var. + Note that this is close but not perfect because on Windows the search + algorithm looks at more than just the %PATH%.

getSystemSearchPath :: NoCallStackIO [FilePath] #

Get the system search path. On Unix systems this is just the $PATH env + var, but on windows it's a bit more complicated.

diff --git a/doc/API/Cabal/Distribution-Simple-Program-GHC.html b/doc/API/Cabal/Distribution-Simple-Program-GHC.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Program-GHC.html @@ -0,0 +1,27 @@ +Distribution.Simple.Program.GHC

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Program.GHC

Synopsis

Documentation

data GhcOptions #

A structured set of GHC options/flags

Note that options containing lists fall into two categories:

  • options that can be safely deduplicated, e.g. input modules or + enabled extensions;
  • options that cannot be deduplicated in general without changing + semantics, e.g. extra ghc options or linking options.

Constructors

GhcOptions 

Fields

Instances
Show GhcOptions # 
Instance details

Defined in Distribution.Simple.Program.GHC

Methods

showsPrec :: Int -> GhcOptions -> ShowS #

show :: GhcOptions -> String #

showList :: [GhcOptions] -> ShowS #

Generic GhcOptions # 
Instance details

Defined in Distribution.Simple.Program.GHC

Associated Types

type Rep GhcOptions :: * -> * #

Methods

from :: GhcOptions -> Rep GhcOptions x #

to :: Rep GhcOptions x -> GhcOptions #

Semigroup GhcOptions # 
Instance details

Defined in Distribution.Simple.Program.GHC

Methods

(<>) :: GhcOptions -> GhcOptions -> GhcOptions #

sconcat :: NonEmpty GhcOptions -> GhcOptions #

stimes :: Integral b => b -> GhcOptions -> GhcOptions #

Monoid GhcOptions # 
Instance details

Defined in Distribution.Simple.Program.GHC

Methods

mempty :: GhcOptions #

mappend :: GhcOptions -> GhcOptions -> GhcOptions #

mconcat :: [GhcOptions] -> GhcOptions #

type Rep GhcOptions # 
Instance details

Defined in Distribution.Simple.Program.GHC

type Rep GhcOptions = D1 (MetaData "GhcOptions" "Distribution.Simple.Program.GHC" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "GhcOptions" PrefixI True) (((((S1 (MetaSel (Just "ghcOptMode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag GhcMode)) :*: (S1 (MetaSel (Just "ghcOptExtra") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "ghcOptExtraDefault") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]))) :*: ((S1 (MetaSel (Just "ghcOptInputFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NubListR FilePath)) :*: S1 (MetaSel (Just "ghcOptInputModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NubListR ModuleName))) :*: (S1 (MetaSel (Just "ghcOptOutputFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)) :*: S1 (MetaSel (Just "ghcOptOutputDynFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath))))) :*: (((S1 (MetaSel (Just "ghcOptSourcePathClear") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)) :*: S1 (MetaSel (Just "ghcOptSourcePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NubListR FilePath))) :*: (S1 (MetaSel (Just "ghcOptThisUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag String)) :*: S1 (MetaSel (Just "ghcOptThisComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag ComponentId)))) :*: ((S1 (MetaSel (Just "ghcOptInstantiatedWith") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(ModuleName, OpenModule)]) :*: S1 (MetaSel (Just "ghcOptNoCode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool))) :*: (S1 (MetaSel (Just "ghcOptPackageDBs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageDBStack) :*: S1 (MetaSel (Just "ghcOptPackages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NubListR (OpenUnitId, ModuleRenaming))))))) :*: (((S1 (MetaSel (Just "ghcOptHideAllPackages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)) :*: (S1 (MetaSel (Just "ghcOptWarnMissingHomeModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)) :*: S1 (MetaSel (Just "ghcOptNoAutoLinkPackages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)))) :*: ((S1 (MetaSel (Just "ghcOptLinkLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "ghcOptLinkLibPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NubListR FilePath))) :*: (S1 (MetaSel (Just "ghcOptLinkOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "ghcOptLinkFrameworks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NubListR String))))) :*: (((S1 (MetaSel (Just "ghcOptLinkFrameworkDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NubListR String)) :*: S1 (MetaSel (Just "ghcOptNoLink") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool))) :*: (S1 (MetaSel (Just "ghcOptLinkNoHsMain") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)) :*: S1 (MetaSel (Just "ghcOptLinkModDefFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NubListR FilePath)))) :*: ((S1 (MetaSel (Just "ghcOptCcOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "ghcOptCxxOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) :*: (S1 (MetaSel (Just "ghcOptCppOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "ghcOptCppIncludePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NubListR FilePath))))))) :*: ((((S1 (MetaSel (Just "ghcOptCppIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NubListR FilePath)) :*: (S1 (MetaSel (Just "ghcOptFfiIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NubListR FilePath)) :*: S1 (MetaSel (Just "ghcOptLanguage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Language)))) :*: ((S1 (MetaSel (Just "ghcOptExtensions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NubListR Extension)) :*: S1 (MetaSel (Just "ghcOptExtensionMap") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Extension (Maybe Flag)))) :*: (S1 (MetaSel (Just "ghcOptOptimisation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag GhcOptimisation)) :*: S1 (MetaSel (Just "ghcOptDebugInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag DebugInfoLevel))))) :*: (((S1 (MetaSel (Just "ghcOptProfilingMode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)) :*: S1 (MetaSel (Just "ghcOptProfilingAuto") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag GhcProfAuto))) :*: (S1 (MetaSel (Just "ghcOptSplitSections") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)) :*: S1 (MetaSel (Just "ghcOptSplitObjs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)))) :*: ((S1 (MetaSel (Just "ghcOptNumJobs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag (Maybe Int))) :*: S1 (MetaSel (Just "ghcOptHPCDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath))) :*: (S1 (MetaSel (Just "ghcOptGHCiScripts") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "ghcOptHiSuffix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag String)))))) :*: ((((S1 (MetaSel (Just "ghcOptObjSuffix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag String)) :*: S1 (MetaSel (Just "ghcOptDynHiSuffix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag String))) :*: (S1 (MetaSel (Just "ghcOptDynObjSuffix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag String)) :*: S1 (MetaSel (Just "ghcOptHiDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)))) :*: ((S1 (MetaSel (Just "ghcOptObjDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)) :*: S1 (MetaSel (Just "ghcOptOutputDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath))) :*: (S1 (MetaSel (Just "ghcOptStubDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)) :*: S1 (MetaSel (Just "ghcOptDynLinkMode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag GhcDynLinkMode))))) :*: (((S1 (MetaSel (Just "ghcOptStaticLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)) :*: S1 (MetaSel (Just "ghcOptShared") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool))) :*: (S1 (MetaSel (Just "ghcOptFPic") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)) :*: S1 (MetaSel (Just "ghcOptDylibName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag String)))) :*: ((S1 (MetaSel (Just "ghcOptRPaths") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NubListR FilePath)) :*: S1 (MetaSel (Just "ghcOptVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Verbosity))) :*: (S1 (MetaSel (Just "ghcOptExtraPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NubListR FilePath)) :*: S1 (MetaSel (Just "ghcOptCabal") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)))))))))

data GhcMode #

Constructors

GhcModeCompile
ghc -c
GhcModeLink
ghc
GhcModeMake
ghc --make
GhcModeInteractive

ghci / ghc --interactive

GhcModeAbiHash

ghc --abi-hash + | GhcModeDepAnalysis -- ^ ghc -M + | GhcModeEvaluate -- ^ ghc -e

Instances
Eq GhcMode # 
Instance details

Defined in Distribution.Simple.Program.GHC

Methods

(==) :: GhcMode -> GhcMode -> Bool #

(/=) :: GhcMode -> GhcMode -> Bool #

Show GhcMode # 
Instance details

Defined in Distribution.Simple.Program.GHC

Methods

showsPrec :: Int -> GhcMode -> ShowS #

show :: GhcMode -> String #

showList :: [GhcMode] -> ShowS #

data GhcOptimisation #

Constructors

GhcNoOptimisation
-O0
GhcNormalOptimisation
-O
GhcMaximumOptimisation
-O2
GhcSpecialOptimisation String

e.g. -Odph

Instances
Eq GhcOptimisation # 
Instance details

Defined in Distribution.Simple.Program.GHC

Methods

(==) :: GhcOptimisation -> GhcOptimisation -> Bool #

(/=) :: GhcOptimisation -> GhcOptimisation -> Bool #

Show GhcOptimisation # 
Instance details

Defined in Distribution.Simple.Program.GHC

Methods

showsPrec :: Int -> GhcOptimisation -> ShowS #

show :: GhcOptimisation -> String #

showList :: [GhcOptimisation] -> ShowS #

data GhcDynLinkMode #

Constructors

GhcStaticOnly
-static
GhcDynamicOnly
-dynamic
GhcStaticAndDynamic
-static -dynamic-too
Instances
Eq GhcDynLinkMode # 
Instance details

Defined in Distribution.Simple.Program.GHC

Methods

(==) :: GhcDynLinkMode -> GhcDynLinkMode -> Bool #

(/=) :: GhcDynLinkMode -> GhcDynLinkMode -> Bool #

Show GhcDynLinkMode # 
Instance details

Defined in Distribution.Simple.Program.GHC

Methods

showsPrec :: Int -> GhcDynLinkMode -> ShowS #

show :: GhcDynLinkMode -> String #

showList :: [GhcDynLinkMode] -> ShowS #

data GhcProfAuto #

Constructors

GhcProfAutoAll
-fprof-auto
GhcProfAutoToplevel
-fprof-auto-top
GhcProfAutoExported
-fprof-auto-exported
Instances
Eq GhcProfAuto # 
Instance details

Defined in Distribution.Simple.Program.GHC

Methods

(==) :: GhcProfAuto -> GhcProfAuto -> Bool #

(/=) :: GhcProfAuto -> GhcProfAuto -> Bool #

Show GhcProfAuto # 
Instance details

Defined in Distribution.Simple.Program.GHC

Methods

showsPrec :: Int -> GhcProfAuto -> ShowS #

show :: GhcProfAuto -> String #

showList :: [GhcProfAuto] -> ShowS #

ghcInvocation :: ConfiguredProgram -> Compiler -> Platform -> GhcOptions -> ProgramInvocation #

renderGhcOptions :: Compiler -> Platform -> GhcOptions -> [String] #

runGHC :: Verbosity -> ConfiguredProgram -> Compiler -> Platform -> GhcOptions -> IO () #

packageDbArgsDb :: PackageDBStack -> [String] #

GHC >= 7.6 uses the '-package-db' flag. See + https://ghc.haskell.org/trac/ghc/ticket/5977.

normaliseGhcArgs :: Maybe Version -> PackageDescription -> [String] -> [String] #

diff --git a/doc/API/Cabal/Distribution-Simple-Program-HcPkg.html b/doc/API/Cabal/Distribution-Simple-Program-HcPkg.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Program-HcPkg.html @@ -0,0 +1,14 @@ +Distribution.Simple.Program.HcPkg

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightDuncan Coutts 2009 2013
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Program.HcPkg

Contents

Description

This module provides an library interface to the hc-pkg program. + Currently only GHC and GHCJS have hc-pkg programs.

Synopsis

Types

data HcPkgInfo #

Information about the features and capabilities of an hc-pkg + program.

Constructors

HcPkgInfo 

Fields

data RegisterOptions #

Additional variations in the behaviour for register.

Constructors

RegisterOptions 

Fields

defaultRegisterOptions :: RegisterOptions #

Defaults are True, False and False

Actions

init :: HcPkgInfo -> Verbosity -> Bool -> FilePath -> IO () #

Call hc-pkg to initialise a package database at the location {path}.

hc-pkg init {path}

invoke :: HcPkgInfo -> Verbosity -> PackageDBStack -> [String] -> IO () #

Run hc-pkg using a given package DB stack, directly forwarding the + provided command-line arguments to it.

register :: HcPkgInfo -> Verbosity -> PackageDBStack -> InstalledPackageInfo -> RegisterOptions -> IO () #

Call hc-pkg to register a package.

hc-pkg register {filename | -} [--user | --global | --package-db]

unregister :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> IO () #

Call hc-pkg to unregister a package

hc-pkg unregister [pkgid] [--user | --global | --package-db]

recache :: HcPkgInfo -> Verbosity -> PackageDB -> IO () #

Call hc-pkg to recache the registered packages.

hc-pkg recache [--user | --global | --package-db]

expose :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> IO () #

Call hc-pkg to expose a package.

hc-pkg expose [pkgid] [--user | --global | --package-db]

hide :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> IO () #

Call hc-pkg to hide a package.

hc-pkg hide [pkgid] [--user | --global | --package-db]

dump :: HcPkgInfo -> Verbosity -> PackageDB -> IO [InstalledPackageInfo] #

Call hc-pkg to get all the details of all the packages in the given + package database.

describe :: HcPkgInfo -> Verbosity -> PackageDBStack -> PackageId -> IO [InstalledPackageInfo] #

Call hc-pkg to retrieve a specific package

hc-pkg describe [pkgid] [--user | --global | --package-db]

list :: HcPkgInfo -> Verbosity -> PackageDB -> IO [PackageId] #

Call hc-pkg to get the source package Id of all the packages in the + given package database.

This is much less information than with dump, but also rather quicker. + Note in particular that it does not include the UnitId, just + the source PackageId which is not necessarily unique in any package db.

Program invocations

initInvocation :: HcPkgInfo -> Verbosity -> FilePath -> ProgramInvocation #

registerInvocation :: HcPkgInfo -> Verbosity -> PackageDBStack -> InstalledPackageInfo -> RegisterOptions -> ProgramInvocation #

unregisterInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> ProgramInvocation #

recacheInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> ProgramInvocation #

exposeInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> ProgramInvocation #

hideInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> ProgramInvocation #

dumpInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> ProgramInvocation #

describeInvocation :: HcPkgInfo -> Verbosity -> PackageDBStack -> PackageId -> ProgramInvocation #

listInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> ProgramInvocation #

diff --git a/doc/API/Cabal/Distribution-Simple-Program-Hpc.html b/doc/API/Cabal/Distribution-Simple-Program-Hpc.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Program-Hpc.html @@ -0,0 +1,5 @@ +Distribution.Simple.Program.Hpc

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightThomas Tuegel 2011
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Program.Hpc

Description

This module provides an library interface to the hpc program.

Synopsis

Documentation

markup #

Arguments

:: ConfiguredProgram 
-> Version 
-> Verbosity 
-> FilePath

Path to .tix file

-> [FilePath]

Paths to .mix file directories

-> FilePath

Path where html output should be located

-> [ModuleName]

List of modules to exclude from report

-> IO () 

Invoke hpc with the given parameters.

Prior to HPC version 0.7 (packaged with GHC 7.8), hpc did not handle + multiple .mix paths correctly, so we print a warning, and only pass it the + first path in the list. This means that e.g. test suites that import their + library as a dependency can still work, but those that include the library + modules directly (in other-modules) don't.

union #

Arguments

:: ConfiguredProgram 
-> Verbosity 
-> [FilePath]

Paths to .tix files

-> FilePath

Path to resultant .tix file

-> [ModuleName]

List of modules to exclude from union

-> IO () 
diff --git a/doc/API/Cabal/Distribution-Simple-Program-Internal.html b/doc/API/Cabal/Distribution-Simple-Program-Internal.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Program-Internal.html @@ -0,0 +1,4 @@ +Distribution.Simple.Program.Internal

Cabal-2.4.0.1: A framework for packaging Haskell software

Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Program.Internal

Description

Internal utilities used by Distribution.Simple.Program.*.

Synopsis

Documentation

stripExtractVersion :: String -> String #

Extract the version number from the output of 'strip --version'.

Invoking "strip --version" gives very inconsistent results. We ignore + everything in parentheses (see #2497), look for the first word that starts + with a number, and try parsing out the first two components of it. Non-GNU + strip doesn't appear to have a version flag.

diff --git a/doc/API/Cabal/Distribution-Simple-Program-Ld.html b/doc/API/Cabal/Distribution-Simple-Program-Ld.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Program-Ld.html @@ -0,0 +1,1 @@ +Distribution.Simple.Program.Ld

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightDuncan Coutts 2009
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Program.Ld

Description

This module provides an library interface to the ld linker program.

Synopsis

Documentation

combineObjectFiles :: Verbosity -> LocalBuildInfo -> ConfiguredProgram -> FilePath -> [FilePath] -> IO () #

Call ld -r to link a bunch of object files together.

diff --git a/doc/API/Cabal/Distribution-Simple-Program-ResponseFile.html b/doc/API/Cabal/Distribution-Simple-Program-ResponseFile.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Program-ResponseFile.html @@ -0,0 +1,1 @@ +Distribution.Simple.Program.ResponseFile

Cabal-2.4.0.1: A framework for packaging Haskell software

Copyright(c) Sergey Vinokurov 2017
LicenseBSD3-style
Maintainercabal-devel@haskell.org
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Program.ResponseFile

Description

Created : 23 July 2017

Documentation

withResponseFile #

Arguments

:: Verbosity 
-> TempFileOptions 
-> FilePath

Working directory to create response file in.

-> FilePath

Template for response file name.

-> Maybe TextEncoding

Encoding to use for response file contents.

-> [String]

Arguments to put into response file.

-> (FilePath -> IO a) 
-> IO a 
diff --git a/doc/API/Cabal/Distribution-Simple-Program-Run.html b/doc/API/Cabal/Distribution-Simple-Program-Run.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Program-Run.html @@ -0,0 +1,17 @@ +Distribution.Simple.Program.Run

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightDuncan Coutts 2009
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Program.Run

Description

This module provides a data type for program invocations and functions to + run them.

Synopsis

Documentation

data ProgramInvocation #

Represents a specific invocation of a specific program.

This is used as an intermediate type between deciding how to call a program + and actually doing it. This provides the opportunity to the caller to + adjust how the program will be called. These invocations can either be run + directly or turned into shell or batch scripts.

Constructors

ProgramInvocation 

Fields

data IOEncoding #

Constructors

IOEncodingText 
IOEncodingUTF8 

emptyProgramInvocation :: ProgramInvocation #

simpleProgramInvocation :: FilePath -> [String] -> ProgramInvocation #

programInvocation :: ConfiguredProgram -> [String] -> ProgramInvocation #

multiStageProgramInvocation :: ProgramInvocation -> (ProgramInvocation, ProgramInvocation, ProgramInvocation) -> [String] -> [ProgramInvocation] #

Like the unix xargs program. Useful for when we've got very long command + lines that might overflow an OS limit on command line length and so you + need to invoke a command multiple times to get all the args in.

It takes four template invocations corresponding to the simple, initial, + middle and last invocations. If the number of args given is small enough + that we can get away with just a single invocation then the simple one is + used:

$ simple args

If the number of args given means that we need to use multiple invocations + then the templates for the initial, middle and last invocations are used:

$ initial args_0
+$ middle  args_1
+$ middle  args_2
+  ...
+$ final   args_n

runProgramInvocation :: Verbosity -> ProgramInvocation -> IO () #

getProgramInvocationOutput :: Verbosity -> ProgramInvocation -> IO String #

getProgramInvocationOutputAndErrors :: Verbosity -> ProgramInvocation -> IO (String, String, ExitCode) #

getEffectiveEnvironment :: [(String, Maybe String)] -> NoCallStackIO (Maybe [(String, String)]) #

Return the current environment extended with the given overrides. + If an entry is specified twice in overrides, the second entry takes + precedence.

diff --git a/doc/API/Cabal/Distribution-Simple-Program-Script.html b/doc/API/Cabal/Distribution-Simple-Program-Script.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Program-Script.html @@ -0,0 +1,3 @@ +Distribution.Simple.Program.Script

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightDuncan Coutts 2009
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Program.Script

Description

This module provides an library interface to the hc-pkg program. + Currently only GHC and LHC have hc-pkg programs.

Synopsis

Documentation

invocationAsSystemScript :: OS -> ProgramInvocation -> String #

Generate a system script, either POSIX shell script or Windows batch file + as appropriate for the given system.

invocationAsShellScript :: ProgramInvocation -> String #

Generate a POSIX shell script that invokes a program.

invocationAsBatchFile :: ProgramInvocation -> String #

Generate a Windows batch file that invokes a program.

diff --git a/doc/API/Cabal/Distribution-Simple-Program-Strip.html b/doc/API/Cabal/Distribution-Simple-Program-Strip.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Program-Strip.html @@ -0,0 +1,1 @@ +Distribution.Simple.Program.Strip

Cabal-2.4.0.1: A framework for packaging Haskell software

Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Program.Strip

Description

This module provides an library interface to the strip program.

Documentation

stripLib :: Verbosity -> Platform -> ProgramDb -> FilePath -> IO () #

stripExe :: Verbosity -> Platform -> ProgramDb -> FilePath -> IO () #

diff --git a/doc/API/Cabal/Distribution-Simple-Program-Types.html b/doc/API/Cabal/Distribution-Simple-Program-Types.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Program-Types.html @@ -0,0 +1,41 @@ +Distribution.Simple.Program.Types

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2006 Duncan Coutts 2007-2009
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Program.Types

Contents

Description

This provides an abstraction which deals with configuring and running + programs. A Program is a static notion of a known program. A + ConfiguredProgram is a Program that has been found on the current + machine and is ready to be run (possibly with some user-supplied default + args). Configuring a program involves finding its location and if necessary + finding its version. There's reasonable default behavior for trying to find + "foo" in PATH, being able to override its location, etc.

Synopsis

Program and functions for constructing them

data Program #

Represents a program which can be configured.

Note: rather than constructing this directly, start with simpleProgram and + override any extra fields.

Constructors

Program 

Fields

Instances
Show Program # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

showsPrec :: Int -> Program -> ShowS #

show :: Program -> String #

showList :: [Program] -> ShowS #

type ProgramSearchPath = [ProgramSearchPathEntry] #

A search path to use when locating executables. This is analogous + to the unix $PATH or win32 %PATH% but with the ability to use + the system default method for finding executables (findExecutable which + on unix is simply looking on the $PATH but on win32 is a bit more + complicated).

The default to use is [ProgSearchPathDefault] but you can add extra dirs + either before, after or instead of the default, e.g. here we add an extra + dir to search after the usual ones.

['ProgramSearchPathDefault', 'ProgramSearchPathDir' dir]

data ProgramSearchPathEntry #

Constructors

ProgramSearchPathDir FilePath

A specific dir

ProgramSearchPathDefault

The system default

Instances
Eq ProgramSearchPathEntry # 
Instance details

Defined in Distribution.Simple.Program.Find

Methods

(==) :: ProgramSearchPathEntry -> ProgramSearchPathEntry -> Bool #

(/=) :: ProgramSearchPathEntry -> ProgramSearchPathEntry -> Bool #

Generic ProgramSearchPathEntry # 
Instance details

Defined in Distribution.Simple.Program.Find

Associated Types

type Rep ProgramSearchPathEntry :: * -> * #

Methods

from :: ProgramSearchPathEntry -> Rep ProgramSearchPathEntry x #

to :: Rep ProgramSearchPathEntry x -> ProgramSearchPathEntry #

Binary ProgramSearchPathEntry # 
Instance details

Defined in Distribution.Simple.Program.Find

Methods

put :: ProgramSearchPathEntry -> Put #

get :: Get ProgramSearchPathEntry #

putList :: [ProgramSearchPathEntry] -> Put #

type Rep ProgramSearchPathEntry # 
Instance details

Defined in Distribution.Simple.Program.Find

type Rep ProgramSearchPathEntry = D1 (MetaData "ProgramSearchPathEntry" "Distribution.Simple.Program.Find" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ProgramSearchPathDir" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :+: C1 (MetaCons "ProgramSearchPathDefault" PrefixI False) (U1 :: * -> *))

simpleProgram :: String -> Program #

Make a simple named program.

By default we'll just search for it in the path and not try to find the + version name. You can override these behaviours if necessary, eg:

(simpleProgram "foo") { programFindLocation = ... , programFindVersion ... }

Configured program and related functions

data ConfiguredProgram #

Represents a program which has been configured and is thus ready to be run.

These are usually made by configuring a Program, but if you have to + construct one directly then start with simpleConfiguredProgram and + override any extra fields.

Constructors

ConfiguredProgram 

Fields

  • programId :: String

    Just the name again

  • programVersion :: Maybe Version

    The version of this program, if it is known.

  • programDefaultArgs :: [String]

    Default command-line args for this program. + These flags will appear first on the command line, so they can be + overridden by subsequent flags.

  • programOverrideArgs :: [String]

    Override command-line args for this program. + These flags will appear last on the command line, so they override + all earlier flags.

  • programOverrideEnv :: [(String, Maybe String)]

    Override environment variables for this program. + These env vars will extend/override the prevailing environment of + the current to form the environment for the new process.

  • programProperties :: Map String String

    A key-value map listing various properties of the program, useful + for feature detection. Populated during the configuration step, key + names depend on the specific program.

  • programLocation :: ProgramLocation

    Location of the program. eg. /usr/bin/ghc-6.4

  • programMonitorFiles :: [FilePath]

    In addition to the programLocation where the program was found, + these are additional locations that were looked at. The combination + of ths found location and these not-found locations can be used to + monitor to detect when the re-configuring the program might give a + different result (e.g. found in a different location).

Instances
Eq ConfiguredProgram # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

(==) :: ConfiguredProgram -> ConfiguredProgram -> Bool #

(/=) :: ConfiguredProgram -> ConfiguredProgram -> Bool #

Read ConfiguredProgram # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

readsPrec :: Int -> ReadS ConfiguredProgram #

readList :: ReadS [ConfiguredProgram] #

readPrec :: ReadPrec ConfiguredProgram #

readListPrec :: ReadPrec [ConfiguredProgram] #

Show ConfiguredProgram # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

showsPrec :: Int -> ConfiguredProgram -> ShowS #

show :: ConfiguredProgram -> String #

showList :: [ConfiguredProgram] -> ShowS #

Generic ConfiguredProgram # 
Instance details

Defined in Distribution.Simple.Program.Types

Associated Types

type Rep ConfiguredProgram :: * -> * #

Methods

from :: ConfiguredProgram -> Rep ConfiguredProgram x #

to :: Rep ConfiguredProgram x -> ConfiguredProgram #

Binary ConfiguredProgram # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

put :: ConfiguredProgram -> Put #

get :: Get ConfiguredProgram #

putList :: [ConfiguredProgram] -> Put #

type Rep ConfiguredProgram # 
Instance details

Defined in Distribution.Simple.Program.Types

type Rep ConfiguredProgram = D1 (MetaData "ConfiguredProgram" "Distribution.Simple.Program.Types" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ConfiguredProgram" PrefixI True) (((S1 (MetaSel (Just "programId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "programVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Version))) :*: (S1 (MetaSel (Just "programDefaultArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "programOverrideArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]))) :*: ((S1 (MetaSel (Just "programOverrideEnv") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, Maybe String)]) :*: S1 (MetaSel (Just "programProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map String String))) :*: (S1 (MetaSel (Just "programLocation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ProgramLocation) :*: S1 (MetaSel (Just "programMonitorFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))))

programPath :: ConfiguredProgram -> FilePath #

The full path of a configured program.

suppressOverrideArgs :: ConfiguredProgram -> ConfiguredProgram #

Suppress any extra arguments added by the user.

type ProgArg = String #

data ProgramLocation #

Where a program was found. Also tells us whether it's specified by user or + not. This includes not just the path, but the program as well.

Constructors

UserSpecified

The user gave the path to this program, + eg. --ghc-path=/usr/bin/ghc-6.6

Fields

FoundOnSystem

The program was found automatically.

Fields

Instances
Eq ProgramLocation # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

(==) :: ProgramLocation -> ProgramLocation -> Bool #

(/=) :: ProgramLocation -> ProgramLocation -> Bool #

Read ProgramLocation # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

readsPrec :: Int -> ReadS ProgramLocation #

readList :: ReadS [ProgramLocation] #

readPrec :: ReadPrec ProgramLocation #

readListPrec :: ReadPrec [ProgramLocation] #

Show ProgramLocation # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

showsPrec :: Int -> ProgramLocation -> ShowS #

show :: ProgramLocation -> String #

showList :: [ProgramLocation] -> ShowS #

Generic ProgramLocation # 
Instance details

Defined in Distribution.Simple.Program.Types

Associated Types

type Rep ProgramLocation :: * -> * #

Methods

from :: ProgramLocation -> Rep ProgramLocation x #

to :: Rep ProgramLocation x -> ProgramLocation #

Binary ProgramLocation # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

put :: ProgramLocation -> Put #

get :: Get ProgramLocation #

putList :: [ProgramLocation] -> Put #

type Rep ProgramLocation # 
Instance details

Defined in Distribution.Simple.Program.Types

type Rep ProgramLocation = D1 (MetaData "ProgramLocation" "Distribution.Simple.Program.Types" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "UserSpecified" PrefixI True) (S1 (MetaSel (Just "locationPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :+: C1 (MetaCons "FoundOnSystem" PrefixI True) (S1 (MetaSel (Just "locationPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)))

simpleConfiguredProgram :: String -> ProgramLocation -> ConfiguredProgram #

Make a simple ConfiguredProgram.

simpleConfiguredProgram "foo" (FoundOnSystem path)
diff --git a/doc/API/Cabal/Distribution-Simple-Program.html b/doc/API/Cabal/Distribution-Simple-Program.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Program.html @@ -0,0 +1,96 @@ +Distribution.Simple.Program

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2006 Duncan Coutts 2007-2009
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Program

Contents

Description

This provides an abstraction which deals with configuring and running + programs. A Program is a static notion of a known program. A + ConfiguredProgram is a Program that has been found on the current + machine and is ready to be run (possibly with some user-supplied default + args). Configuring a program involves finding its location and if necessary + finding its version. There is also a ProgramDb type which holds + configured and not-yet configured programs. It is the parameter to lots of + actions elsewhere in Cabal that need to look up and run programs. If we had + a Cabal monad, the ProgramDb would probably be a reader or + state component of it.

The module also defines all the known built-in Programs and the + defaultProgramDb which contains them all.

One nice thing about using it is that any program that is + registered with Cabal will get some "configure" and ".cabal" + helpers like --with-foo-args --foo-path= and extra-foo-args.

There's also good default behavior for trying to find "foo" in + PATH, being able to override its location, etc.

There's also a hook for adding programs in a Setup.lhs script. See + hookedPrograms in UserHooks. This gives a + hook user the ability to get the above flags and such so that they + don't have to write all the PATH logic inside Setup.lhs.

Synopsis

Program and functions for constructing them

data Program #

Represents a program which can be configured.

Note: rather than constructing this directly, start with simpleProgram and + override any extra fields.

Constructors

Program 

Fields

Instances
Show Program # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

showsPrec :: Int -> Program -> ShowS #

show :: Program -> String #

showList :: [Program] -> ShowS #

type ProgramSearchPath = [ProgramSearchPathEntry] #

A search path to use when locating executables. This is analogous + to the unix $PATH or win32 %PATH% but with the ability to use + the system default method for finding executables (findExecutable which + on unix is simply looking on the $PATH but on win32 is a bit more + complicated).

The default to use is [ProgSearchPathDefault] but you can add extra dirs + either before, after or instead of the default, e.g. here we add an extra + dir to search after the usual ones.

['ProgramSearchPathDefault', 'ProgramSearchPathDir' dir]

data ProgramSearchPathEntry #

Constructors

ProgramSearchPathDir FilePath

A specific dir

ProgramSearchPathDefault

The system default

Instances
Eq ProgramSearchPathEntry # 
Instance details

Defined in Distribution.Simple.Program.Find

Methods

(==) :: ProgramSearchPathEntry -> ProgramSearchPathEntry -> Bool #

(/=) :: ProgramSearchPathEntry -> ProgramSearchPathEntry -> Bool #

Generic ProgramSearchPathEntry # 
Instance details

Defined in Distribution.Simple.Program.Find

Associated Types

type Rep ProgramSearchPathEntry :: * -> * #

Methods

from :: ProgramSearchPathEntry -> Rep ProgramSearchPathEntry x #

to :: Rep ProgramSearchPathEntry x -> ProgramSearchPathEntry #

Binary ProgramSearchPathEntry # 
Instance details

Defined in Distribution.Simple.Program.Find

Methods

put :: ProgramSearchPathEntry -> Put #

get :: Get ProgramSearchPathEntry #

putList :: [ProgramSearchPathEntry] -> Put #

type Rep ProgramSearchPathEntry # 
Instance details

Defined in Distribution.Simple.Program.Find

type Rep ProgramSearchPathEntry = D1 (MetaData "ProgramSearchPathEntry" "Distribution.Simple.Program.Find" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ProgramSearchPathDir" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :+: C1 (MetaCons "ProgramSearchPathDefault" PrefixI False) (U1 :: * -> *))

simpleProgram :: String -> Program #

Make a simple named program.

By default we'll just search for it in the path and not try to find the + version name. You can override these behaviours if necessary, eg:

(simpleProgram "foo") { programFindLocation = ... , programFindVersion ... }

findProgramOnSearchPath :: Verbosity -> ProgramSearchPath -> FilePath -> IO (Maybe (FilePath, [FilePath])) #

defaultProgramSearchPath :: ProgramSearchPath #

findProgramVersion #

Arguments

:: String

version args

-> (String -> String)

function to select version + number from program output

-> Verbosity 
-> FilePath

location

-> IO (Maybe Version) 

Look for a program and try to find it's version number. It can accept + either an absolute path or the name of a program binary, in which case we + will look for the program on the path.

Configured program and related functions

data ConfiguredProgram #

Represents a program which has been configured and is thus ready to be run.

These are usually made by configuring a Program, but if you have to + construct one directly then start with simpleConfiguredProgram and + override any extra fields.

Constructors

ConfiguredProgram 

Fields

  • programId :: String

    Just the name again

  • programVersion :: Maybe Version

    The version of this program, if it is known.

  • programDefaultArgs :: [String]

    Default command-line args for this program. + These flags will appear first on the command line, so they can be + overridden by subsequent flags.

  • programOverrideArgs :: [String]

    Override command-line args for this program. + These flags will appear last on the command line, so they override + all earlier flags.

  • programOverrideEnv :: [(String, Maybe String)]

    Override environment variables for this program. + These env vars will extend/override the prevailing environment of + the current to form the environment for the new process.

  • programProperties :: Map String String

    A key-value map listing various properties of the program, useful + for feature detection. Populated during the configuration step, key + names depend on the specific program.

  • programLocation :: ProgramLocation

    Location of the program. eg. /usr/bin/ghc-6.4

  • programMonitorFiles :: [FilePath]

    In addition to the programLocation where the program was found, + these are additional locations that were looked at. The combination + of ths found location and these not-found locations can be used to + monitor to detect when the re-configuring the program might give a + different result (e.g. found in a different location).

Instances
Eq ConfiguredProgram # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

(==) :: ConfiguredProgram -> ConfiguredProgram -> Bool #

(/=) :: ConfiguredProgram -> ConfiguredProgram -> Bool #

Read ConfiguredProgram # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

readsPrec :: Int -> ReadS ConfiguredProgram #

readList :: ReadS [ConfiguredProgram] #

readPrec :: ReadPrec ConfiguredProgram #

readListPrec :: ReadPrec [ConfiguredProgram] #

Show ConfiguredProgram # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

showsPrec :: Int -> ConfiguredProgram -> ShowS #

show :: ConfiguredProgram -> String #

showList :: [ConfiguredProgram] -> ShowS #

Generic ConfiguredProgram # 
Instance details

Defined in Distribution.Simple.Program.Types

Associated Types

type Rep ConfiguredProgram :: * -> * #

Methods

from :: ConfiguredProgram -> Rep ConfiguredProgram x #

to :: Rep ConfiguredProgram x -> ConfiguredProgram #

Binary ConfiguredProgram # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

put :: ConfiguredProgram -> Put #

get :: Get ConfiguredProgram #

putList :: [ConfiguredProgram] -> Put #

type Rep ConfiguredProgram # 
Instance details

Defined in Distribution.Simple.Program.Types

type Rep ConfiguredProgram = D1 (MetaData "ConfiguredProgram" "Distribution.Simple.Program.Types" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ConfiguredProgram" PrefixI True) (((S1 (MetaSel (Just "programId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "programVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Version))) :*: (S1 (MetaSel (Just "programDefaultArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "programOverrideArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]))) :*: ((S1 (MetaSel (Just "programOverrideEnv") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, Maybe String)]) :*: S1 (MetaSel (Just "programProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map String String))) :*: (S1 (MetaSel (Just "programLocation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ProgramLocation) :*: S1 (MetaSel (Just "programMonitorFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))))

programPath :: ConfiguredProgram -> FilePath #

The full path of a configured program.

type ProgArg = String #

data ProgramLocation #

Where a program was found. Also tells us whether it's specified by user or + not. This includes not just the path, but the program as well.

Constructors

UserSpecified

The user gave the path to this program, + eg. --ghc-path=/usr/bin/ghc-6.6

Fields

FoundOnSystem

The program was found automatically.

Fields

Instances
Eq ProgramLocation # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

(==) :: ProgramLocation -> ProgramLocation -> Bool #

(/=) :: ProgramLocation -> ProgramLocation -> Bool #

Read ProgramLocation # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

readsPrec :: Int -> ReadS ProgramLocation #

readList :: ReadS [ProgramLocation] #

readPrec :: ReadPrec ProgramLocation #

readListPrec :: ReadPrec [ProgramLocation] #

Show ProgramLocation # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

showsPrec :: Int -> ProgramLocation -> ShowS #

show :: ProgramLocation -> String #

showList :: [ProgramLocation] -> ShowS #

Generic ProgramLocation # 
Instance details

Defined in Distribution.Simple.Program.Types

Associated Types

type Rep ProgramLocation :: * -> * #

Methods

from :: ProgramLocation -> Rep ProgramLocation x #

to :: Rep ProgramLocation x -> ProgramLocation #

Binary ProgramLocation # 
Instance details

Defined in Distribution.Simple.Program.Types

Methods

put :: ProgramLocation -> Put #

get :: Get ProgramLocation #

putList :: [ProgramLocation] -> Put #

type Rep ProgramLocation # 
Instance details

Defined in Distribution.Simple.Program.Types

type Rep ProgramLocation = D1 (MetaData "ProgramLocation" "Distribution.Simple.Program.Types" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "UserSpecified" PrefixI True) (S1 (MetaSel (Just "locationPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :+: C1 (MetaCons "FoundOnSystem" PrefixI True) (S1 (MetaSel (Just "locationPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)))

runProgram #

Arguments

:: Verbosity

Verbosity

-> ConfiguredProgram

The program to run

-> [ProgArg]

Any extra arguments to add

-> IO () 

Runs the given configured program.

getProgramOutput #

Arguments

:: Verbosity

Verbosity

-> ConfiguredProgram

The program to run

-> [ProgArg]

Any extra arguments to add

-> IO String 

Runs the given configured program and gets the output.

suppressOverrideArgs :: ConfiguredProgram -> ConfiguredProgram #

Suppress any extra arguments added by the user.

Program invocations

data ProgramInvocation #

Represents a specific invocation of a specific program.

This is used as an intermediate type between deciding how to call a program + and actually doing it. This provides the opportunity to the caller to + adjust how the program will be called. These invocations can either be run + directly or turned into shell or batch scripts.

Constructors

ProgramInvocation 

Fields

emptyProgramInvocation :: ProgramInvocation #

simpleProgramInvocation :: FilePath -> [String] -> ProgramInvocation #

programInvocation :: ConfiguredProgram -> [String] -> ProgramInvocation #

runProgramInvocation :: Verbosity -> ProgramInvocation -> IO () #

getProgramInvocationOutput :: Verbosity -> ProgramInvocation -> IO String #

The collection of unconfigured and configured programs

builtinPrograms :: [Program] #

The default list of programs. + These programs are typically used internally to Cabal.

The collection of configured programs we can run

data ProgramDb #

The configuration is a collection of information about programs. It + contains information both about configured programs and also about programs + that we are yet to configure.

The idea is that we start from a collection of unconfigured programs and one + by one we try to configure them at which point we move them into the + configured collection. For unconfigured programs we record not just the + Program but also any user-provided arguments and location for the program.

Instances
Read ProgramDb #

Note that this instance does not preserve the known Programs. + See restoreProgramDb for details.

Instance details

Defined in Distribution.Simple.Program.Db

Methods

readsPrec :: Int -> ReadS ProgramDb #

readList :: ReadS [ProgramDb] #

readPrec :: ReadPrec ProgramDb #

readListPrec :: ReadPrec [ProgramDb] #

Show ProgramDb #

Note that this instance does not preserve the known Programs. + See restoreProgramDb for details.

Instance details

Defined in Distribution.Simple.Program.Db

Methods

showsPrec :: Int -> ProgramDb -> ShowS #

show :: ProgramDb -> String #

showList :: [ProgramDb] -> ShowS #

Binary ProgramDb #

Note that this instance does not preserve the known Programs. + See restoreProgramDb for details.

Instance details

Defined in Distribution.Simple.Program.Db

Methods

put :: ProgramDb -> Put #

get :: Get ProgramDb #

putList :: [ProgramDb] -> Put #

defaultProgramDb :: ProgramDb #

emptyProgramDb :: ProgramDb #

restoreProgramDb :: [Program] -> ProgramDb -> ProgramDb #

The 'Read'\/'Show' and Binary instances do not preserve all the + unconfigured Programs because Program is not in 'Read'\/'Show' because + it contains functions. So to fully restore a deserialised ProgramDb use + this function to add back all the known Programs.

  • It does not add the default programs, but you probably want them, use + builtinPrograms in addition to any extra you might need.

addKnownProgram :: Program -> ProgramDb -> ProgramDb #

Add a known program that we may configure later

addKnownPrograms :: [Program] -> ProgramDb -> ProgramDb #

lookupKnownProgram :: String -> ProgramDb -> Maybe Program #

knownPrograms :: ProgramDb -> [(Program, Maybe ConfiguredProgram)] #

getProgramSearchPath :: ProgramDb -> ProgramSearchPath #

Get the current ProgramSearchPath used by the ProgramDb. + This is the default list of locations where programs are looked for when + configuring them. This can be overridden for specific programs (with + userSpecifyPath), and specific known programs can modify or ignore this + search path in their own configuration code.

setProgramSearchPath :: ProgramSearchPath -> ProgramDb -> ProgramDb #

Change the current ProgramSearchPath used by the ProgramDb. + This will affect programs that are configured from here on, so you + should usually set it before configuring any programs.

userSpecifyPath #

Arguments

:: String

Program name

-> FilePath

user-specified path to the program

-> ProgramDb 
-> ProgramDb 

User-specify this path. Basically override any path information + for this program in the configuration. If it's not a known + program ignore it.

userSpecifyPaths :: [(String, FilePath)] -> ProgramDb -> ProgramDb #

Like userSpecifyPath but for a list of progs and their paths.

userMaybeSpecifyPath :: String -> Maybe FilePath -> ProgramDb -> ProgramDb #

userSpecifyArgs #

Arguments

:: String

Program name

-> [ProgArg]

user-specified args

-> ProgramDb 
-> ProgramDb 

User-specify the arguments for this program. Basically override + any args information for this program in the configuration. If it's + not a known program, ignore it..

userSpecifyArgss :: [(String, [ProgArg])] -> ProgramDb -> ProgramDb #

Like userSpecifyPath but for a list of progs and their args.

userSpecifiedArgs :: Program -> ProgramDb -> [ProgArg] #

Get any extra args that have been previously specified for a program.

lookupProgram :: Program -> ProgramDb -> Maybe ConfiguredProgram #

Try to find a configured program

lookupProgramVersion :: Verbosity -> Program -> VersionRange -> ProgramDb -> IO (Either String (ConfiguredProgram, Version, ProgramDb)) #

Check that a program is configured and available to be run.

Additionally check that the program version number is suitable and return + it. For example you could require AnyVersion or orLaterVersion + (Version [1,0] [])

It returns the configured program, its version number and a possibly updated + ProgramDb. If the program could not be configured or the version is + unsuitable, it returns an error value.

updateProgram :: ConfiguredProgram -> ProgramDb -> ProgramDb #

Update a configured program in the database.

configureProgram :: Verbosity -> Program -> ProgramDb -> IO ProgramDb #

Try to configure a specific program. If the program is already included in + the collection of unconfigured programs then we use any user-supplied + location and arguments. If the program gets configured successfully it gets + added to the configured collection.

Note that it is not a failure if the program cannot be configured. It's only + a failure if the user supplied a location and the program could not be found + at that location.

The reason for it not being a failure at this stage is that we don't know up + front all the programs we will need, so we try to configure them all. + To verify that a program was actually successfully configured use + requireProgram.

configureAllKnownPrograms :: Verbosity -> ProgramDb -> IO ProgramDb #

Try to configure all the known programs that have not yet been configured.

reconfigurePrograms :: Verbosity -> [(String, FilePath)] -> [(String, [ProgArg])] -> ProgramDb -> IO ProgramDb #

reconfigure a bunch of programs given new user-specified args. It takes + the same inputs as userSpecifyPath and userSpecifyArgs and for all progs + with a new path it calls configureProgram.

requireProgram :: Verbosity -> Program -> ProgramDb -> IO (ConfiguredProgram, ProgramDb) #

Check that a program is configured and available to be run.

It raises an exception if the program could not be configured, otherwise + it returns the configured program.

requireProgramVersion :: Verbosity -> Program -> VersionRange -> ProgramDb -> IO (ConfiguredProgram, Version, ProgramDb) #

Like lookupProgramVersion, but raises an exception in case of error + instead of returning 'Left errMsg'.

runDbProgram #

Arguments

:: Verbosity

verbosity

-> Program

The program to run

-> ProgramDb

look up the program here

-> [ProgArg]

Any extra arguments to add

-> IO () 

Looks up the given program in the program database and runs it.

getDbProgramOutput #

Arguments

:: Verbosity

verbosity

-> Program

The program to run

-> ProgramDb

look up the program here

-> [ProgArg]

Any extra arguments to add

-> IO String 

Looks up the given program in the program database and runs it.

Programs that Cabal knows about

ghcProgram :: Program #

ghcPkgProgram :: Program #

ghcjsProgram :: Program #

ghcjsPkgProgram :: Program #

hmakeProgram :: Program #

jhcProgram :: Program #

uhcProgram :: Program #

gccProgram :: Program #

arProgram :: Program #

stripProgram :: Program #

happyProgram :: Program #

alexProgram :: Program #

hsc2hsProgram :: Program #

c2hsProgram :: Program #

cpphsProgram :: Program #

hscolourProgram :: Program #

doctestProgram :: Program #

haddockProgram :: Program #

greencardProgram :: Program #

ldProgram :: Program #

tarProgram :: Program #

cppProgram :: Program #

pkgConfigProgram :: Program #

hpcProgram :: Program #

deprecated

type ProgramConfiguration = ProgramDb #

Deprecated: use ProgramDb instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

emptyProgramConfiguration :: ProgramConfiguration #

Deprecated: use emptyProgramDb instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

defaultProgramConfiguration :: ProgramConfiguration #

Deprecated: use defaultProgramDb instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

restoreProgramConfiguration :: [Program] -> ProgramConfiguration -> ProgramConfiguration #

Deprecated: use restoreProgramDb instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

rawSystemProgram :: Verbosity -> ConfiguredProgram -> [ProgArg] -> IO () #

Deprecated: use runProgram instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

rawSystemProgramStdout :: Verbosity -> ConfiguredProgram -> [ProgArg] -> IO String #

Deprecated: use getProgramOutput instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

rawSystemProgramConf :: Verbosity -> Program -> ProgramConfiguration -> [ProgArg] -> IO () #

Deprecated: use runDbProgram instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

rawSystemProgramStdoutConf :: Verbosity -> Program -> ProgramConfiguration -> [ProgArg] -> IO String #

Deprecated: use getDbProgramOutput instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

findProgramOnPath :: String -> Verbosity -> IO (Maybe FilePath) #

Deprecated: use findProgramOnSearchPath instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

findProgramLocation :: Verbosity -> FilePath -> IO (Maybe FilePath) #

Deprecated: No longer used within Cabal, try findProgramOnSearchPath

Look for a program on the path.

diff --git a/doc/API/Cabal/Distribution-Simple-Register.html b/doc/API/Cabal/Distribution-Simple-Register.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Register.html @@ -0,0 +1,24 @@ +Distribution.Simple.Register

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2004
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Register

Description

This module deals with registering and unregistering packages. There are a + couple ways it can do this, one is to do it directly. Another is to generate + a script that can be run later to do it. The idea here being that the user + is shielded from the details of what command to use for package registration + for a particular compiler. In practice this aspect was not especially + popular so we also provide a way to simply generate the package registration + file which then must be manually passed to ghc-pkg. It is possible to + generate registration information for where the package is to be installed, + or alternatively to register the package in place in the build tree. The + latter is occasionally handy, and will become more important when we try to + build multi-package systems.

This module does not delegate anything to the per-compiler modules but just + mixes it all in in this module, which is rather unsatisfactory. The script + generation and the unregister feature are not well used or tested.

Synopsis

Documentation

register #

Arguments

:: PackageDescription 
-> LocalBuildInfo 
-> RegisterFlags

Install in the user's database?; verbose

-> IO () 

unregister :: PackageDescription -> LocalBuildInfo -> RegisterFlags -> IO () #

internalPackageDBPath :: LocalBuildInfo -> FilePath -> FilePath #

initPackageDB :: Verbosity -> Compiler -> ProgramDb -> FilePath -> IO () #

doesPackageDBExist :: FilePath -> NoCallStackIO Bool #

createPackageDB :: Verbosity -> Compiler -> ProgramDb -> Bool -> FilePath -> IO () #

Create an empty package DB at the specified location.

deletePackageDB :: FilePath -> NoCallStackIO () #

abiHash :: Verbosity -> PackageDescription -> FilePath -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO AbiHash #

Compute the AbiHash of a library that we built inplace.

invokeHcPkg :: Verbosity -> Compiler -> ProgramDb -> PackageDBStack -> [String] -> IO () #

Run hc-pkg using a given package DB stack, directly forwarding the + provided command-line arguments to it.

registerPackage :: Verbosity -> Compiler -> ProgramDb -> PackageDBStack -> InstalledPackageInfo -> RegisterOptions -> IO () #

data RegisterOptions #

Additional variations in the behaviour for register.

Constructors

RegisterOptions 

Fields

defaultRegisterOptions :: RegisterOptions #

Defaults are True, False and False

generateRegistrationInfo :: Verbosity -> PackageDescription -> Library -> LocalBuildInfo -> ComponentLocalBuildInfo -> Bool -> Bool -> FilePath -> PackageDB -> IO InstalledPackageInfo #

inplaceInstalledPackageInfo #

Arguments

:: FilePath

top of the build tree

-> FilePath

location of the dist tree

-> PackageDescription 
-> AbiHash 
-> Library 
-> LocalBuildInfo 
-> ComponentLocalBuildInfo 
-> InstalledPackageInfo 

Construct InstalledPackageInfo for a library that is in place in the + build tree.

This function knows about the layout of in place packages.

absoluteInstalledPackageInfo :: PackageDescription -> AbiHash -> Library -> LocalBuildInfo -> ComponentLocalBuildInfo -> InstalledPackageInfo #

Construct InstalledPackageInfo for the final install location of a + library package.

This function knows about the layout of installed packages.

generalInstalledPackageInfo #

Arguments

:: ([FilePath] -> [FilePath])

Translate relative include dir paths to + absolute paths.

-> PackageDescription 
-> AbiHash 
-> Library 
-> LocalBuildInfo 
-> ComponentLocalBuildInfo 
-> InstallDirs FilePath 
-> InstalledPackageInfo 

Construct InstalledPackageInfo for a library in a package, given a set + of installation directories.

diff --git a/doc/API/Cabal/Distribution-Simple-Setup.html b/doc/API/Cabal/Distribution-Simple-Setup.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Setup.html @@ -0,0 +1,49 @@ +Distribution.Simple.Setup

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2004
Duncan Coutts 2007
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Setup

Description

This is a big module, but not very complicated. The code is very regular + and repetitive. It 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

Documentation

data GlobalFlags #

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

Constructors

GlobalFlags 

Fields

Instances
Generic GlobalFlags # 
Instance details

Defined in Distribution.Simple.Setup

Associated Types

type Rep GlobalFlags :: * -> * #

Methods

from :: GlobalFlags -> Rep GlobalFlags x #

to :: Rep GlobalFlags x -> GlobalFlags #

Semigroup GlobalFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: GlobalFlags -> GlobalFlags -> GlobalFlags #

sconcat :: NonEmpty GlobalFlags -> GlobalFlags #

stimes :: Integral b => b -> GlobalFlags -> GlobalFlags #

Monoid GlobalFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: GlobalFlags #

mappend :: GlobalFlags -> GlobalFlags -> GlobalFlags #

mconcat :: [GlobalFlags] -> GlobalFlags #

type Rep GlobalFlags # 
Instance details

Defined in Distribution.Simple.Setup

type Rep GlobalFlags = D1 (MetaData "GlobalFlags" "Distribution.Simple.Setup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" 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))))

emptyGlobalFlags :: GlobalFlags #

defaultGlobalFlags :: GlobalFlags #

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

data ConfigFlags #

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

Instances
Eq ConfigFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(==) :: ConfigFlags -> ConfigFlags -> Bool #

(/=) :: ConfigFlags -> ConfigFlags -> Bool #

Read ConfigFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

readsPrec :: Int -> ReadS ConfigFlags #

readList :: ReadS [ConfigFlags] #

readPrec :: ReadPrec ConfigFlags #

readListPrec :: ReadPrec [ConfigFlags] #

Show ConfigFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

showsPrec :: Int -> ConfigFlags -> ShowS #

show :: ConfigFlags -> String #

showList :: [ConfigFlags] -> ShowS #

Generic ConfigFlags # 
Instance details

Defined in Distribution.Simple.Setup

Associated Types

type Rep ConfigFlags :: * -> * #

Methods

from :: ConfigFlags -> Rep ConfigFlags x #

to :: Rep ConfigFlags x -> ConfigFlags #

Semigroup ConfigFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: ConfigFlags -> ConfigFlags -> ConfigFlags #

sconcat :: NonEmpty ConfigFlags -> ConfigFlags #

stimes :: Integral b => b -> ConfigFlags -> ConfigFlags #

Monoid ConfigFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: ConfigFlags #

mappend :: ConfigFlags -> ConfigFlags -> ConfigFlags #

mconcat :: [ConfigFlags] -> ConfigFlags #

Binary ConfigFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

put :: ConfigFlags -> Put #

get :: Get ConfigFlags #

putList :: [ConfigFlags] -> Put #

type Rep ConfigFlags # 
Instance details

Defined in Distribution.Simple.Setup

type Rep ConfigFlags = D1 (MetaData "ConfigFlags" "Distribution.Simple.Setup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ConfigFlags" PrefixI True) (((((S1 (MetaSel (Just "configArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: (S1 (MetaSel (Just "configPrograms_") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (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 "configProfExe") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)) :*: (S1 (MetaSel (Just "configProf") 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 [FilePath])) :*: (S1 (MetaSel (Just "configExtraFrameworkDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "configExtraIncludeDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))))) :*: ((((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 "configDistPref") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)) :*: (S1 (MetaSel (Just "configCabalFilePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)) :*: S1 (MetaSel (Just "configVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Verbosity))))) :*: ((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 [Dependency]) :*: (S1 (MetaSel (Just "configDependencies") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(PackageName, ComponentId)]) :*: 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 "configUseResponseFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)))))))))

emptyConfigFlags :: ConfigFlags #

defaultConfigFlags :: ProgramDb -> ConfigFlags #

configureCommand :: ProgramDb -> CommandUI ConfigFlags #

configPrograms :: WithCallStack (ConfigFlags -> ProgramDb) #

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

configAbsolutePaths :: ConfigFlags -> NoCallStackIO ConfigFlags #

readPackageDbList :: String -> [Maybe PackageDB] #

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

data CopyFlags #

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

Constructors

CopyFlags 

Fields

Instances
Show CopyFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

showsPrec :: Int -> CopyFlags -> ShowS #

show :: CopyFlags -> String #

showList :: [CopyFlags] -> ShowS #

Generic CopyFlags # 
Instance details

Defined in Distribution.Simple.Setup

Associated Types

type Rep CopyFlags :: * -> * #

Methods

from :: CopyFlags -> Rep CopyFlags x #

to :: Rep CopyFlags x -> CopyFlags #

Semigroup CopyFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: CopyFlags -> CopyFlags -> CopyFlags #

sconcat :: NonEmpty CopyFlags -> CopyFlags #

stimes :: Integral b => b -> CopyFlags -> CopyFlags #

Monoid CopyFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: CopyFlags #

mappend :: CopyFlags -> CopyFlags -> CopyFlags #

mconcat :: [CopyFlags] -> CopyFlags #

type Rep CopyFlags # 
Instance details

Defined in Distribution.Simple.Setup

type Rep CopyFlags = D1 (MetaData "CopyFlags" "Distribution.Simple.Setup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "CopyFlags" PrefixI True) ((S1 (MetaSel (Just "copyDest") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag CopyDest)) :*: S1 (MetaSel (Just "copyDistPref") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath))) :*: (S1 (MetaSel (Just "copyVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Verbosity)) :*: (S1 (MetaSel (Just "copyArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "copyCabalFilePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath))))))

emptyCopyFlags :: CopyFlags #

defaultCopyFlags :: CopyFlags #

copyCommand :: CommandUI CopyFlags #

data InstallFlags #

Flags to install: (package db, verbosity)

Constructors

InstallFlags 

Fields

Instances
Show InstallFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

showsPrec :: Int -> InstallFlags -> ShowS #

show :: InstallFlags -> String #

showList :: [InstallFlags] -> ShowS #

Generic InstallFlags # 
Instance details

Defined in Distribution.Simple.Setup

Associated Types

type Rep InstallFlags :: * -> * #

Methods

from :: InstallFlags -> Rep InstallFlags x #

to :: Rep InstallFlags x -> InstallFlags #

Semigroup InstallFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: InstallFlags -> InstallFlags -> InstallFlags #

sconcat :: NonEmpty InstallFlags -> InstallFlags #

stimes :: Integral b => b -> InstallFlags -> InstallFlags #

Monoid InstallFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: InstallFlags #

mappend :: InstallFlags -> InstallFlags -> InstallFlags #

mconcat :: [InstallFlags] -> InstallFlags #

type Rep InstallFlags # 
Instance details

Defined in Distribution.Simple.Setup

type Rep InstallFlags = D1 (MetaData "InstallFlags" "Distribution.Simple.Setup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "InstallFlags" PrefixI True) ((S1 (MetaSel (Just "installPackageDB") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag PackageDB)) :*: (S1 (MetaSel (Just "installDest") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag CopyDest)) :*: S1 (MetaSel (Just "installDistPref") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)))) :*: ((S1 (MetaSel (Just "installUseWrapper") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)) :*: S1 (MetaSel (Just "installInPlace") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool))) :*: (S1 (MetaSel (Just "installVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Verbosity)) :*: S1 (MetaSel (Just "installCabalFilePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath))))))

emptyInstallFlags :: InstallFlags #

defaultInstallFlags :: InstallFlags #

installCommand :: CommandUI InstallFlags #

data DoctestFlags #

Constructors

DoctestFlags 

Fields

Instances
Show DoctestFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

showsPrec :: Int -> DoctestFlags -> ShowS #

show :: DoctestFlags -> String #

showList :: [DoctestFlags] -> ShowS #

Generic DoctestFlags # 
Instance details

Defined in Distribution.Simple.Setup

Associated Types

type Rep DoctestFlags :: * -> * #

Methods

from :: DoctestFlags -> Rep DoctestFlags x #

to :: Rep DoctestFlags x -> DoctestFlags #

Semigroup DoctestFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: DoctestFlags -> DoctestFlags -> DoctestFlags #

sconcat :: NonEmpty DoctestFlags -> DoctestFlags #

stimes :: Integral b => b -> DoctestFlags -> DoctestFlags #

Monoid DoctestFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: DoctestFlags #

mappend :: DoctestFlags -> DoctestFlags -> DoctestFlags #

mconcat :: [DoctestFlags] -> DoctestFlags #

type Rep DoctestFlags # 
Instance details

Defined in Distribution.Simple.Setup

type Rep DoctestFlags = D1 (MetaData "DoctestFlags" "Distribution.Simple.Setup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "DoctestFlags" PrefixI True) ((S1 (MetaSel (Just "doctestProgramPaths") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, FilePath)]) :*: S1 (MetaSel (Just "doctestProgramArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, [String])])) :*: (S1 (MetaSel (Just "doctestDistPref") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)) :*: S1 (MetaSel (Just "doctestVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Verbosity)))))

emptyDoctestFlags :: DoctestFlags #

defaultDoctestFlags :: DoctestFlags #

doctestCommand :: CommandUI DoctestFlags #

data HaddockTarget #

When we build haddock documentation, there are two cases:

  1. 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.
  2. 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
Eq HaddockTarget # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(==) :: HaddockTarget -> HaddockTarget -> Bool #

(/=) :: HaddockTarget -> HaddockTarget -> Bool #

Show HaddockTarget # 
Instance details

Defined in Distribution.Simple.Setup

Methods

showsPrec :: Int -> HaddockTarget -> ShowS #

show :: HaddockTarget -> String #

showList :: [HaddockTarget] -> ShowS #

Generic HaddockTarget # 
Instance details

Defined in Distribution.Simple.Setup

Associated Types

type Rep HaddockTarget :: * -> * #

Methods

from :: HaddockTarget -> Rep HaddockTarget x #

to :: Rep HaddockTarget x -> HaddockTarget #

Binary HaddockTarget # 
Instance details

Defined in Distribution.Simple.Setup

Methods

put :: HaddockTarget -> Put #

get :: Get HaddockTarget #

putList :: [HaddockTarget] -> Put #

Text HaddockTarget # 
Instance details

Defined in Distribution.Simple.Setup

Methods

disp :: HaddockTarget -> Doc #

parse :: ReadP r HaddockTarget #

type Rep HaddockTarget # 
Instance details

Defined in Distribution.Simple.Setup

type Rep HaddockTarget = D1 (MetaData "HaddockTarget" "Distribution.Simple.Setup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ForHackage" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ForDevelopment" PrefixI False) (U1 :: * -> *))

data HaddockFlags #

Constructors

HaddockFlags 

Fields

Instances
Show HaddockFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

showsPrec :: Int -> HaddockFlags -> ShowS #

show :: HaddockFlags -> String #

showList :: [HaddockFlags] -> ShowS #

Generic HaddockFlags # 
Instance details

Defined in Distribution.Simple.Setup

Associated Types

type Rep HaddockFlags :: * -> * #

Methods

from :: HaddockFlags -> Rep HaddockFlags x #

to :: Rep HaddockFlags x -> HaddockFlags #

Semigroup HaddockFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: HaddockFlags -> HaddockFlags -> HaddockFlags #

sconcat :: NonEmpty HaddockFlags -> HaddockFlags #

stimes :: Integral b => b -> HaddockFlags -> HaddockFlags #

Monoid HaddockFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: HaddockFlags #

mappend :: HaddockFlags -> HaddockFlags -> HaddockFlags #

mconcat :: [HaddockFlags] -> HaddockFlags #

type Rep HaddockFlags # 
Instance details

Defined in Distribution.Simple.Setup

type Rep HaddockFlags = D1 (MetaData "HaddockFlags" "Distribution.Simple.Setup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "HaddockFlags" PrefixI True) ((((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 "haddockDistPref") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)) :*: S1 (MetaSel (Just "haddockKeepTempFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)))) :*: (S1 (MetaSel (Just "haddockVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Verbosity)) :*: (S1 (MetaSel (Just "haddockCabalFilePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)) :*: S1 (MetaSel (Just "haddockArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])))))))

emptyHaddockFlags :: HaddockFlags #

defaultHaddockFlags :: HaddockFlags #

haddockCommand :: CommandUI HaddockFlags #

data HscolourFlags #

Constructors

HscolourFlags 

Fields

Instances
Show HscolourFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

showsPrec :: Int -> HscolourFlags -> ShowS #

show :: HscolourFlags -> String #

showList :: [HscolourFlags] -> ShowS #

Generic HscolourFlags # 
Instance details

Defined in Distribution.Simple.Setup

Associated Types

type Rep HscolourFlags :: * -> * #

Methods

from :: HscolourFlags -> Rep HscolourFlags x #

to :: Rep HscolourFlags x -> HscolourFlags #

Semigroup HscolourFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: HscolourFlags -> HscolourFlags -> HscolourFlags #

sconcat :: NonEmpty HscolourFlags -> HscolourFlags #

stimes :: Integral b => b -> HscolourFlags -> HscolourFlags #

Monoid HscolourFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: HscolourFlags #

mappend :: HscolourFlags -> HscolourFlags -> HscolourFlags #

mconcat :: [HscolourFlags] -> HscolourFlags #

type Rep HscolourFlags # 
Instance details

Defined in Distribution.Simple.Setup

type Rep HscolourFlags = D1 (MetaData "HscolourFlags" "Distribution.Simple.Setup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "HscolourFlags" PrefixI True) (((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)) :*: S1 (MetaSel (Just "hscolourDistPref") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath))) :*: (S1 (MetaSel (Just "hscolourVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Verbosity)) :*: S1 (MetaSel (Just "hscolourCabalFilePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath))))))

emptyHscolourFlags :: HscolourFlags #

defaultHscolourFlags :: HscolourFlags #

hscolourCommand :: CommandUI HscolourFlags #

data BuildFlags #

Constructors

BuildFlags 

Fields

Instances
Read BuildFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

readsPrec :: Int -> ReadS BuildFlags #

readList :: ReadS [BuildFlags] #

readPrec :: ReadPrec BuildFlags #

readListPrec :: ReadPrec [BuildFlags] #

Show BuildFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

showsPrec :: Int -> BuildFlags -> ShowS #

show :: BuildFlags -> String #

showList :: [BuildFlags] -> ShowS #

Generic BuildFlags # 
Instance details

Defined in Distribution.Simple.Setup

Associated Types

type Rep BuildFlags :: * -> * #

Methods

from :: BuildFlags -> Rep BuildFlags x #

to :: Rep BuildFlags x -> BuildFlags #

Semigroup BuildFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: BuildFlags -> BuildFlags -> BuildFlags #

sconcat :: NonEmpty BuildFlags -> BuildFlags #

stimes :: Integral b => b -> BuildFlags -> BuildFlags #

Monoid BuildFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: BuildFlags #

mappend :: BuildFlags -> BuildFlags -> BuildFlags #

mconcat :: [BuildFlags] -> BuildFlags #

type Rep BuildFlags # 
Instance details

Defined in Distribution.Simple.Setup

type Rep BuildFlags = D1 (MetaData "BuildFlags" "Distribution.Simple.Setup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "BuildFlags" PrefixI True) ((S1 (MetaSel (Just "buildProgramPaths") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, FilePath)]) :*: (S1 (MetaSel (Just "buildProgramArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, [String])]) :*: S1 (MetaSel (Just "buildDistPref") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)))) :*: ((S1 (MetaSel (Just "buildVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Verbosity)) :*: S1 (MetaSel (Just "buildNumJobs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag (Maybe Int)))) :*: (S1 (MetaSel (Just "buildArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "buildCabalFilePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath))))))

emptyBuildFlags :: BuildFlags #

defaultBuildFlags :: BuildFlags #

buildCommand :: ProgramDb -> CommandUI BuildFlags #

buildVerbose :: BuildFlags -> Verbosity #

Deprecated: Use buildVerbosity instead

data ReplFlags #

Constructors

ReplFlags 

Fields

Instances
Show ReplFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

showsPrec :: Int -> ReplFlags -> ShowS #

show :: ReplFlags -> String #

showList :: [ReplFlags] -> ShowS #

Generic ReplFlags # 
Instance details

Defined in Distribution.Simple.Setup

Associated Types

type Rep ReplFlags :: * -> * #

Methods

from :: ReplFlags -> Rep ReplFlags x #

to :: Rep ReplFlags x -> ReplFlags #

Semigroup ReplFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: ReplFlags -> ReplFlags -> ReplFlags #

sconcat :: NonEmpty ReplFlags -> ReplFlags #

stimes :: Integral b => b -> ReplFlags -> ReplFlags #

Monoid ReplFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: ReplFlags #

mappend :: ReplFlags -> ReplFlags -> ReplFlags #

mconcat :: [ReplFlags] -> ReplFlags #

type Rep ReplFlags # 
Instance details

Defined in Distribution.Simple.Setup

type Rep ReplFlags = D1 (MetaData "ReplFlags" "Distribution.Simple.Setup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ReplFlags" PrefixI True) ((S1 (MetaSel (Just "replProgramPaths") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, FilePath)]) :*: (S1 (MetaSel (Just "replProgramArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, [String])]) :*: S1 (MetaSel (Just "replDistPref") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)))) :*: (S1 (MetaSel (Just "replVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Verbosity)) :*: (S1 (MetaSel (Just "replReload") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)) :*: S1 (MetaSel (Just "replReplOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])))))

defaultReplFlags :: ReplFlags #

replCommand :: ProgramDb -> CommandUI ReplFlags #

data CleanFlags #

Constructors

CleanFlags 

Fields

Instances
Show CleanFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

showsPrec :: Int -> CleanFlags -> ShowS #

show :: CleanFlags -> String #

showList :: [CleanFlags] -> ShowS #

Generic CleanFlags # 
Instance details

Defined in Distribution.Simple.Setup

Associated Types

type Rep CleanFlags :: * -> * #

Methods

from :: CleanFlags -> Rep CleanFlags x #

to :: Rep CleanFlags x -> CleanFlags #

Semigroup CleanFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: CleanFlags -> CleanFlags -> CleanFlags #

sconcat :: NonEmpty CleanFlags -> CleanFlags #

stimes :: Integral b => b -> CleanFlags -> CleanFlags #

Monoid CleanFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: CleanFlags #

mappend :: CleanFlags -> CleanFlags -> CleanFlags #

mconcat :: [CleanFlags] -> CleanFlags #

type Rep CleanFlags # 
Instance details

Defined in Distribution.Simple.Setup

type Rep CleanFlags = D1 (MetaData "CleanFlags" "Distribution.Simple.Setup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "CleanFlags" PrefixI True) ((S1 (MetaSel (Just "cleanSaveConf") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)) :*: S1 (MetaSel (Just "cleanDistPref") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath))) :*: (S1 (MetaSel (Just "cleanVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Verbosity)) :*: S1 (MetaSel (Just "cleanCabalFilePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)))))

emptyCleanFlags :: CleanFlags #

defaultCleanFlags :: CleanFlags #

cleanCommand :: CommandUI CleanFlags #

data RegisterFlags #

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

Constructors

RegisterFlags 

Fields

Instances
Show RegisterFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

showsPrec :: Int -> RegisterFlags -> ShowS #

show :: RegisterFlags -> String #

showList :: [RegisterFlags] -> ShowS #

Generic RegisterFlags # 
Instance details

Defined in Distribution.Simple.Setup

Associated Types

type Rep RegisterFlags :: * -> * #

Methods

from :: RegisterFlags -> Rep RegisterFlags x #

to :: Rep RegisterFlags x -> RegisterFlags #

Semigroup RegisterFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: RegisterFlags -> RegisterFlags -> RegisterFlags #

sconcat :: NonEmpty RegisterFlags -> RegisterFlags #

stimes :: Integral b => b -> RegisterFlags -> RegisterFlags #

Monoid RegisterFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: RegisterFlags #

mappend :: RegisterFlags -> RegisterFlags -> RegisterFlags #

mconcat :: [RegisterFlags] -> RegisterFlags #

type Rep RegisterFlags # 
Instance details

Defined in Distribution.Simple.Setup

type Rep RegisterFlags = D1 (MetaData "RegisterFlags" "Distribution.Simple.Setup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "RegisterFlags" PrefixI True) (((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 FilePath))) :*: S1 (MetaSel (Just "regInPlace") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)))) :*: ((S1 (MetaSel (Just "regDistPref") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)) :*: S1 (MetaSel (Just "regPrintId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool))) :*: (S1 (MetaSel (Just "regVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Verbosity)) :*: (S1 (MetaSel (Just "regArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "regCabalFilePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)))))))

emptyRegisterFlags :: RegisterFlags #

defaultRegisterFlags :: RegisterFlags #

registerCommand :: CommandUI RegisterFlags #

unregisterCommand :: CommandUI RegisterFlags #

data SDistFlags #

Flags to sdist: (snapshot, verbosity)

Constructors

SDistFlags 

Fields

Instances
Show SDistFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

showsPrec :: Int -> SDistFlags -> ShowS #

show :: SDistFlags -> String #

showList :: [SDistFlags] -> ShowS #

Generic SDistFlags # 
Instance details

Defined in Distribution.Simple.Setup

Associated Types

type Rep SDistFlags :: * -> * #

Methods

from :: SDistFlags -> Rep SDistFlags x #

to :: Rep SDistFlags x -> SDistFlags #

Semigroup SDistFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: SDistFlags -> SDistFlags -> SDistFlags #

sconcat :: NonEmpty SDistFlags -> SDistFlags #

stimes :: Integral b => b -> SDistFlags -> SDistFlags #

Monoid SDistFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: SDistFlags #

mappend :: SDistFlags -> SDistFlags -> SDistFlags #

mconcat :: [SDistFlags] -> SDistFlags #

type Rep SDistFlags # 
Instance details

Defined in Distribution.Simple.Setup

type Rep SDistFlags = D1 (MetaData "SDistFlags" "Distribution.Simple.Setup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "SDistFlags" PrefixI True) ((S1 (MetaSel (Just "sDistSnapshot") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Bool)) :*: S1 (MetaSel (Just "sDistDirectory") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath))) :*: (S1 (MetaSel (Just "sDistDistPref") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)) :*: (S1 (MetaSel (Just "sDistListSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)) :*: S1 (MetaSel (Just "sDistVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Verbosity))))))

emptySDistFlags :: SDistFlags #

defaultSDistFlags :: SDistFlags #

sdistCommand :: CommandUI SDistFlags #

data TestFlags #

Constructors

TestFlags 

Fields

Instances
Generic TestFlags # 
Instance details

Defined in Distribution.Simple.Setup

Associated Types

type Rep TestFlags :: * -> * #

Methods

from :: TestFlags -> Rep TestFlags x #

to :: Rep TestFlags x -> TestFlags #

Semigroup TestFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: TestFlags -> TestFlags -> TestFlags #

sconcat :: NonEmpty TestFlags -> TestFlags #

stimes :: Integral b => b -> TestFlags -> TestFlags #

Monoid TestFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: TestFlags #

mappend :: TestFlags -> TestFlags -> TestFlags #

mconcat :: [TestFlags] -> TestFlags #

type Rep TestFlags # 
Instance details

Defined in Distribution.Simple.Setup

type Rep TestFlags = D1 (MetaData "TestFlags" "Distribution.Simple.Setup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "TestFlags" PrefixI True) ((S1 (MetaSel (Just "testDistPref") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)) :*: (S1 (MetaSel (Just "testVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Verbosity)) :*: 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 "testOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [PathTemplate])))))

emptyTestFlags :: TestFlags #

defaultTestFlags :: TestFlags #

testCommand :: CommandUI TestFlags #

data TestShowDetails #

Constructors

Never 
Failures 
Always 
Streaming 
Direct 
Instances
Bounded TestShowDetails # 
Instance details

Defined in Distribution.Simple.Setup

Methods

minBound :: TestShowDetails #

maxBound :: TestShowDetails #

Enum TestShowDetails # 
Instance details

Defined in Distribution.Simple.Setup

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] #

Eq TestShowDetails # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(==) :: TestShowDetails -> TestShowDetails -> Bool #

(/=) :: TestShowDetails -> TestShowDetails -> Bool #

Ord TestShowDetails # 
Instance details

Defined in Distribution.Simple.Setup

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 #

Show TestShowDetails # 
Instance details

Defined in Distribution.Simple.Setup

Methods

showsPrec :: Int -> TestShowDetails -> ShowS #

show :: TestShowDetails -> String #

showList :: [TestShowDetails] -> ShowS #

Semigroup TestShowDetails # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: TestShowDetails -> TestShowDetails -> TestShowDetails #

sconcat :: NonEmpty TestShowDetails -> TestShowDetails #

stimes :: Integral b => b -> TestShowDetails -> TestShowDetails #

Monoid TestShowDetails # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: TestShowDetails #

mappend :: TestShowDetails -> TestShowDetails -> TestShowDetails #

mconcat :: [TestShowDetails] -> TestShowDetails #

Pretty TestShowDetails # 
Instance details

Defined in Distribution.Simple.Setup

Methods

pretty :: TestShowDetails -> Doc #

Parsec TestShowDetails # 
Instance details

Defined in Distribution.Simple.Setup

Methods

parsec :: CabalParsing m => m TestShowDetails #

Text TestShowDetails # 
Instance details

Defined in Distribution.Simple.Setup

Methods

disp :: TestShowDetails -> Doc #

parse :: ReadP r TestShowDetails #

data BenchmarkFlags #

Constructors

BenchmarkFlags 

Fields

Instances
Generic BenchmarkFlags # 
Instance details

Defined in Distribution.Simple.Setup

Associated Types

type Rep BenchmarkFlags :: * -> * #

Methods

from :: BenchmarkFlags -> Rep BenchmarkFlags x #

to :: Rep BenchmarkFlags x -> BenchmarkFlags #

Semigroup BenchmarkFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

(<>) :: BenchmarkFlags -> BenchmarkFlags -> BenchmarkFlags #

sconcat :: NonEmpty BenchmarkFlags -> BenchmarkFlags #

stimes :: Integral b => b -> BenchmarkFlags -> BenchmarkFlags #

Monoid BenchmarkFlags # 
Instance details

Defined in Distribution.Simple.Setup

Methods

mempty :: BenchmarkFlags #

mappend :: BenchmarkFlags -> BenchmarkFlags -> BenchmarkFlags #

mconcat :: [BenchmarkFlags] -> BenchmarkFlags #

type Rep BenchmarkFlags # 
Instance details

Defined in Distribution.Simple.Setup

type Rep BenchmarkFlags = D1 (MetaData "BenchmarkFlags" "Distribution.Simple.Setup" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "BenchmarkFlags" PrefixI True) (S1 (MetaSel (Just "benchmarkDistPref") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag FilePath)) :*: (S1 (MetaSel (Just "benchmarkVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Flag Verbosity)) :*: S1 (MetaSel (Just "benchmarkOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [PathTemplate]))))

emptyBenchmarkFlags :: BenchmarkFlags #

defaultBenchmarkFlags :: BenchmarkFlags #

benchmarkCommand :: CommandUI BenchmarkFlags #

data CopyDest #

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
Eq CopyDest # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

(==) :: CopyDest -> CopyDest -> Bool #

(/=) :: CopyDest -> CopyDest -> Bool #

Show CopyDest # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

showsPrec :: Int -> CopyDest -> ShowS #

show :: CopyDest -> String #

showList :: [CopyDest] -> ShowS #

Generic CopyDest # 
Instance details

Defined in Distribution.Simple.InstallDirs

Associated Types

type Rep CopyDest :: * -> * #

Methods

from :: CopyDest -> Rep CopyDest x #

to :: Rep CopyDest x -> CopyDest #

Binary CopyDest # 
Instance details

Defined in Distribution.Simple.InstallDirs

Methods

put :: CopyDest -> Put #

get :: Get CopyDest #

putList :: [CopyDest] -> Put #

type Rep CopyDest # 
Instance details

Defined in Distribution.Simple.InstallDirs

type Rep CopyDest = D1 (MetaData "CopyDest" "Distribution.Simple.InstallDirs" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "NoCopyDest" PrefixI False) (U1 :: * -> *) :+: (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] #

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

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] #

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

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

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] #

Like programDbPaths, but allows to customise the option name.

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

Deprecated: Use programDbOptions instead

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

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

Deprecated: Use programDbPaths' instead

Like programDbPaths, but allows to customise the option name.

programFlagsDescription :: ProgramDb -> String #

replOptions :: ShowOrParseArgs -> [OptionField [String]] #

splitArgs :: String -> [String] #

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 :: FilePath #

optionDistPref :: (flags -> Flag FilePath) -> (Flag FilePath -> flags -> flags) -> ShowOrParseArgs -> OptionField flags #

data Flag a #

All flags are monoids, they come in two flavours:

  1. list flags eg
--ghc-option=foo --ghc-option=bar

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

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

Constructors

Flag a 
NoFlag 
Instances
Functor Flag # 
Instance details

Defined in Distribution.Simple.Flag

Methods

fmap :: (a -> b) -> Flag a -> Flag b #

(<$) :: a -> Flag b -> Flag a #

Applicative Flag # 
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 #

Bounded a => Bounded (Flag a) # 
Instance details

Defined in Distribution.Simple.Flag

Methods

minBound :: Flag a #

maxBound :: Flag a #

Enum a => Enum (Flag a) # 
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] #

Eq a => Eq (Flag a) # 
Instance details

Defined in Distribution.Simple.Flag

Methods

(==) :: Flag a -> Flag a -> Bool #

(/=) :: Flag a -> Flag a -> Bool #

Read a => Read (Flag a) # 
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) # 
Instance details

Defined in Distribution.Simple.Flag

Methods

showsPrec :: Int -> Flag a -> ShowS #

show :: Flag a -> String #

showList :: [Flag a] -> ShowS #

Generic (Flag a) # 
Instance details

Defined in Distribution.Simple.Flag

Associated Types

type Rep (Flag a) :: * -> * #

Methods

from :: Flag a -> Rep (Flag a) x #

to :: Rep (Flag a) x -> Flag a #

Semigroup (Flag a) # 
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 #

Monoid (Flag a) # 
Instance details

Defined in Distribution.Simple.Flag

Methods

mempty :: Flag a #

mappend :: Flag a -> Flag a -> Flag a #

mconcat :: [Flag a] -> Flag a #

Binary a => Binary (Flag a) # 
Instance details

Defined in Distribution.Simple.Flag

Methods

put :: Flag a -> Put #

get :: Get (Flag a) #

putList :: [Flag a] -> Put #

type Rep (Flag a) # 
Instance details

Defined in Distribution.Simple.Flag

type Rep (Flag a) = D1 (MetaData "Flag" "Distribution.Simple.Flag" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Flag" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)) :+: C1 (MetaCons "NoFlag" PrefixI False) (U1 :: * -> *))

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 #

Types that represent boolean flags.

Minimal complete definition

asBool

Methods

asBool :: a -> Bool #

Instances
BooleanFlag Bool # 
Instance details

Defined in Distribution.Simple.Flag

Methods

asBool :: Bool -> 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 #

optionNumJobs :: (flags -> Flag (Maybe Int)) -> (Flag (Maybe Int) -> flags -> flags) -> OptionField flags #

readPToMaybe :: ReadP a a -> String -> Maybe a #

diff --git a/doc/API/Cabal/Distribution-Simple-SrcDist.html b/doc/API/Cabal/Distribution-Simple-SrcDist.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-SrcDist.html @@ -0,0 +1,17 @@ +Distribution.Simple.SrcDist

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightSimon Marlow 2004
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.SrcDist

Contents

Description

This handles the sdist command. The module exports an sdist action but + also some of the phases that make it up so that other tools can use just the + bits they need. In particular the preparation of the tree of files to go + into the source tarball is separated from actually building the source + tarball.

The createArchive action uses the external tar program and assumes that + it accepts the -z flag. Neither of these assumptions are valid on Windows. + The sdist action now also does some distribution QA checks.

Synopsis

The top level action

sdist #

Arguments

:: PackageDescription

information from the tarball

-> Maybe LocalBuildInfo

Information from configure

-> SDistFlags

verbosity & snapshot

-> (FilePath -> FilePath)

build prefix (temp dir)

-> [PPSuffixHandler]

extra preprocessors (includes suffixes)

-> IO () 

Create a source distribution.

Parts of sdist

printPackageProblems :: Verbosity -> PackageDescription -> IO () #

Note: must be called with the CWD set to the directory containing + the '.cabal' file.

prepareTree #

Arguments

:: Verbosity

verbosity

-> PackageDescription

info from the cabal file

-> Maybe LocalBuildInfo 
-> FilePath

source tree to populate

-> [PPSuffixHandler]

extra preprocessors (includes suffixes)

-> IO () 

Prepare a directory tree of source files.

createArchive :: CreateArchiveFun #

Create an archive from a tree of source files, and clean up the tree.

Snapshots

prepareSnapshotTree #

Arguments

:: Verbosity

verbosity

-> PackageDescription

info from the cabal file

-> Maybe LocalBuildInfo 
-> FilePath

source tree to populate

-> [PPSuffixHandler]

extra preprocessors (includes + suffixes)

-> IO () 

Prepare a directory tree of source files for a snapshot version. + It is expected that the appropriate snapshot version has already been set + in the package description, eg using snapshotPackage or snapshotVersion.

snapshotPackage :: UTCTime -> PackageDescription -> PackageDescription #

Modifies a PackageDescription by appending a snapshot number + corresponding to the given date.

snapshotVersion :: UTCTime -> Version -> Version #

Modifies a Version by appending a snapshot number corresponding + to the given date.

dateToSnapshotNumber :: UTCTime -> Int #

Given a date produce a corresponding integer representation. + For example given a date 18032008 produce the number 20080318.

Extracting the source files

listPackageSources #

Arguments

:: Verbosity

verbosity

-> PackageDescription

info from the cabal file

-> [PPSuffixHandler]

extra preprocessors (include + suffixes)

-> IO ([FilePath], [FilePath]) 

List all source files of a package. Returns a tuple of lists: first + component is a list of ordinary files, second one is a list of those files + that may be executable.

diff --git a/doc/API/Cabal/Distribution-Simple-Test-ExeV10.html b/doc/API/Cabal/Distribution-Simple-Test-ExeV10.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Test-ExeV10.html @@ -0,0 +1,1 @@ +Distribution.Simple.Test.ExeV10

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Test.ExeV10

Documentation

runTest :: PackageDescription -> LocalBuildInfo -> ComponentLocalBuildInfo -> TestFlags -> TestSuite -> IO TestSuiteLog #

diff --git a/doc/API/Cabal/Distribution-Simple-Test-LibV09.html b/doc/API/Cabal/Distribution-Simple-Test-LibV09.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Test-LibV09.html @@ -0,0 +1,7 @@ +Distribution.Simple.Test.LibV09

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Test.LibV09

Synopsis

Documentation

runTest :: PackageDescription -> LocalBuildInfo -> ComponentLocalBuildInfo -> TestFlags -> TestSuite -> IO TestSuiteLog #

simpleTestStub :: ModuleName -> String #

Source code for library test suite stub executable

stubFilePath :: TestSuite -> FilePath #

The filename of the source file for the stub executable associated with a + library TestSuite.

stubMain :: IO [Test] -> IO () #

Main function for test stubs. Once, it was written directly into the stub, + but minimizing the amount of code actually in the stub maximizes the number + of detectable errors when Cabal is compiled.

stubName :: TestSuite -> FilePath #

The name of the stub executable associated with a library TestSuite.

stubWriteLog :: FilePath -> UnqualComponentName -> TestLogs -> NoCallStackIO () #

From a test stub, write the TestSuiteLog to temporary file for the calling + Cabal process to read.

writeSimpleTestStub #

Arguments

:: TestSuite

library TestSuite for which a stub + is being created

-> FilePath

path to directory where stub source + should be located

-> NoCallStackIO () 

Write the source file for a library TestSuite stub executable.

diff --git a/doc/API/Cabal/Distribution-Simple-Test-Log.html b/doc/API/Cabal/Distribution-Simple-Test-Log.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Test-Log.html @@ -0,0 +1,8 @@ +Distribution.Simple.Test.Log

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Test.Log

Synopsis

Documentation

data PackageLog #

Logs all test results for a package, broken down first by test suite and + then by test case.

Constructors

PackageLog 

Fields

Instances
Eq PackageLog # 
Instance details

Defined in Distribution.Simple.Test.Log

Methods

(==) :: PackageLog -> PackageLog -> Bool #

(/=) :: PackageLog -> PackageLog -> Bool #

Read PackageLog # 
Instance details

Defined in Distribution.Simple.Test.Log

Methods

readsPrec :: Int -> ReadS PackageLog #

readList :: ReadS [PackageLog] #

readPrec :: ReadPrec PackageLog #

readListPrec :: ReadPrec [PackageLog] #

Show PackageLog # 
Instance details

Defined in Distribution.Simple.Test.Log

Methods

showsPrec :: Int -> PackageLog -> ShowS #

show :: PackageLog -> String #

showList :: [PackageLog] -> ShowS #

data TestLogs #

Constructors

TestLog 

Fields

GroupLogs String [TestLogs] 
Instances
Eq TestLogs # 
Instance details

Defined in Distribution.Simple.Test.Log

Methods

(==) :: TestLogs -> TestLogs -> Bool #

(/=) :: TestLogs -> TestLogs -> Bool #

Read TestLogs # 
Instance details

Defined in Distribution.Simple.Test.Log

Methods

readsPrec :: Int -> ReadS TestLogs #

readList :: ReadS [TestLogs] #

readPrec :: ReadPrec TestLogs #

readListPrec :: ReadPrec [TestLogs] #

Show TestLogs # 
Instance details

Defined in Distribution.Simple.Test.Log

Methods

showsPrec :: Int -> TestLogs -> ShowS #

show :: TestLogs -> String #

showList :: [TestLogs] -> ShowS #

data TestSuiteLog #

Logs test suite results, itemized by test case.

Constructors

TestSuiteLog 

Fields

Instances
Eq TestSuiteLog # 
Instance details

Defined in Distribution.Simple.Test.Log

Methods

(==) :: TestSuiteLog -> TestSuiteLog -> Bool #

(/=) :: TestSuiteLog -> TestSuiteLog -> Bool #

Read TestSuiteLog # 
Instance details

Defined in Distribution.Simple.Test.Log

Methods

readsPrec :: Int -> ReadS TestSuiteLog #

readList :: ReadS [TestSuiteLog] #

readPrec :: ReadPrec TestSuiteLog #

readListPrec :: ReadPrec [TestSuiteLog] #

Show TestSuiteLog # 
Instance details

Defined in Distribution.Simple.Test.Log

Methods

showsPrec :: Int -> TestSuiteLog -> ShowS #

show :: TestSuiteLog -> String #

showList :: [TestSuiteLog] -> ShowS #

countTestResults #

Arguments

:: TestLogs 
-> (Int, Int, Int)

Passes, fails, and errors, + respectively.

Count the number of pass, fail, and error test results in a TestLogs + tree.

localPackageLog :: PackageDescription -> LocalBuildInfo -> PackageLog #

A PackageLog with package and platform information specified.

summarizePackage :: Verbosity -> PackageLog -> IO Bool #

Print a summary to the console after all test suites have been run + indicating the number of successful test suites and cases. Returns True if + all test suites passed and False otherwise.

summarizeSuiteFinish :: TestSuiteLog -> String #

Print a summary of the test suite's results on the console, suppressing + output for certain verbosity or test filter levels.

summarizeSuiteStart :: String -> String #

summarizeTest :: Verbosity -> TestShowDetails -> TestLogs -> IO () #

Print a summary of a single test case's result to the console, supressing + output for certain verbosity or test filter levels.

suiteError :: TestLogs -> Bool #

From a TestSuiteLog, determine if the test suite encountered errors.

suiteFailed :: TestLogs -> Bool #

From a TestSuiteLog, determine if the test suite failed.

suitePassed :: TestLogs -> Bool #

From a TestSuiteLog, determine if the test suite passed.

testSuiteLogPath #

Arguments

:: PathTemplate 
-> PackageDescription 
-> LocalBuildInfo 
-> String

test suite name

-> TestLogs

test suite results

-> FilePath 
diff --git a/doc/API/Cabal/Distribution-Simple-Test.html b/doc/API/Cabal/Distribution-Simple-Test.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Test.html @@ -0,0 +1,3 @@ +Distribution.Simple.Test

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightThomas Tuegel 2010
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Test

Description

This is the entry point into testing a built package. It performs the + "./setup test" action. It runs test suites designated in the package + description and reports on the results.

Synopsis

Documentation

test #

Arguments

:: Args

positional command-line arguments

-> PackageDescription

information from the .cabal file

-> LocalBuildInfo

information from the configure step

-> TestFlags

flags sent to test

-> IO () 

Perform the "./setup test" action.

diff --git a/doc/API/Cabal/Distribution-Simple-UHC.html b/doc/API/Cabal/Distribution-Simple-UHC.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-UHC.html @@ -0,0 +1,4 @@ +Distribution.Simple.UHC

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightAndres Loeh 2009
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.UHC

Description

This module contains most of the UHC-specific code for configuring, building + and installing packages.

Thanks to the authors of the other implementation-specific files, in + particular to Isaac Jones, Duncan Coutts and Henning Thielemann, for + inspiration on how to design this module.

Documentation

configure :: Verbosity -> Maybe FilePath -> Maybe FilePath -> ProgramDb -> IO (Compiler, Maybe Platform, ProgramDb) #

getInstalledPackages :: Verbosity -> Compiler -> PackageDBStack -> ProgramDb -> IO InstalledPackageIndex #

buildLib :: Verbosity -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO () #

buildExe :: Verbosity -> PackageDescription -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO () #

installLib :: Verbosity -> LocalBuildInfo -> FilePath -> FilePath -> FilePath -> PackageDescription -> Library -> ComponentLocalBuildInfo -> IO () #

registerPackage :: Verbosity -> Compiler -> ProgramDb -> PackageDBStack -> InstalledPackageInfo -> IO () #

inplacePackageDbPath :: LocalBuildInfo -> FilePath #

diff --git a/doc/API/Cabal/Distribution-Simple-UserHooks.html b/doc/API/Cabal/Distribution-Simple-UserHooks.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-UserHooks.html @@ -0,0 +1,18 @@ +Distribution.Simple.UserHooks

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2005
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.UserHooks

Description

This defines the API that Setup.hs scripts can use to customise the way + the build works. This module just defines the UserHooks type. The + predefined sets of hooks that implement the Simple, Make and Configure + build systems are defined in Distribution.Simple. The UserHooks is a big + record of functions. There are 3 for each action, a pre, post and the action + itself. There are few other miscellaneous hooks, ones to extend the set of + programs and preprocessors and one to override the function used to read the + .cabal file.

This hooks type is widely agreed to not be the right solution. Partly this + is because changes to it usually break custom Setup.hs files and yet many + internal code changes do require changes to the hooks. For example we cannot + pass any extra parameters to most of the functions that implement the + various phases because it would involve changing the types of the + corresponding hook. At some point it will have to be replaced.

Synopsis

Documentation

data UserHooks #

Hooks allow authors to add specific functionality before and after a + command is run, and also to specify additional preprocessors.

  • WARNING: The hooks interface is under rather constant flux as we try to + understand users needs. Setup files that depend on this interface may + break in future releases.

Constructors

UserHooks 

Fields

type Args = [String] #

emptyUserHooks :: UserHooks #

Empty UserHooks which do nothing.

diff --git a/doc/API/Cabal/Distribution-Simple-Utils.html b/doc/API/Cabal/Distribution-Simple-Utils.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple-Utils.html @@ -0,0 +1,130 @@ +Distribution.Simple.Utils

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones Simon Marlow 2003-2004
LicenseBSD3 + portions Copyright (c) 2007, Galois Inc.
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.Utils

Contents

Description

A large and somewhat miscellaneous collection of utility functions used + throughout the rest of the Cabal lib and in other tools that use the Cabal + lib like cabal-install. It has a very simple set of logging actions. It + has low level functions for running programs, a bunch of wrappers for + various directory and file functions that do extra logging.

Synopsis

Documentation

cabalVersion :: Version #

logging and errors

die :: String -> IO a #

Deprecated: Messages thrown with die can't be controlled with Verbosity; use die' instead, or dieNoVerbosity if Verbosity truly is not available

dieWithLocation :: FilePath -> Maybe Int -> String -> IO a #

Deprecated: Messages thrown with dieWithLocation can't be controlled with Verbosity; use dieWithLocation' instead

dieNoVerbosity :: String -> IO a #

die' :: Verbosity -> String -> IO a #

dieWithLocation' :: Verbosity -> FilePath -> Maybe Int -> String -> IO a #

dieNoWrap :: Verbosity -> String -> IO a #

topHandler :: IO a -> IO a #

topHandlerWith :: forall a. (SomeException -> IO a) -> IO a -> IO a #

warn :: Verbosity -> String -> IO () #

Non fatal conditions that may be indicative of an error or problem.

We display these at the normal verbosity level.

notice :: Verbosity -> String -> IO () #

Useful status messages.

We display these at the normal verbosity level.

This is for the ordinary helpful status messages that users see. Just + enough information to know that things are working but not floods of detail.

noticeNoWrap :: Verbosity -> String -> IO () #

Display a message at normal verbosity level, but without + wrapping.

noticeDoc :: Verbosity -> Doc -> IO () #

Pretty-print a Doc status message at normal verbosity + level. Use this if you need fancy formatting.

setupMessage :: Verbosity -> String -> PackageIdentifier -> IO () #

Display a "setup status message". Prefer using setupMessage' + if possible.

info :: Verbosity -> String -> IO () #

More detail on the operation of some action.

We display these messages when the verbosity level is verbose

infoNoWrap :: Verbosity -> String -> IO () #

debug :: Verbosity -> String -> IO () #

Detailed internal debugging information

We display these messages when the verbosity level is deafening

debugNoWrap :: Verbosity -> String -> IO () #

A variant of debug that doesn't perform the automatic line + wrapping. Produces better output in some cases.

chattyTry #

Arguments

:: String

a description of the action we were attempting

-> IO ()

the action itself

-> IO () 

Perform an IO action, catching any IO exceptions and printing an error + if one occurs.

annotateIO :: Verbosity -> IO a -> IO a #

Given a block of IO code that may raise an exception, annotate + it with the metadata from the current scope. Use this as close + to external code that raises IO exceptions as possible, since + this function unconditionally wraps the error message with a trace + (so it is NOT idempotent.)

printRawCommandAndArgs :: Verbosity -> FilePath -> [String] -> IO () #

printRawCommandAndArgsAndEnv :: Verbosity -> FilePath -> [String] -> Maybe FilePath -> Maybe [(String, String)] -> IO () #

withOutputMarker :: Verbosity -> String -> String #

Wrap output with a marker if +markoutput verbosity flag is set.

NB: Why is markoutput done with start/end markers, and not prefixes? + Markers are more convenient to add (if we want to add prefixes, + we have to lines and then map; here's it's just some + concatenates). Note that even in the prefix case, we can't + guarantee that the markers are unambiguous, because some of + Cabal's output comes straight from external programs, where + we don't have the ability to interpose on the output.

This is used by withMetadata

exceptions

handleDoesNotExist :: a -> NoCallStackIO a -> NoCallStackIO a #

Run an IO computation, returning e if it raises a "file + does not exist" error.

running programs

rawSystemExit :: Verbosity -> FilePath -> [String] -> IO () #

rawSystemExitCode :: Verbosity -> FilePath -> [String] -> IO ExitCode #

rawSystemExitWithEnv :: Verbosity -> FilePath -> [String] -> [(String, String)] -> IO () #

rawSystemStdout :: Verbosity -> FilePath -> [String] -> IO String #

Run a command and return its output.

The output is assumed to be text in the locale encoding.

rawSystemStdInOut #

Arguments

:: Verbosity 
-> FilePath

Program location

-> [String]

Arguments

-> Maybe FilePath

New working dir or inherit

-> Maybe [(String, String)]

New environment or inherit

-> Maybe IOData

input text and binary mode

-> IODataMode

output in binary mode

-> IO (IOData, String, ExitCode)

output, errors, exit

Run a command and return its output, errors and exit status. Optionally + also supply some input. Also provides control over whether the binary/text + mode of the input and output.

rawSystemIOWithEnv #

Arguments

:: Verbosity 
-> FilePath 
-> [String] 
-> Maybe FilePath

New working dir or inherit

-> Maybe [(String, String)]

New environment or inherit

-> Maybe Handle

stdin

-> Maybe Handle

stdout

-> Maybe Handle

stderr

-> IO ExitCode 

createProcessWithEnv #

Arguments

:: Verbosity 
-> FilePath 
-> [String] 
-> Maybe FilePath

New working dir or inherit

-> Maybe [(String, String)]

New environment or inherit

-> StdStream

stdin

-> StdStream

stdout

-> StdStream

stderr

-> IO (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle)

Any handles created for stdin, stdout, or stderr + with CreateProcess, and a handle to the process.

maybeExit :: IO ExitCode -> IO () #

xargs :: Int -> ([String] -> IO ()) -> [String] -> [String] -> IO () #

Like the Unix xargs program. Useful for when we've got very long command + lines that might overflow an OS limit on command line length and so you + need to invoke a command multiple times to get all the args in.

Use it with either of the rawSystem variants above. For example:

xargs (32*1024) (rawSystemExit verbosity) prog fixedArgs bigArgs

findProgramLocation :: Verbosity -> FilePath -> IO (Maybe FilePath) #

Deprecated: No longer used within Cabal, try findProgramOnSearchPath

Look for a program on the path.

findProgramVersion #

Arguments

:: String

version args

-> (String -> String)

function to select version + number from program output

-> Verbosity 
-> FilePath

location

-> IO (Maybe Version) 

Look for a program and try to find it's version number. It can accept + either an absolute path or the name of a program binary, in which case we + will look for the program on the path.

IOData re-export

data IOData #

Represents either textual or binary data passed via I/O functions + which support binary/text mode

Since: 2.2.0

Constructors

IODataText String

How Text gets encoded is usually locale-dependent.

IODataBinary ByteString

Raw binary which gets read/written in binary mode.

Instances
NFData IOData # 
Instance details

Defined in Distribution.Utils.IOData

Methods

rnf :: IOData -> () #

data IODataMode #

Constructors

IODataModeText 
IODataModeBinary 

copying files

smartCopySources :: Verbosity -> [FilePath] -> FilePath -> [ModuleName] -> [String] -> IO () #

Deprecated: Use findModuleFiles and copyFiles or installOrdinaryFiles

createDirectoryIfMissingVerbose #

Arguments

:: Verbosity 
-> Bool

Create its parents too?

-> FilePath 
-> IO () 

Same as createDirectoryIfMissing but logs at higher verbosity levels.

copyFileVerbose :: Verbosity -> FilePath -> FilePath -> IO () #

Copies a file without copying file permissions. The target file is created + with default permissions. Any existing target file is replaced.

At higher verbosity levels it logs an info message.

copyDirectoryRecursiveVerbose :: Verbosity -> FilePath -> FilePath -> IO () #

Deprecated: You probably want installDirectoryContents instead

copyFiles :: Verbosity -> FilePath -> [(FilePath, FilePath)] -> IO () #

Copies a bunch of files to a target directory, preserving the directory + structure in the target location. The target directories are created if they + do not exist.

The files are identified by a pair of base directory and a path relative to + that base. It is only the relative part that is preserved in the + destination.

For example:

copyFiles normal "dist/src"
+   [("", "src/Foo.hs"), ("dist/build/", "src/Bar.hs")]

This would copy "src/Foo.hs" to "dist/src/src/Foo.hs" and + copy "dist/build/src/Bar.hs" to "dist/src/src/Bar.hs".

This operation is not atomic. Any IO failure during the copy (including any + missing source files) leaves the target in an unknown state so it is best to + use it with a freshly created directory so that it can be simply deleted if + anything goes wrong.

copyFileTo :: Verbosity -> FilePath -> FilePath -> IO () #

Given a relative path to a file, copy it to the given directory, preserving + the relative path and creating the parent directories if needed.

installing files

installOrdinaryFile :: Verbosity -> FilePath -> FilePath -> IO () #

Install an ordinary file. This is like a file copy but the permissions + are set appropriately for an installed file. On Unix it is "-rw-r--r--" + while on Windows it uses the default permissions for the target directory.

installExecutableFile :: Verbosity -> FilePath -> FilePath -> IO () #

Install an executable file. This is like a file copy but the permissions + are set appropriately for an installed file. On Unix it is "-rwxr-xr-x" + while on Windows it uses the default permissions for the target directory.

installMaybeExecutableFile :: Verbosity -> FilePath -> FilePath -> IO () #

Install a file that may or not be executable, preserving permissions.

installOrdinaryFiles :: Verbosity -> FilePath -> [(FilePath, FilePath)] -> IO () #

This is like copyFiles but uses installOrdinaryFile.

installExecutableFiles :: Verbosity -> FilePath -> [(FilePath, FilePath)] -> IO () #

This is like copyFiles but uses installExecutableFile.

installMaybeExecutableFiles :: Verbosity -> FilePath -> [(FilePath, FilePath)] -> IO () #

This is like copyFiles but uses installMaybeExecutableFile.

installDirectoryContents :: Verbosity -> FilePath -> FilePath -> IO () #

This installs all the files in a directory to a target location, + preserving the directory layout. All the files are assumed to be ordinary + rather than executable files.

copyDirectoryRecursive :: Verbosity -> FilePath -> FilePath -> IO () #

Recursively copy the contents of one directory to another path.

File permissions

doesExecutableExist :: FilePath -> NoCallStackIO Bool #

Like doesFileExist, but also checks that the file is executable.

setFileOrdinary :: FilePath -> NoCallStackIO () #

setFileExecutable :: FilePath -> NoCallStackIO () #

file names

currentDir :: FilePath #

The path name that represents the current directory. + In Unix, it's ".", but this is system-specific. + (E.g. AmigaOS uses the empty string "" for the current directory.)

shortRelativePath :: FilePath -> FilePath -> FilePath #

dropExeExtension :: FilePath -> FilePath #

Drop the extension if it's one of exeExtensions, or return the path + unchanged.

exeExtensions :: [String] #

List of possible executable file extensions on the current platform.

finding files

findFile #

Arguments

:: [FilePath]

search locations

-> FilePath

File Name

-> IO FilePath 

Find a file by looking in a search path. The file path must match exactly.

findFirstFile :: (a -> FilePath) -> [a] -> NoCallStackIO (Maybe a) #

findFileWithExtension :: [String] -> [FilePath] -> FilePath -> NoCallStackIO (Maybe FilePath) #

Find a file by looking in a search path with one of a list of possible + file extensions. The file base name should be given and it will be tried + with each of the extensions in each element of the search path.

findFileWithExtension' :: [String] -> [FilePath] -> FilePath -> NoCallStackIO (Maybe (FilePath, FilePath)) #

Like findFileWithExtension but returns which element of the search path + the file was found in, and the file path relative to that base directory.

findAllFilesWithExtension :: [String] -> [FilePath] -> FilePath -> NoCallStackIO [FilePath] #

findModuleFile #

Arguments

:: [FilePath]

build prefix (location of objects)

-> [String]

search suffixes

-> ModuleName

module

-> IO (FilePath, FilePath) 

Find the file corresponding to a Haskell module name.

This is similar to findFileWithExtension' but specialised to a module + name. The function fails if the file corresponding to the module is missing.

findModuleFiles #

Arguments

:: [FilePath]

build prefix (location of objects)

-> [String]

search suffixes

-> [ModuleName]

modules

-> IO [(FilePath, FilePath)] 

Finds the files corresponding to a list of Haskell module names.

As findModuleFile but for a list of module names.

getDirectoryContentsRecursive :: FilePath -> IO [FilePath] #

List all the files in a directory and all subdirectories.

The order places files in sub-directories after all the files in their + parent directories. The list is generated lazily so is not well defined if + the source directory structure changes before the list is used.

environment variables

isInSearchPath :: FilePath -> NoCallStackIO Bool #

Is this directory in the system search path?

addLibraryPath :: OS -> [FilePath] -> [(String, String)] -> [(String, String)] #

modification time

moreRecentFile :: FilePath -> FilePath -> NoCallStackIO Bool #

Compare the modification times of two files to see if the first is newer + than the second. The first file must exist but the second need not. + The expected use case is when the second file is generated using the first. + In this use case, if the result is True then the second file is out of date.

existsAndIsMoreRecentThan :: FilePath -> FilePath -> NoCallStackIO Bool #

Like moreRecentFile, but also checks that the first file exists.

temp files and dirs

data TempFileOptions #

Advanced options for withTempFile and withTempDirectory.

Constructors

TempFileOptions 

Fields

defaultTempFileOptions :: TempFileOptions #

withTempFile #

Arguments

:: FilePath

Temp dir to create the file in

-> String

File name template. See openTempFile.

-> (FilePath -> Handle -> IO a) 
-> IO a 

Use a temporary filename that doesn't already exist.

withTempFileEx #

Arguments

:: TempFileOptions 
-> FilePath

Temp dir to create the file in

-> String

File name template. See openTempFile.

-> (FilePath -> Handle -> IO a) 
-> IO a 

A version of withTempFile that additionally takes a TempFileOptions + argument.

withTempDirectory :: Verbosity -> FilePath -> String -> (FilePath -> IO a) -> IO a #

Create and use a temporary directory.

Creates a new temporary directory inside the given directory, making use + of the template. The temp directory is deleted after use. For example:

withTempDirectory verbosity "src" "sdist." $ \tmpDir -> do ...

The tmpDir will be a new subdirectory of the given directory, e.g. + src/sdist.342.

withTempDirectoryEx :: Verbosity -> TempFileOptions -> FilePath -> String -> (FilePath -> IO a) -> IO a #

A version of withTempDirectory that additionally takes a + TempFileOptions argument.

createTempDirectory :: FilePath -> String -> IO FilePath #

.cabal and .buildinfo files

defaultPackageDesc :: Verbosity -> IO FilePath #

Package description file (pkgname.cabal)

findPackageDesc #

Arguments

:: FilePath

Where to look

-> NoCallStackIO (Either String FilePath)

pkgname.cabal

Find a package description file in the given directory. Looks for + .cabal files.

tryFindPackageDesc :: FilePath -> IO FilePath #

Like findPackageDesc, but calls die in case of error.

defaultHookedPackageDesc :: IO (Maybe FilePath) #

Deprecated: Use findHookedPackageDesc with the proper base directory instead

Optional auxiliary package information file (pkgname.buildinfo)

findHookedPackageDesc #

Arguments

:: FilePath

Directory to search

-> IO (Maybe FilePath)

dir/pkgname.buildinfo, if present

Find auxiliary package information in the given directory. + Looks for .buildinfo files.

reading and writing files safely

withFileContents :: FilePath -> (String -> NoCallStackIO a) -> NoCallStackIO a #

Gets the contents of a file, but guarantee that it gets closed.

The file is read lazily but if it is not fully consumed by the action then + the remaining input is truncated and the file is closed.

writeFileAtomic :: FilePath -> ByteString -> NoCallStackIO () #

Writes a file atomically.

The file is either written successfully or an IO exception is raised and + the original file is left unchanged.

On windows it is not possible to delete a file that is open by a process. + This case will give an IO exception but the atomic property is not affected.

rewriteFile :: FilePath -> String -> IO () #

Deprecated: Use rewriteFileEx so that Verbosity is respected

rewriteFileEx :: Verbosity -> FilePath -> String -> IO () #

Write a file but only if it would have new content. If we would be writing + the same as the existing content then leave the file as is so that we do not + update the file's modification time.

NB: the file is assumed to be ASCII-encoded.

Unicode

fromUTF8BS :: ByteString -> String #

Decode String from UTF8-encoded ByteString

Invalid data in the UTF8 stream (this includes code-points U+D800 + through U+DFFF) will be decoded as the replacement character (U+FFFD).

fromUTF8LBS :: ByteString -> String #

Variant of fromUTF8BS for lazy ByteStrings

toUTF8BS :: String -> ByteString #

Encode String to to UTF8-encoded ByteString

Code-points in the U+D800-U+DFFF range will be encoded + as the replacement character (i.e. U+FFFD).

toUTF8LBS :: String -> ByteString #

Variant of toUTF8BS for lazy ByteStrings

readUTF8File :: FilePath -> NoCallStackIO String #

Reads a UTF8 encoded text file as a Unicode String

Reads lazily using ordinary readFile.

withUTF8FileContents :: FilePath -> (String -> IO a) -> IO a #

Reads a UTF8 encoded text file as a Unicode String

Same behaviour as withFileContents.

writeUTF8File :: FilePath -> String -> NoCallStackIO () #

Writes a Unicode String as a UTF8 encoded text file.

Uses writeFileAtomic, so provides the same guarantees.

normaliseLineEndings :: String -> String #

Fix different systems silly line ending conventions

BOM

ignoreBOM :: String -> String #

Ignore a Unicode byte order mark (BOM) at the beginning of the input

generic utils

dropWhileEndLE :: (a -> Bool) -> [a] -> [a] #

dropWhileEndLE p is equivalent to reverse . dropWhile p . reverse, but + quite a bit faster. The difference between "Data.List.dropWhileEnd" and this + version is that the one in Data.List is strict in elements, but spine-lazy, + while this one is spine-strict but lazy in elements. That's what LE stands + for - "lazy in elements".

Example:

>>> tail $ Data.List.dropWhileEnd (<3) [undefined, 5, 4, 3, 2, 1]
+*** Exception: Prelude.undefined
+...
+
>>> tail $ dropWhileEndLE (<3) [undefined, 5, 4, 3, 2, 1]
+[5,4,3]
+
>>> take 3 $ Data.List.dropWhileEnd (<3) [5, 4, 3, 2, 1, undefined]
+[5,4,3]
+
>>> take 3 $ dropWhileEndLE (<3) [5, 4, 3, 2, 1, undefined]
+*** Exception: Prelude.undefined
+...
+

takeWhileEndLE :: (a -> Bool) -> [a] -> [a] #

takeWhileEndLE p is equivalent to reverse . takeWhile p . reverse, but + is usually faster (as well as being easier to read).

equating :: Eq a => (b -> a) -> b -> b -> Bool #

comparing :: Ord a => (b -> a) -> b -> b -> Ordering #

comparing p x y = compare (p x) (p y)

Useful combinator for use in conjunction with the xxxBy family + of functions from Data.List, for example:

  ... sortBy (comparing fst) ...

isInfixOf :: Eq a => [a] -> [a] -> Bool #

The isInfixOf function takes two lists and returns True + iff the first list is contained, wholly and intact, + anywhere within the second.

>>> isInfixOf "Haskell" "I really like Haskell."
+True
+
>>> isInfixOf "Ial" "I really like Haskell."
+False
+

intercalate :: [a] -> [[a]] -> [a] #

intercalate xs xss is equivalent to (concat (intersperse xs xss)). + It inserts the list xs in between the lists in xss and concatenates the + result.

>>> intercalate ", " ["Lorem", "ipsum", "dolor"]
+"Lorem, ipsum, dolor"
+

lowercase :: String -> String #

Lower case string

>>> lowercase "Foobar"
+"foobar"
+

listUnion :: Ord a => [a] -> [a] -> [a] #

Like "Data.List.union", but has O(n log n) complexity instead of + O(n^2).

listUnionRight :: Ord a => [a] -> [a] -> [a] #

A right-biased version of listUnion.

Example:

>>> listUnion [1,2,3,4,3] [2,1,1]
+[1,2,3,4,3]
+
>>> listUnionRight [1,2,3,4,3] [2,1,1]
+[4,3,2,1,1]
+

ordNub :: Ord a => [a] -> [a] #

Like nub, but has O(n log n) complexity instead of + O(n^2). Code for ordNub and listUnion taken from Niklas Hambüchen's + ordnub package.

ordNubBy :: Ord b => (a -> b) -> [a] -> [a] #

Like ordNub and nubBy. Selects a key for each element and + takes the nub based on that key.

ordNubRight :: Ord a => [a] -> [a] #

A right-biased version of ordNub.

Example:

>>> ordNub [1,2,1] :: [Int]
+[1,2]
+
>>> ordNubRight [1,2,1] :: [Int]
+[2,1]
+

safeTail :: [a] -> [a] #

A total variant of tail.

unintersperse :: Char -> String -> [String] #

wrapText :: String -> String #

Wraps text to the default line width. Existing newlines are preserved.

wrapLine :: Int -> [String] -> [[String]] #

Wraps a list of words to a list of lines of words of a particular width.

FilePath stuff

isAbsoluteOnAnyPlatform :: FilePath -> Bool #

isAbsoluteOnAnyPlatform and isRelativeOnAnyPlatform are like + isAbsolute and isRelative but have + platform independent heuristics. + The System.FilePath exists in two versions, Windows and Posix. The two + versions don't agree on what is a relative path and we don't know if we're + given Windows or Posix paths. + This results in false positives when running on Posix and inspecting + Windows paths, like the hackage server does. + System.FilePath.Posix.isAbsolute "C:\hello" == False + System.FilePath.Windows.isAbsolute "/hello" == False + This means that we would treat paths that start with "/" to be absolute. + On Posix they are indeed absolute, while on Windows they are not.

The portable versions should be used when we might deal with paths that + are from another OS than the host OS. For example, the Hackage Server + deals with both Windows and Posix paths while performing the + PackageDescription checks. In contrast, when we run 'cabal configure' we + do expect the paths to be correct for our OS and we should not have to use + the platform independent heuristics.

isRelativeOnAnyPlatform :: FilePath -> Bool #

isRelativeOnAnyPlatform = not . isAbsoluteOnAnyPlatform
diff --git a/doc/API/Cabal/Distribution-Simple.html b/doc/API/Cabal/Distribution-Simple.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Simple.html @@ -0,0 +1,70 @@ +Distribution.Simple

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2005
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple

Contents

Description

This is the command line front end to the Simple build system. When given + the parsed command-line args and package information, is able to perform + basic commands like configure, build, install, register, etc.

This module exports the main functions that Setup.hs scripts use. It + re-exports the UserHooks type, the standard entry points like + defaultMain and defaultMainWithHooks and the predefined sets of + UserHooks that custom Setup.hs scripts can extend to add their own + behaviour.

This module isn't called "Simple" because it's simple. Far from + it. It's called "Simple" because it does complicated things to + simple software.

The original idea was that there could be different build systems that all + presented the same compatible command line interfaces. There is still a + Distribution.Make system but in practice no packages use it.

Synopsis

Documentation

module Distribution.Package

module Distribution.Version

module Distribution.License

data AbiTag #

Constructors

NoAbiTag 
AbiTag String 
Instances
Eq AbiTag # 
Instance details

Defined in Distribution.Compiler

Methods

(==) :: AbiTag -> AbiTag -> Bool #

(/=) :: AbiTag -> AbiTag -> Bool #

Read AbiTag # 
Instance details

Defined in Distribution.Compiler

Methods

readsPrec :: Int -> ReadS AbiTag #

readList :: ReadS [AbiTag] #

readPrec :: ReadPrec AbiTag #

readListPrec :: ReadPrec [AbiTag] #

Show AbiTag # 
Instance details

Defined in Distribution.Compiler

Methods

showsPrec :: Int -> AbiTag -> ShowS #

show :: AbiTag -> String #

showList :: [AbiTag] -> ShowS #

Generic AbiTag # 
Instance details

Defined in Distribution.Compiler

Associated Types

type Rep AbiTag :: * -> * #

Methods

from :: AbiTag -> Rep AbiTag x #

to :: Rep AbiTag x -> AbiTag #

Binary AbiTag # 
Instance details

Defined in Distribution.Compiler

Methods

put :: AbiTag -> Put #

get :: Get AbiTag #

putList :: [AbiTag] -> Put #

Text AbiTag # 
Instance details

Defined in Distribution.Compiler

Methods

disp :: AbiTag -> Doc #

parse :: ReadP r AbiTag #

type Rep AbiTag # 
Instance details

Defined in Distribution.Compiler

type Rep AbiTag = D1 (MetaData "AbiTag" "Distribution.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "NoAbiTag" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "AbiTag" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))

data CompilerInfo #

Compiler information used for resolving configurations. Some + fields can be set to Nothing to indicate that the information is + unknown.

Constructors

CompilerInfo 

Fields

Instances
Read CompilerInfo # 
Instance details

Defined in Distribution.Compiler

Methods

readsPrec :: Int -> ReadS CompilerInfo #

readList :: ReadS [CompilerInfo] #

readPrec :: ReadPrec CompilerInfo #

readListPrec :: ReadPrec [CompilerInfo] #

Show CompilerInfo # 
Instance details

Defined in Distribution.Compiler

Methods

showsPrec :: Int -> CompilerInfo -> ShowS #

show :: CompilerInfo -> String #

showList :: [CompilerInfo] -> ShowS #

Generic CompilerInfo # 
Instance details

Defined in Distribution.Compiler

Associated Types

type Rep CompilerInfo :: * -> * #

Methods

from :: CompilerInfo -> Rep CompilerInfo x #

to :: Rep CompilerInfo x -> CompilerInfo #

Binary CompilerInfo # 
Instance details

Defined in Distribution.Compiler

Methods

put :: CompilerInfo -> Put #

get :: Get CompilerInfo #

putList :: [CompilerInfo] -> Put #

type Rep CompilerInfo # 
Instance details

Defined in Distribution.Compiler

type Rep CompilerInfo = D1 (MetaData "CompilerInfo" "Distribution.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "CompilerInfo" PrefixI True) ((S1 (MetaSel (Just "compilerInfoId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CompilerId) :*: S1 (MetaSel (Just "compilerInfoAbiTag") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AbiTag)) :*: (S1 (MetaSel (Just "compilerInfoCompat") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [CompilerId])) :*: (S1 (MetaSel (Just "compilerInfoLanguages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Language])) :*: S1 (MetaSel (Just "compilerInfoExtensions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Extension]))))))

data CompilerId #

Constructors

CompilerId CompilerFlavor Version 
Instances
Eq CompilerId # 
Instance details

Defined in Distribution.Compiler

Methods

(==) :: CompilerId -> CompilerId -> Bool #

(/=) :: CompilerId -> CompilerId -> Bool #

Ord CompilerId # 
Instance details

Defined in Distribution.Compiler

Methods

compare :: CompilerId -> CompilerId -> Ordering #

(<) :: CompilerId -> CompilerId -> Bool #

(<=) :: CompilerId -> CompilerId -> Bool #

(>) :: CompilerId -> CompilerId -> Bool #

(>=) :: CompilerId -> CompilerId -> Bool #

max :: CompilerId -> CompilerId -> CompilerId #

min :: CompilerId -> CompilerId -> CompilerId #

Read CompilerId # 
Instance details

Defined in Distribution.Compiler

Methods

readsPrec :: Int -> ReadS CompilerId #

readList :: ReadS [CompilerId] #

readPrec :: ReadPrec CompilerId #

readListPrec :: ReadPrec [CompilerId] #

Show CompilerId # 
Instance details

Defined in Distribution.Compiler

Methods

showsPrec :: Int -> CompilerId -> ShowS #

show :: CompilerId -> String #

showList :: [CompilerId] -> ShowS #

Generic CompilerId # 
Instance details

Defined in Distribution.Compiler

Associated Types

type Rep CompilerId :: * -> * #

Methods

from :: CompilerId -> Rep CompilerId x #

to :: Rep CompilerId x -> CompilerId #

Binary CompilerId # 
Instance details

Defined in Distribution.Compiler

Methods

put :: CompilerId -> Put #

get :: Get CompilerId #

putList :: [CompilerId] -> Put #

NFData CompilerId # 
Instance details

Defined in Distribution.Compiler

Methods

rnf :: CompilerId -> () #

Text CompilerId # 
Instance details

Defined in Distribution.Compiler

Methods

disp :: CompilerId -> Doc #

parse :: ReadP r CompilerId #

type Rep CompilerId # 
Instance details

Defined in Distribution.Compiler

type Rep CompilerId = D1 (MetaData "CompilerId" "Distribution.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "CompilerId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CompilerFlavor) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)))

data CompilerFlavor #

Constructors

GHC 
GHCJS 
NHC 
YHC 
Hugs 
HBC 
Helium 
JHC 
LHC 
UHC 
Eta 
HaskellSuite String 
OtherCompiler String 
Instances
Eq CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

(==) :: CompilerFlavor -> CompilerFlavor -> Bool #

(/=) :: CompilerFlavor -> CompilerFlavor -> Bool #

Data CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CompilerFlavor -> c CompilerFlavor #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CompilerFlavor #

toConstr :: CompilerFlavor -> Constr #

dataTypeOf :: CompilerFlavor -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CompilerFlavor) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CompilerFlavor) #

gmapT :: (forall b. Data b => b -> b) -> CompilerFlavor -> CompilerFlavor #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CompilerFlavor -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CompilerFlavor -> r #

gmapQ :: (forall d. Data d => d -> u) -> CompilerFlavor -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CompilerFlavor -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CompilerFlavor -> m CompilerFlavor #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CompilerFlavor -> m CompilerFlavor #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CompilerFlavor -> m CompilerFlavor #

Ord CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

compare :: CompilerFlavor -> CompilerFlavor -> Ordering #

(<) :: CompilerFlavor -> CompilerFlavor -> Bool #

(<=) :: CompilerFlavor -> CompilerFlavor -> Bool #

(>) :: CompilerFlavor -> CompilerFlavor -> Bool #

(>=) :: CompilerFlavor -> CompilerFlavor -> Bool #

max :: CompilerFlavor -> CompilerFlavor -> CompilerFlavor #

min :: CompilerFlavor -> CompilerFlavor -> CompilerFlavor #

Read CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

readsPrec :: Int -> ReadS CompilerFlavor #

readList :: ReadS [CompilerFlavor] #

readPrec :: ReadPrec CompilerFlavor #

readListPrec :: ReadPrec [CompilerFlavor] #

Show CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

showsPrec :: Int -> CompilerFlavor -> ShowS #

show :: CompilerFlavor -> String #

showList :: [CompilerFlavor] -> ShowS #

Generic CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Associated Types

type Rep CompilerFlavor :: * -> * #

Methods

from :: CompilerFlavor -> Rep CompilerFlavor x #

to :: Rep CompilerFlavor x -> CompilerFlavor #

Binary CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

put :: CompilerFlavor -> Put #

get :: Get CompilerFlavor #

putList :: [CompilerFlavor] -> Put #

NFData CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

rnf :: CompilerFlavor -> () #

Pretty CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

pretty :: CompilerFlavor -> Doc #

Parsec CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

parsec :: CabalParsing m => m CompilerFlavor #

Text CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

disp :: CompilerFlavor -> Doc #

parse :: ReadP r CompilerFlavor #

Newtype TestedWith (CompilerFlavor, VersionRange) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: (CompilerFlavor, VersionRange) -> TestedWith #

unpack :: TestedWith -> (CompilerFlavor, VersionRange) #

type Rep CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

type Rep CompilerFlavor = D1 (MetaData "CompilerFlavor" "Distribution.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (((C1 (MetaCons "GHC" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "GHCJS" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NHC" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "YHC" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Hugs" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "HBC" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "Helium" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "JHC" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LHC" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "UHC" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Eta" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "HaskellSuite" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "OtherCompiler" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))))

knownCompilerFlavors :: [CompilerFlavor] #

classifyCompilerFlavor :: String -> CompilerFlavor #

parseCompilerFlavorCompat :: ReadP r CompilerFlavor #

Like classifyCompilerFlavor but compatible with the old ReadS parser.

It is compatible in the sense that it accepts only the same strings, + eg GHC but not "ghc". However other strings get mapped to OtherCompiler. + The point of this is that we do not allow extra valid values that would + upset older Cabal versions that had a stricter parser however we cope with + new values more gracefully so that we'll be able to introduce new value in + future without breaking things so much.

buildCompilerFlavor :: CompilerFlavor #

buildCompilerId :: CompilerId #

defaultCompilerFlavor :: Maybe CompilerFlavor #

The default compiler flavour to pick when compiling stuff. This defaults + to the compiler used to build the Cabal lib.

However if it's not a recognised compiler then it's Nothing and the user + will have to specify which compiler they want.

abiTagString :: AbiTag -> String #

unknownCompilerInfo :: CompilerId -> AbiTag -> CompilerInfo #

Make a CompilerInfo of which only the known information is its CompilerId, + its AbiTag and that it does not claim to be compatible with other + compiler id's.

data ProfDetailLevel #

Some compilers (notably GHC) support profiling and can instrument + programs so the system can account costs to different functions. There are + different levels of detail that can be used for this accounting. + For compilers that do not support this notion or the particular detail + levels, this is either ignored or just capped to some similar level + they do support.

Constructors

ProfDetailNone 
ProfDetailDefault 
ProfDetailExportedFunctions 
ProfDetailToplevelFunctions 
ProfDetailAllFunctions 
ProfDetailOther String 
Instances
Eq ProfDetailLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

(==) :: ProfDetailLevel -> ProfDetailLevel -> Bool #

(/=) :: ProfDetailLevel -> ProfDetailLevel -> Bool #

Read ProfDetailLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

readsPrec :: Int -> ReadS ProfDetailLevel #

readList :: ReadS [ProfDetailLevel] #

readPrec :: ReadPrec ProfDetailLevel #

readListPrec :: ReadPrec [ProfDetailLevel] #

Show ProfDetailLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

showsPrec :: Int -> ProfDetailLevel -> ShowS #

show :: ProfDetailLevel -> String #

showList :: [ProfDetailLevel] -> ShowS #

Generic ProfDetailLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Associated Types

type Rep ProfDetailLevel :: * -> * #

Methods

from :: ProfDetailLevel -> Rep ProfDetailLevel x #

to :: Rep ProfDetailLevel x -> ProfDetailLevel #

Binary ProfDetailLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

put :: ProfDetailLevel -> Put #

get :: Get ProfDetailLevel #

putList :: [ProfDetailLevel] -> Put #

type Rep ProfDetailLevel # 
Instance details

Defined in Distribution.Simple.Compiler

type Rep ProfDetailLevel = D1 (MetaData "ProfDetailLevel" "Distribution.Simple.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "ProfDetailNone" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ProfDetailDefault" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ProfDetailExportedFunctions" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "ProfDetailToplevelFunctions" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ProfDetailAllFunctions" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ProfDetailOther" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))))

data DebugInfoLevel #

Some compilers support emitting debug info. Some have different + levels. For compilers that do not the level is just capped to the + level they do support.

Constructors

NoDebugInfo 
MinimalDebugInfo 
NormalDebugInfo 
MaximalDebugInfo 
Instances
Bounded DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

minBound :: DebugInfoLevel #

maxBound :: DebugInfoLevel #

Enum DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

succ :: DebugInfoLevel -> DebugInfoLevel #

pred :: DebugInfoLevel -> DebugInfoLevel #

toEnum :: Int -> DebugInfoLevel #

fromEnum :: DebugInfoLevel -> Int #

enumFrom :: DebugInfoLevel -> [DebugInfoLevel] #

enumFromThen :: DebugInfoLevel -> DebugInfoLevel -> [DebugInfoLevel] #

enumFromTo :: DebugInfoLevel -> DebugInfoLevel -> [DebugInfoLevel] #

enumFromThenTo :: DebugInfoLevel -> DebugInfoLevel -> DebugInfoLevel -> [DebugInfoLevel] #

Eq DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

(==) :: DebugInfoLevel -> DebugInfoLevel -> Bool #

(/=) :: DebugInfoLevel -> DebugInfoLevel -> Bool #

Read DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

readsPrec :: Int -> ReadS DebugInfoLevel #

readList :: ReadS [DebugInfoLevel] #

readPrec :: ReadPrec DebugInfoLevel #

readListPrec :: ReadPrec [DebugInfoLevel] #

Show DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

showsPrec :: Int -> DebugInfoLevel -> ShowS #

show :: DebugInfoLevel -> String #

showList :: [DebugInfoLevel] -> ShowS #

Generic DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Associated Types

type Rep DebugInfoLevel :: * -> * #

Methods

from :: DebugInfoLevel -> Rep DebugInfoLevel x #

to :: Rep DebugInfoLevel x -> DebugInfoLevel #

Binary DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

put :: DebugInfoLevel -> Put #

get :: Get DebugInfoLevel #

putList :: [DebugInfoLevel] -> Put #

type Rep DebugInfoLevel # 
Instance details

Defined in Distribution.Simple.Compiler

type Rep DebugInfoLevel = D1 (MetaData "DebugInfoLevel" "Distribution.Simple.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "NoDebugInfo" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MinimalDebugInfo" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "NormalDebugInfo" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MaximalDebugInfo" PrefixI False) (U1 :: * -> *)))

data OptimisationLevel #

Some compilers support optimising. Some have different levels. + For compilers that do not the level is just capped to the level + they do support.

Constructors

NoOptimisation 
NormalOptimisation 
MaximumOptimisation 
Instances
Bounded OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

minBound :: OptimisationLevel #

maxBound :: OptimisationLevel #

Enum OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

succ :: OptimisationLevel -> OptimisationLevel #

pred :: OptimisationLevel -> OptimisationLevel #

toEnum :: Int -> OptimisationLevel #

fromEnum :: OptimisationLevel -> Int #

enumFrom :: OptimisationLevel -> [OptimisationLevel] #

enumFromThen :: OptimisationLevel -> OptimisationLevel -> [OptimisationLevel] #

enumFromTo :: OptimisationLevel -> OptimisationLevel -> [OptimisationLevel] #

enumFromThenTo :: OptimisationLevel -> OptimisationLevel -> OptimisationLevel -> [OptimisationLevel] #

Eq OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

(==) :: OptimisationLevel -> OptimisationLevel -> Bool #

(/=) :: OptimisationLevel -> OptimisationLevel -> Bool #

Read OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

readsPrec :: Int -> ReadS OptimisationLevel #

readList :: ReadS [OptimisationLevel] #

readPrec :: ReadPrec OptimisationLevel #

readListPrec :: ReadPrec [OptimisationLevel] #

Show OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

showsPrec :: Int -> OptimisationLevel -> ShowS #

show :: OptimisationLevel -> String #

showList :: [OptimisationLevel] -> ShowS #

Generic OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Associated Types

type Rep OptimisationLevel :: * -> * #

Methods

from :: OptimisationLevel -> Rep OptimisationLevel x #

to :: Rep OptimisationLevel x -> OptimisationLevel #

Binary OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

put :: OptimisationLevel -> Put #

get :: Get OptimisationLevel #

putList :: [OptimisationLevel] -> Put #

type Rep OptimisationLevel # 
Instance details

Defined in Distribution.Simple.Compiler

type Rep OptimisationLevel = D1 (MetaData "OptimisationLevel" "Distribution.Simple.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "NoOptimisation" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "NormalOptimisation" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MaximumOptimisation" PrefixI False) (U1 :: * -> *)))

type PackageDBStack = [PackageDB] #

We typically get packages from several databases, and stack them + together. This type lets us be explicit about that stacking. For example + typical stacks include:

[GlobalPackageDB]
+[GlobalPackageDB, UserPackageDB]
+[GlobalPackageDB, SpecificPackageDB "package.conf.inplace"]

Note that the GlobalPackageDB is invariably at the bottom since it + contains the rts, base and other special compiler-specific packages.

We are not restricted to using just the above combinations. In particular + we can use several custom package dbs and the user package db together.

When it comes to writing, the top most (last) package is used.

data PackageDB #

Some compilers have a notion of a database of available packages. + For some there is just one global db of packages, other compilers + support a per-user or an arbitrary db specified at some location in + the file system. This can be used to build isloated environments of + packages, for example to build a collection of related packages + without installing them globally.

Constructors

GlobalPackageDB 
UserPackageDB 
SpecificPackageDB FilePath 
Instances
Eq PackageDB # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

(==) :: PackageDB -> PackageDB -> Bool #

(/=) :: PackageDB -> PackageDB -> Bool #

Ord PackageDB # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

compare :: PackageDB -> PackageDB -> Ordering #

(<) :: PackageDB -> PackageDB -> Bool #

(<=) :: PackageDB -> PackageDB -> Bool #

(>) :: PackageDB -> PackageDB -> Bool #

(>=) :: PackageDB -> PackageDB -> Bool #

max :: PackageDB -> PackageDB -> PackageDB #

min :: PackageDB -> PackageDB -> PackageDB #

Read PackageDB # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

readsPrec :: Int -> ReadS PackageDB #

readList :: ReadS [PackageDB] #

readPrec :: ReadPrec PackageDB #

readListPrec :: ReadPrec [PackageDB] #

Show PackageDB # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

showsPrec :: Int -> PackageDB -> ShowS #

show :: PackageDB -> String #

showList :: [PackageDB] -> ShowS #

Generic PackageDB # 
Instance details

Defined in Distribution.Simple.Compiler

Associated Types

type Rep PackageDB :: * -> * #

Methods

from :: PackageDB -> Rep PackageDB x #

to :: Rep PackageDB x -> PackageDB #

Binary PackageDB # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

put :: PackageDB -> Put #

get :: Get PackageDB #

putList :: [PackageDB] -> Put #

type Rep PackageDB # 
Instance details

Defined in Distribution.Simple.Compiler

type Rep PackageDB = D1 (MetaData "PackageDB" "Distribution.Simple.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "GlobalPackageDB" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "UserPackageDB" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SpecificPackageDB" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath))))

data Compiler #

Constructors

Compiler 

Fields

Instances
Eq Compiler # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

(==) :: Compiler -> Compiler -> Bool #

(/=) :: Compiler -> Compiler -> Bool #

Read Compiler # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

readsPrec :: Int -> ReadS Compiler #

readList :: ReadS [Compiler] #

readPrec :: ReadPrec Compiler #

readListPrec :: ReadPrec [Compiler] #

Show Compiler # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

showsPrec :: Int -> Compiler -> ShowS #

show :: Compiler -> String #

showList :: [Compiler] -> ShowS #

Generic Compiler # 
Instance details

Defined in Distribution.Simple.Compiler

Associated Types

type Rep Compiler :: * -> * #

Methods

from :: Compiler -> Rep Compiler x #

to :: Rep Compiler x -> Compiler #

Binary Compiler # 
Instance details

Defined in Distribution.Simple.Compiler

Methods

put :: Compiler -> Put #

get :: Get Compiler #

putList :: [Compiler] -> Put #

type Rep Compiler # 
Instance details

Defined in Distribution.Simple.Compiler

type Rep Compiler = D1 (MetaData "Compiler" "Distribution.Simple.Compiler" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Compiler" PrefixI True) ((S1 (MetaSel (Just "compilerId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CompilerId) :*: (S1 (MetaSel (Just "compilerAbiTag") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AbiTag) :*: S1 (MetaSel (Just "compilerCompat") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [CompilerId]))) :*: (S1 (MetaSel (Just "compilerLanguages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Language, Flag)]) :*: (S1 (MetaSel (Just "compilerExtensions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Extension, Maybe Flag)]) :*: S1 (MetaSel (Just "compilerProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map String String))))))

showCompilerId :: Compiler -> String #

showCompilerIdWithAbi :: Compiler -> String #

compilerFlavor :: Compiler -> CompilerFlavor #

compilerVersion :: Compiler -> Version #

compilerCompatFlavor :: CompilerFlavor -> Compiler -> Bool #

Is this compiler compatible with the compiler flavour we're interested in?

For example this checks if the compiler is actually GHC or is another + compiler that claims to be compatible with some version of GHC, e.g. GHCJS.

if compilerCompatFlavor GHC compiler then ... else ...

compilerCompatVersion :: CompilerFlavor -> Compiler -> Maybe Version #

Is this compiler compatible with the compiler flavour we're interested in, + and if so what version does it claim to be compatible with.

For example this checks if the compiler is actually GHC-7.x or is another + compiler that claims to be compatible with some GHC-7.x version.

case compilerCompatVersion GHC compiler of
+  Just (Version (7:_)) -> ...
+  _                    -> ...

compilerInfo :: Compiler -> CompilerInfo #

registrationPackageDB :: PackageDBStack -> PackageDB #

Return the package that we should register into. This is the package db at + the top of the stack.

absolutePackageDBPaths :: PackageDBStack -> NoCallStackIO PackageDBStack #

Make package paths absolute

absolutePackageDBPath :: PackageDB -> NoCallStackIO PackageDB #

flagToOptimisationLevel :: Maybe String -> OptimisationLevel #

flagToDebugInfoLevel :: Maybe String -> DebugInfoLevel #

unsupportedLanguages :: Compiler -> [Language] -> [Language] #

languageToFlags :: Compiler -> Maybe Language -> [Flag] #

unsupportedExtensions :: Compiler -> [Extension] -> [Extension] #

For the given compiler, return the extensions it does not support.

extensionsToFlags :: Compiler -> [Extension] -> [Flag] #

For the given compiler, return the flags for the supported extensions.

parmakeSupported :: Compiler -> Bool #

Does this compiler support parallel --make mode?

reexportedModulesSupported :: Compiler -> Bool #

Does this compiler support reexported-modules?

renamingPackageFlagsSupported :: Compiler -> Bool #

Does this compiler support thinning/renaming on package flags?

unifiedIPIDRequired :: Compiler -> Bool #

Does this compiler have unified IPIDs (so no package keys)

packageKeySupported :: Compiler -> Bool #

Does this compiler support package keys?

unitIdSupported :: Compiler -> Bool #

Does this compiler support unit IDs?

backpackSupported :: Compiler -> Bool #

Does this compiler support Backpack?

libraryDynDirSupported :: Compiler -> Bool #

Does this compiler support a package database entry with: + "dynamic-library-dirs"?

arResponseFilesSupported :: Compiler -> Bool #

Does this compiler's "ar" command supports response file + arguments (i.e. @file-style arguments).

coverageSupported :: Compiler -> Bool #

Does this compiler support Haskell program coverage?

profilingSupported :: Compiler -> Bool #

Does this compiler support profiling?

flagToProfDetailLevel :: String -> ProfDetailLevel #

knownProfDetailLevels :: [(String, [String], ProfDetailLevel)] #

showProfDetailLevel :: ProfDetailLevel -> String #

module Language.Haskell.Extension

Simple interface

defaultMain :: IO () #

A simple implementation of main for a Cabal setup script. + It reads the package description file using IO, and performs the + action specified on the command line.

defaultMainNoRead :: GenericPackageDescription -> IO () #

Like defaultMain, but accepts the package description as input + rather than using IO to read it.

defaultMainArgs :: [String] -> IO () #

A version of defaultMain that is passed the command line + arguments, rather than getting them from the environment.

Customization

data UserHooks #

Hooks allow authors to add specific functionality before and after a + command is run, and also to specify additional preprocessors.

  • WARNING: The hooks interface is under rather constant flux as we try to + understand users needs. Setup files that depend on this interface may + break in future releases.

Constructors

UserHooks 

Fields

type Args = [String] #

defaultMainWithHooks :: UserHooks -> IO () #

A customizable version of defaultMain.

defaultMainWithHooksArgs :: UserHooks -> [String] -> IO () #

A customizable version of defaultMain that also takes the command + line arguments.

defaultMainWithHooksNoRead :: UserHooks -> GenericPackageDescription -> IO () #

A customizable version of defaultMainNoRead.

defaultMainWithHooksNoReadArgs :: UserHooks -> GenericPackageDescription -> [String] -> IO () #

A customizable version of defaultMainNoRead that also takes the + command line arguments.

Since: 2.2.0.0

Standard sets of hooks

simpleUserHooks :: UserHooks #

Hooks that correspond to a plain instantiation of the + "simple" build system

autoconfUserHooks :: UserHooks #

defaultUserHooks :: UserHooks #

Deprecated: Use simpleUserHooks or autoconfUserHooks, unless you need Cabal-1.2 + compatibility in which case you must stick with defaultUserHooks

Basic autoconf UserHooks:

Thus configure can use local system information to generate + package.buildinfo and possibly other files.

emptyUserHooks :: UserHooks #

Empty UserHooks which do nothing.

Utils

defaultHookedPackageDesc :: IO (Maybe FilePath) #

Deprecated: Use findHookedPackageDesc with the proper base directory instead

Optional auxiliary package information file (pkgname.buildinfo)

diff --git a/doc/API/Cabal/Distribution-System.html b/doc/API/Cabal/Distribution-System.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-System.html @@ -0,0 +1,31 @@ +Distribution.System

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightDuncan Coutts 2007-2008
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.System

Contents

Description

Cabal often needs to do slightly different things on specific platforms. You + probably know about the os however using that is very + inconvenient because it is a string and different Haskell implementations + do not agree on using the same strings for the same platforms! (In + particular see the controversy over "windows" vs "mingw32"). So to make it + more consistent and easy to use we have an OS enumeration.

Synopsis

Operating System

data OS #

These are the known OS names: Linux, Windows, OSX + ,FreeBSD, OpenBSD, NetBSD, DragonFly + ,Solaris, AIX, HPUX, IRIX + ,HaLVM ,Hurd ,IOS, Android,Ghcjs

The following aliases can also be used:, + * Windows aliases: mingw32, win32, cygwin32 + * OSX alias: darwin + * Hurd alias: gnu + * FreeBSD alias: kfreebsdgnu + * Solaris alias: solaris2

Constructors

Linux 
Windows 
OSX 
FreeBSD 
OpenBSD 
NetBSD 
DragonFly 
Solaris 
AIX 
HPUX 
IRIX 
HaLVM 
Hurd 
IOS 
Android 
Ghcjs 
OtherOS String 
Instances
Eq OS # 
Instance details

Defined in Distribution.System

Methods

(==) :: OS -> OS -> Bool #

(/=) :: OS -> OS -> Bool #

Data OS # 
Instance details

Defined in Distribution.System

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OS -> c OS #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OS #

toConstr :: OS -> Constr #

dataTypeOf :: OS -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OS) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OS) #

gmapT :: (forall b. Data b => b -> b) -> OS -> OS #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OS -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OS -> r #

gmapQ :: (forall d. Data d => d -> u) -> OS -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> OS -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> OS -> m OS #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OS -> m OS #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OS -> m OS #

Ord OS # 
Instance details

Defined in Distribution.System

Methods

compare :: OS -> OS -> Ordering #

(<) :: OS -> OS -> Bool #

(<=) :: OS -> OS -> Bool #

(>) :: OS -> OS -> Bool #

(>=) :: OS -> OS -> Bool #

max :: OS -> OS -> OS #

min :: OS -> OS -> OS #

Read OS # 
Instance details

Defined in Distribution.System

Methods

readsPrec :: Int -> ReadS OS #

readList :: ReadS [OS] #

readPrec :: ReadPrec OS #

readListPrec :: ReadPrec [OS] #

Show OS # 
Instance details

Defined in Distribution.System

Methods

showsPrec :: Int -> OS -> ShowS #

show :: OS -> String #

showList :: [OS] -> ShowS #

Generic OS # 
Instance details

Defined in Distribution.System

Associated Types

type Rep OS :: * -> * #

Methods

from :: OS -> Rep OS x #

to :: Rep OS x -> OS #

Binary OS # 
Instance details

Defined in Distribution.System

Methods

put :: OS -> Put #

get :: Get OS #

putList :: [OS] -> Put #

NFData OS # 
Instance details

Defined in Distribution.System

Methods

rnf :: OS -> () #

Pretty OS # 
Instance details

Defined in Distribution.System

Methods

pretty :: OS -> Doc #

Parsec OS # 
Instance details

Defined in Distribution.System

Methods

parsec :: CabalParsing m => m OS #

Text OS # 
Instance details

Defined in Distribution.System

Methods

disp :: OS -> Doc #

parse :: ReadP r OS #

type Rep OS # 
Instance details

Defined in Distribution.System

type Rep OS = D1 (MetaData "OS" "Distribution.System" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((((C1 (MetaCons "Linux" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Windows" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "OSX" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "FreeBSD" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "OpenBSD" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NetBSD" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "DragonFly" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Solaris" PrefixI False) (U1 :: * -> *)))) :+: (((C1 (MetaCons "AIX" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "HPUX" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "IRIX" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "HaLVM" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "Hurd" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "IOS" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Android" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Ghcjs" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OtherOS" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))))))

buildOS :: OS #

Machine Architecture

data Arch #

These are the known Arches: I386, X86_64, PPC, PPC64, Sparc, + Arm, AArch64, Mips, SH, IA64, S39, Alpha, Hppa, Rs6000, M68k, + Vax, and JavaScript.

The following aliases can also be used: + * PPC alias: powerpc + * PPC64 alias : powerpc64, powerpc64le + * Sparc aliases: sparc64, sun4 + * Mips aliases: mipsel, mipseb + * Arm aliases: armeb, armel + * AArch64 aliases: arm64

Constructors

I386 
X86_64 
PPC 
PPC64 
Sparc 
Arm 
AArch64 
Mips 
SH 
IA64 
S390 
Alpha 
Hppa 
Rs6000 
M68k 
Vax 
JavaScript 
OtherArch String 
Instances
Eq Arch # 
Instance details

Defined in Distribution.System

Methods

(==) :: Arch -> Arch -> Bool #

(/=) :: Arch -> Arch -> Bool #

Data Arch # 
Instance details

Defined in Distribution.System

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Arch -> c Arch #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Arch #

toConstr :: Arch -> Constr #

dataTypeOf :: Arch -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Arch) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Arch) #

gmapT :: (forall b. Data b => b -> b) -> Arch -> Arch #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Arch -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Arch -> r #

gmapQ :: (forall d. Data d => d -> u) -> Arch -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Arch -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Arch -> m Arch #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Arch -> m Arch #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Arch -> m Arch #

Ord Arch # 
Instance details

Defined in Distribution.System

Methods

compare :: Arch -> Arch -> Ordering #

(<) :: Arch -> Arch -> Bool #

(<=) :: Arch -> Arch -> Bool #

(>) :: Arch -> Arch -> Bool #

(>=) :: Arch -> Arch -> Bool #

max :: Arch -> Arch -> Arch #

min :: Arch -> Arch -> Arch #

Read Arch # 
Instance details

Defined in Distribution.System

Methods

readsPrec :: Int -> ReadS Arch #

readList :: ReadS [Arch] #

readPrec :: ReadPrec Arch #

readListPrec :: ReadPrec [Arch] #

Show Arch # 
Instance details

Defined in Distribution.System

Methods

showsPrec :: Int -> Arch -> ShowS #

show :: Arch -> String #

showList :: [Arch] -> ShowS #

Generic Arch # 
Instance details

Defined in Distribution.System

Associated Types

type Rep Arch :: * -> * #

Methods

from :: Arch -> Rep Arch x #

to :: Rep Arch x -> Arch #

Binary Arch # 
Instance details

Defined in Distribution.System

Methods

put :: Arch -> Put #

get :: Get Arch #

putList :: [Arch] -> Put #

NFData Arch # 
Instance details

Defined in Distribution.System

Methods

rnf :: Arch -> () #

Pretty Arch # 
Instance details

Defined in Distribution.System

Methods

pretty :: Arch -> Doc #

Parsec Arch # 
Instance details

Defined in Distribution.System

Methods

parsec :: CabalParsing m => m Arch #

Text Arch # 
Instance details

Defined in Distribution.System

Methods

disp :: Arch -> Doc #

parse :: ReadP r Arch #

type Rep Arch # 
Instance details

Defined in Distribution.System

type Rep Arch = D1 (MetaData "Arch" "Distribution.System" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((((C1 (MetaCons "I386" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "X86_64" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "PPC" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PPC64" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "Sparc" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Arm" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "AArch64" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Mips" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SH" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "IA64" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "S390" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Alpha" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Hppa" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "Rs6000" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "M68k" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Vax" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "JavaScript" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OtherArch" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))))))

buildArch :: Arch #

Platform is a pair of arch and OS

data Platform #

Constructors

Platform Arch OS 
Instances
Eq Platform # 
Instance details

Defined in Distribution.System

Methods

(==) :: Platform -> Platform -> Bool #

(/=) :: Platform -> Platform -> Bool #

Data Platform # 
Instance details

Defined in Distribution.System

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Platform -> c Platform #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Platform #

toConstr :: Platform -> Constr #

dataTypeOf :: Platform -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Platform) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Platform) #

gmapT :: (forall b. Data b => b -> b) -> Platform -> Platform #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Platform -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Platform -> r #

gmapQ :: (forall d. Data d => d -> u) -> Platform -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Platform -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Platform -> m Platform #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Platform -> m Platform #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Platform -> m Platform #

Ord Platform # 
Instance details

Defined in Distribution.System

Methods

compare :: Platform -> Platform -> Ordering #

(<) :: Platform -> Platform -> Bool #

(<=) :: Platform -> Platform -> Bool #

(>) :: Platform -> Platform -> Bool #

(>=) :: Platform -> Platform -> Bool #

max :: Platform -> Platform -> Platform #

min :: Platform -> Platform -> Platform #

Read Platform # 
Instance details

Defined in Distribution.System

Methods

readsPrec :: Int -> ReadS Platform #

readList :: ReadS [Platform] #

readPrec :: ReadPrec Platform #

readListPrec :: ReadPrec [Platform] #

Show Platform # 
Instance details

Defined in Distribution.System

Methods

showsPrec :: Int -> Platform -> ShowS #

show :: Platform -> String #

showList :: [Platform] -> ShowS #

Generic Platform # 
Instance details

Defined in Distribution.System

Associated Types

type Rep Platform :: * -> * #

Methods

from :: Platform -> Rep Platform x #

to :: Rep Platform x -> Platform #

Binary Platform # 
Instance details

Defined in Distribution.System

Methods

put :: Platform -> Put #

get :: Get Platform #

putList :: [Platform] -> Put #

NFData Platform # 
Instance details

Defined in Distribution.System

Methods

rnf :: Platform -> () #

Pretty Platform # 
Instance details

Defined in Distribution.System

Methods

pretty :: Platform -> Doc #

Parsec Platform # 
Instance details

Defined in Distribution.System

Methods

parsec :: CabalParsing m => m Platform #

Text Platform # 
Instance details

Defined in Distribution.System

Methods

disp :: Platform -> Doc #

parse :: ReadP r Platform #

type Rep Platform # 
Instance details

Defined in Distribution.System

type Rep Platform = D1 (MetaData "Platform" "Distribution.System" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Platform" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Arch) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OS)))

buildPlatform :: Platform #

The platform Cabal was compiled on. In most cases, + LocalBuildInfo.hostPlatform should be used instead (the platform we're + targeting).

platformFromTriple :: String -> Maybe Platform #

Internal

knownOSs :: [OS] #

knownArches :: [Arch] #

Classification

data ClassificationStrictness #

How strict to be when classifying strings into the OS and Arch enums.

The reason we have multiple ways to do the classification is because there + are two situations where we need to do it.

For parsing OS and arch names in .cabal files we really want everyone to be + referring to the same or or arch by the same name. Variety is not a virtue + in this case. We don't mind about case though.

For the System.Info.os/arch different Haskell implementations use different + names for the same or/arch. Also they tend to distinguish versions of an + OS/arch which we just don't care about.

The Compat classification allows us to recognise aliases that are already + in common use but it allows us to distinguish them from the canonical name + which enables us to warn about such deprecated aliases.

Constructors

Permissive 
Compat 
Strict 

classifyOS :: ClassificationStrictness -> String -> OS #

classifyArch :: ClassificationStrictness -> String -> Arch #

diff --git a/doc/API/Cabal/Distribution-TestSuite.html b/doc/API/Cabal/Distribution-TestSuite.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-TestSuite.html @@ -0,0 +1,16 @@ +Distribution.TestSuite

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightThomas Tuegel 2010
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.TestSuite

Description

This module defines the detailed test suite interface which makes it + possible to expose individual tests to Cabal or other test agents.

Synopsis

Documentation

data TestInstance #

Constructors

TestInstance 

Fields

data OptionDescr #

Constructors

OptionDescr 

Fields

Instances
Eq OptionDescr # 
Instance details

Defined in Distribution.TestSuite

Methods

(==) :: OptionDescr -> OptionDescr -> Bool #

(/=) :: OptionDescr -> OptionDescr -> Bool #

Read OptionDescr # 
Instance details

Defined in Distribution.TestSuite

Methods

readsPrec :: Int -> ReadS OptionDescr #

readList :: ReadS [OptionDescr] #

readPrec :: ReadPrec OptionDescr #

readListPrec :: ReadPrec [OptionDescr] #

Show OptionDescr # 
Instance details

Defined in Distribution.TestSuite

Methods

showsPrec :: Int -> OptionDescr -> ShowS #

show :: OptionDescr -> String #

showList :: [OptionDescr] -> ShowS #

data OptionType #

Constructors

OptionFile 

Fields

OptionString 

Fields

OptionNumber 

Fields

OptionBool 
OptionEnum [String] 
OptionSet [String] 
OptionRngSeed 
Instances
Eq OptionType # 
Instance details

Defined in Distribution.TestSuite

Methods

(==) :: OptionType -> OptionType -> Bool #

(/=) :: OptionType -> OptionType -> Bool #

Read OptionType # 
Instance details

Defined in Distribution.TestSuite

Methods

readsPrec :: Int -> ReadS OptionType #

readList :: ReadS [OptionType] #

readPrec :: ReadPrec OptionType #

readListPrec :: ReadPrec [OptionType] #

Show OptionType # 
Instance details

Defined in Distribution.TestSuite

Methods

showsPrec :: Int -> OptionType -> ShowS #

show :: OptionType -> String #

showList :: [OptionType] -> ShowS #

data Test #

Constructors

Test TestInstance 
Group 

Fields

  • groupName :: String
     
  • concurrently :: Bool

    If true, then children of this group may be run in parallel. + Note that this setting is not inherited by children. In + particular, consider a group F with "concurrently = False" that + has some children, including a group T with "concurrently = + True". The children of group T may be run concurrently with each + other, as long as none are run at the same time as any of the + direct children of group F.

  • groupTests :: [Test]
     
ExtraOptions [OptionDescr] Test 

type Options = [(String, String)] #

data Progress #

Constructors

Finished Result 
Progress String (IO Progress) 

data Result #

Constructors

Pass 
Fail String 
Error String 
Instances
Eq Result # 
Instance details

Defined in Distribution.TestSuite

Methods

(==) :: Result -> Result -> Bool #

(/=) :: Result -> Result -> Bool #

Read Result # 
Instance details

Defined in Distribution.TestSuite

Methods

readsPrec :: Int -> ReadS Result #

readList :: ReadS [Result] #

readPrec :: ReadPrec Result #

readListPrec :: ReadPrec [Result] #

Show Result # 
Instance details

Defined in Distribution.TestSuite

Methods

showsPrec :: Int -> Result -> ShowS #

show :: Result -> String #

showList :: [Result] -> ShowS #

testGroup :: String -> [Test] -> Test #

Create a named group of tests, which are assumed to be safe to run in + parallel.

diff --git a/doc/API/Cabal/Distribution-Text.html b/doc/API/Cabal/Distribution-Text.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Text.html @@ -0,0 +1,7 @@ +Distribution.Text

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightDuncan Coutts 2007
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Text

Description

This defines a Text class which is a bit like the Read and Show + classes. The difference is that it uses a modern pretty printer and parser + system and the format is not expected to be Haskell concrete syntax but + rather the external human readable representation used by Cabal.

Synopsis

Documentation

class Text a where #

Note: this class will soon be deprecated. + It's not yet, so that we are -Wall clean.

Methods

disp :: a -> Doc #

disp :: Pretty a => a -> Doc #

parse :: ReadP r a #

parse :: Parsec a => ReadP r a #

Instances
Text Bool # 
Instance details

Defined in Distribution.Text

Methods

disp :: Bool -> Doc #

parse :: ReadP r Bool #

Text Int # 
Instance details

Defined in Distribution.Text

Methods

disp :: Int -> Doc #

parse :: ReadP r Int #

Text Version # 
Instance details

Defined in Distribution.Text

Methods

disp :: Version -> Doc #

parse :: ReadP r Version #

Text Version # 
Instance details

Defined in Distribution.Types.Version

Methods

disp :: Version -> Doc #

parse :: ReadP r Version #

Text VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

disp :: VersionRange -> Doc #

parse :: ReadP r VersionRange #

Text RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

disp :: RepoType -> Doc #

parse :: ReadP r RepoType #

Text RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

disp :: RepoKind -> Doc #

parse :: ReadP r RepoKind #

Text PkgconfigName # 
Instance details

Defined in Distribution.Types.PkgconfigName

Methods

disp :: PkgconfigName -> Doc #

parse :: ReadP r PkgconfigName #

Text ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

disp :: ForeignLibType -> Doc #

parse :: ReadP r ForeignLibType #

Text ForeignLibOption # 
Instance details

Defined in Distribution.Types.ForeignLibOption

Methods

disp :: ForeignLibOption -> Doc #

parse :: ReadP r ForeignLibOption #

Text ExecutableScope # 
Instance details

Defined in Distribution.Types.ExecutableScope

Methods

disp :: ExecutableScope -> Doc #

parse :: ReadP r ExecutableScope #

Text ComponentId # 
Instance details

Defined in Distribution.Types.ComponentId

Methods

disp :: ComponentId -> Doc #

parse :: ReadP r ComponentId #

Text BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

disp :: BuildType -> Doc #

parse :: ReadP r BuildType #

Text AbiHash # 
Instance details

Defined in Distribution.Types.AbiHash

Methods

disp :: AbiHash -> Doc #

parse :: ReadP r AbiHash #

Text Platform # 
Instance details

Defined in Distribution.System

Methods

disp :: Platform -> Doc #

parse :: ReadP r Platform #

Text Arch # 
Instance details

Defined in Distribution.System

Methods

disp :: Arch -> Doc #

parse :: ReadP r Arch #

Text OS # 
Instance details

Defined in Distribution.System

Methods

disp :: OS -> Doc #

parse :: ReadP r OS #

Text ModuleName # 
Instance details

Defined in Distribution.ModuleName

Methods

disp :: ModuleName -> Doc #

parse :: ReadP r ModuleName #

Text ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

disp :: ModuleRenaming -> Doc #

parse :: ReadP r ModuleRenaming #

Text IncludeRenaming # 
Instance details

Defined in Distribution.Types.IncludeRenaming

Methods

disp :: IncludeRenaming -> Doc #

parse :: ReadP r IncludeRenaming #

Text TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

disp :: TestType -> Doc #

parse :: ReadP r TestType #

Text PkgconfigDependency # 
Instance details

Defined in Distribution.Types.PkgconfigDependency

Methods

disp :: PkgconfigDependency -> Doc #

parse :: ReadP r PkgconfigDependency #

Text BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

disp :: BenchmarkType -> Doc #

parse :: ReadP r BenchmarkType #

Text License # 
Instance details

Defined in Distribution.License

Methods

disp :: License -> Doc #

parse :: ReadP r License #

Text KnownExtension # 
Instance details

Defined in Language.Haskell.Extension

Methods

disp :: KnownExtension -> Doc #

parse :: ReadP r KnownExtension #

Text Extension # 
Instance details

Defined in Language.Haskell.Extension

Methods

disp :: Extension -> Doc #

parse :: ReadP r Extension #

Text Language # 
Instance details

Defined in Language.Haskell.Extension

Methods

disp :: Language -> Doc #

parse :: ReadP r Language #

Text AbiTag # 
Instance details

Defined in Distribution.Compiler

Methods

disp :: AbiTag -> Doc #

parse :: ReadP r AbiTag #

Text CompilerId # 
Instance details

Defined in Distribution.Compiler

Methods

disp :: CompilerId -> Doc #

parse :: ReadP r CompilerId #

Text CompilerFlavor # 
Instance details

Defined in Distribution.Compiler

Methods

disp :: CompilerFlavor -> Doc #

parse :: ReadP r CompilerFlavor #

Text PackageName # 
Instance details

Defined in Distribution.Types.PackageName

Methods

disp :: PackageName -> Doc #

parse :: ReadP r PackageName #

Text UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

disp :: UnqualComponentName -> Doc #

parse :: ReadP r UnqualComponentName #

Text ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

disp :: ComponentName -> Doc #

parse :: ReadP r ComponentName #

Text PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

disp :: PackageIdentifier -> Doc #

parse :: ReadP r PackageIdentifier #

Text DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

disp :: DefUnitId -> Doc #

parse :: ReadP r DefUnitId #

Text UnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

disp :: UnitId -> Doc #

parse :: ReadP r UnitId #

Text Module # 
Instance details

Defined in Distribution.Types.Module

Methods

disp :: Module -> Doc #

parse :: ReadP r Module #

Text OpenModule # 
Instance details

Defined in Distribution.Backpack

Methods

disp :: OpenModule -> Doc #

parse :: ReadP r OpenModule #

Text OpenUnitId # 
Instance details

Defined in Distribution.Backpack

Methods

disp :: OpenUnitId -> Doc #

parse :: ReadP r OpenUnitId #

Text ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

disp :: ModuleReexport -> Doc #

parse :: ReadP r ModuleReexport #

Text Mixin # 
Instance details

Defined in Distribution.Types.Mixin

Methods

disp :: Mixin -> Doc #

parse :: ReadP r Mixin #

Text ExeDependency # 
Instance details

Defined in Distribution.Types.ExeDependency

Methods

disp :: ExeDependency -> Doc #

parse :: ReadP r ExeDependency #

Text Dependency # 
Instance details

Defined in Distribution.Types.Dependency

Methods

disp :: Dependency -> Doc #

parse :: ReadP r Dependency #

Text MungedPackageName # 
Instance details

Defined in Distribution.Types.MungedPackageName

Methods

disp :: MungedPackageName -> Doc #

parse :: ReadP r MungedPackageName #

Text MungedPackageId # 
Instance details

Defined in Distribution.Types.MungedPackageId

Methods

disp :: MungedPackageId -> Doc #

parse :: ReadP r MungedPackageId #

Text AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

disp :: AbiDependency -> Doc #

parse :: ReadP r AbiDependency #

Text LegacyExeDependency # 
Instance details

Defined in Distribution.Types.LegacyExeDependency

Methods

disp :: LegacyExeDependency -> Doc #

parse :: ReadP r LegacyExeDependency #

Text LibVersionInfo # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

disp :: LibVersionInfo -> Doc #

parse :: ReadP r LibVersionInfo #

Text FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

disp :: FlagName -> Doc #

parse :: ReadP r FlagName #

Text ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

disp :: ExposedModule -> Doc #

parse :: ReadP r ExposedModule #

Text TestShowDetails # 
Instance details

Defined in Distribution.Simple.Setup

Methods

disp :: TestShowDetails -> Doc #

parse :: ReadP r TestShowDetails #

Text HaddockTarget # 
Instance details

Defined in Distribution.Simple.Setup

Methods

disp :: HaddockTarget -> Doc #

parse :: ReadP r HaddockTarget #

Text a => Text (Identity a) # 
Instance details

Defined in Distribution.Text

Methods

disp :: Identity a -> Doc #

parse :: ReadP r (Identity a) #

defaultStyle :: Style #

The default rendering style used in Cabal for console + output. It has a fixed page width and adds line breaks + automatically.

display :: Text a => a -> String #

Pretty-prints with the default style.

flatStyle :: Style #

A style for rendering all on one line.

simpleParse :: Text a => String -> Maybe a #

stdParse :: Text ver => (ver -> String -> res) -> ReadP r res #

diff --git a/doc/API/Cabal/Distribution-Types-AbiDependency.html b/doc/API/Cabal/Distribution-Types-AbiDependency.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-AbiDependency.html @@ -0,0 +1,8 @@ +Distribution.Types.AbiDependency

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.AbiDependency

Synopsis

Documentation

data AbiDependency #

An ABI dependency is a dependency on a library which also + records the ABI hash (abiHash) of the library it depends + on.

The primary utility of this is to enable an extra sanity when + GHC loads libraries: it can check if the dependency has a matching + ABI and if not, refuse to load this library. This information + is critical if we are shadowing libraries; differences in the + ABI hash let us know what packages get shadowed by the new version + of a package.

Constructors

AbiDependency 

Fields

Instances
Eq AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

(==) :: AbiDependency -> AbiDependency -> Bool #

(/=) :: AbiDependency -> AbiDependency -> Bool #

Read AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

readsPrec :: Int -> ReadS AbiDependency #

readList :: ReadS [AbiDependency] #

readPrec :: ReadPrec AbiDependency #

readListPrec :: ReadPrec [AbiDependency] #

Show AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

showsPrec :: Int -> AbiDependency -> ShowS #

show :: AbiDependency -> String #

showList :: [AbiDependency] -> ShowS #

Generic AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Associated Types

type Rep AbiDependency :: * -> * #

Methods

from :: AbiDependency -> Rep AbiDependency x #

to :: Rep AbiDependency x -> AbiDependency #

Binary AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

put :: AbiDependency -> Put #

get :: Get AbiDependency #

putList :: [AbiDependency] -> Put #

NFData AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

rnf :: AbiDependency -> () #

Pretty AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

pretty :: AbiDependency -> Doc #

Parsec AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

parsec :: CabalParsing m => m AbiDependency #

Text AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

disp :: AbiDependency -> Doc #

parse :: ReadP r AbiDependency #

type Rep AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

type Rep AbiDependency = D1 (MetaData "AbiDependency" "Distribution.Types.AbiDependency" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "AbiDependency" PrefixI True) (S1 (MetaSel (Just "depUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId) :*: S1 (MetaSel (Just "depAbiHash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AbiHash)))
diff --git a/doc/API/Cabal/Distribution-Types-AbiHash.html b/doc/API/Cabal/Distribution-Types-AbiHash.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-AbiHash.html @@ -0,0 +1,3 @@ +Distribution.Types.AbiHash

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.AbiHash

Synopsis

Documentation

data AbiHash #

ABI Hashes

Use mkAbiHash and unAbiHash to convert from/to a + String.

This type is opaque since Cabal-2.0

Since: 2.0.0.2

Instances
Eq AbiHash # 
Instance details

Defined in Distribution.Types.AbiHash

Methods

(==) :: AbiHash -> AbiHash -> Bool #

(/=) :: AbiHash -> AbiHash -> Bool #

Read AbiHash # 
Instance details

Defined in Distribution.Types.AbiHash

Methods

readsPrec :: Int -> ReadS AbiHash #

readList :: ReadS [AbiHash] #

readPrec :: ReadPrec AbiHash #

readListPrec :: ReadPrec [AbiHash] #

Show AbiHash # 
Instance details

Defined in Distribution.Types.AbiHash

Methods

showsPrec :: Int -> AbiHash -> ShowS #

show :: AbiHash -> String #

showList :: [AbiHash] -> ShowS #

IsString AbiHash #

mkAbiHash

Since: 2.0.0.2

Instance details

Defined in Distribution.Types.AbiHash

Methods

fromString :: String -> AbiHash #

Generic AbiHash # 
Instance details

Defined in Distribution.Types.AbiHash

Associated Types

type Rep AbiHash :: * -> * #

Methods

from :: AbiHash -> Rep AbiHash x #

to :: Rep AbiHash x -> AbiHash #

Binary AbiHash # 
Instance details

Defined in Distribution.Types.AbiHash

Methods

put :: AbiHash -> Put #

get :: Get AbiHash #

putList :: [AbiHash] -> Put #

NFData AbiHash # 
Instance details

Defined in Distribution.Types.AbiHash

Methods

rnf :: AbiHash -> () #

Pretty AbiHash # 
Instance details

Defined in Distribution.Types.AbiHash

Methods

pretty :: AbiHash -> Doc #

Parsec AbiHash # 
Instance details

Defined in Distribution.Types.AbiHash

Methods

parsec :: CabalParsing m => m AbiHash #

Text AbiHash # 
Instance details

Defined in Distribution.Types.AbiHash

Methods

disp :: AbiHash -> Doc #

parse :: ReadP r AbiHash #

type Rep AbiHash # 
Instance details

Defined in Distribution.Types.AbiHash

type Rep AbiHash = D1 (MetaData "AbiHash" "Distribution.Types.AbiHash" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "AbiHash" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ShortText)))

unAbiHash :: AbiHash -> String #

Construct a AbiHash from a String

mkAbiHash is the inverse to unAbiHash

Note: No validations are performed to ensure that the resulting + AbiHash is valid

Since: 2.0.0.2

mkAbiHash :: String -> AbiHash #

Convert AbiHash to String

Since: 2.0.0.2

diff --git a/doc/API/Cabal/Distribution-Types-AnnotatedId.html b/doc/API/Cabal/Distribution-Types-AnnotatedId.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-AnnotatedId.html @@ -0,0 +1,4 @@ +Distribution.Types.AnnotatedId

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.AnnotatedId

Synopsis

Documentation

data AnnotatedId id #

An AnnotatedId is a ComponentId, UnitId, etc. + which is annotated with some other useful information + that is useful for printing to users, etc.

Invariant: if ann_id x == ann_id y, then ann_pid x == ann_pid y + and ann_cname x == ann_cname y

Constructors

AnnotatedId 

Fields

Instances
Functor AnnotatedId # 
Instance details

Defined in Distribution.Types.AnnotatedId

Methods

fmap :: (a -> b) -> AnnotatedId a -> AnnotatedId b #

(<$) :: a -> AnnotatedId b -> AnnotatedId a #

Eq id => Eq (AnnotatedId id) # 
Instance details

Defined in Distribution.Types.AnnotatedId

Methods

(==) :: AnnotatedId id -> AnnotatedId id -> Bool #

(/=) :: AnnotatedId id -> AnnotatedId id -> Bool #

Ord id => Ord (AnnotatedId id) # 
Instance details

Defined in Distribution.Types.AnnotatedId

Methods

compare :: AnnotatedId id -> AnnotatedId id -> Ordering #

(<) :: AnnotatedId id -> AnnotatedId id -> Bool #

(<=) :: AnnotatedId id -> AnnotatedId id -> Bool #

(>) :: AnnotatedId id -> AnnotatedId id -> Bool #

(>=) :: AnnotatedId id -> AnnotatedId id -> Bool #

max :: AnnotatedId id -> AnnotatedId id -> AnnotatedId id #

min :: AnnotatedId id -> AnnotatedId id -> AnnotatedId id #

Show id => Show (AnnotatedId id) # 
Instance details

Defined in Distribution.Types.AnnotatedId

Methods

showsPrec :: Int -> AnnotatedId id -> ShowS #

show :: AnnotatedId id -> String #

showList :: [AnnotatedId id] -> ShowS #

Package (AnnotatedId id) # 
Instance details

Defined in Distribution.Types.AnnotatedId

Methods

packageId :: AnnotatedId id -> PackageIdentifier #

diff --git a/doc/API/Cabal/Distribution-Types-Benchmark-Lens.html b/doc/API/Cabal/Distribution-Types-Benchmark-Lens.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-Benchmark-Lens.html @@ -0,0 +1,1 @@ +Distribution.Types.Benchmark.Lens

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.Benchmark.Lens

Synopsis

Documentation

data Benchmark #

A "benchmark" stanza in a cabal file.

Instances
Eq Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

(==) :: Benchmark -> Benchmark -> Bool #

(/=) :: Benchmark -> Benchmark -> Bool #

Data Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Benchmark -> c Benchmark #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Benchmark #

toConstr :: Benchmark -> Constr #

dataTypeOf :: Benchmark -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Benchmark) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Benchmark) #

gmapT :: (forall b. Data b => b -> b) -> Benchmark -> Benchmark #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Benchmark -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Benchmark -> r #

gmapQ :: (forall d. Data d => d -> u) -> Benchmark -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Benchmark -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Benchmark -> m Benchmark #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Benchmark -> m Benchmark #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Benchmark -> m Benchmark #

Read Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

readsPrec :: Int -> ReadS Benchmark #

readList :: ReadS [Benchmark] #

readPrec :: ReadPrec Benchmark #

readListPrec :: ReadPrec [Benchmark] #

Show Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

showsPrec :: Int -> Benchmark -> ShowS #

show :: Benchmark -> String #

showList :: [Benchmark] -> ShowS #

Generic Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Associated Types

type Rep Benchmark :: * -> * #

Methods

from :: Benchmark -> Rep Benchmark x #

to :: Rep Benchmark x -> Benchmark #

Semigroup Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

(<>) :: Benchmark -> Benchmark -> Benchmark #

sconcat :: NonEmpty Benchmark -> Benchmark #

stimes :: Integral b => b -> Benchmark -> Benchmark #

Monoid Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

mempty :: Benchmark #

mappend :: Benchmark -> Benchmark -> Benchmark #

mconcat :: [Benchmark] -> Benchmark #

Binary Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

put :: Benchmark -> Put #

get :: Get Benchmark #

putList :: [Benchmark] -> Put #

NFData Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

rnf :: Benchmark -> () #

HasBuildInfo Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

buildInfo :: Lens' Benchmark BuildInfo #

buildable :: Lens' Benchmark Bool #

buildTools :: Lens' Benchmark [LegacyExeDependency] #

buildToolDepends :: Lens' Benchmark [ExeDependency] #

cppOptions :: Lens' Benchmark [String] #

asmOptions :: Lens' Benchmark [String] #

cmmOptions :: Lens' Benchmark [String] #

ccOptions :: Lens' Benchmark [String] #

cxxOptions :: Lens' Benchmark [String] #

ldOptions :: Lens' Benchmark [String] #

pkgconfigDepends :: Lens' Benchmark [PkgconfigDependency] #

frameworks :: Lens' Benchmark [String] #

extraFrameworkDirs :: Lens' Benchmark [String] #

asmSources :: Lens' Benchmark [FilePath] #

cmmSources :: Lens' Benchmark [FilePath] #

cSources :: Lens' Benchmark [FilePath] #

cxxSources :: Lens' Benchmark [FilePath] #

jsSources :: Lens' Benchmark [FilePath] #

hsSourceDirs :: Lens' Benchmark [FilePath] #

otherModules :: Lens' Benchmark [ModuleName] #

virtualModules :: Lens' Benchmark [ModuleName] #

autogenModules :: Lens' Benchmark [ModuleName] #

defaultLanguage :: Lens' Benchmark (Maybe Language) #

otherLanguages :: Lens' Benchmark [Language] #

defaultExtensions :: Lens' Benchmark [Extension] #

otherExtensions :: Lens' Benchmark [Extension] #

oldExtensions :: Lens' Benchmark [Extension] #

extraLibs :: Lens' Benchmark [String] #

extraGHCiLibs :: Lens' Benchmark [String] #

extraBundledLibs :: Lens' Benchmark [String] #

extraLibFlavours :: Lens' Benchmark [String] #

extraLibDirs :: Lens' Benchmark [String] #

includeDirs :: Lens' Benchmark [FilePath] #

includes :: Lens' Benchmark [FilePath] #

installIncludes :: Lens' Benchmark [FilePath] #

options :: Lens' Benchmark [(CompilerFlavor, [String])] #

profOptions :: Lens' Benchmark [(CompilerFlavor, [String])] #

sharedOptions :: Lens' Benchmark [(CompilerFlavor, [String])] #

staticOptions :: Lens' Benchmark [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' Benchmark [(String, String)] #

targetBuildDepends :: Lens' Benchmark [Dependency] #

mixins :: Lens' Benchmark [Mixin] #

type Rep Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

type Rep Benchmark = D1 (MetaData "Benchmark" "Distribution.Types.Benchmark" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Benchmark" PrefixI True) (S1 (MetaSel (Just "benchmarkName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName) :*: (S1 (MetaSel (Just "benchmarkInterface") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BenchmarkInterface) :*: S1 (MetaSel (Just "benchmarkBuildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BuildInfo))))

benchmarkName :: Lens' Benchmark UnqualComponentName #

benchmarkInterface :: Lens' Benchmark BenchmarkInterface #

benchmarkBuildInfo :: Lens' Benchmark BuildInfo #

diff --git a/doc/API/Cabal/Distribution-Types-Benchmark.html b/doc/API/Cabal/Distribution-Types-Benchmark.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-Benchmark.html @@ -0,0 +1,2 @@ +Distribution.Types.Benchmark

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.Benchmark

Synopsis

Documentation

data Benchmark #

A "benchmark" stanza in a cabal file.

Constructors

Benchmark 

Fields

Instances
Eq Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

(==) :: Benchmark -> Benchmark -> Bool #

(/=) :: Benchmark -> Benchmark -> Bool #

Data Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Benchmark -> c Benchmark #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Benchmark #

toConstr :: Benchmark -> Constr #

dataTypeOf :: Benchmark -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Benchmark) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Benchmark) #

gmapT :: (forall b. Data b => b -> b) -> Benchmark -> Benchmark #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Benchmark -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Benchmark -> r #

gmapQ :: (forall d. Data d => d -> u) -> Benchmark -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Benchmark -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Benchmark -> m Benchmark #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Benchmark -> m Benchmark #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Benchmark -> m Benchmark #

Read Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

readsPrec :: Int -> ReadS Benchmark #

readList :: ReadS [Benchmark] #

readPrec :: ReadPrec Benchmark #

readListPrec :: ReadPrec [Benchmark] #

Show Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

showsPrec :: Int -> Benchmark -> ShowS #

show :: Benchmark -> String #

showList :: [Benchmark] -> ShowS #

Generic Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Associated Types

type Rep Benchmark :: * -> * #

Methods

from :: Benchmark -> Rep Benchmark x #

to :: Rep Benchmark x -> Benchmark #

Semigroup Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

(<>) :: Benchmark -> Benchmark -> Benchmark #

sconcat :: NonEmpty Benchmark -> Benchmark #

stimes :: Integral b => b -> Benchmark -> Benchmark #

Monoid Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

mempty :: Benchmark #

mappend :: Benchmark -> Benchmark -> Benchmark #

mconcat :: [Benchmark] -> Benchmark #

Binary Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

put :: Benchmark -> Put #

get :: Get Benchmark #

putList :: [Benchmark] -> Put #

NFData Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

rnf :: Benchmark -> () #

HasBuildInfo Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

buildInfo :: Lens' Benchmark BuildInfo #

buildable :: Lens' Benchmark Bool #

buildTools :: Lens' Benchmark [LegacyExeDependency] #

buildToolDepends :: Lens' Benchmark [ExeDependency] #

cppOptions :: Lens' Benchmark [String] #

asmOptions :: Lens' Benchmark [String] #

cmmOptions :: Lens' Benchmark [String] #

ccOptions :: Lens' Benchmark [String] #

cxxOptions :: Lens' Benchmark [String] #

ldOptions :: Lens' Benchmark [String] #

pkgconfigDepends :: Lens' Benchmark [PkgconfigDependency] #

frameworks :: Lens' Benchmark [String] #

extraFrameworkDirs :: Lens' Benchmark [String] #

asmSources :: Lens' Benchmark [FilePath] #

cmmSources :: Lens' Benchmark [FilePath] #

cSources :: Lens' Benchmark [FilePath] #

cxxSources :: Lens' Benchmark [FilePath] #

jsSources :: Lens' Benchmark [FilePath] #

hsSourceDirs :: Lens' Benchmark [FilePath] #

otherModules :: Lens' Benchmark [ModuleName] #

virtualModules :: Lens' Benchmark [ModuleName] #

autogenModules :: Lens' Benchmark [ModuleName] #

defaultLanguage :: Lens' Benchmark (Maybe Language) #

otherLanguages :: Lens' Benchmark [Language] #

defaultExtensions :: Lens' Benchmark [Extension] #

otherExtensions :: Lens' Benchmark [Extension] #

oldExtensions :: Lens' Benchmark [Extension] #

extraLibs :: Lens' Benchmark [String] #

extraGHCiLibs :: Lens' Benchmark [String] #

extraBundledLibs :: Lens' Benchmark [String] #

extraLibFlavours :: Lens' Benchmark [String] #

extraLibDirs :: Lens' Benchmark [String] #

includeDirs :: Lens' Benchmark [FilePath] #

includes :: Lens' Benchmark [FilePath] #

installIncludes :: Lens' Benchmark [FilePath] #

options :: Lens' Benchmark [(CompilerFlavor, [String])] #

profOptions :: Lens' Benchmark [(CompilerFlavor, [String])] #

sharedOptions :: Lens' Benchmark [(CompilerFlavor, [String])] #

staticOptions :: Lens' Benchmark [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' Benchmark [(String, String)] #

targetBuildDepends :: Lens' Benchmark [Dependency] #

mixins :: Lens' Benchmark [Mixin] #

type Rep Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

type Rep Benchmark = D1 (MetaData "Benchmark" "Distribution.Types.Benchmark" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Benchmark" PrefixI True) (S1 (MetaSel (Just "benchmarkName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName) :*: (S1 (MetaSel (Just "benchmarkInterface") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BenchmarkInterface) :*: S1 (MetaSel (Just "benchmarkBuildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BuildInfo))))

emptyBenchmark :: Benchmark #

benchmarkType :: Benchmark -> BenchmarkType #

benchmarkModules :: Benchmark -> [ModuleName] #

Get all the module names from a benchmark.

benchmarkModulesAutogen :: Benchmark -> [ModuleName] #

Get all the auto generated module names from a benchmark. + This are a subset of benchmarkModules.

diff --git a/doc/API/Cabal/Distribution-Types-BenchmarkInterface.html b/doc/API/Cabal/Distribution-Types-BenchmarkInterface.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-BenchmarkInterface.html @@ -0,0 +1,8 @@ +Distribution.Types.BenchmarkInterface

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.BenchmarkInterface

Synopsis

Documentation

data BenchmarkInterface #

The benchmark interfaces that are currently defined. Each + benchmark must specify which interface it supports.

More interfaces may be defined in future, either new revisions or + totally new interfaces.

Constructors

BenchmarkExeV10 Version FilePath

Benchmark interface "exitcode-stdio-1.0". The benchmark + takes the form of an executable. It returns a zero exit code + for success, non-zero for failure. The stdout and stderr + channels may be logged. It takes no command line parameters + and nothing on stdin.

BenchmarkUnsupported BenchmarkType

A benchmark that does not conform to one of the above + interfaces for the given reason (e.g. unknown benchmark type).

Instances
Eq BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

(==) :: BenchmarkInterface -> BenchmarkInterface -> Bool #

(/=) :: BenchmarkInterface -> BenchmarkInterface -> Bool #

Data BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BenchmarkInterface -> c BenchmarkInterface #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BenchmarkInterface #

toConstr :: BenchmarkInterface -> Constr #

dataTypeOf :: BenchmarkInterface -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BenchmarkInterface) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BenchmarkInterface) #

gmapT :: (forall b. Data b => b -> b) -> BenchmarkInterface -> BenchmarkInterface #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BenchmarkInterface -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BenchmarkInterface -> r #

gmapQ :: (forall d. Data d => d -> u) -> BenchmarkInterface -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BenchmarkInterface -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BenchmarkInterface -> m BenchmarkInterface #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BenchmarkInterface -> m BenchmarkInterface #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BenchmarkInterface -> m BenchmarkInterface #

Read BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

readsPrec :: Int -> ReadS BenchmarkInterface #

readList :: ReadS [BenchmarkInterface] #

readPrec :: ReadPrec BenchmarkInterface #

readListPrec :: ReadPrec [BenchmarkInterface] #

Show BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

showsPrec :: Int -> BenchmarkInterface -> ShowS #

show :: BenchmarkInterface -> String #

showList :: [BenchmarkInterface] -> ShowS #

Generic BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Associated Types

type Rep BenchmarkInterface :: * -> * #

Methods

from :: BenchmarkInterface -> Rep BenchmarkInterface x #

to :: Rep BenchmarkInterface x -> BenchmarkInterface #

Semigroup BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

(<>) :: BenchmarkInterface -> BenchmarkInterface -> BenchmarkInterface #

sconcat :: NonEmpty BenchmarkInterface -> BenchmarkInterface #

stimes :: Integral b => b -> BenchmarkInterface -> BenchmarkInterface #

Monoid BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

mempty :: BenchmarkInterface #

mappend :: BenchmarkInterface -> BenchmarkInterface -> BenchmarkInterface #

mconcat :: [BenchmarkInterface] -> BenchmarkInterface #

Binary BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

put :: BenchmarkInterface -> Put #

get :: Get BenchmarkInterface #

putList :: [BenchmarkInterface] -> Put #

NFData BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

Methods

rnf :: BenchmarkInterface -> () #

type Rep BenchmarkInterface # 
Instance details

Defined in Distribution.Types.BenchmarkInterface

type Rep BenchmarkInterface = D1 (MetaData "BenchmarkInterface" "Distribution.Types.BenchmarkInterface" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "BenchmarkExeV10" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :+: C1 (MetaCons "BenchmarkUnsupported" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BenchmarkType)))
diff --git a/doc/API/Cabal/Distribution-Types-BenchmarkType.html b/doc/API/Cabal/Distribution-Types-BenchmarkType.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-BenchmarkType.html @@ -0,0 +1,1 @@ +Distribution.Types.BenchmarkType

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.BenchmarkType

Synopsis

Documentation

data BenchmarkType #

The "benchmark-type" field in the benchmark stanza.

Constructors

BenchmarkTypeExe Version

"type: exitcode-stdio-x.y"

BenchmarkTypeUnknown String Version

Some unknown benchmark type e.g. "type: foo"

Instances
Eq BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

(==) :: BenchmarkType -> BenchmarkType -> Bool #

(/=) :: BenchmarkType -> BenchmarkType -> Bool #

Data BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BenchmarkType -> c BenchmarkType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BenchmarkType #

toConstr :: BenchmarkType -> Constr #

dataTypeOf :: BenchmarkType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BenchmarkType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BenchmarkType) #

gmapT :: (forall b. Data b => b -> b) -> BenchmarkType -> BenchmarkType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BenchmarkType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BenchmarkType -> r #

gmapQ :: (forall d. Data d => d -> u) -> BenchmarkType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BenchmarkType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BenchmarkType -> m BenchmarkType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BenchmarkType -> m BenchmarkType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BenchmarkType -> m BenchmarkType #

Read BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

readsPrec :: Int -> ReadS BenchmarkType #

readList :: ReadS [BenchmarkType] #

readPrec :: ReadPrec BenchmarkType #

readListPrec :: ReadPrec [BenchmarkType] #

Show BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

showsPrec :: Int -> BenchmarkType -> ShowS #

show :: BenchmarkType -> String #

showList :: [BenchmarkType] -> ShowS #

Generic BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Associated Types

type Rep BenchmarkType :: * -> * #

Methods

from :: BenchmarkType -> Rep BenchmarkType x #

to :: Rep BenchmarkType x -> BenchmarkType #

Binary BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

put :: BenchmarkType -> Put #

get :: Get BenchmarkType #

putList :: [BenchmarkType] -> Put #

NFData BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

rnf :: BenchmarkType -> () #

Pretty BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

pretty :: BenchmarkType -> Doc #

Parsec BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

parsec :: CabalParsing m => m BenchmarkType #

Text BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

disp :: BenchmarkType -> Doc #

parse :: ReadP r BenchmarkType #

type Rep BenchmarkType # 
Instance details

Defined in Distribution.Types.BenchmarkType

type Rep BenchmarkType = D1 (MetaData "BenchmarkType" "Distribution.Types.BenchmarkType" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "BenchmarkTypeExe" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: C1 (MetaCons "BenchmarkTypeUnknown" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)))

knownBenchmarkTypes :: [BenchmarkType] #

diff --git a/doc/API/Cabal/Distribution-Types-BuildInfo-Lens.html b/doc/API/Cabal/Distribution-Types-BuildInfo-Lens.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-BuildInfo-Lens.html @@ -0,0 +1,1 @@ +Distribution.Types.BuildInfo.Lens

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.BuildInfo.Lens

Synopsis

Documentation

data BuildInfo #

Instances
Eq BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

(==) :: BuildInfo -> BuildInfo -> Bool #

(/=) :: BuildInfo -> BuildInfo -> Bool #

Data BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BuildInfo -> c BuildInfo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BuildInfo #

toConstr :: BuildInfo -> Constr #

dataTypeOf :: BuildInfo -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BuildInfo) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BuildInfo) #

gmapT :: (forall b. Data b => b -> b) -> BuildInfo -> BuildInfo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BuildInfo -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BuildInfo -> r #

gmapQ :: (forall d. Data d => d -> u) -> BuildInfo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BuildInfo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BuildInfo -> m BuildInfo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BuildInfo -> m BuildInfo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BuildInfo -> m BuildInfo #

Read BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

readsPrec :: Int -> ReadS BuildInfo #

readList :: ReadS [BuildInfo] #

readPrec :: ReadPrec BuildInfo #

readListPrec :: ReadPrec [BuildInfo] #

Show BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

showsPrec :: Int -> BuildInfo -> ShowS #

show :: BuildInfo -> String #

showList :: [BuildInfo] -> ShowS #

Generic BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Associated Types

type Rep BuildInfo :: * -> * #

Methods

from :: BuildInfo -> Rep BuildInfo x #

to :: Rep BuildInfo x -> BuildInfo #

Semigroup BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

(<>) :: BuildInfo -> BuildInfo -> BuildInfo #

sconcat :: NonEmpty BuildInfo -> BuildInfo #

stimes :: Integral b => b -> BuildInfo -> BuildInfo #

Monoid BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

mempty :: BuildInfo #

mappend :: BuildInfo -> BuildInfo -> BuildInfo #

mconcat :: [BuildInfo] -> BuildInfo #

Binary BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

put :: BuildInfo -> Put #

get :: Get BuildInfo #

putList :: [BuildInfo] -> Put #

NFData BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

rnf :: BuildInfo -> () #

HasBuildInfo BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo.Lens

Methods

buildInfo :: Lens' BuildInfo BuildInfo #

buildable :: Lens' BuildInfo Bool #

buildTools :: Lens' BuildInfo [LegacyExeDependency] #

buildToolDepends :: Lens' BuildInfo [ExeDependency] #

cppOptions :: Lens' BuildInfo [String] #

asmOptions :: Lens' BuildInfo [String] #

cmmOptions :: Lens' BuildInfo [String] #

ccOptions :: Lens' BuildInfo [String] #

cxxOptions :: Lens' BuildInfo [String] #

ldOptions :: Lens' BuildInfo [String] #

pkgconfigDepends :: Lens' BuildInfo [PkgconfigDependency] #

frameworks :: Lens' BuildInfo [String] #

extraFrameworkDirs :: Lens' BuildInfo [String] #

asmSources :: Lens' BuildInfo [FilePath] #

cmmSources :: Lens' BuildInfo [FilePath] #

cSources :: Lens' BuildInfo [FilePath] #

cxxSources :: Lens' BuildInfo [FilePath] #

jsSources :: Lens' BuildInfo [FilePath] #

hsSourceDirs :: Lens' BuildInfo [FilePath] #

otherModules :: Lens' BuildInfo [ModuleName] #

virtualModules :: Lens' BuildInfo [ModuleName] #

autogenModules :: Lens' BuildInfo [ModuleName] #

defaultLanguage :: Lens' BuildInfo (Maybe Language) #

otherLanguages :: Lens' BuildInfo [Language] #

defaultExtensions :: Lens' BuildInfo [Extension] #

otherExtensions :: Lens' BuildInfo [Extension] #

oldExtensions :: Lens' BuildInfo [Extension] #

extraLibs :: Lens' BuildInfo [String] #

extraGHCiLibs :: Lens' BuildInfo [String] #

extraBundledLibs :: Lens' BuildInfo [String] #

extraLibFlavours :: Lens' BuildInfo [String] #

extraLibDirs :: Lens' BuildInfo [String] #

includeDirs :: Lens' BuildInfo [FilePath] #

includes :: Lens' BuildInfo [FilePath] #

installIncludes :: Lens' BuildInfo [FilePath] #

options :: Lens' BuildInfo [(CompilerFlavor, [String])] #

profOptions :: Lens' BuildInfo [(CompilerFlavor, [String])] #

sharedOptions :: Lens' BuildInfo [(CompilerFlavor, [String])] #

staticOptions :: Lens' BuildInfo [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' BuildInfo [(String, String)] #

targetBuildDepends :: Lens' BuildInfo [Dependency] #

mixins :: Lens' BuildInfo [Mixin] #

type Rep BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

type Rep BuildInfo = D1 (MetaData "BuildInfo" "Distribution.Types.BuildInfo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "BuildInfo" PrefixI True) (((((S1 (MetaSel (Just "buildable") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "buildTools") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [LegacyExeDependency])) :*: (S1 (MetaSel (Just "buildToolDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ExeDependency]) :*: (S1 (MetaSel (Just "cppOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "asmOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])))) :*: ((S1 (MetaSel (Just "cmmOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "ccOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) :*: (S1 (MetaSel (Just "cxxOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: (S1 (MetaSel (Just "ldOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "pkgconfigDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [PkgconfigDependency]))))) :*: (((S1 (MetaSel (Just "frameworks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "extraFrameworkDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) :*: (S1 (MetaSel (Just "asmSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: (S1 (MetaSel (Just "cmmSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "cSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))) :*: ((S1 (MetaSel (Just "cxxSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "jsSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])) :*: (S1 (MetaSel (Just "hsSourceDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: (S1 (MetaSel (Just "otherModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]) :*: S1 (MetaSel (Just "virtualModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName])))))) :*: ((((S1 (MetaSel (Just "autogenModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]) :*: S1 (MetaSel (Just "defaultLanguage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Language))) :*: (S1 (MetaSel (Just "otherLanguages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Language]) :*: (S1 (MetaSel (Just "defaultExtensions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Extension]) :*: S1 (MetaSel (Just "otherExtensions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Extension])))) :*: ((S1 (MetaSel (Just "oldExtensions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Extension]) :*: S1 (MetaSel (Just "extraLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) :*: (S1 (MetaSel (Just "extraGHCiLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: (S1 (MetaSel (Just "extraBundledLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "extraLibFlavours") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]))))) :*: (((S1 (MetaSel (Just "extraLibDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "includeDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])) :*: (S1 (MetaSel (Just "includes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: (S1 (MetaSel (Just "installIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "options") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(CompilerFlavor, [String])])))) :*: ((S1 (MetaSel (Just "profOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(CompilerFlavor, [String])]) :*: (S1 (MetaSel (Just "sharedOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(CompilerFlavor, [String])]) :*: S1 (MetaSel (Just "staticOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(CompilerFlavor, [String])]))) :*: (S1 (MetaSel (Just "customFieldsBI") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, String)]) :*: (S1 (MetaSel (Just "targetBuildDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Dependency]) :*: S1 (MetaSel (Just "mixins") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Mixin]))))))))

class HasBuildInfo a where #

Classy lenses for BuildInfo.

Minimal complete definition

buildInfo

Methods

buildInfo :: Lens' a BuildInfo #

buildable :: Lens' a Bool #

buildTools :: Lens' a [LegacyExeDependency] #

buildToolDepends :: Lens' a [ExeDependency] #

cppOptions :: Lens' a [String] #

asmOptions :: Lens' a [String] #

cmmOptions :: Lens' a [String] #

ccOptions :: Lens' a [String] #

cxxOptions :: Lens' a [String] #

ldOptions :: Lens' a [String] #

pkgconfigDepends :: Lens' a [PkgconfigDependency] #

frameworks :: Lens' a [String] #

extraFrameworkDirs :: Lens' a [String] #

asmSources :: Lens' a [FilePath] #

cmmSources :: Lens' a [FilePath] #

cSources :: Lens' a [FilePath] #

cxxSources :: Lens' a [FilePath] #

jsSources :: Lens' a [FilePath] #

hsSourceDirs :: Lens' a [FilePath] #

otherModules :: Lens' a [ModuleName] #

virtualModules :: Lens' a [ModuleName] #

autogenModules :: Lens' a [ModuleName] #

defaultLanguage :: Lens' a (Maybe Language) #

otherLanguages :: Lens' a [Language] #

defaultExtensions :: Lens' a [Extension] #

otherExtensions :: Lens' a [Extension] #

oldExtensions :: Lens' a [Extension] #

extraLibs :: Lens' a [String] #

extraGHCiLibs :: Lens' a [String] #

extraBundledLibs :: Lens' a [String] #

extraLibFlavours :: Lens' a [String] #

extraLibDirs :: Lens' a [String] #

includeDirs :: Lens' a [FilePath] #

includes :: Lens' a [FilePath] #

installIncludes :: Lens' a [FilePath] #

options :: Lens' a [(CompilerFlavor, [String])] #

profOptions :: Lens' a [(CompilerFlavor, [String])] #

sharedOptions :: Lens' a [(CompilerFlavor, [String])] #

staticOptions :: Lens' a [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' a [(String, String)] #

targetBuildDepends :: Lens' a [Dependency] #

mixins :: Lens' a [Mixin] #

Instances
HasBuildInfo BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo.Lens

Methods

buildInfo :: Lens' BuildInfo BuildInfo #

buildable :: Lens' BuildInfo Bool #

buildTools :: Lens' BuildInfo [LegacyExeDependency] #

buildToolDepends :: Lens' BuildInfo [ExeDependency] #

cppOptions :: Lens' BuildInfo [String] #

asmOptions :: Lens' BuildInfo [String] #

cmmOptions :: Lens' BuildInfo [String] #

ccOptions :: Lens' BuildInfo [String] #

cxxOptions :: Lens' BuildInfo [String] #

ldOptions :: Lens' BuildInfo [String] #

pkgconfigDepends :: Lens' BuildInfo [PkgconfigDependency] #

frameworks :: Lens' BuildInfo [String] #

extraFrameworkDirs :: Lens' BuildInfo [String] #

asmSources :: Lens' BuildInfo [FilePath] #

cmmSources :: Lens' BuildInfo [FilePath] #

cSources :: Lens' BuildInfo [FilePath] #

cxxSources :: Lens' BuildInfo [FilePath] #

jsSources :: Lens' BuildInfo [FilePath] #

hsSourceDirs :: Lens' BuildInfo [FilePath] #

otherModules :: Lens' BuildInfo [ModuleName] #

virtualModules :: Lens' BuildInfo [ModuleName] #

autogenModules :: Lens' BuildInfo [ModuleName] #

defaultLanguage :: Lens' BuildInfo (Maybe Language) #

otherLanguages :: Lens' BuildInfo [Language] #

defaultExtensions :: Lens' BuildInfo [Extension] #

otherExtensions :: Lens' BuildInfo [Extension] #

oldExtensions :: Lens' BuildInfo [Extension] #

extraLibs :: Lens' BuildInfo [String] #

extraGHCiLibs :: Lens' BuildInfo [String] #

extraBundledLibs :: Lens' BuildInfo [String] #

extraLibFlavours :: Lens' BuildInfo [String] #

extraLibDirs :: Lens' BuildInfo [String] #

includeDirs :: Lens' BuildInfo [FilePath] #

includes :: Lens' BuildInfo [FilePath] #

installIncludes :: Lens' BuildInfo [FilePath] #

options :: Lens' BuildInfo [(CompilerFlavor, [String])] #

profOptions :: Lens' BuildInfo [(CompilerFlavor, [String])] #

sharedOptions :: Lens' BuildInfo [(CompilerFlavor, [String])] #

staticOptions :: Lens' BuildInfo [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' BuildInfo [(String, String)] #

targetBuildDepends :: Lens' BuildInfo [Dependency] #

mixins :: Lens' BuildInfo [Mixin] #

HasBuildInfo TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

buildInfo :: Lens' TestSuite BuildInfo #

buildable :: Lens' TestSuite Bool #

buildTools :: Lens' TestSuite [LegacyExeDependency] #

buildToolDepends :: Lens' TestSuite [ExeDependency] #

cppOptions :: Lens' TestSuite [String] #

asmOptions :: Lens' TestSuite [String] #

cmmOptions :: Lens' TestSuite [String] #

ccOptions :: Lens' TestSuite [String] #

cxxOptions :: Lens' TestSuite [String] #

ldOptions :: Lens' TestSuite [String] #

pkgconfigDepends :: Lens' TestSuite [PkgconfigDependency] #

frameworks :: Lens' TestSuite [String] #

extraFrameworkDirs :: Lens' TestSuite [String] #

asmSources :: Lens' TestSuite [FilePath] #

cmmSources :: Lens' TestSuite [FilePath] #

cSources :: Lens' TestSuite [FilePath] #

cxxSources :: Lens' TestSuite [FilePath] #

jsSources :: Lens' TestSuite [FilePath] #

hsSourceDirs :: Lens' TestSuite [FilePath] #

otherModules :: Lens' TestSuite [ModuleName] #

virtualModules :: Lens' TestSuite [ModuleName] #

autogenModules :: Lens' TestSuite [ModuleName] #

defaultLanguage :: Lens' TestSuite (Maybe Language) #

otherLanguages :: Lens' TestSuite [Language] #

defaultExtensions :: Lens' TestSuite [Extension] #

otherExtensions :: Lens' TestSuite [Extension] #

oldExtensions :: Lens' TestSuite [Extension] #

extraLibs :: Lens' TestSuite [String] #

extraGHCiLibs :: Lens' TestSuite [String] #

extraBundledLibs :: Lens' TestSuite [String] #

extraLibFlavours :: Lens' TestSuite [String] #

extraLibDirs :: Lens' TestSuite [String] #

includeDirs :: Lens' TestSuite [FilePath] #

includes :: Lens' TestSuite [FilePath] #

installIncludes :: Lens' TestSuite [FilePath] #

options :: Lens' TestSuite [(CompilerFlavor, [String])] #

profOptions :: Lens' TestSuite [(CompilerFlavor, [String])] #

sharedOptions :: Lens' TestSuite [(CompilerFlavor, [String])] #

staticOptions :: Lens' TestSuite [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' TestSuite [(String, String)] #

targetBuildDepends :: Lens' TestSuite [Dependency] #

mixins :: Lens' TestSuite [Mixin] #

HasBuildInfo Library # 
Instance details

Defined in Distribution.Types.Library

Methods

buildInfo :: Lens' Library BuildInfo #

buildable :: Lens' Library Bool #

buildTools :: Lens' Library [LegacyExeDependency] #

buildToolDepends :: Lens' Library [ExeDependency] #

cppOptions :: Lens' Library [String] #

asmOptions :: Lens' Library [String] #

cmmOptions :: Lens' Library [String] #

ccOptions :: Lens' Library [String] #

cxxOptions :: Lens' Library [String] #

ldOptions :: Lens' Library [String] #

pkgconfigDepends :: Lens' Library [PkgconfigDependency] #

frameworks :: Lens' Library [String] #

extraFrameworkDirs :: Lens' Library [String] #

asmSources :: Lens' Library [FilePath] #

cmmSources :: Lens' Library [FilePath] #

cSources :: Lens' Library [FilePath] #

cxxSources :: Lens' Library [FilePath] #

jsSources :: Lens' Library [FilePath] #

hsSourceDirs :: Lens' Library [FilePath] #

otherModules :: Lens' Library [ModuleName] #

virtualModules :: Lens' Library [ModuleName] #

autogenModules :: Lens' Library [ModuleName] #

defaultLanguage :: Lens' Library (Maybe Language) #

otherLanguages :: Lens' Library [Language] #

defaultExtensions :: Lens' Library [Extension] #

otherExtensions :: Lens' Library [Extension] #

oldExtensions :: Lens' Library [Extension] #

extraLibs :: Lens' Library [String] #

extraGHCiLibs :: Lens' Library [String] #

extraBundledLibs :: Lens' Library [String] #

extraLibFlavours :: Lens' Library [String] #

extraLibDirs :: Lens' Library [String] #

includeDirs :: Lens' Library [FilePath] #

includes :: Lens' Library [FilePath] #

installIncludes :: Lens' Library [FilePath] #

options :: Lens' Library [(CompilerFlavor, [String])] #

profOptions :: Lens' Library [(CompilerFlavor, [String])] #

sharedOptions :: Lens' Library [(CompilerFlavor, [String])] #

staticOptions :: Lens' Library [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' Library [(String, String)] #

targetBuildDepends :: Lens' Library [Dependency] #

mixins :: Lens' Library [Mixin] #

HasBuildInfo ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

buildInfo :: Lens' ForeignLib BuildInfo #

buildable :: Lens' ForeignLib Bool #

buildTools :: Lens' ForeignLib [LegacyExeDependency] #

buildToolDepends :: Lens' ForeignLib [ExeDependency] #

cppOptions :: Lens' ForeignLib [String] #

asmOptions :: Lens' ForeignLib [String] #

cmmOptions :: Lens' ForeignLib [String] #

ccOptions :: Lens' ForeignLib [String] #

cxxOptions :: Lens' ForeignLib [String] #

ldOptions :: Lens' ForeignLib [String] #

pkgconfigDepends :: Lens' ForeignLib [PkgconfigDependency] #

frameworks :: Lens' ForeignLib [String] #

extraFrameworkDirs :: Lens' ForeignLib [String] #

asmSources :: Lens' ForeignLib [FilePath] #

cmmSources :: Lens' ForeignLib [FilePath] #

cSources :: Lens' ForeignLib [FilePath] #

cxxSources :: Lens' ForeignLib [FilePath] #

jsSources :: Lens' ForeignLib [FilePath] #

hsSourceDirs :: Lens' ForeignLib [FilePath] #

otherModules :: Lens' ForeignLib [ModuleName] #

virtualModules :: Lens' ForeignLib [ModuleName] #

autogenModules :: Lens' ForeignLib [ModuleName] #

defaultLanguage :: Lens' ForeignLib (Maybe Language) #

otherLanguages :: Lens' ForeignLib [Language] #

defaultExtensions :: Lens' ForeignLib [Extension] #

otherExtensions :: Lens' ForeignLib [Extension] #

oldExtensions :: Lens' ForeignLib [Extension] #

extraLibs :: Lens' ForeignLib [String] #

extraGHCiLibs :: Lens' ForeignLib [String] #

extraBundledLibs :: Lens' ForeignLib [String] #

extraLibFlavours :: Lens' ForeignLib [String] #

extraLibDirs :: Lens' ForeignLib [String] #

includeDirs :: Lens' ForeignLib [FilePath] #

includes :: Lens' ForeignLib [FilePath] #

installIncludes :: Lens' ForeignLib [FilePath] #

options :: Lens' ForeignLib [(CompilerFlavor, [String])] #

profOptions :: Lens' ForeignLib [(CompilerFlavor, [String])] #

sharedOptions :: Lens' ForeignLib [(CompilerFlavor, [String])] #

staticOptions :: Lens' ForeignLib [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' ForeignLib [(String, String)] #

targetBuildDepends :: Lens' ForeignLib [Dependency] #

mixins :: Lens' ForeignLib [Mixin] #

HasBuildInfo Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

buildInfo :: Lens' Executable BuildInfo #

buildable :: Lens' Executable Bool #

buildTools :: Lens' Executable [LegacyExeDependency] #

buildToolDepends :: Lens' Executable [ExeDependency] #

cppOptions :: Lens' Executable [String] #

asmOptions :: Lens' Executable [String] #

cmmOptions :: Lens' Executable [String] #

ccOptions :: Lens' Executable [String] #

cxxOptions :: Lens' Executable [String] #

ldOptions :: Lens' Executable [String] #

pkgconfigDepends :: Lens' Executable [PkgconfigDependency] #

frameworks :: Lens' Executable [String] #

extraFrameworkDirs :: Lens' Executable [String] #

asmSources :: Lens' Executable [FilePath] #

cmmSources :: Lens' Executable [FilePath] #

cSources :: Lens' Executable [FilePath] #

cxxSources :: Lens' Executable [FilePath] #

jsSources :: Lens' Executable [FilePath] #

hsSourceDirs :: Lens' Executable [FilePath] #

otherModules :: Lens' Executable [ModuleName] #

virtualModules :: Lens' Executable [ModuleName] #

autogenModules :: Lens' Executable [ModuleName] #

defaultLanguage :: Lens' Executable (Maybe Language) #

otherLanguages :: Lens' Executable [Language] #

defaultExtensions :: Lens' Executable [Extension] #

otherExtensions :: Lens' Executable [Extension] #

oldExtensions :: Lens' Executable [Extension] #

extraLibs :: Lens' Executable [String] #

extraGHCiLibs :: Lens' Executable [String] #

extraBundledLibs :: Lens' Executable [String] #

extraLibFlavours :: Lens' Executable [String] #

extraLibDirs :: Lens' Executable [String] #

includeDirs :: Lens' Executable [FilePath] #

includes :: Lens' Executable [FilePath] #

installIncludes :: Lens' Executable [FilePath] #

options :: Lens' Executable [(CompilerFlavor, [String])] #

profOptions :: Lens' Executable [(CompilerFlavor, [String])] #

sharedOptions :: Lens' Executable [(CompilerFlavor, [String])] #

staticOptions :: Lens' Executable [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' Executable [(String, String)] #

targetBuildDepends :: Lens' Executable [Dependency] #

mixins :: Lens' Executable [Mixin] #

HasBuildInfo Benchmark # 
Instance details

Defined in Distribution.Types.Benchmark

Methods

buildInfo :: Lens' Benchmark BuildInfo #

buildable :: Lens' Benchmark Bool #

buildTools :: Lens' Benchmark [LegacyExeDependency] #

buildToolDepends :: Lens' Benchmark [ExeDependency] #

cppOptions :: Lens' Benchmark [String] #

asmOptions :: Lens' Benchmark [String] #

cmmOptions :: Lens' Benchmark [String] #

ccOptions :: Lens' Benchmark [String] #

cxxOptions :: Lens' Benchmark [String] #

ldOptions :: Lens' Benchmark [String] #

pkgconfigDepends :: Lens' Benchmark [PkgconfigDependency] #

frameworks :: Lens' Benchmark [String] #

extraFrameworkDirs :: Lens' Benchmark [String] #

asmSources :: Lens' Benchmark [FilePath] #

cmmSources :: Lens' Benchmark [FilePath] #

cSources :: Lens' Benchmark [FilePath] #

cxxSources :: Lens' Benchmark [FilePath] #

jsSources :: Lens' Benchmark [FilePath] #

hsSourceDirs :: Lens' Benchmark [FilePath] #

otherModules :: Lens' Benchmark [ModuleName] #

virtualModules :: Lens' Benchmark [ModuleName] #

autogenModules :: Lens' Benchmark [ModuleName] #

defaultLanguage :: Lens' Benchmark (Maybe Language) #

otherLanguages :: Lens' Benchmark [Language] #

defaultExtensions :: Lens' Benchmark [Extension] #

otherExtensions :: Lens' Benchmark [Extension] #

oldExtensions :: Lens' Benchmark [Extension] #

extraLibs :: Lens' Benchmark [String] #

extraGHCiLibs :: Lens' Benchmark [String] #

extraBundledLibs :: Lens' Benchmark [String] #

extraLibFlavours :: Lens' Benchmark [String] #

extraLibDirs :: Lens' Benchmark [String] #

includeDirs :: Lens' Benchmark [FilePath] #

includes :: Lens' Benchmark [FilePath] #

installIncludes :: Lens' Benchmark [FilePath] #

options :: Lens' Benchmark [(CompilerFlavor, [String])] #

profOptions :: Lens' Benchmark [(CompilerFlavor, [String])] #

sharedOptions :: Lens' Benchmark [(CompilerFlavor, [String])] #

staticOptions :: Lens' Benchmark [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' Benchmark [(String, String)] #

targetBuildDepends :: Lens' Benchmark [Dependency] #

mixins :: Lens' Benchmark [Mixin] #

HasBuildInfo Component # 
Instance details

Defined in Distribution.Types.Component

Methods

buildInfo :: Lens' Component BuildInfo #

buildable :: Lens' Component Bool #

buildTools :: Lens' Component [LegacyExeDependency] #

buildToolDepends :: Lens' Component [ExeDependency] #

cppOptions :: Lens' Component [String] #

asmOptions :: Lens' Component [String] #

cmmOptions :: Lens' Component [String] #

ccOptions :: Lens' Component [String] #

cxxOptions :: Lens' Component [String] #

ldOptions :: Lens' Component [String] #

pkgconfigDepends :: Lens' Component [PkgconfigDependency] #

frameworks :: Lens' Component [String] #

extraFrameworkDirs :: Lens' Component [String] #

asmSources :: Lens' Component [FilePath] #

cmmSources :: Lens' Component [FilePath] #

cSources :: Lens' Component [FilePath] #

cxxSources :: Lens' Component [FilePath] #

jsSources :: Lens' Component [FilePath] #

hsSourceDirs :: Lens' Component [FilePath] #

otherModules :: Lens' Component [ModuleName] #

virtualModules :: Lens' Component [ModuleName] #

autogenModules :: Lens' Component [ModuleName] #

defaultLanguage :: Lens' Component (Maybe Language) #

otherLanguages :: Lens' Component [Language] #

defaultExtensions :: Lens' Component [Extension] #

otherExtensions :: Lens' Component [Extension] #

oldExtensions :: Lens' Component [Extension] #

extraLibs :: Lens' Component [String] #

extraGHCiLibs :: Lens' Component [String] #

extraBundledLibs :: Lens' Component [String] #

extraLibFlavours :: Lens' Component [String] #

extraLibDirs :: Lens' Component [String] #

includeDirs :: Lens' Component [FilePath] #

includes :: Lens' Component [FilePath] #

installIncludes :: Lens' Component [FilePath] #

options :: Lens' Component [(CompilerFlavor, [String])] #

profOptions :: Lens' Component [(CompilerFlavor, [String])] #

sharedOptions :: Lens' Component [(CompilerFlavor, [String])] #

staticOptions :: Lens' Component [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' Component [(String, String)] #

targetBuildDepends :: Lens' Component [Dependency] #

mixins :: Lens' Component [Mixin] #

HasBuildInfo BenchmarkStanza # 
Instance details

Defined in Distribution.PackageDescription.FieldGrammar

Methods

buildInfo :: Lens' BenchmarkStanza BuildInfo #

buildable :: Lens' BenchmarkStanza Bool #

buildTools :: Lens' BenchmarkStanza [LegacyExeDependency] #

buildToolDepends :: Lens' BenchmarkStanza [ExeDependency] #

cppOptions :: Lens' BenchmarkStanza [String] #

asmOptions :: Lens' BenchmarkStanza [String] #

cmmOptions :: Lens' BenchmarkStanza [String] #

ccOptions :: Lens' BenchmarkStanza [String] #

cxxOptions :: Lens' BenchmarkStanza [String] #

ldOptions :: Lens' BenchmarkStanza [String] #

pkgconfigDepends :: Lens' BenchmarkStanza [PkgconfigDependency] #

frameworks :: Lens' BenchmarkStanza [String] #

extraFrameworkDirs :: Lens' BenchmarkStanza [String] #

asmSources :: Lens' BenchmarkStanza [FilePath] #

cmmSources :: Lens' BenchmarkStanza [FilePath] #

cSources :: Lens' BenchmarkStanza [FilePath] #

cxxSources :: Lens' BenchmarkStanza [FilePath] #

jsSources :: Lens' BenchmarkStanza [FilePath] #

hsSourceDirs :: Lens' BenchmarkStanza [FilePath] #

otherModules :: Lens' BenchmarkStanza [ModuleName] #

virtualModules :: Lens' BenchmarkStanza [ModuleName] #

autogenModules :: Lens' BenchmarkStanza [ModuleName] #

defaultLanguage :: Lens' BenchmarkStanza (Maybe Language) #

otherLanguages :: Lens' BenchmarkStanza [Language] #

defaultExtensions :: Lens' BenchmarkStanza [Extension] #

otherExtensions :: Lens' BenchmarkStanza [Extension] #

oldExtensions :: Lens' BenchmarkStanza [Extension] #

extraLibs :: Lens' BenchmarkStanza [String] #

extraGHCiLibs :: Lens' BenchmarkStanza [String] #

extraBundledLibs :: Lens' BenchmarkStanza [String] #

extraLibFlavours :: Lens' BenchmarkStanza [String] #

extraLibDirs :: Lens' BenchmarkStanza [String] #

includeDirs :: Lens' BenchmarkStanza [FilePath] #

includes :: Lens' BenchmarkStanza [FilePath] #

installIncludes :: Lens' BenchmarkStanza [FilePath] #

options :: Lens' BenchmarkStanza [(CompilerFlavor, [String])] #

profOptions :: Lens' BenchmarkStanza [(CompilerFlavor, [String])] #

sharedOptions :: Lens' BenchmarkStanza [(CompilerFlavor, [String])] #

staticOptions :: Lens' BenchmarkStanza [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' BenchmarkStanza [(String, String)] #

targetBuildDepends :: Lens' BenchmarkStanza [Dependency] #

mixins :: Lens' BenchmarkStanza [Mixin] #

HasBuildInfo TestSuiteStanza # 
Instance details

Defined in Distribution.PackageDescription.FieldGrammar

Methods

buildInfo :: Lens' TestSuiteStanza BuildInfo #

buildable :: Lens' TestSuiteStanza Bool #

buildTools :: Lens' TestSuiteStanza [LegacyExeDependency] #

buildToolDepends :: Lens' TestSuiteStanza [ExeDependency] #

cppOptions :: Lens' TestSuiteStanza [String] #

asmOptions :: Lens' TestSuiteStanza [String] #

cmmOptions :: Lens' TestSuiteStanza [String] #

ccOptions :: Lens' TestSuiteStanza [String] #

cxxOptions :: Lens' TestSuiteStanza [String] #

ldOptions :: Lens' TestSuiteStanza [String] #

pkgconfigDepends :: Lens' TestSuiteStanza [PkgconfigDependency] #

frameworks :: Lens' TestSuiteStanza [String] #

extraFrameworkDirs :: Lens' TestSuiteStanza [String] #

asmSources :: Lens' TestSuiteStanza [FilePath] #

cmmSources :: Lens' TestSuiteStanza [FilePath] #

cSources :: Lens' TestSuiteStanza [FilePath] #

cxxSources :: Lens' TestSuiteStanza [FilePath] #

jsSources :: Lens' TestSuiteStanza [FilePath] #

hsSourceDirs :: Lens' TestSuiteStanza [FilePath] #

otherModules :: Lens' TestSuiteStanza [ModuleName] #

virtualModules :: Lens' TestSuiteStanza [ModuleName] #

autogenModules :: Lens' TestSuiteStanza [ModuleName] #

defaultLanguage :: Lens' TestSuiteStanza (Maybe Language) #

otherLanguages :: Lens' TestSuiteStanza [Language] #

defaultExtensions :: Lens' TestSuiteStanza [Extension] #

otherExtensions :: Lens' TestSuiteStanza [Extension] #

oldExtensions :: Lens' TestSuiteStanza [Extension] #

extraLibs :: Lens' TestSuiteStanza [String] #

extraGHCiLibs :: Lens' TestSuiteStanza [String] #

extraBundledLibs :: Lens' TestSuiteStanza [String] #

extraLibFlavours :: Lens' TestSuiteStanza [String] #

extraLibDirs :: Lens' TestSuiteStanza [String] #

includeDirs :: Lens' TestSuiteStanza [FilePath] #

includes :: Lens' TestSuiteStanza [FilePath] #

installIncludes :: Lens' TestSuiteStanza [FilePath] #

options :: Lens' TestSuiteStanza [(CompilerFlavor, [String])] #

profOptions :: Lens' TestSuiteStanza [(CompilerFlavor, [String])] #

sharedOptions :: Lens' TestSuiteStanza [(CompilerFlavor, [String])] #

staticOptions :: Lens' TestSuiteStanza [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' TestSuiteStanza [(String, String)] #

targetBuildDepends :: Lens' TestSuiteStanza [Dependency] #

mixins :: Lens' TestSuiteStanza [Mixin] #

class HasBuildInfos a where #

Minimal complete definition

traverseBuildInfos

Methods

traverseBuildInfos :: Traversal' a BuildInfo #

Instances
HasBuildInfos PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

traverseBuildInfos :: Traversal' PackageDescription BuildInfo #

HasBuildInfos GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

traverseBuildInfos :: Traversal' GenericPackageDescription BuildInfo #

diff --git a/doc/API/Cabal/Distribution-Types-BuildInfo.html b/doc/API/Cabal/Distribution-Types-BuildInfo.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-BuildInfo.html @@ -0,0 +1,18 @@ +Distribution.Types.BuildInfo

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.BuildInfo

Synopsis

Documentation

data BuildInfo #

Constructors

BuildInfo 

Fields

Instances
Eq BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

(==) :: BuildInfo -> BuildInfo -> Bool #

(/=) :: BuildInfo -> BuildInfo -> Bool #

Data BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BuildInfo -> c BuildInfo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BuildInfo #

toConstr :: BuildInfo -> Constr #

dataTypeOf :: BuildInfo -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BuildInfo) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BuildInfo) #

gmapT :: (forall b. Data b => b -> b) -> BuildInfo -> BuildInfo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BuildInfo -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BuildInfo -> r #

gmapQ :: (forall d. Data d => d -> u) -> BuildInfo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BuildInfo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BuildInfo -> m BuildInfo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BuildInfo -> m BuildInfo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BuildInfo -> m BuildInfo #

Read BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

readsPrec :: Int -> ReadS BuildInfo #

readList :: ReadS [BuildInfo] #

readPrec :: ReadPrec BuildInfo #

readListPrec :: ReadPrec [BuildInfo] #

Show BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

showsPrec :: Int -> BuildInfo -> ShowS #

show :: BuildInfo -> String #

showList :: [BuildInfo] -> ShowS #

Generic BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Associated Types

type Rep BuildInfo :: * -> * #

Methods

from :: BuildInfo -> Rep BuildInfo x #

to :: Rep BuildInfo x -> BuildInfo #

Semigroup BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

(<>) :: BuildInfo -> BuildInfo -> BuildInfo #

sconcat :: NonEmpty BuildInfo -> BuildInfo #

stimes :: Integral b => b -> BuildInfo -> BuildInfo #

Monoid BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

mempty :: BuildInfo #

mappend :: BuildInfo -> BuildInfo -> BuildInfo #

mconcat :: [BuildInfo] -> BuildInfo #

Binary BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

put :: BuildInfo -> Put #

get :: Get BuildInfo #

putList :: [BuildInfo] -> Put #

NFData BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

Methods

rnf :: BuildInfo -> () #

HasBuildInfo BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo.Lens

Methods

buildInfo :: Lens' BuildInfo BuildInfo #

buildable :: Lens' BuildInfo Bool #

buildTools :: Lens' BuildInfo [LegacyExeDependency] #

buildToolDepends :: Lens' BuildInfo [ExeDependency] #

cppOptions :: Lens' BuildInfo [String] #

asmOptions :: Lens' BuildInfo [String] #

cmmOptions :: Lens' BuildInfo [String] #

ccOptions :: Lens' BuildInfo [String] #

cxxOptions :: Lens' BuildInfo [String] #

ldOptions :: Lens' BuildInfo [String] #

pkgconfigDepends :: Lens' BuildInfo [PkgconfigDependency] #

frameworks :: Lens' BuildInfo [String] #

extraFrameworkDirs :: Lens' BuildInfo [String] #

asmSources :: Lens' BuildInfo [FilePath] #

cmmSources :: Lens' BuildInfo [FilePath] #

cSources :: Lens' BuildInfo [FilePath] #

cxxSources :: Lens' BuildInfo [FilePath] #

jsSources :: Lens' BuildInfo [FilePath] #

hsSourceDirs :: Lens' BuildInfo [FilePath] #

otherModules :: Lens' BuildInfo [ModuleName] #

virtualModules :: Lens' BuildInfo [ModuleName] #

autogenModules :: Lens' BuildInfo [ModuleName] #

defaultLanguage :: Lens' BuildInfo (Maybe Language) #

otherLanguages :: Lens' BuildInfo [Language] #

defaultExtensions :: Lens' BuildInfo [Extension] #

otherExtensions :: Lens' BuildInfo [Extension] #

oldExtensions :: Lens' BuildInfo [Extension] #

extraLibs :: Lens' BuildInfo [String] #

extraGHCiLibs :: Lens' BuildInfo [String] #

extraBundledLibs :: Lens' BuildInfo [String] #

extraLibFlavours :: Lens' BuildInfo [String] #

extraLibDirs :: Lens' BuildInfo [String] #

includeDirs :: Lens' BuildInfo [FilePath] #

includes :: Lens' BuildInfo [FilePath] #

installIncludes :: Lens' BuildInfo [FilePath] #

options :: Lens' BuildInfo [(CompilerFlavor, [String])] #

profOptions :: Lens' BuildInfo [(CompilerFlavor, [String])] #

sharedOptions :: Lens' BuildInfo [(CompilerFlavor, [String])] #

staticOptions :: Lens' BuildInfo [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' BuildInfo [(String, String)] #

targetBuildDepends :: Lens' BuildInfo [Dependency] #

mixins :: Lens' BuildInfo [Mixin] #

type Rep BuildInfo # 
Instance details

Defined in Distribution.Types.BuildInfo

type Rep BuildInfo = D1 (MetaData "BuildInfo" "Distribution.Types.BuildInfo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "BuildInfo" PrefixI True) (((((S1 (MetaSel (Just "buildable") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "buildTools") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [LegacyExeDependency])) :*: (S1 (MetaSel (Just "buildToolDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ExeDependency]) :*: (S1 (MetaSel (Just "cppOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "asmOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])))) :*: ((S1 (MetaSel (Just "cmmOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "ccOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) :*: (S1 (MetaSel (Just "cxxOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: (S1 (MetaSel (Just "ldOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "pkgconfigDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [PkgconfigDependency]))))) :*: (((S1 (MetaSel (Just "frameworks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "extraFrameworkDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) :*: (S1 (MetaSel (Just "asmSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: (S1 (MetaSel (Just "cmmSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "cSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))) :*: ((S1 (MetaSel (Just "cxxSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "jsSources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])) :*: (S1 (MetaSel (Just "hsSourceDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: (S1 (MetaSel (Just "otherModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]) :*: S1 (MetaSel (Just "virtualModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName])))))) :*: ((((S1 (MetaSel (Just "autogenModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]) :*: S1 (MetaSel (Just "defaultLanguage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Language))) :*: (S1 (MetaSel (Just "otherLanguages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Language]) :*: (S1 (MetaSel (Just "defaultExtensions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Extension]) :*: S1 (MetaSel (Just "otherExtensions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Extension])))) :*: ((S1 (MetaSel (Just "oldExtensions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Extension]) :*: S1 (MetaSel (Just "extraLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) :*: (S1 (MetaSel (Just "extraGHCiLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: (S1 (MetaSel (Just "extraBundledLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "extraLibFlavours") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]))))) :*: (((S1 (MetaSel (Just "extraLibDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "includeDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])) :*: (S1 (MetaSel (Just "includes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: (S1 (MetaSel (Just "installIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "options") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(CompilerFlavor, [String])])))) :*: ((S1 (MetaSel (Just "profOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(CompilerFlavor, [String])]) :*: (S1 (MetaSel (Just "sharedOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(CompilerFlavor, [String])]) :*: S1 (MetaSel (Just "staticOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(CompilerFlavor, [String])]))) :*: (S1 (MetaSel (Just "customFieldsBI") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, String)]) :*: (S1 (MetaSel (Just "targetBuildDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Dependency]) :*: S1 (MetaSel (Just "mixins") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Mixin]))))))))

emptyBuildInfo :: BuildInfo #

allLanguages :: BuildInfo -> [Language] #

The Languages used by this component

allExtensions :: BuildInfo -> [Extension] #

The Extensions that are used somewhere by this component

usedExtensions :: BuildInfo -> [Extension] #

The Extensions that are used by all modules in this component

usesTemplateHaskellOrQQ :: BuildInfo -> Bool #

Whether any modules in this component use Template Haskell or + Quasi Quotes

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

Select options for a particular Haskell compiler.

hcProfOptions :: CompilerFlavor -> BuildInfo -> [String] #

hcSharedOptions :: CompilerFlavor -> BuildInfo -> [String] #

hcStaticOptions :: CompilerFlavor -> BuildInfo -> [String] #

diff --git a/doc/API/Cabal/Distribution-Types-BuildType.html b/doc/API/Cabal/Distribution-Types-BuildType.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-BuildType.html @@ -0,0 +1,3 @@ +Distribution.Types.BuildType

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.BuildType

Synopsis

Documentation

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)

Instances
Eq BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

(==) :: BuildType -> BuildType -> Bool #

(/=) :: BuildType -> BuildType -> Bool #

Data BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BuildType -> c BuildType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BuildType #

toConstr :: BuildType -> Constr #

dataTypeOf :: BuildType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BuildType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BuildType) #

gmapT :: (forall b. Data b => b -> b) -> BuildType -> BuildType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BuildType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BuildType -> r #

gmapQ :: (forall d. Data d => d -> u) -> BuildType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BuildType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BuildType -> m BuildType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BuildType -> m BuildType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BuildType -> m BuildType #

Read BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

readsPrec :: Int -> ReadS BuildType #

readList :: ReadS [BuildType] #

readPrec :: ReadPrec BuildType #

readListPrec :: ReadPrec [BuildType] #

Show BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

showsPrec :: Int -> BuildType -> ShowS #

show :: BuildType -> String #

showList :: [BuildType] -> ShowS #

Generic BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Associated Types

type Rep BuildType :: * -> * #

Methods

from :: BuildType -> Rep BuildType x #

to :: Rep BuildType x -> BuildType #

Binary BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

put :: BuildType -> Put #

get :: Get BuildType #

putList :: [BuildType] -> Put #

NFData BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

rnf :: BuildType -> () #

Pretty BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

pretty :: BuildType -> Doc #

Parsec BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

parsec :: CabalParsing m => m BuildType #

Text BuildType # 
Instance details

Defined in Distribution.Types.BuildType

Methods

disp :: BuildType -> Doc #

parse :: ReadP r BuildType #

type Rep BuildType # 
Instance details

Defined in Distribution.Types.BuildType

type Rep BuildType = D1 (MetaData "BuildType" "Distribution.Types.BuildType" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "Simple" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Configure" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Make" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Custom" PrefixI False) (U1 :: * -> *)))

knownBuildTypes :: [BuildType] #

diff --git a/doc/API/Cabal/Distribution-Types-Component.html b/doc/API/Cabal/Distribution-Types-Component.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-Component.html @@ -0,0 +1,3 @@ +Distribution.Types.Component

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.Component

Synopsis

Documentation

data Component #

Constructors

CLib Library 
CFLib ForeignLib 
CExe Executable 
CTest TestSuite 
CBench Benchmark 
Instances
Eq Component # 
Instance details

Defined in Distribution.Types.Component

Methods

(==) :: Component -> Component -> Bool #

(/=) :: Component -> Component -> Bool #

Read Component # 
Instance details

Defined in Distribution.Types.Component

Methods

readsPrec :: Int -> ReadS Component #

readList :: ReadS [Component] #

readPrec :: ReadPrec Component #

readListPrec :: ReadPrec [Component] #

Show Component # 
Instance details

Defined in Distribution.Types.Component

Methods

showsPrec :: Int -> Component -> ShowS #

show :: Component -> String #

showList :: [Component] -> ShowS #

Semigroup Component # 
Instance details

Defined in Distribution.Types.Component

Methods

(<>) :: Component -> Component -> Component #

sconcat :: NonEmpty Component -> Component #

stimes :: Integral b => b -> Component -> Component #

HasBuildInfo Component # 
Instance details

Defined in Distribution.Types.Component

Methods

buildInfo :: Lens' Component BuildInfo #

buildable :: Lens' Component Bool #

buildTools :: Lens' Component [LegacyExeDependency] #

buildToolDepends :: Lens' Component [ExeDependency] #

cppOptions :: Lens' Component [String] #

asmOptions :: Lens' Component [String] #

cmmOptions :: Lens' Component [String] #

ccOptions :: Lens' Component [String] #

cxxOptions :: Lens' Component [String] #

ldOptions :: Lens' Component [String] #

pkgconfigDepends :: Lens' Component [PkgconfigDependency] #

frameworks :: Lens' Component [String] #

extraFrameworkDirs :: Lens' Component [String] #

asmSources :: Lens' Component [FilePath] #

cmmSources :: Lens' Component [FilePath] #

cSources :: Lens' Component [FilePath] #

cxxSources :: Lens' Component [FilePath] #

jsSources :: Lens' Component [FilePath] #

hsSourceDirs :: Lens' Component [FilePath] #

otherModules :: Lens' Component [ModuleName] #

virtualModules :: Lens' Component [ModuleName] #

autogenModules :: Lens' Component [ModuleName] #

defaultLanguage :: Lens' Component (Maybe Language) #

otherLanguages :: Lens' Component [Language] #

defaultExtensions :: Lens' Component [Extension] #

otherExtensions :: Lens' Component [Extension] #

oldExtensions :: Lens' Component [Extension] #

extraLibs :: Lens' Component [String] #

extraGHCiLibs :: Lens' Component [String] #

extraBundledLibs :: Lens' Component [String] #

extraLibFlavours :: Lens' Component [String] #

extraLibDirs :: Lens' Component [String] #

includeDirs :: Lens' Component [FilePath] #

includes :: Lens' Component [FilePath] #

installIncludes :: Lens' Component [FilePath] #

options :: Lens' Component [(CompilerFlavor, [String])] #

profOptions :: Lens' Component [(CompilerFlavor, [String])] #

sharedOptions :: Lens' Component [(CompilerFlavor, [String])] #

staticOptions :: Lens' Component [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' Component [(String, String)] #

targetBuildDepends :: Lens' Component [Dependency] #

mixins :: Lens' Component [Mixin] #

foldComponent :: (Library -> a) -> (ForeignLib -> a) -> (Executable -> a) -> (TestSuite -> a) -> (Benchmark -> a) -> Component -> a #

componentBuildInfo :: Component -> BuildInfo #

componentBuildable :: Component -> Bool #

Is a component buildable (i.e., not marked with buildable: False)? + See also this note in + Distribution.Types.ComponentRequestedSpec.

Since: 2.0.0.2

componentName :: Component -> ComponentName #

partitionComponents :: [Component] -> ([Library], [ForeignLib], [Executable], [TestSuite], [Benchmark]) #

diff --git a/doc/API/Cabal/Distribution-Types-ComponentId.html b/doc/API/Cabal/Distribution-Types-ComponentId.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-ComponentId.html @@ -0,0 +1,6 @@ +Distribution.Types.ComponentId

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.ComponentId

Synopsis

Documentation

data ComponentId #

A ComponentId uniquely identifies the transitive source + code closure of a component (i.e. libraries, executables).

For non-Backpack components, this corresponds one to one with + the UnitId, which serves as the basis for install paths, + linker symbols, etc.

Use mkComponentId and unComponentId to convert from/to a + String.

This type is opaque since Cabal-2.0

Since: 2.0.0.2

Instances
Eq ComponentId # 
Instance details

Defined in Distribution.Types.ComponentId

Methods

(==) :: ComponentId -> ComponentId -> Bool #

(/=) :: ComponentId -> ComponentId -> Bool #

Data ComponentId # 
Instance details

Defined in Distribution.Types.ComponentId

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ComponentId -> c ComponentId #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ComponentId #

toConstr :: ComponentId -> Constr #

dataTypeOf :: ComponentId -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ComponentId) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ComponentId) #

gmapT :: (forall b. Data b => b -> b) -> ComponentId -> ComponentId #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ComponentId -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ComponentId -> r #

gmapQ :: (forall d. Data d => d -> u) -> ComponentId -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ComponentId -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ComponentId -> m ComponentId #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ComponentId -> m ComponentId #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ComponentId -> m ComponentId #

Ord ComponentId # 
Instance details

Defined in Distribution.Types.ComponentId

Methods

compare :: ComponentId -> ComponentId -> Ordering #

(<) :: ComponentId -> ComponentId -> Bool #

(<=) :: ComponentId -> ComponentId -> Bool #

(>) :: ComponentId -> ComponentId -> Bool #

(>=) :: ComponentId -> ComponentId -> Bool #

max :: ComponentId -> ComponentId -> ComponentId #

min :: ComponentId -> ComponentId -> ComponentId #

Read ComponentId # 
Instance details

Defined in Distribution.Types.ComponentId

Methods

readsPrec :: Int -> ReadS ComponentId #

readList :: ReadS [ComponentId] #

readPrec :: ReadPrec ComponentId #

readListPrec :: ReadPrec [ComponentId] #

Show ComponentId # 
Instance details

Defined in Distribution.Types.ComponentId

Methods

showsPrec :: Int -> ComponentId -> ShowS #

show :: ComponentId -> String #

showList :: [ComponentId] -> ShowS #

IsString ComponentId #

mkComponentId

Since: 2.0.0.2

Instance details

Defined in Distribution.Types.ComponentId

Methods

fromString :: String -> ComponentId #

Generic ComponentId # 
Instance details

Defined in Distribution.Types.ComponentId

Associated Types

type Rep ComponentId :: * -> * #

Methods

from :: ComponentId -> Rep ComponentId x #

to :: Rep ComponentId x -> ComponentId #

Binary ComponentId # 
Instance details

Defined in Distribution.Types.ComponentId

Methods

put :: ComponentId -> Put #

get :: Get ComponentId #

putList :: [ComponentId] -> Put #

NFData ComponentId # 
Instance details

Defined in Distribution.Types.ComponentId

Methods

rnf :: ComponentId -> () #

Pretty ComponentId # 
Instance details

Defined in Distribution.Types.ComponentId

Methods

pretty :: ComponentId -> Doc #

Parsec ComponentId # 
Instance details

Defined in Distribution.Types.ComponentId

Methods

parsec :: CabalParsing m => m ComponentId #

Text ComponentId # 
Instance details

Defined in Distribution.Types.ComponentId

Methods

disp :: ComponentId -> Doc #

parse :: ReadP r ComponentId #

type Rep ComponentId # 
Instance details

Defined in Distribution.Types.ComponentId

type Rep ComponentId = D1 (MetaData "ComponentId" "Distribution.Types.ComponentId" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "ComponentId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ShortText)))

unComponentId :: ComponentId -> String #

Convert ComponentId to String

Since: 2.0.0.2

mkComponentId :: String -> ComponentId #

Construct a ComponentId from a String

mkComponentId is the inverse to unComponentId

Note: No validations are performed to ensure that the resulting + ComponentId is valid

Since: 2.0.0.2

diff --git a/doc/API/Cabal/Distribution-Types-ComponentInclude.html b/doc/API/Cabal/Distribution-Types-ComponentInclude.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-ComponentInclude.html @@ -0,0 +1,2 @@ +Distribution.Types.ComponentInclude

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.ComponentInclude

Synopsis

Documentation

data ComponentInclude id rn #

Constructors

ComponentInclude 

Fields

ci_id :: ComponentInclude id rn -> id #

ci_pkgid :: ComponentInclude id rn -> PackageId #

ci_cname :: ComponentInclude id rn -> ComponentName #

This should always return CLibName or CSubLibName

diff --git a/doc/API/Cabal/Distribution-Types-ComponentLocalBuildInfo.html b/doc/API/Cabal/Distribution-Types-ComponentLocalBuildInfo.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-ComponentLocalBuildInfo.html @@ -0,0 +1,88 @@ +Distribution.Types.ComponentLocalBuildInfo

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.ComponentLocalBuildInfo

Synopsis

Documentation

data ComponentLocalBuildInfo #

The first five fields are common across all algebraic variants.

Constructors

LibComponentLocalBuildInfo 

Fields

FLibComponentLocalBuildInfo 

Fields

ExeComponentLocalBuildInfo 

Fields

TestComponentLocalBuildInfo 

Fields

BenchComponentLocalBuildInfo 

Fields

Instances
Read ComponentLocalBuildInfo # 
Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Methods

readsPrec :: Int -> ReadS ComponentLocalBuildInfo #

readList :: ReadS [ComponentLocalBuildInfo] #

readPrec :: ReadPrec ComponentLocalBuildInfo #

readListPrec :: ReadPrec [ComponentLocalBuildInfo] #

Show ComponentLocalBuildInfo # 
Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Methods

showsPrec :: Int -> ComponentLocalBuildInfo -> ShowS #

show :: ComponentLocalBuildInfo -> String #

showList :: [ComponentLocalBuildInfo] -> ShowS #

Generic ComponentLocalBuildInfo # 
Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Associated Types

type Rep ComponentLocalBuildInfo :: * -> * #

Methods

from :: ComponentLocalBuildInfo -> Rep ComponentLocalBuildInfo x #

to :: Rep ComponentLocalBuildInfo x -> ComponentLocalBuildInfo #

Binary ComponentLocalBuildInfo # 
Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Methods

put :: ComponentLocalBuildInfo -> Put #

get :: Get ComponentLocalBuildInfo #

putList :: [ComponentLocalBuildInfo] -> Put #

IsNode ComponentLocalBuildInfo # 
Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Associated Types

type Key ComponentLocalBuildInfo :: * #

Methods

nodeKey :: ComponentLocalBuildInfo -> Key ComponentLocalBuildInfo #

nodeNeighbors :: ComponentLocalBuildInfo -> [Key ComponentLocalBuildInfo] #

type Rep ComponentLocalBuildInfo # 
Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

type Rep ComponentLocalBuildInfo = D1 (MetaData "ComponentLocalBuildInfo" "Distribution.Types.ComponentLocalBuildInfo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "LibComponentLocalBuildInfo" PrefixI True) (((S1 (MetaSel (Just "componentLocalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: (S1 (MetaSel (Just "componentComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Just "componentUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId))) :*: (S1 (MetaSel (Just "componentIsIndefinite_") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: (S1 (MetaSel (Just "componentInstantiatedWith") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(ModuleName, OpenModule)]) :*: S1 (MetaSel (Just "componentPackageDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnitId, MungedPackageId)])))) :*: ((S1 (MetaSel (Just "componentIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)]) :*: (S1 (MetaSel (Just "componentExeDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]) :*: S1 (MetaSel (Just "componentInternalDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]))) :*: ((S1 (MetaSel (Just "componentCompatPackageKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "componentCompatPackageName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MungedPackageName)) :*: (S1 (MetaSel (Just "componentExposedModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ExposedModule]) :*: S1 (MetaSel (Just "componentIsPublic") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))) :+: C1 (MetaCons "FLibComponentLocalBuildInfo" PrefixI True) ((S1 (MetaSel (Just "componentLocalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: (S1 (MetaSel (Just "componentComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Just "componentUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId))) :*: ((S1 (MetaSel (Just "componentPackageDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 (MetaSel (Just "componentIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 (MetaSel (Just "componentExeDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]) :*: S1 (MetaSel (Just "componentInternalDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]))))) :+: (C1 (MetaCons "ExeComponentLocalBuildInfo" PrefixI True) ((S1 (MetaSel (Just "componentLocalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: (S1 (MetaSel (Just "componentComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Just "componentUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId))) :*: ((S1 (MetaSel (Just "componentPackageDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 (MetaSel (Just "componentIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 (MetaSel (Just "componentExeDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]) :*: S1 (MetaSel (Just "componentInternalDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId])))) :+: (C1 (MetaCons "TestComponentLocalBuildInfo" PrefixI True) ((S1 (MetaSel (Just "componentLocalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: (S1 (MetaSel (Just "componentComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Just "componentUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId))) :*: ((S1 (MetaSel (Just "componentPackageDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 (MetaSel (Just "componentIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 (MetaSel (Just "componentExeDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]) :*: S1 (MetaSel (Just "componentInternalDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId])))) :+: C1 (MetaCons "BenchComponentLocalBuildInfo" PrefixI True) ((S1 (MetaSel (Just "componentLocalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: (S1 (MetaSel (Just "componentComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Just "componentUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId))) :*: ((S1 (MetaSel (Just "componentPackageDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 (MetaSel (Just "componentIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 (MetaSel (Just "componentExeDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]) :*: S1 (MetaSel (Just "componentInternalDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId])))))))
type Key ComponentLocalBuildInfo # 
Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

type Key ComponentLocalBuildInfo = UnitId

componentIsIndefinite :: ComponentLocalBuildInfo -> Bool #

maybeComponentInstantiatedWith :: ComponentLocalBuildInfo -> Maybe [(ModuleName, OpenModule)] #

diff --git a/doc/API/Cabal/Distribution-Types-ComponentName.html b/doc/API/Cabal/Distribution-Types-ComponentName.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-ComponentName.html @@ -0,0 +1,5 @@ +Distribution.Types.ComponentName

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.ComponentName

Synopsis

Documentation

data ComponentName #

Constructors

CLibName 
CSubLibName UnqualComponentName 
CFLibName UnqualComponentName 
CExeName UnqualComponentName 
CTestName UnqualComponentName 
CBenchName UnqualComponentName 
Instances
Eq ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

(==) :: ComponentName -> ComponentName -> Bool #

(/=) :: ComponentName -> ComponentName -> Bool #

Ord ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

compare :: ComponentName -> ComponentName -> Ordering #

(<) :: ComponentName -> ComponentName -> Bool #

(<=) :: ComponentName -> ComponentName -> Bool #

(>) :: ComponentName -> ComponentName -> Bool #

(>=) :: ComponentName -> ComponentName -> Bool #

max :: ComponentName -> ComponentName -> ComponentName #

min :: ComponentName -> ComponentName -> ComponentName #

Read ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

readsPrec :: Int -> ReadS ComponentName #

readList :: ReadS [ComponentName] #

readPrec :: ReadPrec ComponentName #

readListPrec :: ReadPrec [ComponentName] #

Show ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

showsPrec :: Int -> ComponentName -> ShowS #

show :: ComponentName -> String #

showList :: [ComponentName] -> ShowS #

Generic ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Associated Types

type Rep ComponentName :: * -> * #

Methods

from :: ComponentName -> Rep ComponentName x #

to :: Rep ComponentName x -> ComponentName #

Binary ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

put :: ComponentName -> Put #

get :: Get ComponentName #

putList :: [ComponentName] -> Put #

Pretty ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

pretty :: ComponentName -> Doc #

Text ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

disp :: ComponentName -> Doc #

parse :: ReadP r ComponentName #

type Rep ComponentName # 
Instance details

Defined in Distribution.Types.ComponentName

type Rep ComponentName = D1 (MetaData "ComponentName" "Distribution.Types.ComponentName" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "CLibName" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CSubLibName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)) :+: C1 (MetaCons "CFLibName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)))) :+: (C1 (MetaCons "CExeName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)) :+: (C1 (MetaCons "CTestName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)) :+: C1 (MetaCons "CBenchName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)))))

defaultLibName :: ComponentName #

libraryComponentName :: Maybe UnqualComponentName -> ComponentName #

Convert the UnqualComponentName of a library into a + ComponentName.

showComponentName :: ComponentName -> String #

componentNameStanza :: ComponentName -> String #

componentNameString :: ComponentName -> Maybe UnqualComponentName #

This gets the underlying unqualified component name. In fact, it is + guaranteed to uniquely identify a component, returning + Nothing if the ComponentName was for the public + library.

diff --git a/doc/API/Cabal/Distribution-Types-ComponentRequestedSpec.html b/doc/API/Cabal/Distribution-Types-ComponentRequestedSpec.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-ComponentRequestedSpec.html @@ -0,0 +1,27 @@ +Distribution.Types.ComponentRequestedSpec

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.ComponentRequestedSpec

Synopsis

Documentation

Note: Buildable versus requested versus enabled components

What's the difference between a buildable component (ala + componentBuildable), a requested component + (ala componentNameRequested), and an enabled component (ala + componentEnabled)?

A component is buildable if, after resolving flags and + conditionals, there is no buildable: False property in it. + This is a static property that arises from the + Cabal file and the package description flattening; once we have + a PackageDescription buildability is known.

A component is requested if a user specified, via a + the flags and arguments passed to configure, that it should be + built. E.g., --enable-tests or --enable-benchmarks request + all tests and benchmarks, if they are provided. What is requested + can be read off directly from ComponentRequestedSpec. A requested + component is not always buildable; e.g., a user may --enable-tests + but one of the test suites may have buildable: False.

A component is enabled if it is BOTH buildable + and requested. Once we have a LocalBuildInfo, whether or not a + component is enabled is known.

Generally speaking, most Cabal API code cares if a component + is enabled. (For example, if you want to run a preprocessor on each + component prior to building them, you want to run this on each + enabled component.)

Note that post-configuration, you will generally not see a + non-buildable Component. This is because flattenPD will drop + any such components from PackageDescription. See #3858 for + an example where this causes problems.

data ComponentRequestedSpec #

Describes what components are enabled by user-interaction. + See also this note in + Distribution.Types.ComponentRequestedSpec.

Since: 2.0.0.2

Constructors

ComponentRequestedSpec 

Fields

OneComponentRequestedSpec ComponentName 
Instances
Eq ComponentRequestedSpec # 
Instance details

Defined in Distribution.Types.ComponentRequestedSpec

Methods

(==) :: ComponentRequestedSpec -> ComponentRequestedSpec -> Bool #

(/=) :: ComponentRequestedSpec -> ComponentRequestedSpec -> Bool #

Read ComponentRequestedSpec # 
Instance details

Defined in Distribution.Types.ComponentRequestedSpec

Methods

readsPrec :: Int -> ReadS ComponentRequestedSpec #

readList :: ReadS [ComponentRequestedSpec] #

readPrec :: ReadPrec ComponentRequestedSpec #

readListPrec :: ReadPrec [ComponentRequestedSpec] #

Show ComponentRequestedSpec # 
Instance details

Defined in Distribution.Types.ComponentRequestedSpec

Methods

showsPrec :: Int -> ComponentRequestedSpec -> ShowS #

show :: ComponentRequestedSpec -> String #

showList :: [ComponentRequestedSpec] -> ShowS #

Generic ComponentRequestedSpec # 
Instance details

Defined in Distribution.Types.ComponentRequestedSpec

Associated Types

type Rep ComponentRequestedSpec :: * -> * #

Methods

from :: ComponentRequestedSpec -> Rep ComponentRequestedSpec x #

to :: Rep ComponentRequestedSpec x -> ComponentRequestedSpec #

Binary ComponentRequestedSpec # 
Instance details

Defined in Distribution.Types.ComponentRequestedSpec

Methods

put :: ComponentRequestedSpec -> Put #

get :: Get ComponentRequestedSpec #

putList :: [ComponentRequestedSpec] -> Put #

type Rep ComponentRequestedSpec # 
Instance details

Defined in Distribution.Types.ComponentRequestedSpec

type Rep ComponentRequestedSpec = D1 (MetaData "ComponentRequestedSpec" "Distribution.Types.ComponentRequestedSpec" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ComponentRequestedSpec" PrefixI True) (S1 (MetaSel (Just "testsRequested") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "benchmarksRequested") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :+: C1 (MetaCons "OneComponentRequestedSpec" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName)))

data ComponentDisabledReason #

A reason explaining why a component is disabled.

Since: 2.0.0.2

Constructors

DisabledComponent 
DisabledAllTests 
DisabledAllBenchmarks 
DisabledAllButOne String 

defaultComponentRequestedSpec :: ComponentRequestedSpec #

The default set of enabled components. Historically tests and + benchmarks are NOT enabled by default.

Since: 2.0.0.2

componentNameRequested :: ComponentRequestedSpec -> ComponentName -> Bool #

Is this component name enabled? See also this note in + Distribution.Types.ComponentRequestedSpec.

Since: 2.0.0.2

componentEnabled :: ComponentRequestedSpec -> Component -> Bool #

Is this component enabled? See also this note in + Distribution.Types.ComponentRequestedSpec.

Since: 2.0.0.2

componentDisabledReason :: ComponentRequestedSpec -> Component -> Maybe ComponentDisabledReason #

Is this component disabled, and if so, why?

Since: 2.0.0.2

diff --git a/doc/API/Cabal/Distribution-Types-CondTree.html b/doc/API/Cabal/Distribution-Types-CondTree.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-CondTree.html @@ -0,0 +1,23 @@ +Distribution.Types.CondTree

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.CondTree

Synopsis

Documentation

data CondTree v c a #

A CondTree is used to represent the conditional structure of + a Cabal file, reflecting a syntax element subject to constraints, + and then any number of sub-elements which may be enabled subject + to some condition. Both a and c are usually Monoids.

To be more concrete, consider the following fragment of a Cabal + file:

build-depends: base >= 4.0
+if flag(extra)
+    build-depends: base >= 4.2
+

One way to represent this is to have CondTree ConfVar + [Dependency] BuildInfo. Here, condTreeData represents + the actual fields which are not behind any conditional, while + condTreeComponents recursively records any further fields + which are behind a conditional. condTreeConstraints records + the constraints (in this case, base >= 4.0) which would + be applied if you use this syntax; in general, this is + derived off of targetBuildInfo (perhaps a good refactoring + would be to convert this into an opaque type, with a smart + constructor that pre-computes the dependencies.)

Constructors

CondNode 

Fields

Instances
Functor (CondTree v c) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

fmap :: (a -> b) -> CondTree v c a -> CondTree v c b #

(<$) :: a -> CondTree v c b -> CondTree v c a #

Foldable (CondTree v c) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

fold :: Monoid m => CondTree v c m -> m #

foldMap :: Monoid m => (a -> m) -> CondTree v c a -> m #

foldr :: (a -> b -> b) -> b -> CondTree v c a -> b #

foldr' :: (a -> b -> b) -> b -> CondTree v c a -> b #

foldl :: (b -> a -> b) -> b -> CondTree v c a -> b #

foldl' :: (b -> a -> b) -> b -> CondTree v c a -> b #

foldr1 :: (a -> a -> a) -> CondTree v c a -> a #

foldl1 :: (a -> a -> a) -> CondTree v c a -> a #

toList :: CondTree v c a -> [a] #

null :: CondTree v c a -> Bool #

length :: CondTree v c a -> Int #

elem :: Eq a => a -> CondTree v c a -> Bool #

maximum :: Ord a => CondTree v c a -> a #

minimum :: Ord a => CondTree v c a -> a #

sum :: Num a => CondTree v c a -> a #

product :: Num a => CondTree v c a -> a #

Traversable (CondTree v c) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

traverse :: Applicative f => (a -> f b) -> CondTree v c a -> f (CondTree v c b) #

sequenceA :: Applicative f => CondTree v c (f a) -> f (CondTree v c a) #

mapM :: Monad m => (a -> m b) -> CondTree v c a -> m (CondTree v c b) #

sequence :: Monad m => CondTree v c (m a) -> m (CondTree v c a) #

(Eq a, Eq c, Eq v) => Eq (CondTree v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

(==) :: CondTree v c a -> CondTree v c a -> Bool #

(/=) :: CondTree v c a -> CondTree v c a -> Bool #

(Data v, Data c, Data a) => Data (CondTree v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

gfoldl :: (forall d b. Data d => c0 (d -> b) -> d -> c0 b) -> (forall g. g -> c0 g) -> CondTree v c a -> c0 (CondTree v c a) #

gunfold :: (forall b r. Data b => c0 (b -> r) -> c0 r) -> (forall r. r -> c0 r) -> Constr -> c0 (CondTree v c a) #

toConstr :: CondTree v c a -> Constr #

dataTypeOf :: CondTree v c a -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c0 (t d)) -> Maybe (c0 (CondTree v c a)) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c0 (t d e)) -> Maybe (c0 (CondTree v c a)) #

gmapT :: (forall b. Data b => b -> b) -> CondTree v c a -> CondTree v c a #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CondTree v c a -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CondTree v c a -> r #

gmapQ :: (forall d. Data d => d -> u) -> CondTree v c a -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CondTree v c a -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CondTree v c a -> m (CondTree v c a) #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CondTree v c a -> m (CondTree v c a) #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CondTree v c a -> m (CondTree v c a) #

(Show a, Show c, Show v) => Show (CondTree v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

showsPrec :: Int -> CondTree v c a -> ShowS #

show :: CondTree v c a -> String #

showList :: [CondTree v c a] -> ShowS #

Generic (CondTree v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Associated Types

type Rep (CondTree v c a) :: * -> * #

Methods

from :: CondTree v c a -> Rep (CondTree v c a) x #

to :: Rep (CondTree v c a) x -> CondTree v c a #

(Binary v, Binary c, Binary a) => Binary (CondTree v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

put :: CondTree v c a -> Put #

get :: Get (CondTree v c a) #

putList :: [CondTree v c a] -> Put #

(NFData v, NFData c, NFData a) => NFData (CondTree v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

rnf :: CondTree v c a -> () #

type Rep (CondTree v c a) # 
Instance details

Defined in Distribution.Types.CondTree

type Rep (CondTree v c a) = D1 (MetaData "CondTree" "Distribution.Types.CondTree" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "CondNode" PrefixI True) (S1 (MetaSel (Just "condTreeData") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a) :*: (S1 (MetaSel (Just "condTreeConstraints") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 c) :*: S1 (MetaSel (Just "condTreeComponents") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [CondBranch v c a]))))

data CondBranch v c a #

A CondBranch represents a conditional branch, e.g., if + flag(foo) on some syntax a. It also has an optional false + branch.

Constructors

CondBranch 

Fields

Instances
Functor (CondBranch v c) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

fmap :: (a -> b) -> CondBranch v c a -> CondBranch v c b #

(<$) :: a -> CondBranch v c b -> CondBranch v c a #

Foldable (CondBranch v c) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

fold :: Monoid m => CondBranch v c m -> m #

foldMap :: Monoid m => (a -> m) -> CondBranch v c a -> m #

foldr :: (a -> b -> b) -> b -> CondBranch v c a -> b #

foldr' :: (a -> b -> b) -> b -> CondBranch v c a -> b #

foldl :: (b -> a -> b) -> b -> CondBranch v c a -> b #

foldl' :: (b -> a -> b) -> b -> CondBranch v c a -> b #

foldr1 :: (a -> a -> a) -> CondBranch v c a -> a #

foldl1 :: (a -> a -> a) -> CondBranch v c a -> a #

toList :: CondBranch v c a -> [a] #

null :: CondBranch v c a -> Bool #

length :: CondBranch v c a -> Int #

elem :: Eq a => a -> CondBranch v c a -> Bool #

maximum :: Ord a => CondBranch v c a -> a #

minimum :: Ord a => CondBranch v c a -> a #

sum :: Num a => CondBranch v c a -> a #

product :: Num a => CondBranch v c a -> a #

Traversable (CondBranch v c) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

traverse :: Applicative f => (a -> f b) -> CondBranch v c a -> f (CondBranch v c b) #

sequenceA :: Applicative f => CondBranch v c (f a) -> f (CondBranch v c a) #

mapM :: Monad m => (a -> m b) -> CondBranch v c a -> m (CondBranch v c b) #

sequence :: Monad m => CondBranch v c (m a) -> m (CondBranch v c a) #

(Eq v, Eq a, Eq c) => Eq (CondBranch v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

(==) :: CondBranch v c a -> CondBranch v c a -> Bool #

(/=) :: CondBranch v c a -> CondBranch v c a -> Bool #

(Data v, Data c, Data a) => Data (CondBranch v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

gfoldl :: (forall d b. Data d => c0 (d -> b) -> d -> c0 b) -> (forall g. g -> c0 g) -> CondBranch v c a -> c0 (CondBranch v c a) #

gunfold :: (forall b r. Data b => c0 (b -> r) -> c0 r) -> (forall r. r -> c0 r) -> Constr -> c0 (CondBranch v c a) #

toConstr :: CondBranch v c a -> Constr #

dataTypeOf :: CondBranch v c a -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c0 (t d)) -> Maybe (c0 (CondBranch v c a)) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c0 (t d e)) -> Maybe (c0 (CondBranch v c a)) #

gmapT :: (forall b. Data b => b -> b) -> CondBranch v c a -> CondBranch v c a #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CondBranch v c a -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CondBranch v c a -> r #

gmapQ :: (forall d. Data d => d -> u) -> CondBranch v c a -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CondBranch v c a -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CondBranch v c a -> m (CondBranch v c a) #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CondBranch v c a -> m (CondBranch v c a) #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CondBranch v c a -> m (CondBranch v c a) #

(Show v, Show a, Show c) => Show (CondBranch v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

showsPrec :: Int -> CondBranch v c a -> ShowS #

show :: CondBranch v c a -> String #

showList :: [CondBranch v c a] -> ShowS #

Generic (CondBranch v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Associated Types

type Rep (CondBranch v c a) :: * -> * #

Methods

from :: CondBranch v c a -> Rep (CondBranch v c a) x #

to :: Rep (CondBranch v c a) x -> CondBranch v c a #

(Binary v, Binary c, Binary a) => Binary (CondBranch v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

put :: CondBranch v c a -> Put #

get :: Get (CondBranch v c a) #

putList :: [CondBranch v c a] -> Put #

(NFData v, NFData c, NFData a) => NFData (CondBranch v c a) # 
Instance details

Defined in Distribution.Types.CondTree

Methods

rnf :: CondBranch v c a -> () #

type Rep (CondBranch v c a) # 
Instance details

Defined in Distribution.Types.CondTree

type Rep (CondBranch v c a) = D1 (MetaData "CondBranch" "Distribution.Types.CondTree" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "CondBranch" PrefixI True) (S1 (MetaSel (Just "condBranchCondition") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Condition v)) :*: (S1 (MetaSel (Just "condBranchIfTrue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (CondTree v c a)) :*: S1 (MetaSel (Just "condBranchIfFalse") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (CondTree v c a))))))

condIfThen :: Condition v -> CondTree v c a -> CondBranch v c a #

condIfThenElse :: Condition v -> CondTree v c a -> CondTree v c a -> CondBranch v c a #

mapCondTree :: (a -> b) -> (c -> d) -> (Condition v -> Condition w) -> CondTree v c a -> CondTree w d b #

mapTreeConstrs :: (c -> d) -> CondTree v c a -> CondTree v d a #

mapTreeConds :: (Condition v -> Condition w) -> CondTree v c a -> CondTree w c a #

mapTreeData :: (a -> b) -> CondTree v c a -> CondTree v c b #

traverseCondTreeV :: Traversal (CondTree v c a) (CondTree w c a) v w #

@Traversal@ for the variables

traverseCondBranchV :: Traversal (CondBranch v c a) (CondBranch w c a) v w #

@Traversal@ for the variables

traverseCondTreeC :: Traversal (CondTree v c a) (CondTree v d a) c d #

@Traversal@ for the aggregated constraints

traverseCondBranchC :: Traversal (CondBranch v c a) (CondBranch v d a) c d #

@Traversal@ for the aggregated constraints

extractCondition :: Eq v => (a -> Bool) -> CondTree v c a -> Condition v #

Extract the condition matched by the given predicate from a cond tree.

We use this mainly for extracting buildable conditions (see the Note above), + but the function is in fact more general.

simplifyCondTree :: (Monoid a, Monoid d) => (v -> Either v Bool) -> CondTree v d a -> (d, a) #

Flattens a CondTree using a partial flag assignment. When a condition + cannot be evaluated, both branches are ignored.

ignoreConditions :: (Monoid a, Monoid c) => CondTree v c a -> (a, c) #

Flatten a CondTree. This will resolve the CondTree by taking all + possible paths into account. Note that since branches represent exclusive + choices this may not result in a "sane" result.

diff --git a/doc/API/Cabal/Distribution-Types-Condition.html b/doc/API/Cabal/Distribution-Types-Condition.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-Condition.html @@ -0,0 +1,1 @@ +Distribution.Types.Condition

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.Condition

Synopsis

Documentation

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
Monad Condition # 
Instance details

Defined in Distribution.Types.Condition

Methods

(>>=) :: Condition a -> (a -> Condition b) -> Condition b #

(>>) :: Condition a -> Condition b -> Condition b #

return :: a -> Condition a #

fail :: String -> Condition a #

Functor Condition # 
Instance details

Defined in Distribution.Types.Condition

Methods

fmap :: (a -> b) -> Condition a -> Condition b #

(<$) :: a -> Condition b -> Condition a #

Applicative Condition # 
Instance details

Defined in Distribution.Types.Condition

Methods

pure :: a -> Condition a #

(<*>) :: Condition (a -> b) -> Condition a -> Condition b #

liftA2 :: (a -> b -> c) -> Condition a -> Condition b -> Condition c #

(*>) :: Condition a -> Condition b -> Condition b #

(<*) :: Condition a -> Condition b -> Condition a #

Foldable Condition # 
Instance details

Defined in Distribution.Types.Condition

Methods

fold :: Monoid m => Condition m -> m #

foldMap :: Monoid m => (a -> m) -> Condition a -> m #

foldr :: (a -> b -> b) -> b -> Condition a -> b #

foldr' :: (a -> b -> b) -> b -> Condition a -> b #

foldl :: (b -> a -> b) -> b -> Condition a -> b #

foldl' :: (b -> a -> b) -> b -> Condition a -> b #

foldr1 :: (a -> a -> a) -> Condition a -> a #

foldl1 :: (a -> a -> a) -> Condition a -> a #

toList :: Condition a -> [a] #

null :: Condition a -> Bool #

length :: Condition a -> Int #

elem :: Eq a => a -> Condition a -> Bool #

maximum :: Ord a => Condition a -> a #

minimum :: Ord a => Condition a -> a #

sum :: Num a => Condition a -> a #

product :: Num a => Condition a -> a #

Traversable Condition # 
Instance details

Defined in Distribution.Types.Condition

Methods

traverse :: Applicative f => (a -> f b) -> Condition a -> f (Condition b) #

sequenceA :: Applicative f => Condition (f a) -> f (Condition a) #

mapM :: Monad m => (a -> m b) -> Condition a -> m (Condition b) #

sequence :: Monad m => Condition (m a) -> m (Condition a) #

Alternative Condition # 
Instance details

Defined in Distribution.Types.Condition

Methods

empty :: Condition a #

(<|>) :: Condition a -> Condition a -> Condition a #

some :: Condition a -> Condition [a] #

many :: Condition a -> Condition [a] #

MonadPlus Condition # 
Instance details

Defined in Distribution.Types.Condition

Methods

mzero :: Condition a #

mplus :: Condition a -> Condition a -> Condition a #

Eq c => Eq (Condition c) # 
Instance details

Defined in Distribution.Types.Condition

Methods

(==) :: Condition c -> Condition c -> Bool #

(/=) :: Condition c -> Condition c -> Bool #

Data c => Data (Condition c) # 
Instance details

Defined in Distribution.Types.Condition

Methods

gfoldl :: (forall d b. Data d => c0 (d -> b) -> d -> c0 b) -> (forall g. g -> c0 g) -> Condition c -> c0 (Condition c) #

gunfold :: (forall b r. Data b => c0 (b -> r) -> c0 r) -> (forall r. r -> c0 r) -> Constr -> c0 (Condition c) #

toConstr :: Condition c -> Constr #

dataTypeOf :: Condition c -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c0 (t d)) -> Maybe (c0 (Condition c)) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c0 (t d e)) -> Maybe (c0 (Condition c)) #

gmapT :: (forall b. Data b => b -> b) -> Condition c -> Condition c #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Condition c -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Condition c -> r #

gmapQ :: (forall d. Data d => d -> u) -> Condition c -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Condition c -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Condition c -> m (Condition c) #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Condition c -> m (Condition c) #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Condition c -> m (Condition c) #

Show c => Show (Condition c) # 
Instance details

Defined in Distribution.Types.Condition

Methods

showsPrec :: Int -> Condition c -> ShowS #

show :: Condition c -> String #

showList :: [Condition c] -> ShowS #

Generic (Condition c) # 
Instance details

Defined in Distribution.Types.Condition

Associated Types

type Rep (Condition c) :: * -> * #

Methods

from :: Condition c -> Rep (Condition c) x #

to :: Rep (Condition c) x -> Condition c #

Semigroup (Condition a) # 
Instance details

Defined in Distribution.Types.Condition

Methods

(<>) :: Condition a -> Condition a -> Condition a #

sconcat :: NonEmpty (Condition a) -> Condition a #

stimes :: Integral b => b -> Condition a -> Condition a #

Monoid (Condition a) # 
Instance details

Defined in Distribution.Types.Condition

Methods

mempty :: Condition a #

mappend :: Condition a -> Condition a -> Condition a #

mconcat :: [Condition a] -> Condition a #

Binary c => Binary (Condition c) # 
Instance details

Defined in Distribution.Types.Condition

Methods

put :: Condition c -> Put #

get :: Get (Condition c) #

putList :: [Condition c] -> Put #

NFData c => NFData (Condition c) # 
Instance details

Defined in Distribution.Types.Condition

Methods

rnf :: Condition c -> () #

type Rep (Condition c) # 
Instance details

Defined in Distribution.Types.Condition

type Rep (Condition c) = D1 (MetaData "Condition" "Distribution.Types.Condition" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "Var" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 c)) :+: C1 (MetaCons "Lit" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :+: (C1 (MetaCons "CNot" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Condition c))) :+: (C1 (MetaCons "COr" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Condition c)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Condition c))) :+: C1 (MetaCons "CAnd" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Condition c)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Condition c))))))

cNot :: Condition a -> Condition a #

Boolean negation of a Condition value.

cAnd :: Condition a -> Condition a -> Condition a #

Boolean AND of two Condtion values.

cOr :: Eq v => Condition v -> Condition v -> Condition v #

Boolean OR of two Condition values.

simplifyCondition #

Arguments

:: Condition c 
-> (c -> Either d Bool)

(partial) variable assignment

-> (Condition d, [d]) 

Simplify the condition and return its free variables.

diff --git a/doc/API/Cabal/Distribution-Types-Dependency.html b/doc/API/Cabal/Distribution-Types-Dependency.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-Dependency.html @@ -0,0 +1,2 @@ +Distribution.Types.Dependency

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.Dependency

Synopsis

Documentation

data Dependency #

Describes a dependency on a source package (API)

Constructors

Dependency PackageName VersionRange 
Instances
Eq Dependency # 
Instance details

Defined in Distribution.Types.Dependency

Methods

(==) :: Dependency -> Dependency -> Bool #

(/=) :: Dependency -> Dependency -> Bool #

Data Dependency # 
Instance details

Defined in Distribution.Types.Dependency

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Dependency -> c Dependency #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Dependency #

toConstr :: Dependency -> Constr #

dataTypeOf :: Dependency -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Dependency) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Dependency) #

gmapT :: (forall b. Data b => b -> b) -> Dependency -> Dependency #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Dependency -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Dependency -> r #

gmapQ :: (forall d. Data d => d -> u) -> Dependency -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Dependency -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Dependency -> m Dependency #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Dependency -> m Dependency #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Dependency -> m Dependency #

Read Dependency # 
Instance details

Defined in Distribution.Types.Dependency

Methods

readsPrec :: Int -> ReadS Dependency #

readList :: ReadS [Dependency] #

readPrec :: ReadPrec Dependency #

readListPrec :: ReadPrec [Dependency] #

Show Dependency # 
Instance details

Defined in Distribution.Types.Dependency

Methods

showsPrec :: Int -> Dependency -> ShowS #

show :: Dependency -> String #

showList :: [Dependency] -> ShowS #

Generic Dependency # 
Instance details

Defined in Distribution.Types.Dependency

Associated Types

type Rep Dependency :: * -> * #

Methods

from :: Dependency -> Rep Dependency x #

to :: Rep Dependency x -> Dependency #

Binary Dependency # 
Instance details

Defined in Distribution.Types.Dependency

Methods

put :: Dependency -> Put #

get :: Get Dependency #

putList :: [Dependency] -> Put #

NFData Dependency # 
Instance details

Defined in Distribution.Types.Dependency

Methods

rnf :: Dependency -> () #

Pretty Dependency # 
Instance details

Defined in Distribution.Types.Dependency

Methods

pretty :: Dependency -> Doc #

Parsec Dependency # 
Instance details

Defined in Distribution.Types.Dependency

Methods

parsec :: CabalParsing m => m Dependency #

Text Dependency # 
Instance details

Defined in Distribution.Types.Dependency

Methods

disp :: Dependency -> Doc #

parse :: ReadP r Dependency #

type Rep Dependency # 
Instance details

Defined in Distribution.Types.Dependency

type Rep Dependency = D1 (MetaData "Dependency" "Distribution.Types.Dependency" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Dependency" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageName) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange)))

depPkgName :: Dependency -> PackageName #

depVerRange :: Dependency -> VersionRange #

thisPackageVersion :: PackageIdentifier -> Dependency #

notThisPackageVersion :: PackageIdentifier -> Dependency #

simplifyDependency :: Dependency -> Dependency #

Simplify the VersionRange expression in a Dependency. + See simplifyVersionRange.

diff --git a/doc/API/Cabal/Distribution-Types-DependencyMap.html b/doc/API/Cabal/Distribution-Types-DependencyMap.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-DependencyMap.html @@ -0,0 +1,2 @@ +Distribution.Types.DependencyMap

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.DependencyMap

Synopsis

Documentation

data DependencyMap #

A map of dependencies. Newtyped since the default monoid instance is not + appropriate. The monoid instance uses intersectVersionRanges.

Instances
Read DependencyMap # 
Instance details

Defined in Distribution.Types.DependencyMap

Methods

readsPrec :: Int -> ReadS DependencyMap #

readList :: ReadS [DependencyMap] #

readPrec :: ReadPrec DependencyMap #

readListPrec :: ReadPrec [DependencyMap] #

Show DependencyMap # 
Instance details

Defined in Distribution.Types.DependencyMap

Methods

showsPrec :: Int -> DependencyMap -> ShowS #

show :: DependencyMap -> String #

showList :: [DependencyMap] -> ShowS #

Semigroup DependencyMap # 
Instance details

Defined in Distribution.Types.DependencyMap

Methods

(<>) :: DependencyMap -> DependencyMap -> DependencyMap #

sconcat :: NonEmpty DependencyMap -> DependencyMap #

stimes :: Integral b => b -> DependencyMap -> DependencyMap #

Monoid DependencyMap # 
Instance details

Defined in Distribution.Types.DependencyMap

Methods

mempty :: DependencyMap #

mappend :: DependencyMap -> DependencyMap -> DependencyMap #

mconcat :: [DependencyMap] -> DependencyMap #

toDepMap :: [Dependency] -> DependencyMap #

fromDepMap :: DependencyMap -> [Dependency] #

constrainBy #

Arguments

:: DependencyMap

Input map

-> DependencyMap

Extra constraints

-> DependencyMap 
diff --git a/doc/API/Cabal/Distribution-Types-ExeDependency.html b/doc/API/Cabal/Distribution-Types-ExeDependency.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-ExeDependency.html @@ -0,0 +1,1 @@ +Distribution.Types.ExeDependency

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.ExeDependency

Synopsis

Documentation

data ExeDependency #

Describes a dependency on an executable from a package

Constructors

ExeDependency PackageName UnqualComponentName VersionRange 
Instances
Eq ExeDependency # 
Instance details

Defined in Distribution.Types.ExeDependency

Methods

(==) :: ExeDependency -> ExeDependency -> Bool #

(/=) :: ExeDependency -> ExeDependency -> Bool #

Data ExeDependency # 
Instance details

Defined in Distribution.Types.ExeDependency

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExeDependency -> c ExeDependency #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExeDependency #

toConstr :: ExeDependency -> Constr #

dataTypeOf :: ExeDependency -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ExeDependency) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExeDependency) #

gmapT :: (forall b. Data b => b -> b) -> ExeDependency -> ExeDependency #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExeDependency -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExeDependency -> r #

gmapQ :: (forall d. Data d => d -> u) -> ExeDependency -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExeDependency -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExeDependency -> m ExeDependency #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExeDependency -> m ExeDependency #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExeDependency -> m ExeDependency #

Read ExeDependency # 
Instance details

Defined in Distribution.Types.ExeDependency

Methods

readsPrec :: Int -> ReadS ExeDependency #

readList :: ReadS [ExeDependency] #

readPrec :: ReadPrec ExeDependency #

readListPrec :: ReadPrec [ExeDependency] #

Show ExeDependency # 
Instance details

Defined in Distribution.Types.ExeDependency

Methods

showsPrec :: Int -> ExeDependency -> ShowS #

show :: ExeDependency -> String #

showList :: [ExeDependency] -> ShowS #

Generic ExeDependency # 
Instance details

Defined in Distribution.Types.ExeDependency

Associated Types

type Rep ExeDependency :: * -> * #

Methods

from :: ExeDependency -> Rep ExeDependency x #

to :: Rep ExeDependency x -> ExeDependency #

Binary ExeDependency # 
Instance details

Defined in Distribution.Types.ExeDependency

Methods

put :: ExeDependency -> Put #

get :: Get ExeDependency #

putList :: [ExeDependency] -> Put #

NFData ExeDependency # 
Instance details

Defined in Distribution.Types.ExeDependency

Methods

rnf :: ExeDependency -> () #

Pretty ExeDependency # 
Instance details

Defined in Distribution.Types.ExeDependency

Methods

pretty :: ExeDependency -> Doc #

Parsec ExeDependency # 
Instance details

Defined in Distribution.Types.ExeDependency

Methods

parsec :: CabalParsing m => m ExeDependency #

Text ExeDependency # 
Instance details

Defined in Distribution.Types.ExeDependency

Methods

disp :: ExeDependency -> Doc #

parse :: ReadP r ExeDependency #

type Rep ExeDependency # 
Instance details

Defined in Distribution.Types.ExeDependency

type Rep ExeDependency = D1 (MetaData "ExeDependency" "Distribution.Types.ExeDependency" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ExeDependency" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageName) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange))))

qualifiedExeName :: ExeDependency -> ComponentName #

diff --git a/doc/API/Cabal/Distribution-Types-Executable-Lens.html b/doc/API/Cabal/Distribution-Types-Executable-Lens.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-Executable-Lens.html @@ -0,0 +1,1 @@ +Distribution.Types.Executable.Lens

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.Executable.Lens

Documentation

data Executable #

Instances
Eq Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

(==) :: Executable -> Executable -> Bool #

(/=) :: Executable -> Executable -> Bool #

Data Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Executable -> c Executable #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Executable #

toConstr :: Executable -> Constr #

dataTypeOf :: Executable -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Executable) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Executable) #

gmapT :: (forall b. Data b => b -> b) -> Executable -> Executable #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Executable -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Executable -> r #

gmapQ :: (forall d. Data d => d -> u) -> Executable -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Executable -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Executable -> m Executable #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Executable -> m Executable #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Executable -> m Executable #

Read Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

readsPrec :: Int -> ReadS Executable #

readList :: ReadS [Executable] #

readPrec :: ReadPrec Executable #

readListPrec :: ReadPrec [Executable] #

Show Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

showsPrec :: Int -> Executable -> ShowS #

show :: Executable -> String #

showList :: [Executable] -> ShowS #

Generic Executable # 
Instance details

Defined in Distribution.Types.Executable

Associated Types

type Rep Executable :: * -> * #

Methods

from :: Executable -> Rep Executable x #

to :: Rep Executable x -> Executable #

Semigroup Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

(<>) :: Executable -> Executable -> Executable #

sconcat :: NonEmpty Executable -> Executable #

stimes :: Integral b => b -> Executable -> Executable #

Monoid Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

mempty :: Executable #

mappend :: Executable -> Executable -> Executable #

mconcat :: [Executable] -> Executable #

Binary Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

put :: Executable -> Put #

get :: Get Executable #

putList :: [Executable] -> Put #

NFData Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

rnf :: Executable -> () #

HasBuildInfo Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

buildInfo :: Lens' Executable BuildInfo #

buildable :: Lens' Executable Bool #

buildTools :: Lens' Executable [LegacyExeDependency] #

buildToolDepends :: Lens' Executable [ExeDependency] #

cppOptions :: Lens' Executable [String] #

asmOptions :: Lens' Executable [String] #

cmmOptions :: Lens' Executable [String] #

ccOptions :: Lens' Executable [String] #

cxxOptions :: Lens' Executable [String] #

ldOptions :: Lens' Executable [String] #

pkgconfigDepends :: Lens' Executable [PkgconfigDependency] #

frameworks :: Lens' Executable [String] #

extraFrameworkDirs :: Lens' Executable [String] #

asmSources :: Lens' Executable [FilePath] #

cmmSources :: Lens' Executable [FilePath] #

cSources :: Lens' Executable [FilePath] #

cxxSources :: Lens' Executable [FilePath] #

jsSources :: Lens' Executable [FilePath] #

hsSourceDirs :: Lens' Executable [FilePath] #

otherModules :: Lens' Executable [ModuleName] #

virtualModules :: Lens' Executable [ModuleName] #

autogenModules :: Lens' Executable [ModuleName] #

defaultLanguage :: Lens' Executable (Maybe Language) #

otherLanguages :: Lens' Executable [Language] #

defaultExtensions :: Lens' Executable [Extension] #

otherExtensions :: Lens' Executable [Extension] #

oldExtensions :: Lens' Executable [Extension] #

extraLibs :: Lens' Executable [String] #

extraGHCiLibs :: Lens' Executable [String] #

extraBundledLibs :: Lens' Executable [String] #

extraLibFlavours :: Lens' Executable [String] #

extraLibDirs :: Lens' Executable [String] #

includeDirs :: Lens' Executable [FilePath] #

includes :: Lens' Executable [FilePath] #

installIncludes :: Lens' Executable [FilePath] #

options :: Lens' Executable [(CompilerFlavor, [String])] #

profOptions :: Lens' Executable [(CompilerFlavor, [String])] #

sharedOptions :: Lens' Executable [(CompilerFlavor, [String])] #

staticOptions :: Lens' Executable [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' Executable [(String, String)] #

targetBuildDepends :: Lens' Executable [Dependency] #

mixins :: Lens' Executable [Mixin] #

type Rep Executable # 
Instance details

Defined in Distribution.Types.Executable

type Rep Executable = D1 (MetaData "Executable" "Distribution.Types.Executable" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Executable" PrefixI True) ((S1 (MetaSel (Just "exeName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName) :*: S1 (MetaSel (Just "modulePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :*: (S1 (MetaSel (Just "exeScope") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ExecutableScope) :*: S1 (MetaSel (Just "buildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BuildInfo))))

exeName :: Lens' Executable UnqualComponentName #

modulePath :: Lens' Executable String #

exeScope :: Lens' Executable ExecutableScope #

exeBuildInfo :: Lens' Executable BuildInfo #

diff --git a/doc/API/Cabal/Distribution-Types-Executable.html b/doc/API/Cabal/Distribution-Types-Executable.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-Executable.html @@ -0,0 +1,2 @@ +Distribution.Types.Executable

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.Executable

Synopsis

Documentation

data Executable #

Constructors

Executable 

Fields

Instances
Eq Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

(==) :: Executable -> Executable -> Bool #

(/=) :: Executable -> Executable -> Bool #

Data Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Executable -> c Executable #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Executable #

toConstr :: Executable -> Constr #

dataTypeOf :: Executable -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Executable) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Executable) #

gmapT :: (forall b. Data b => b -> b) -> Executable -> Executable #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Executable -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Executable -> r #

gmapQ :: (forall d. Data d => d -> u) -> Executable -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Executable -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Executable -> m Executable #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Executable -> m Executable #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Executable -> m Executable #

Read Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

readsPrec :: Int -> ReadS Executable #

readList :: ReadS [Executable] #

readPrec :: ReadPrec Executable #

readListPrec :: ReadPrec [Executable] #

Show Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

showsPrec :: Int -> Executable -> ShowS #

show :: Executable -> String #

showList :: [Executable] -> ShowS #

Generic Executable # 
Instance details

Defined in Distribution.Types.Executable

Associated Types

type Rep Executable :: * -> * #

Methods

from :: Executable -> Rep Executable x #

to :: Rep Executable x -> Executable #

Semigroup Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

(<>) :: Executable -> Executable -> Executable #

sconcat :: NonEmpty Executable -> Executable #

stimes :: Integral b => b -> Executable -> Executable #

Monoid Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

mempty :: Executable #

mappend :: Executable -> Executable -> Executable #

mconcat :: [Executable] -> Executable #

Binary Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

put :: Executable -> Put #

get :: Get Executable #

putList :: [Executable] -> Put #

NFData Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

rnf :: Executable -> () #

HasBuildInfo Executable # 
Instance details

Defined in Distribution.Types.Executable

Methods

buildInfo :: Lens' Executable BuildInfo #

buildable :: Lens' Executable Bool #

buildTools :: Lens' Executable [LegacyExeDependency] #

buildToolDepends :: Lens' Executable [ExeDependency] #

cppOptions :: Lens' Executable [String] #

asmOptions :: Lens' Executable [String] #

cmmOptions :: Lens' Executable [String] #

ccOptions :: Lens' Executable [String] #

cxxOptions :: Lens' Executable [String] #

ldOptions :: Lens' Executable [String] #

pkgconfigDepends :: Lens' Executable [PkgconfigDependency] #

frameworks :: Lens' Executable [String] #

extraFrameworkDirs :: Lens' Executable [String] #

asmSources :: Lens' Executable [FilePath] #

cmmSources :: Lens' Executable [FilePath] #

cSources :: Lens' Executable [FilePath] #

cxxSources :: Lens' Executable [FilePath] #

jsSources :: Lens' Executable [FilePath] #

hsSourceDirs :: Lens' Executable [FilePath] #

otherModules :: Lens' Executable [ModuleName] #

virtualModules :: Lens' Executable [ModuleName] #

autogenModules :: Lens' Executable [ModuleName] #

defaultLanguage :: Lens' Executable (Maybe Language) #

otherLanguages :: Lens' Executable [Language] #

defaultExtensions :: Lens' Executable [Extension] #

otherExtensions :: Lens' Executable [Extension] #

oldExtensions :: Lens' Executable [Extension] #

extraLibs :: Lens' Executable [String] #

extraGHCiLibs :: Lens' Executable [String] #

extraBundledLibs :: Lens' Executable [String] #

extraLibFlavours :: Lens' Executable [String] #

extraLibDirs :: Lens' Executable [String] #

includeDirs :: Lens' Executable [FilePath] #

includes :: Lens' Executable [FilePath] #

installIncludes :: Lens' Executable [FilePath] #

options :: Lens' Executable [(CompilerFlavor, [String])] #

profOptions :: Lens' Executable [(CompilerFlavor, [String])] #

sharedOptions :: Lens' Executable [(CompilerFlavor, [String])] #

staticOptions :: Lens' Executable [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' Executable [(String, String)] #

targetBuildDepends :: Lens' Executable [Dependency] #

mixins :: Lens' Executable [Mixin] #

type Rep Executable # 
Instance details

Defined in Distribution.Types.Executable

type Rep Executable = D1 (MetaData "Executable" "Distribution.Types.Executable" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Executable" PrefixI True) ((S1 (MetaSel (Just "exeName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName) :*: S1 (MetaSel (Just "modulePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :*: (S1 (MetaSel (Just "exeScope") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ExecutableScope) :*: S1 (MetaSel (Just "buildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BuildInfo))))

emptyExecutable :: Executable #

exeModules :: Executable -> [ModuleName] #

Get all the module names from an exe

exeModulesAutogen :: Executable -> [ModuleName] #

Get all the auto generated module names from an exe + This are a subset of exeModules.

diff --git a/doc/API/Cabal/Distribution-Types-ExecutableScope.html b/doc/API/Cabal/Distribution-Types-ExecutableScope.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-ExecutableScope.html @@ -0,0 +1,1 @@ +Distribution.Types.ExecutableScope

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.ExecutableScope

Documentation

data ExecutableScope #

Constructors

ExecutablePublic 
ExecutablePrivate 
Instances
Eq ExecutableScope # 
Instance details

Defined in Distribution.Types.ExecutableScope

Methods

(==) :: ExecutableScope -> ExecutableScope -> Bool #

(/=) :: ExecutableScope -> ExecutableScope -> Bool #

Data ExecutableScope # 
Instance details

Defined in Distribution.Types.ExecutableScope

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExecutableScope -> c ExecutableScope #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExecutableScope #

toConstr :: ExecutableScope -> Constr #

dataTypeOf :: ExecutableScope -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ExecutableScope) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExecutableScope) #

gmapT :: (forall b. Data b => b -> b) -> ExecutableScope -> ExecutableScope #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExecutableScope -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExecutableScope -> r #

gmapQ :: (forall d. Data d => d -> u) -> ExecutableScope -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExecutableScope -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExecutableScope -> m ExecutableScope #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutableScope -> m ExecutableScope #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutableScope -> m ExecutableScope #

Read ExecutableScope # 
Instance details

Defined in Distribution.Types.ExecutableScope

Methods

readsPrec :: Int -> ReadS ExecutableScope #

readList :: ReadS [ExecutableScope] #

readPrec :: ReadPrec ExecutableScope #

readListPrec :: ReadPrec [ExecutableScope] #

Show ExecutableScope # 
Instance details

Defined in Distribution.Types.ExecutableScope

Methods

showsPrec :: Int -> ExecutableScope -> ShowS #

show :: ExecutableScope -> String #

showList :: [ExecutableScope] -> ShowS #

Generic ExecutableScope # 
Instance details

Defined in Distribution.Types.ExecutableScope

Associated Types

type Rep ExecutableScope :: * -> * #

Methods

from :: ExecutableScope -> Rep ExecutableScope x #

to :: Rep ExecutableScope x -> ExecutableScope #

Semigroup ExecutableScope #

Any like semigroup, where ExecutablePrivate is 'Any True'

Instance details

Defined in Distribution.Types.ExecutableScope

Methods

(<>) :: ExecutableScope -> ExecutableScope -> ExecutableScope #

sconcat :: NonEmpty ExecutableScope -> ExecutableScope #

stimes :: Integral b => b -> ExecutableScope -> ExecutableScope #

Monoid ExecutableScope #

mempty = ExecutablePublic

Instance details

Defined in Distribution.Types.ExecutableScope

Methods

mempty :: ExecutableScope #

mappend :: ExecutableScope -> ExecutableScope -> ExecutableScope #

mconcat :: [ExecutableScope] -> ExecutableScope #

Binary ExecutableScope # 
Instance details

Defined in Distribution.Types.ExecutableScope

Methods

put :: ExecutableScope -> Put #

get :: Get ExecutableScope #

putList :: [ExecutableScope] -> Put #

NFData ExecutableScope # 
Instance details

Defined in Distribution.Types.ExecutableScope

Methods

rnf :: ExecutableScope -> () #

Pretty ExecutableScope # 
Instance details

Defined in Distribution.Types.ExecutableScope

Methods

pretty :: ExecutableScope -> Doc #

Parsec ExecutableScope # 
Instance details

Defined in Distribution.Types.ExecutableScope

Methods

parsec :: CabalParsing m => m ExecutableScope #

Text ExecutableScope # 
Instance details

Defined in Distribution.Types.ExecutableScope

Methods

disp :: ExecutableScope -> Doc #

parse :: ReadP r ExecutableScope #

type Rep ExecutableScope # 
Instance details

Defined in Distribution.Types.ExecutableScope

type Rep ExecutableScope = D1 (MetaData "ExecutableScope" "Distribution.Types.ExecutableScope" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ExecutablePublic" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ExecutablePrivate" PrefixI False) (U1 :: * -> *))
diff --git a/doc/API/Cabal/Distribution-Types-ExposedModule.html b/doc/API/Cabal/Distribution-Types-ExposedModule.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-ExposedModule.html @@ -0,0 +1,1 @@ +Distribution.Types.ExposedModule

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.ExposedModule

Documentation

data ExposedModule #

Constructors

ExposedModule 

Fields

Instances
Eq ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

(==) :: ExposedModule -> ExposedModule -> Bool #

(/=) :: ExposedModule -> ExposedModule -> Bool #

Read ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

readsPrec :: Int -> ReadS ExposedModule #

readList :: ReadS [ExposedModule] #

readPrec :: ReadPrec ExposedModule #

readListPrec :: ReadPrec [ExposedModule] #

Show ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

showsPrec :: Int -> ExposedModule -> ShowS #

show :: ExposedModule -> String #

showList :: [ExposedModule] -> ShowS #

Generic ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Associated Types

type Rep ExposedModule :: * -> * #

Methods

from :: ExposedModule -> Rep ExposedModule x #

to :: Rep ExposedModule x -> ExposedModule #

Binary ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

put :: ExposedModule -> Put #

get :: Get ExposedModule #

putList :: [ExposedModule] -> Put #

NFData ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

rnf :: ExposedModule -> () #

Pretty ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

pretty :: ExposedModule -> Doc #

Parsec ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

parsec :: CabalParsing m => m ExposedModule #

Text ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

disp :: ExposedModule -> Doc #

parse :: ReadP r ExposedModule #

type Rep ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

type Rep ExposedModule = D1 (MetaData "ExposedModule" "Distribution.Types.ExposedModule" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ExposedModule" PrefixI True) (S1 (MetaSel (Just "exposedName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleName) :*: S1 (MetaSel (Just "exposedReexport") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe OpenModule))))
diff --git a/doc/API/Cabal/Distribution-Types-ForeignLib-Lens.html b/doc/API/Cabal/Distribution-Types-ForeignLib-Lens.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-ForeignLib-Lens.html @@ -0,0 +1,2 @@ +Distribution.Types.ForeignLib.Lens

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.ForeignLib.Lens

Synopsis

Documentation

data ForeignLib #

A foreign library stanza is like a library stanza, except that + the built code is intended for consumption by a non-Haskell client.

Instances
Eq ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

(==) :: ForeignLib -> ForeignLib -> Bool #

(/=) :: ForeignLib -> ForeignLib -> Bool #

Data ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ForeignLib -> c ForeignLib #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ForeignLib #

toConstr :: ForeignLib -> Constr #

dataTypeOf :: ForeignLib -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ForeignLib) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ForeignLib) #

gmapT :: (forall b. Data b => b -> b) -> ForeignLib -> ForeignLib #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ForeignLib -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ForeignLib -> r #

gmapQ :: (forall d. Data d => d -> u) -> ForeignLib -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ForeignLib -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ForeignLib -> m ForeignLib #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ForeignLib -> m ForeignLib #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ForeignLib -> m ForeignLib #

Read ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

readsPrec :: Int -> ReadS ForeignLib #

readList :: ReadS [ForeignLib] #

readPrec :: ReadPrec ForeignLib #

readListPrec :: ReadPrec [ForeignLib] #

Show ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

showsPrec :: Int -> ForeignLib -> ShowS #

show :: ForeignLib -> String #

showList :: [ForeignLib] -> ShowS #

Generic ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Associated Types

type Rep ForeignLib :: * -> * #

Methods

from :: ForeignLib -> Rep ForeignLib x #

to :: Rep ForeignLib x -> ForeignLib #

Semigroup ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

(<>) :: ForeignLib -> ForeignLib -> ForeignLib #

sconcat :: NonEmpty ForeignLib -> ForeignLib #

stimes :: Integral b => b -> ForeignLib -> ForeignLib #

Monoid ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

mempty :: ForeignLib #

mappend :: ForeignLib -> ForeignLib -> ForeignLib #

mconcat :: [ForeignLib] -> ForeignLib #

Binary ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

put :: ForeignLib -> Put #

get :: Get ForeignLib #

putList :: [ForeignLib] -> Put #

NFData ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

rnf :: ForeignLib -> () #

HasBuildInfo ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

buildInfo :: Lens' ForeignLib BuildInfo #

buildable :: Lens' ForeignLib Bool #

buildTools :: Lens' ForeignLib [LegacyExeDependency] #

buildToolDepends :: Lens' ForeignLib [ExeDependency] #

cppOptions :: Lens' ForeignLib [String] #

asmOptions :: Lens' ForeignLib [String] #

cmmOptions :: Lens' ForeignLib [String] #

ccOptions :: Lens' ForeignLib [String] #

cxxOptions :: Lens' ForeignLib [String] #

ldOptions :: Lens' ForeignLib [String] #

pkgconfigDepends :: Lens' ForeignLib [PkgconfigDependency] #

frameworks :: Lens' ForeignLib [String] #

extraFrameworkDirs :: Lens' ForeignLib [String] #

asmSources :: Lens' ForeignLib [FilePath] #

cmmSources :: Lens' ForeignLib [FilePath] #

cSources :: Lens' ForeignLib [FilePath] #

cxxSources :: Lens' ForeignLib [FilePath] #

jsSources :: Lens' ForeignLib [FilePath] #

hsSourceDirs :: Lens' ForeignLib [FilePath] #

otherModules :: Lens' ForeignLib [ModuleName] #

virtualModules :: Lens' ForeignLib [ModuleName] #

autogenModules :: Lens' ForeignLib [ModuleName] #

defaultLanguage :: Lens' ForeignLib (Maybe Language) #

otherLanguages :: Lens' ForeignLib [Language] #

defaultExtensions :: Lens' ForeignLib [Extension] #

otherExtensions :: Lens' ForeignLib [Extension] #

oldExtensions :: Lens' ForeignLib [Extension] #

extraLibs :: Lens' ForeignLib [String] #

extraGHCiLibs :: Lens' ForeignLib [String] #

extraBundledLibs :: Lens' ForeignLib [String] #

extraLibFlavours :: Lens' ForeignLib [String] #

extraLibDirs :: Lens' ForeignLib [String] #

includeDirs :: Lens' ForeignLib [FilePath] #

includes :: Lens' ForeignLib [FilePath] #

installIncludes :: Lens' ForeignLib [FilePath] #

options :: Lens' ForeignLib [(CompilerFlavor, [String])] #

profOptions :: Lens' ForeignLib [(CompilerFlavor, [String])] #

sharedOptions :: Lens' ForeignLib [(CompilerFlavor, [String])] #

staticOptions :: Lens' ForeignLib [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' ForeignLib [(String, String)] #

targetBuildDepends :: Lens' ForeignLib [Dependency] #

mixins :: Lens' ForeignLib [Mixin] #

type Rep ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

type Rep ForeignLib = D1 (MetaData "ForeignLib" "Distribution.Types.ForeignLib" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ForeignLib" PrefixI True) ((S1 (MetaSel (Just "foreignLibName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName) :*: (S1 (MetaSel (Just "foreignLibType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ForeignLibType) :*: S1 (MetaSel (Just "foreignLibOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ForeignLibOption]))) :*: ((S1 (MetaSel (Just "foreignLibBuildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BuildInfo) :*: S1 (MetaSel (Just "foreignLibVersionInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe LibVersionInfo))) :*: (S1 (MetaSel (Just "foreignLibVersionLinux") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Version)) :*: S1 (MetaSel (Just "foreignLibModDefFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))))

foreignLibName :: Lens' ForeignLib UnqualComponentName #

foreignLibType :: Lens' ForeignLib ForeignLibType #

foreignLibOptions :: Lens' ForeignLib [ForeignLibOption] #

foreignLibBuildInfo :: Lens' ForeignLib BuildInfo #

foreignLibVersionInfo :: Lens' ForeignLib (Maybe LibVersionInfo) #

foreignLibVersionLinux :: Lens' ForeignLib (Maybe Version) #

foreignLibModDefFile :: Lens' ForeignLib [FilePath] #

diff --git a/doc/API/Cabal/Distribution-Types-ForeignLib.html b/doc/API/Cabal/Distribution-Types-ForeignLib.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-ForeignLib.html @@ -0,0 +1,14 @@ +Distribution.Types.ForeignLib

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.ForeignLib

Synopsis

Documentation

data ForeignLib #

A foreign library stanza is like a library stanza, except that + the built code is intended for consumption by a non-Haskell client.

Constructors

ForeignLib 

Fields

Instances
Eq ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

(==) :: ForeignLib -> ForeignLib -> Bool #

(/=) :: ForeignLib -> ForeignLib -> Bool #

Data ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ForeignLib -> c ForeignLib #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ForeignLib #

toConstr :: ForeignLib -> Constr #

dataTypeOf :: ForeignLib -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ForeignLib) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ForeignLib) #

gmapT :: (forall b. Data b => b -> b) -> ForeignLib -> ForeignLib #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ForeignLib -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ForeignLib -> r #

gmapQ :: (forall d. Data d => d -> u) -> ForeignLib -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ForeignLib -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ForeignLib -> m ForeignLib #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ForeignLib -> m ForeignLib #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ForeignLib -> m ForeignLib #

Read ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

readsPrec :: Int -> ReadS ForeignLib #

readList :: ReadS [ForeignLib] #

readPrec :: ReadPrec ForeignLib #

readListPrec :: ReadPrec [ForeignLib] #

Show ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

showsPrec :: Int -> ForeignLib -> ShowS #

show :: ForeignLib -> String #

showList :: [ForeignLib] -> ShowS #

Generic ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Associated Types

type Rep ForeignLib :: * -> * #

Methods

from :: ForeignLib -> Rep ForeignLib x #

to :: Rep ForeignLib x -> ForeignLib #

Semigroup ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

(<>) :: ForeignLib -> ForeignLib -> ForeignLib #

sconcat :: NonEmpty ForeignLib -> ForeignLib #

stimes :: Integral b => b -> ForeignLib -> ForeignLib #

Monoid ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

mempty :: ForeignLib #

mappend :: ForeignLib -> ForeignLib -> ForeignLib #

mconcat :: [ForeignLib] -> ForeignLib #

Binary ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

put :: ForeignLib -> Put #

get :: Get ForeignLib #

putList :: [ForeignLib] -> Put #

NFData ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

rnf :: ForeignLib -> () #

HasBuildInfo ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

buildInfo :: Lens' ForeignLib BuildInfo #

buildable :: Lens' ForeignLib Bool #

buildTools :: Lens' ForeignLib [LegacyExeDependency] #

buildToolDepends :: Lens' ForeignLib [ExeDependency] #

cppOptions :: Lens' ForeignLib [String] #

asmOptions :: Lens' ForeignLib [String] #

cmmOptions :: Lens' ForeignLib [String] #

ccOptions :: Lens' ForeignLib [String] #

cxxOptions :: Lens' ForeignLib [String] #

ldOptions :: Lens' ForeignLib [String] #

pkgconfigDepends :: Lens' ForeignLib [PkgconfigDependency] #

frameworks :: Lens' ForeignLib [String] #

extraFrameworkDirs :: Lens' ForeignLib [String] #

asmSources :: Lens' ForeignLib [FilePath] #

cmmSources :: Lens' ForeignLib [FilePath] #

cSources :: Lens' ForeignLib [FilePath] #

cxxSources :: Lens' ForeignLib [FilePath] #

jsSources :: Lens' ForeignLib [FilePath] #

hsSourceDirs :: Lens' ForeignLib [FilePath] #

otherModules :: Lens' ForeignLib [ModuleName] #

virtualModules :: Lens' ForeignLib [ModuleName] #

autogenModules :: Lens' ForeignLib [ModuleName] #

defaultLanguage :: Lens' ForeignLib (Maybe Language) #

otherLanguages :: Lens' ForeignLib [Language] #

defaultExtensions :: Lens' ForeignLib [Extension] #

otherExtensions :: Lens' ForeignLib [Extension] #

oldExtensions :: Lens' ForeignLib [Extension] #

extraLibs :: Lens' ForeignLib [String] #

extraGHCiLibs :: Lens' ForeignLib [String] #

extraBundledLibs :: Lens' ForeignLib [String] #

extraLibFlavours :: Lens' ForeignLib [String] #

extraLibDirs :: Lens' ForeignLib [String] #

includeDirs :: Lens' ForeignLib [FilePath] #

includes :: Lens' ForeignLib [FilePath] #

installIncludes :: Lens' ForeignLib [FilePath] #

options :: Lens' ForeignLib [(CompilerFlavor, [String])] #

profOptions :: Lens' ForeignLib [(CompilerFlavor, [String])] #

sharedOptions :: Lens' ForeignLib [(CompilerFlavor, [String])] #

staticOptions :: Lens' ForeignLib [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' ForeignLib [(String, String)] #

targetBuildDepends :: Lens' ForeignLib [Dependency] #

mixins :: Lens' ForeignLib [Mixin] #

type Rep ForeignLib # 
Instance details

Defined in Distribution.Types.ForeignLib

type Rep ForeignLib = D1 (MetaData "ForeignLib" "Distribution.Types.ForeignLib" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ForeignLib" PrefixI True) ((S1 (MetaSel (Just "foreignLibName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName) :*: (S1 (MetaSel (Just "foreignLibType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ForeignLibType) :*: S1 (MetaSel (Just "foreignLibOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ForeignLibOption]))) :*: ((S1 (MetaSel (Just "foreignLibBuildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BuildInfo) :*: S1 (MetaSel (Just "foreignLibVersionInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe LibVersionInfo))) :*: (S1 (MetaSel (Just "foreignLibVersionLinux") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Version)) :*: S1 (MetaSel (Just "foreignLibModDefFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))))

emptyForeignLib :: ForeignLib #

An empty foreign library.

foreignLibModules :: ForeignLib -> [ModuleName] #

Modules defined by a foreign library.

foreignLibIsShared :: ForeignLib -> Bool #

Is the foreign library shared?

foreignLibVersion :: ForeignLib -> OS -> [Int] #

Get a version number for a foreign library. + If we're on Linux, and a Linux version is specified, use that. + If we're on Linux, and libtool-style version-info is specified, translate + that field into appropriate version numbers. + Otherwise, this feature is unsupported so we don't return any version data.

data LibVersionInfo #

Instances
Eq LibVersionInfo # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

(==) :: LibVersionInfo -> LibVersionInfo -> Bool #

(/=) :: LibVersionInfo -> LibVersionInfo -> Bool #

Data LibVersionInfo # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LibVersionInfo -> c LibVersionInfo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LibVersionInfo #

toConstr :: LibVersionInfo -> Constr #

dataTypeOf :: LibVersionInfo -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LibVersionInfo) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LibVersionInfo) #

gmapT :: (forall b. Data b => b -> b) -> LibVersionInfo -> LibVersionInfo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LibVersionInfo -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LibVersionInfo -> r #

gmapQ :: (forall d. Data d => d -> u) -> LibVersionInfo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LibVersionInfo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LibVersionInfo -> m LibVersionInfo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LibVersionInfo -> m LibVersionInfo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LibVersionInfo -> m LibVersionInfo #

Ord LibVersionInfo # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

compare :: LibVersionInfo -> LibVersionInfo -> Ordering #

(<) :: LibVersionInfo -> LibVersionInfo -> Bool #

(<=) :: LibVersionInfo -> LibVersionInfo -> Bool #

(>) :: LibVersionInfo -> LibVersionInfo -> Bool #

(>=) :: LibVersionInfo -> LibVersionInfo -> Bool #

max :: LibVersionInfo -> LibVersionInfo -> LibVersionInfo #

min :: LibVersionInfo -> LibVersionInfo -> LibVersionInfo #

Read LibVersionInfo # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

readsPrec :: Int -> ReadS LibVersionInfo #

readList :: ReadS [LibVersionInfo] #

readPrec :: ReadPrec LibVersionInfo #

readListPrec :: ReadPrec [LibVersionInfo] #

Show LibVersionInfo # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

showsPrec :: Int -> LibVersionInfo -> ShowS #

show :: LibVersionInfo -> String #

showList :: [LibVersionInfo] -> ShowS #

Generic LibVersionInfo # 
Instance details

Defined in Distribution.Types.ForeignLib

Associated Types

type Rep LibVersionInfo :: * -> * #

Methods

from :: LibVersionInfo -> Rep LibVersionInfo x #

to :: Rep LibVersionInfo x -> LibVersionInfo #

Binary LibVersionInfo # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

put :: LibVersionInfo -> Put #

get :: Get LibVersionInfo #

putList :: [LibVersionInfo] -> Put #

NFData LibVersionInfo # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

rnf :: LibVersionInfo -> () #

Pretty LibVersionInfo # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

pretty :: LibVersionInfo -> Doc #

Parsec LibVersionInfo # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

parsec :: CabalParsing m => m LibVersionInfo #

Text LibVersionInfo # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

disp :: LibVersionInfo -> Doc #

parse :: ReadP r LibVersionInfo #

type Rep LibVersionInfo # 
Instance details

Defined in Distribution.Types.ForeignLib

type Rep LibVersionInfo = D1 (MetaData "LibVersionInfo" "Distribution.Types.ForeignLib" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "LibVersionInfo" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))))

mkLibVersionInfo :: (Int, Int, Int) -> LibVersionInfo #

Construct LibVersionInfo from (current, revision, age) + numbers.

For instance, mkLibVersionInfo (3,0,0) constructs a + LibVersionInfo representing the version-info 3:0:0.

All version components must be non-negative.

libVersionInfoCRA :: LibVersionInfo -> (Int, Int, Int) #

From a given LibVersionInfo, extract the (current, revision, + age) numbers.

libVersionNumber :: LibVersionInfo -> (Int, Int, Int) #

Given a version-info field, produce a major.minor.build version

libVersionNumberShow :: LibVersionInfo -> String #

Given a version-info field, return "major.minor.build" as a + String

libVersionMajor :: LibVersionInfo -> Int #

Return the major version of a version-info field.

diff --git a/doc/API/Cabal/Distribution-Types-ForeignLibOption.html b/doc/API/Cabal/Distribution-Types-ForeignLibOption.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-ForeignLibOption.html @@ -0,0 +1,5 @@ +Distribution.Types.ForeignLibOption

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.ForeignLibOption

Documentation

data ForeignLibOption #

Constructors

ForeignLibStandalone

Merge in all dependent libraries (i.e., use + ghc -shared -static rather than just record + the dependencies, ala ghc -shared -dynamic). + This option is compulsory on Windows and unsupported + on other platforms.

Instances
Eq ForeignLibOption # 
Instance details

Defined in Distribution.Types.ForeignLibOption

Methods

(==) :: ForeignLibOption -> ForeignLibOption -> Bool #

(/=) :: ForeignLibOption -> ForeignLibOption -> Bool #

Data ForeignLibOption # 
Instance details

Defined in Distribution.Types.ForeignLibOption

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ForeignLibOption -> c ForeignLibOption #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ForeignLibOption #

toConstr :: ForeignLibOption -> Constr #

dataTypeOf :: ForeignLibOption -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ForeignLibOption) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ForeignLibOption) #

gmapT :: (forall b. Data b => b -> b) -> ForeignLibOption -> ForeignLibOption #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ForeignLibOption -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ForeignLibOption -> r #

gmapQ :: (forall d. Data d => d -> u) -> ForeignLibOption -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ForeignLibOption -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ForeignLibOption -> m ForeignLibOption #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ForeignLibOption -> m ForeignLibOption #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ForeignLibOption -> m ForeignLibOption #

Read ForeignLibOption # 
Instance details

Defined in Distribution.Types.ForeignLibOption

Methods

readsPrec :: Int -> ReadS ForeignLibOption #

readList :: ReadS [ForeignLibOption] #

readPrec :: ReadPrec ForeignLibOption #

readListPrec :: ReadPrec [ForeignLibOption] #

Show ForeignLibOption # 
Instance details

Defined in Distribution.Types.ForeignLibOption

Methods

showsPrec :: Int -> ForeignLibOption -> ShowS #

show :: ForeignLibOption -> String #

showList :: [ForeignLibOption] -> ShowS #

Generic ForeignLibOption # 
Instance details

Defined in Distribution.Types.ForeignLibOption

Associated Types

type Rep ForeignLibOption :: * -> * #

Methods

from :: ForeignLibOption -> Rep ForeignLibOption x #

to :: Rep ForeignLibOption x -> ForeignLibOption #

Binary ForeignLibOption # 
Instance details

Defined in Distribution.Types.ForeignLibOption

Methods

put :: ForeignLibOption -> Put #

get :: Get ForeignLibOption #

putList :: [ForeignLibOption] -> Put #

NFData ForeignLibOption # 
Instance details

Defined in Distribution.Types.ForeignLibOption

Methods

rnf :: ForeignLibOption -> () #

Pretty ForeignLibOption # 
Instance details

Defined in Distribution.Types.ForeignLibOption

Methods

pretty :: ForeignLibOption -> Doc #

Parsec ForeignLibOption # 
Instance details

Defined in Distribution.Types.ForeignLibOption

Methods

parsec :: CabalParsing m => m ForeignLibOption #

Text ForeignLibOption # 
Instance details

Defined in Distribution.Types.ForeignLibOption

Methods

disp :: ForeignLibOption -> Doc #

parse :: ReadP r ForeignLibOption #

type Rep ForeignLibOption # 
Instance details

Defined in Distribution.Types.ForeignLibOption

type Rep ForeignLibOption = D1 (MetaData "ForeignLibOption" "Distribution.Types.ForeignLibOption" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ForeignLibStandalone" PrefixI False) (U1 :: * -> *))
diff --git a/doc/API/Cabal/Distribution-Types-ForeignLibType.html b/doc/API/Cabal/Distribution-Types-ForeignLibType.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-ForeignLibType.html @@ -0,0 +1,2 @@ +Distribution.Types.ForeignLibType

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.ForeignLibType

Synopsis

Documentation

data ForeignLibType #

What kind of foreign library is to be built?

Constructors

ForeignLibNativeShared

A native shared library (.so on Linux, .dylib on OSX, or + .dll on Windows).

ForeignLibNativeStatic

A native static library (not currently supported.)

ForeignLibTypeUnknown 
Instances
Eq ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

(==) :: ForeignLibType -> ForeignLibType -> Bool #

(/=) :: ForeignLibType -> ForeignLibType -> Bool #

Data ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ForeignLibType -> c ForeignLibType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ForeignLibType #

toConstr :: ForeignLibType -> Constr #

dataTypeOf :: ForeignLibType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ForeignLibType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ForeignLibType) #

gmapT :: (forall b. Data b => b -> b) -> ForeignLibType -> ForeignLibType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ForeignLibType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ForeignLibType -> r #

gmapQ :: (forall d. Data d => d -> u) -> ForeignLibType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ForeignLibType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ForeignLibType -> m ForeignLibType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ForeignLibType -> m ForeignLibType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ForeignLibType -> m ForeignLibType #

Read ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

readsPrec :: Int -> ReadS ForeignLibType #

readList :: ReadS [ForeignLibType] #

readPrec :: ReadPrec ForeignLibType #

readListPrec :: ReadPrec [ForeignLibType] #

Show ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

showsPrec :: Int -> ForeignLibType -> ShowS #

show :: ForeignLibType -> String #

showList :: [ForeignLibType] -> ShowS #

Generic ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Associated Types

type Rep ForeignLibType :: * -> * #

Methods

from :: ForeignLibType -> Rep ForeignLibType x #

to :: Rep ForeignLibType x -> ForeignLibType #

Semigroup ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

(<>) :: ForeignLibType -> ForeignLibType -> ForeignLibType #

sconcat :: NonEmpty ForeignLibType -> ForeignLibType #

stimes :: Integral b => b -> ForeignLibType -> ForeignLibType #

Monoid ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

mempty :: ForeignLibType #

mappend :: ForeignLibType -> ForeignLibType -> ForeignLibType #

mconcat :: [ForeignLibType] -> ForeignLibType #

Binary ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

put :: ForeignLibType -> Put #

get :: Get ForeignLibType #

putList :: [ForeignLibType] -> Put #

NFData ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

rnf :: ForeignLibType -> () #

Pretty ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

pretty :: ForeignLibType -> Doc #

Parsec ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

parsec :: CabalParsing m => m ForeignLibType #

Text ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

disp :: ForeignLibType -> Doc #

parse :: ReadP r ForeignLibType #

type Rep ForeignLibType # 
Instance details

Defined in Distribution.Types.ForeignLibType

type Rep ForeignLibType = D1 (MetaData "ForeignLibType" "Distribution.Types.ForeignLibType" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ForeignLibNativeShared" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ForeignLibNativeStatic" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ForeignLibTypeUnknown" PrefixI False) (U1 :: * -> *)))

knownForeignLibTypes :: [ForeignLibType] #

foreignLibTypeIsShared :: ForeignLibType -> Bool #

diff --git a/doc/API/Cabal/Distribution-Types-GenericPackageDescription-Lens.html b/doc/API/Cabal/Distribution-Types-GenericPackageDescription-Lens.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-GenericPackageDescription-Lens.html @@ -0,0 +1,2 @@ +Distribution.Types.GenericPackageDescription.Lens

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.GenericPackageDescription.Lens

Synopsis

Documentation

data GenericPackageDescription #

Instances
Eq GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(==) :: GenericPackageDescription -> GenericPackageDescription -> Bool #

(/=) :: GenericPackageDescription -> GenericPackageDescription -> Bool #

Data GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GenericPackageDescription -> c GenericPackageDescription #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GenericPackageDescription #

toConstr :: GenericPackageDescription -> Constr #

dataTypeOf :: GenericPackageDescription -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GenericPackageDescription) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GenericPackageDescription) #

gmapT :: (forall b. Data b => b -> b) -> GenericPackageDescription -> GenericPackageDescription #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GenericPackageDescription -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GenericPackageDescription -> r #

gmapQ :: (forall d. Data d => d -> u) -> GenericPackageDescription -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GenericPackageDescription -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GenericPackageDescription -> m GenericPackageDescription #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GenericPackageDescription -> m GenericPackageDescription #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GenericPackageDescription -> m GenericPackageDescription #

Show GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

showsPrec :: Int -> GenericPackageDescription -> ShowS #

show :: GenericPackageDescription -> String #

showList :: [GenericPackageDescription] -> ShowS #

Generic GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Associated Types

type Rep GenericPackageDescription :: * -> * #

Methods

from :: GenericPackageDescription -> Rep GenericPackageDescription x #

to :: Rep GenericPackageDescription x -> GenericPackageDescription #

Binary GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

put :: GenericPackageDescription -> Put #

get :: Get GenericPackageDescription #

putList :: [GenericPackageDescription] -> Put #

NFData GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

rnf :: GenericPackageDescription -> () #

Package GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

packageId :: GenericPackageDescription -> PackageIdentifier #

HasBuildInfos GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

traverseBuildInfos :: Traversal' GenericPackageDescription BuildInfo #

type Rep GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

type Rep GenericPackageDescription = D1 (MetaData "GenericPackageDescription" "Distribution.Types.GenericPackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "GenericPackageDescription" PrefixI True) (((S1 (MetaSel (Just "packageDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageDescription) :*: S1 (MetaSel (Just "genPackageFlags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Flag])) :*: (S1 (MetaSel (Just "condLibrary") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (CondTree ConfVar [Dependency] Library))) :*: S1 (MetaSel (Just "condSubLibraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnqualComponentName, CondTree ConfVar [Dependency] Library)]))) :*: ((S1 (MetaSel (Just "condForeignLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnqualComponentName, CondTree ConfVar [Dependency] ForeignLib)]) :*: S1 (MetaSel (Just "condExecutables") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnqualComponentName, CondTree ConfVar [Dependency] Executable)])) :*: (S1 (MetaSel (Just "condTestSuites") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnqualComponentName, CondTree ConfVar [Dependency] TestSuite)]) :*: S1 (MetaSel (Just "condBenchmarks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnqualComponentName, CondTree ConfVar [Dependency] Benchmark)])))))

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.

Instances
Eq Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(==) :: Flag -> Flag -> Bool #

(/=) :: Flag -> Flag -> Bool #

Data Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Flag -> c Flag #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Flag #

toConstr :: Flag -> Constr #

dataTypeOf :: Flag -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Flag) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Flag) #

gmapT :: (forall b. Data b => b -> b) -> Flag -> Flag #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Flag -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Flag -> r #

gmapQ :: (forall d. Data d => d -> u) -> Flag -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Flag -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Flag -> m Flag #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Flag -> m Flag #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Flag -> m Flag #

Show Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

showsPrec :: Int -> Flag -> ShowS #

show :: Flag -> String #

showList :: [Flag] -> ShowS #

Generic Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Associated Types

type Rep Flag :: * -> * #

Methods

from :: Flag -> Rep Flag x #

to :: Rep Flag x -> Flag #

Binary Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

put :: Flag -> Put #

get :: Get Flag #

putList :: [Flag] -> Put #

NFData Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

rnf :: Flag -> () #

type Rep Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

type Rep Flag = D1 (MetaData "Flag" "Distribution.Types.GenericPackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "MkFlag" PrefixI True) ((S1 (MetaSel (Just "flagName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FlagName) :*: S1 (MetaSel (Just "flagDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :*: (S1 (MetaSel (Just "flagDefault") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "flagManual") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))

data FlagName #

A FlagName is the name of a user-defined configuration flag

Use mkFlagName and unFlagName to convert from/to a String.

This type is opaque since Cabal-2.0

Since: 2.0.0.2

Instances
Eq FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(==) :: FlagName -> FlagName -> Bool #

(/=) :: FlagName -> FlagName -> Bool #

Data FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FlagName -> c FlagName #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FlagName #

toConstr :: FlagName -> Constr #

dataTypeOf :: FlagName -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c FlagName) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FlagName) #

gmapT :: (forall b. Data b => b -> b) -> FlagName -> FlagName #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FlagName -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FlagName -> r #

gmapQ :: (forall d. Data d => d -> u) -> FlagName -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> FlagName -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FlagName -> m FlagName #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FlagName -> m FlagName #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FlagName -> m FlagName #

Ord FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

compare :: FlagName -> FlagName -> Ordering #

(<) :: FlagName -> FlagName -> Bool #

(<=) :: FlagName -> FlagName -> Bool #

(>) :: FlagName -> FlagName -> Bool #

(>=) :: FlagName -> FlagName -> Bool #

max :: FlagName -> FlagName -> FlagName #

min :: FlagName -> FlagName -> FlagName #

Read FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

readsPrec :: Int -> ReadS FlagName #

readList :: ReadS [FlagName] #

readPrec :: ReadPrec FlagName #

readListPrec :: ReadPrec [FlagName] #

Show FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

showsPrec :: Int -> FlagName -> ShowS #

show :: FlagName -> String #

showList :: [FlagName] -> ShowS #

IsString FlagName #

mkFlagName

Since: 2.0.0.2

Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

fromString :: String -> FlagName #

Generic FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Associated Types

type Rep FlagName :: * -> * #

Methods

from :: FlagName -> Rep FlagName x #

to :: Rep FlagName x -> FlagName #

Binary FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

put :: FlagName -> Put #

get :: Get FlagName #

putList :: [FlagName] -> Put #

NFData FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

rnf :: FlagName -> () #

Pretty FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

pretty :: FlagName -> Doc #

Parsec FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

parsec :: CabalParsing m => m FlagName #

Text FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

disp :: FlagName -> Doc #

parse :: ReadP r FlagName #

type Rep FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

type Rep FlagName = D1 (MetaData "FlagName" "Distribution.Types.GenericPackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "FlagName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ShortText)))

data ConfVar #

A ConfVar represents the variable type used.

Constructors

OS OS 
Arch Arch 
Flag FlagName 
Impl CompilerFlavor VersionRange 
Instances
Eq ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(==) :: ConfVar -> ConfVar -> Bool #

(/=) :: ConfVar -> ConfVar -> Bool #

Data ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ConfVar -> c ConfVar #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ConfVar #

toConstr :: ConfVar -> Constr #

dataTypeOf :: ConfVar -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ConfVar) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ConfVar) #

gmapT :: (forall b. Data b => b -> b) -> ConfVar -> ConfVar #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ConfVar -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ConfVar -> r #

gmapQ :: (forall d. Data d => d -> u) -> ConfVar -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ConfVar -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ConfVar -> m ConfVar #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ConfVar -> m ConfVar #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ConfVar -> m ConfVar #

Show ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

showsPrec :: Int -> ConfVar -> ShowS #

show :: ConfVar -> String #

showList :: [ConfVar] -> ShowS #

Generic ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Associated Types

type Rep ConfVar :: * -> * #

Methods

from :: ConfVar -> Rep ConfVar x #

to :: Rep ConfVar x -> ConfVar #

Binary ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

put :: ConfVar -> Put #

get :: Get ConfVar #

putList :: [ConfVar] -> Put #

NFData ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

rnf :: ConfVar -> () #

type Rep ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

type Rep ConfVar = D1 (MetaData "ConfVar" "Distribution.Types.GenericPackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "OS" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OS)) :+: C1 (MetaCons "Arch" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Arch))) :+: (C1 (MetaCons "Flag" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FlagName)) :+: C1 (MetaCons "Impl" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CompilerFlavor) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange))))

condBenchmarks :: Lens' GenericPackageDescription [(UnqualComponentName, CondTree ConfVar [Dependency] Benchmark)] #

condExecutables :: Lens' GenericPackageDescription [(UnqualComponentName, CondTree ConfVar [Dependency] Executable)] #

condForeignLibs :: Lens' GenericPackageDescription [(UnqualComponentName, CondTree ConfVar [Dependency] ForeignLib)] #

condLibrary :: Lens' GenericPackageDescription (Maybe (CondTree ConfVar [Dependency] Library)) #

condSubLibraries :: Lens' GenericPackageDescription [(UnqualComponentName, CondTree ConfVar [Dependency] Library)] #

condTestSuites :: Lens' GenericPackageDescription [(UnqualComponentName, CondTree ConfVar [Dependency] TestSuite)] #

genPackageFlags :: Lens' GenericPackageDescription [Flag] #

packageDescription :: Lens' GenericPackageDescription PackageDescription #

allCondTrees :: Applicative f => (forall a. CondTree ConfVar [Dependency] a -> f (CondTree ConfVar [Dependency] a)) -> GenericPackageDescription -> f GenericPackageDescription #

flagName :: Lens' Flag FlagName #

flagDescription :: Lens' Flag String #

flagDefault :: Lens' Flag Bool #

flagManual :: Lens' Flag Bool #

_OS :: Traversal' ConfVar OS #

_Arch :: Traversal' ConfVar Arch #

_Flag :: Traversal' ConfVar FlagName #

_Impl :: Traversal' ConfVar (CompilerFlavor, VersionRange) #

diff --git a/doc/API/Cabal/Distribution-Types-GenericPackageDescription.html b/doc/API/Cabal/Distribution-Types-GenericPackageDescription.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-GenericPackageDescription.html @@ -0,0 +1,14 @@ +Distribution.Types.GenericPackageDescription

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.GenericPackageDescription

Synopsis

Documentation

data GenericPackageDescription #

Constructors

GenericPackageDescription 

Fields

Instances
Eq GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(==) :: GenericPackageDescription -> GenericPackageDescription -> Bool #

(/=) :: GenericPackageDescription -> GenericPackageDescription -> Bool #

Data GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GenericPackageDescription -> c GenericPackageDescription #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GenericPackageDescription #

toConstr :: GenericPackageDescription -> Constr #

dataTypeOf :: GenericPackageDescription -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GenericPackageDescription) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GenericPackageDescription) #

gmapT :: (forall b. Data b => b -> b) -> GenericPackageDescription -> GenericPackageDescription #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GenericPackageDescription -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GenericPackageDescription -> r #

gmapQ :: (forall d. Data d => d -> u) -> GenericPackageDescription -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GenericPackageDescription -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GenericPackageDescription -> m GenericPackageDescription #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GenericPackageDescription -> m GenericPackageDescription #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GenericPackageDescription -> m GenericPackageDescription #

Show GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

showsPrec :: Int -> GenericPackageDescription -> ShowS #

show :: GenericPackageDescription -> String #

showList :: [GenericPackageDescription] -> ShowS #

Generic GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Associated Types

type Rep GenericPackageDescription :: * -> * #

Methods

from :: GenericPackageDescription -> Rep GenericPackageDescription x #

to :: Rep GenericPackageDescription x -> GenericPackageDescription #

Binary GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

put :: GenericPackageDescription -> Put #

get :: Get GenericPackageDescription #

putList :: [GenericPackageDescription] -> Put #

NFData GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

rnf :: GenericPackageDescription -> () #

Package GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

packageId :: GenericPackageDescription -> PackageIdentifier #

HasBuildInfos GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

traverseBuildInfos :: Traversal' GenericPackageDescription BuildInfo #

type Rep GenericPackageDescription # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

type Rep GenericPackageDescription = D1 (MetaData "GenericPackageDescription" "Distribution.Types.GenericPackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "GenericPackageDescription" PrefixI True) (((S1 (MetaSel (Just "packageDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageDescription) :*: S1 (MetaSel (Just "genPackageFlags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Flag])) :*: (S1 (MetaSel (Just "condLibrary") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (CondTree ConfVar [Dependency] Library))) :*: S1 (MetaSel (Just "condSubLibraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnqualComponentName, CondTree ConfVar [Dependency] Library)]))) :*: ((S1 (MetaSel (Just "condForeignLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnqualComponentName, CondTree ConfVar [Dependency] ForeignLib)]) :*: S1 (MetaSel (Just "condExecutables") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnqualComponentName, CondTree ConfVar [Dependency] Executable)])) :*: (S1 (MetaSel (Just "condTestSuites") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnqualComponentName, CondTree ConfVar [Dependency] TestSuite)]) :*: S1 (MetaSel (Just "condBenchmarks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnqualComponentName, CondTree ConfVar [Dependency] Benchmark)])))))

emptyGenericPackageDescription :: 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 

Fields

Instances
Eq Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(==) :: Flag -> Flag -> Bool #

(/=) :: Flag -> Flag -> Bool #

Data Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Flag -> c Flag #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Flag #

toConstr :: Flag -> Constr #

dataTypeOf :: Flag -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Flag) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Flag) #

gmapT :: (forall b. Data b => b -> b) -> Flag -> Flag #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Flag -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Flag -> r #

gmapQ :: (forall d. Data d => d -> u) -> Flag -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Flag -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Flag -> m Flag #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Flag -> m Flag #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Flag -> m Flag #

Show Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

showsPrec :: Int -> Flag -> ShowS #

show :: Flag -> String #

showList :: [Flag] -> ShowS #

Generic Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Associated Types

type Rep Flag :: * -> * #

Methods

from :: Flag -> Rep Flag x #

to :: Rep Flag x -> Flag #

Binary Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

put :: Flag -> Put #

get :: Get Flag #

putList :: [Flag] -> Put #

NFData Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

rnf :: Flag -> () #

type Rep Flag # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

type Rep Flag = D1 (MetaData "Flag" "Distribution.Types.GenericPackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "MkFlag" PrefixI True) ((S1 (MetaSel (Just "flagName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FlagName) :*: S1 (MetaSel (Just "flagDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :*: (S1 (MetaSel (Just "flagDefault") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "flagManual") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))

emptyFlag :: FlagName -> Flag #

A Flag initialized with default parameters.

data FlagName #

A FlagName is the name of a user-defined configuration flag

Use mkFlagName and unFlagName to convert from/to a String.

This type is opaque since Cabal-2.0

Since: 2.0.0.2

Instances
Eq FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(==) :: FlagName -> FlagName -> Bool #

(/=) :: FlagName -> FlagName -> Bool #

Data FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FlagName -> c FlagName #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FlagName #

toConstr :: FlagName -> Constr #

dataTypeOf :: FlagName -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c FlagName) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FlagName) #

gmapT :: (forall b. Data b => b -> b) -> FlagName -> FlagName #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FlagName -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FlagName -> r #

gmapQ :: (forall d. Data d => d -> u) -> FlagName -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> FlagName -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FlagName -> m FlagName #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FlagName -> m FlagName #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FlagName -> m FlagName #

Ord FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

compare :: FlagName -> FlagName -> Ordering #

(<) :: FlagName -> FlagName -> Bool #

(<=) :: FlagName -> FlagName -> Bool #

(>) :: FlagName -> FlagName -> Bool #

(>=) :: FlagName -> FlagName -> Bool #

max :: FlagName -> FlagName -> FlagName #

min :: FlagName -> FlagName -> FlagName #

Read FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

readsPrec :: Int -> ReadS FlagName #

readList :: ReadS [FlagName] #

readPrec :: ReadPrec FlagName #

readListPrec :: ReadPrec [FlagName] #

Show FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

showsPrec :: Int -> FlagName -> ShowS #

show :: FlagName -> String #

showList :: [FlagName] -> ShowS #

IsString FlagName #

mkFlagName

Since: 2.0.0.2

Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

fromString :: String -> FlagName #

Generic FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Associated Types

type Rep FlagName :: * -> * #

Methods

from :: FlagName -> Rep FlagName x #

to :: Rep FlagName x -> FlagName #

Binary FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

put :: FlagName -> Put #

get :: Get FlagName #

putList :: [FlagName] -> Put #

NFData FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

rnf :: FlagName -> () #

Pretty FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

pretty :: FlagName -> Doc #

Parsec FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

parsec :: CabalParsing m => m FlagName #

Text FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

disp :: FlagName -> Doc #

parse :: ReadP r FlagName #

type Rep FlagName # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

type Rep FlagName = D1 (MetaData "FlagName" "Distribution.Types.GenericPackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "FlagName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ShortText)))

mkFlagName :: String -> FlagName #

Construct a FlagName from a String

mkFlagName is the inverse to unFlagName

Note: No validations are performed to ensure that the resulting + FlagName is valid

Since: 2.0.0.2

unFlagName :: FlagName -> String #

Convert FlagName to String

Since: 2.0.0.2

data FlagAssignment #

A FlagAssignment is a total or partial mapping of FlagNames to + Bool flag values. It represents the flags chosen by the user or + discovered during configuration. For example --flags=foo --flags=-bar + becomes [("foo", True), ("bar", False)]

Instances
Eq FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(==) :: FlagAssignment -> FlagAssignment -> Bool #

(/=) :: FlagAssignment -> FlagAssignment -> Bool #

Ord FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

compare :: FlagAssignment -> FlagAssignment -> Ordering #

(<) :: FlagAssignment -> FlagAssignment -> Bool #

(<=) :: FlagAssignment -> FlagAssignment -> Bool #

(>) :: FlagAssignment -> FlagAssignment -> Bool #

(>=) :: FlagAssignment -> FlagAssignment -> Bool #

max :: FlagAssignment -> FlagAssignment -> FlagAssignment #

min :: FlagAssignment -> FlagAssignment -> FlagAssignment #

Read FlagAssignment #

Since: 2.2.0

Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

readsPrec :: Int -> ReadS FlagAssignment #

readList :: ReadS [FlagAssignment] #

readPrec :: ReadPrec FlagAssignment #

readListPrec :: ReadPrec [FlagAssignment] #

Show FlagAssignment #

Since: 2.2.0

Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

showsPrec :: Int -> FlagAssignment -> ShowS #

show :: FlagAssignment -> String #

showList :: [FlagAssignment] -> ShowS #

Generic FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Associated Types

type Rep FlagAssignment :: * -> * #

Methods

from :: FlagAssignment -> Rep FlagAssignment x #

to :: Rep FlagAssignment x -> FlagAssignment #

Semigroup FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(<>) :: FlagAssignment -> FlagAssignment -> FlagAssignment #

sconcat :: NonEmpty FlagAssignment -> FlagAssignment #

stimes :: Integral b => b -> FlagAssignment -> FlagAssignment #

Monoid FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

mempty :: FlagAssignment #

mappend :: FlagAssignment -> FlagAssignment -> FlagAssignment #

mconcat :: [FlagAssignment] -> FlagAssignment #

Binary FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

put :: FlagAssignment -> Put #

get :: Get FlagAssignment #

putList :: [FlagAssignment] -> Put #

NFData FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

rnf :: FlagAssignment -> () #

type Rep FlagAssignment # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

type Rep FlagAssignment = D1 (MetaData "FlagAssignment" "Distribution.Types.GenericPackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "FlagAssignment" PrefixI True) (S1 (MetaSel (Just "getFlagAssignment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map FlagName (Int, Bool)))))

mkFlagAssignment :: [(FlagName, Bool)] -> FlagAssignment #

Construct a FlagAssignment from a list of flag/value pairs.

If duplicate flags occur in the input list, the later entries + in the list will take precedence.

Since: 2.2.0

unFlagAssignment :: FlagAssignment -> [(FlagName, Bool)] #

Deconstruct a FlagAssignment into a list of flag/value pairs.

 null (findDuplicateFlagAssignments fa) ==> (mkFlagAssignment . unFlagAssignment) fa == fa

Since: 2.2.0

lookupFlagAssignment :: FlagName -> FlagAssignment -> Maybe Bool #

Lookup the value for a flag

Returns Nothing if the flag isn't contained in the FlagAssignment.

Since: 2.2.0

insertFlagAssignment :: FlagName -> Bool -> FlagAssignment -> FlagAssignment #

Insert or update the boolean value of a flag.

If the flag is already present in the FlagAssigment, the + value will be updated and the fact that multiple values have + been provided for that flag will be recorded so that a + warning can be generated later on.

Since: 2.2.0

diffFlagAssignment :: FlagAssignment -> FlagAssignment -> FlagAssignment #

Remove all flag-assignments from the first FlagAssignment that + are contained in the second FlagAssignment

NB/TODO: This currently only removes flag assignments which also + match the value assignment! We should review the code which uses + this operation to figure out if this it's not enough to only + compare the flagnames without the values.

Since: 2.2.0

findDuplicateFlagAssignments :: FlagAssignment -> [FlagName] #

Find the FlagNames that have been listed more than once.

Since: 2.2.0

nullFlagAssignment :: FlagAssignment -> Bool #

Test whether FlagAssignment is empty.

Since: 2.2.0

showFlagValue :: (FlagName, Bool) -> String #

String representation of a flag-value pair.

dispFlagAssignment :: FlagAssignment -> Doc #

Pretty-prints a flag assignment.

parseFlagAssignment :: ReadP r FlagAssignment #

Parses a flag assignment.

parsecFlagAssignment :: ParsecParser FlagAssignment #

Parses a flag assignment.

data ConfVar #

A ConfVar represents the variable type used.

Constructors

OS OS 
Arch Arch 
Flag FlagName 
Impl CompilerFlavor VersionRange 
Instances
Eq ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

(==) :: ConfVar -> ConfVar -> Bool #

(/=) :: ConfVar -> ConfVar -> Bool #

Data ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ConfVar -> c ConfVar #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ConfVar #

toConstr :: ConfVar -> Constr #

dataTypeOf :: ConfVar -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ConfVar) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ConfVar) #

gmapT :: (forall b. Data b => b -> b) -> ConfVar -> ConfVar #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ConfVar -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ConfVar -> r #

gmapQ :: (forall d. Data d => d -> u) -> ConfVar -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ConfVar -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ConfVar -> m ConfVar #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ConfVar -> m ConfVar #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ConfVar -> m ConfVar #

Show ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

showsPrec :: Int -> ConfVar -> ShowS #

show :: ConfVar -> String #

showList :: [ConfVar] -> ShowS #

Generic ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Associated Types

type Rep ConfVar :: * -> * #

Methods

from :: ConfVar -> Rep ConfVar x #

to :: Rep ConfVar x -> ConfVar #

Binary ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

put :: ConfVar -> Put #

get :: Get ConfVar #

putList :: [ConfVar] -> Put #

NFData ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

Methods

rnf :: ConfVar -> () #

type Rep ConfVar # 
Instance details

Defined in Distribution.Types.GenericPackageDescription

type Rep ConfVar = D1 (MetaData "ConfVar" "Distribution.Types.GenericPackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((C1 (MetaCons "OS" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OS)) :+: C1 (MetaCons "Arch" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Arch))) :+: (C1 (MetaCons "Flag" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FlagName)) :+: C1 (MetaCons "Impl" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CompilerFlavor) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange))))
diff --git a/doc/API/Cabal/Distribution-Types-HookedBuildInfo.html b/doc/API/Cabal/Distribution-Types-HookedBuildInfo.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-HookedBuildInfo.html @@ -0,0 +1,38 @@ +Distribution.Types.HookedBuildInfo

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.HookedBuildInfo

Synopsis

Documentation

type HookedBuildInfo = (Maybe BuildInfo, [(UnqualComponentName, BuildInfo)]) #

HookedBuildInfo is mechanism that hooks can use to + override the BuildInfos inside packages. One example + use-case (which is used in core libraries today) is as + a way of passing flags which are computed by a configure + script into Cabal. In this case, the autoconf build type adds + hooks to read in a textual HookedBuildInfo format prior + to doing any operations.

Quite honestly, this mechanism is a massive hack since we shouldn't + be editing the PackageDescription data structure (it's easy + to assume that this data structure shouldn't change and + run into bugs, see for example 1c20a6328579af9e37677d507e2e9836ef70ab9d). + But it's a bit convenient, because there isn't another data + structure that allows adding extra BuildInfo style things.

In any case, a lot of care has to be taken to make sure the + HookedBuildInfo is applied to the PackageDescription. In + general this process occurs in Distribution.Simple, which is + responsible for orchestrating the hooks mechanism. The + general strategy:

  1. We run the pre-hook, which produces a HookedBuildInfo + (e.g., in the Autoconf case, it reads it out from a file).
  2. We sanity-check the hooked build info with + sanityCheckHookedBuildInfo.
  3. We update our PackageDescription (either freshly read + or cached from LocalBuildInfo) with updatePackageDescription.

In principle, we are also supposed to update the copy of + the PackageDescription stored in LocalBuildInfo + at localPkgDescr. Unfortunately, in practice, there + are lots of Custom setup scripts which fail to update + localPkgDescr so you really shouldn't rely on it. + It's not DEPRECATED because there are legitimate uses + for it, but... yeah. Sharp knife. See + https://github.com/haskell/cabal/issues/3606 + for more information on the issue.

It is not well-specified whether or not a HookedBuildInfo applied + at configure time is persistent to the LocalBuildInfo. The + fact that HookedBuildInfo is passed to confHook MIGHT SUGGEST + that the HookedBuildInfo is applied at this time, but actually + since 9317b67e6122ab14e53f81b573bd0ecb388eca5a it has been ONLY used + to create a modified package description that we check for problems: + it is never actually saved to the LBI. Since HookedBuildInfo is + applied monoidally to the existing build infos (and it is not an + idempotent monoid), it could break things to save it, since we + are obligated to apply any new HookedBuildInfo and then we'd + get the effect twice. But this does mean we have to re-apply + it every time. Hey, it's more flexibility.

emptyHookedBuildInfo :: HookedBuildInfo #

diff --git a/doc/API/Cabal/Distribution-Types-IncludeRenaming.html b/doc/API/Cabal/Distribution-Types-IncludeRenaming.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-IncludeRenaming.html @@ -0,0 +1,2 @@ +Distribution.Types.IncludeRenaming

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.IncludeRenaming

Synopsis

Documentation

data IncludeRenaming #

A renaming on an include: (provides renaming, requires renaming)

Constructors

IncludeRenaming 

Fields

Instances
Eq IncludeRenaming # 
Instance details

Defined in Distribution.Types.IncludeRenaming

Methods

(==) :: IncludeRenaming -> IncludeRenaming -> Bool #

(/=) :: IncludeRenaming -> IncludeRenaming -> Bool #

Data IncludeRenaming # 
Instance details

Defined in Distribution.Types.IncludeRenaming

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IncludeRenaming -> c IncludeRenaming #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IncludeRenaming #

toConstr :: IncludeRenaming -> Constr #

dataTypeOf :: IncludeRenaming -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c IncludeRenaming) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IncludeRenaming) #

gmapT :: (forall b. Data b => b -> b) -> IncludeRenaming -> IncludeRenaming #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IncludeRenaming -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IncludeRenaming -> r #

gmapQ :: (forall d. Data d => d -> u) -> IncludeRenaming -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> IncludeRenaming -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IncludeRenaming -> m IncludeRenaming #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IncludeRenaming -> m IncludeRenaming #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IncludeRenaming -> m IncludeRenaming #

Ord IncludeRenaming # 
Instance details

Defined in Distribution.Types.IncludeRenaming

Methods

compare :: IncludeRenaming -> IncludeRenaming -> Ordering #

(<) :: IncludeRenaming -> IncludeRenaming -> Bool #

(<=) :: IncludeRenaming -> IncludeRenaming -> Bool #

(>) :: IncludeRenaming -> IncludeRenaming -> Bool #

(>=) :: IncludeRenaming -> IncludeRenaming -> Bool #

max :: IncludeRenaming -> IncludeRenaming -> IncludeRenaming #

min :: IncludeRenaming -> IncludeRenaming -> IncludeRenaming #

Read IncludeRenaming # 
Instance details

Defined in Distribution.Types.IncludeRenaming

Methods

readsPrec :: Int -> ReadS IncludeRenaming #

readList :: ReadS [IncludeRenaming] #

readPrec :: ReadPrec IncludeRenaming #

readListPrec :: ReadPrec [IncludeRenaming] #

Show IncludeRenaming # 
Instance details

Defined in Distribution.Types.IncludeRenaming

Methods

showsPrec :: Int -> IncludeRenaming -> ShowS #

show :: IncludeRenaming -> String #

showList :: [IncludeRenaming] -> ShowS #

Generic IncludeRenaming # 
Instance details

Defined in Distribution.Types.IncludeRenaming

Associated Types

type Rep IncludeRenaming :: * -> * #

Methods

from :: IncludeRenaming -> Rep IncludeRenaming x #

to :: Rep IncludeRenaming x -> IncludeRenaming #

Binary IncludeRenaming # 
Instance details

Defined in Distribution.Types.IncludeRenaming

Methods

put :: IncludeRenaming -> Put #

get :: Get IncludeRenaming #

putList :: [IncludeRenaming] -> Put #

NFData IncludeRenaming # 
Instance details

Defined in Distribution.Types.IncludeRenaming

Methods

rnf :: IncludeRenaming -> () #

Pretty IncludeRenaming # 
Instance details

Defined in Distribution.Types.IncludeRenaming

Methods

pretty :: IncludeRenaming -> Doc #

Parsec IncludeRenaming # 
Instance details

Defined in Distribution.Types.IncludeRenaming

Methods

parsec :: CabalParsing m => m IncludeRenaming #

Text IncludeRenaming # 
Instance details

Defined in Distribution.Types.IncludeRenaming

Methods

disp :: IncludeRenaming -> Doc #

parse :: ReadP r IncludeRenaming #

type Rep IncludeRenaming # 
Instance details

Defined in Distribution.Types.IncludeRenaming

type Rep IncludeRenaming = D1 (MetaData "IncludeRenaming" "Distribution.Types.IncludeRenaming" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "IncludeRenaming" PrefixI True) (S1 (MetaSel (Just "includeProvidesRn") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleRenaming) :*: S1 (MetaSel (Just "includeRequiresRn") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleRenaming)))

defaultIncludeRenaming :: IncludeRenaming #

The defaultIncludeRenaming applied when you only build-depends + on a package.

isDefaultIncludeRenaming :: IncludeRenaming -> Bool #

Is an IncludeRenaming the default one?

diff --git a/doc/API/Cabal/Distribution-Types-InstalledPackageInfo-FieldGrammar.html b/doc/API/Cabal/Distribution-Types-InstalledPackageInfo-FieldGrammar.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-InstalledPackageInfo-FieldGrammar.html @@ -0,0 +1,1 @@ +Distribution.Types.InstalledPackageInfo.FieldGrammar

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.InstalledPackageInfo.FieldGrammar

Documentation

ipiFieldGrammar :: (FieldGrammar g, Applicative (g InstalledPackageInfo), Applicative (g Basic)) => g InstalledPackageInfo InstalledPackageInfo #

diff --git a/doc/API/Cabal/Distribution-Types-InstalledPackageInfo-Lens.html b/doc/API/Cabal/Distribution-Types-InstalledPackageInfo-Lens.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-InstalledPackageInfo-Lens.html @@ -0,0 +1,1 @@ +Distribution.Types.InstalledPackageInfo.Lens

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.InstalledPackageInfo.Lens

Documentation

data InstalledPackageInfo #

Instances
Eq InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

(==) :: InstalledPackageInfo -> InstalledPackageInfo -> Bool #

(/=) :: InstalledPackageInfo -> InstalledPackageInfo -> Bool #

Read InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

readsPrec :: Int -> ReadS InstalledPackageInfo #

readList :: ReadS [InstalledPackageInfo] #

readPrec :: ReadPrec InstalledPackageInfo #

readListPrec :: ReadPrec [InstalledPackageInfo] #

Show InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

showsPrec :: Int -> InstalledPackageInfo -> ShowS #

show :: InstalledPackageInfo -> String #

showList :: [InstalledPackageInfo] -> ShowS #

Generic InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Associated Types

type Rep InstalledPackageInfo :: * -> * #

Methods

from :: InstalledPackageInfo -> Rep InstalledPackageInfo x #

to :: Rep InstalledPackageInfo x -> InstalledPackageInfo #

Binary InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

put :: InstalledPackageInfo -> Put #

get :: Get InstalledPackageInfo #

putList :: [InstalledPackageInfo] -> Put #

NFData InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

rnf :: InstalledPackageInfo -> () #

IsNode InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Associated Types

type Key InstalledPackageInfo :: * #

Methods

nodeKey :: InstalledPackageInfo -> Key InstalledPackageInfo #

nodeNeighbors :: InstalledPackageInfo -> [Key InstalledPackageInfo] #

PackageInstalled InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

installedDepends :: InstalledPackageInfo -> [UnitId] #

HasUnitId InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

installedUnitId :: InstalledPackageInfo -> UnitId #

HasMungedPackageId InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

mungedId :: InstalledPackageInfo -> MungedPackageId #

Package InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

packageId :: InstalledPackageInfo -> PackageIdentifier #

Semigroup (PackageIndex InstalledPackageInfo) # 
Instance details

Defined in Distribution.Simple.PackageIndex

Methods

(<>) :: PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo #

sconcat :: NonEmpty (PackageIndex InstalledPackageInfo) -> PackageIndex InstalledPackageInfo #

stimes :: Integral b => b -> PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo #

Monoid (PackageIndex InstalledPackageInfo) # 
Instance details

Defined in Distribution.Simple.PackageIndex

Methods

mempty :: PackageIndex InstalledPackageInfo #

mappend :: PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo #

mconcat :: [PackageIndex InstalledPackageInfo] -> PackageIndex InstalledPackageInfo #

type Rep InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

type Rep InstalledPackageInfo = D1 (MetaData "InstalledPackageInfo" "Distribution.Types.InstalledPackageInfo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "InstalledPackageInfo" PrefixI True) (((((S1 (MetaSel (Just "sourcePackageId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageId) :*: S1 (MetaSel (Just "sourceLibName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UnqualComponentName))) :*: (S1 (MetaSel (Just "installedComponentId_") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: (S1 (MetaSel (Just "installedUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId) :*: S1 (MetaSel (Just "instantiatedWith") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(ModuleName, OpenModule)])))) :*: ((S1 (MetaSel (Just "compatPackageKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "license") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Either License License))) :*: (S1 (MetaSel (Just "copyright") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: (S1 (MetaSel (Just "maintainer") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "author") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))) :*: (((S1 (MetaSel (Just "stability") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "homepage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :*: (S1 (MetaSel (Just "pkgUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: (S1 (MetaSel (Just "synopsis") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "description") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))) :*: ((S1 (MetaSel (Just "category") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "abiHash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AbiHash)) :*: (S1 (MetaSel (Just "indefinite") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: (S1 (MetaSel (Just "exposed") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "exposedModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ExposedModule])))))) :*: ((((S1 (MetaSel (Just "hiddenModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]) :*: S1 (MetaSel (Just "trusted") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "importDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: (S1 (MetaSel (Just "libraryDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "libraryDynDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))) :*: ((S1 (MetaSel (Just "dataDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "hsLibraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) :*: (S1 (MetaSel (Just "extraLibraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: (S1 (MetaSel (Just "extraGHCiLibraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "includeDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]))))) :*: (((S1 (MetaSel (Just "includes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "depends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId])) :*: (S1 (MetaSel (Just "abiDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [AbiDependency]) :*: (S1 (MetaSel (Just "ccOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "cxxOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])))) :*: ((S1 (MetaSel (Just "ldOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: (S1 (MetaSel (Just "frameworkDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "frameworks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]))) :*: (S1 (MetaSel (Just "haddockInterfaces") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: (S1 (MetaSel (Just "haddockHTMLs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "pkgRoot") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)))))))))
type Key InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

type Key InstalledPackageInfo = UnitId

sourcePackageId :: Lens' InstalledPackageInfo PackageIdentifier #

installedUnitId :: Lens' InstalledPackageInfo UnitId #

installedComponentId_ :: Lens' InstalledPackageInfo ComponentId #

instantiatedWith :: Lens' InstalledPackageInfo [(ModuleName, OpenModule)] #

sourceLibName :: Lens' InstalledPackageInfo (Maybe UnqualComponentName) #

compatPackageKey :: Lens' InstalledPackageInfo String #

license :: Lens' InstalledPackageInfo (Either License License) #

copyright :: Lens' InstalledPackageInfo String #

maintainer :: Lens' InstalledPackageInfo String #

author :: Lens' InstalledPackageInfo String #

stability :: Lens' InstalledPackageInfo String #

homepage :: Lens' InstalledPackageInfo String #

pkgUrl :: Lens' InstalledPackageInfo String #

synopsis :: Lens' InstalledPackageInfo String #

description :: Lens' InstalledPackageInfo String #

category :: Lens' InstalledPackageInfo String #

abiHash :: Lens' InstalledPackageInfo AbiHash #

indefinite :: Lens' InstalledPackageInfo Bool #

exposed :: Lens' InstalledPackageInfo Bool #

exposedModules :: Lens' InstalledPackageInfo [ExposedModule] #

hiddenModules :: Lens' InstalledPackageInfo [ModuleName] #

trusted :: Lens' InstalledPackageInfo Bool #

importDirs :: Lens' InstalledPackageInfo [FilePath] #

libraryDirs :: Lens' InstalledPackageInfo [FilePath] #

libraryDynDirs :: Lens' InstalledPackageInfo [FilePath] #

dataDir :: Lens' InstalledPackageInfo FilePath #

hsLibraries :: Lens' InstalledPackageInfo [String] #

extraLibraries :: Lens' InstalledPackageInfo [String] #

extraGHCiLibraries :: Lens' InstalledPackageInfo [String] #

includeDirs :: Lens' InstalledPackageInfo [FilePath] #

includes :: Lens' InstalledPackageInfo [String] #

depends :: Lens' InstalledPackageInfo [UnitId] #

abiDepends :: Lens' InstalledPackageInfo [AbiDependency] #

ccOptions :: Lens' InstalledPackageInfo [String] #

cxxOptions :: Lens' InstalledPackageInfo [String] #

ldOptions :: Lens' InstalledPackageInfo [String] #

frameworkDirs :: Lens' InstalledPackageInfo [FilePath] #

frameworks :: Lens' InstalledPackageInfo [String] #

haddockInterfaces :: Lens' InstalledPackageInfo [FilePath] #

haddockHTMLs :: Lens' InstalledPackageInfo [FilePath] #

pkgRoot :: Lens' InstalledPackageInfo (Maybe FilePath) #

diff --git a/doc/API/Cabal/Distribution-Types-InstalledPackageInfo.html b/doc/API/Cabal/Distribution-Types-InstalledPackageInfo.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-InstalledPackageInfo.html @@ -0,0 +1,9 @@ +Distribution.Types.InstalledPackageInfo

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.InstalledPackageInfo

Synopsis

Documentation

data InstalledPackageInfo #

Constructors

InstalledPackageInfo 

Fields

Instances
Eq InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

(==) :: InstalledPackageInfo -> InstalledPackageInfo -> Bool #

(/=) :: InstalledPackageInfo -> InstalledPackageInfo -> Bool #

Read InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

readsPrec :: Int -> ReadS InstalledPackageInfo #

readList :: ReadS [InstalledPackageInfo] #

readPrec :: ReadPrec InstalledPackageInfo #

readListPrec :: ReadPrec [InstalledPackageInfo] #

Show InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

showsPrec :: Int -> InstalledPackageInfo -> ShowS #

show :: InstalledPackageInfo -> String #

showList :: [InstalledPackageInfo] -> ShowS #

Generic InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Associated Types

type Rep InstalledPackageInfo :: * -> * #

Methods

from :: InstalledPackageInfo -> Rep InstalledPackageInfo x #

to :: Rep InstalledPackageInfo x -> InstalledPackageInfo #

Binary InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

put :: InstalledPackageInfo -> Put #

get :: Get InstalledPackageInfo #

putList :: [InstalledPackageInfo] -> Put #

NFData InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

rnf :: InstalledPackageInfo -> () #

IsNode InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Associated Types

type Key InstalledPackageInfo :: * #

Methods

nodeKey :: InstalledPackageInfo -> Key InstalledPackageInfo #

nodeNeighbors :: InstalledPackageInfo -> [Key InstalledPackageInfo] #

PackageInstalled InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

installedDepends :: InstalledPackageInfo -> [UnitId] #

HasUnitId InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

installedUnitId :: InstalledPackageInfo -> UnitId #

HasMungedPackageId InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

mungedId :: InstalledPackageInfo -> MungedPackageId #

Package InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

Methods

packageId :: InstalledPackageInfo -> PackageIdentifier #

Semigroup (PackageIndex InstalledPackageInfo) # 
Instance details

Defined in Distribution.Simple.PackageIndex

Methods

(<>) :: PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo #

sconcat :: NonEmpty (PackageIndex InstalledPackageInfo) -> PackageIndex InstalledPackageInfo #

stimes :: Integral b => b -> PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo #

Monoid (PackageIndex InstalledPackageInfo) # 
Instance details

Defined in Distribution.Simple.PackageIndex

Methods

mempty :: PackageIndex InstalledPackageInfo #

mappend :: PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo -> PackageIndex InstalledPackageInfo #

mconcat :: [PackageIndex InstalledPackageInfo] -> PackageIndex InstalledPackageInfo #

type Rep InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

type Rep InstalledPackageInfo = D1 (MetaData "InstalledPackageInfo" "Distribution.Types.InstalledPackageInfo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "InstalledPackageInfo" PrefixI True) (((((S1 (MetaSel (Just "sourcePackageId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageId) :*: S1 (MetaSel (Just "sourceLibName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UnqualComponentName))) :*: (S1 (MetaSel (Just "installedComponentId_") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: (S1 (MetaSel (Just "installedUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId) :*: S1 (MetaSel (Just "instantiatedWith") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(ModuleName, OpenModule)])))) :*: ((S1 (MetaSel (Just "compatPackageKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "license") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Either License License))) :*: (S1 (MetaSel (Just "copyright") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: (S1 (MetaSel (Just "maintainer") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "author") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))) :*: (((S1 (MetaSel (Just "stability") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "homepage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :*: (S1 (MetaSel (Just "pkgUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: (S1 (MetaSel (Just "synopsis") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "description") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))) :*: ((S1 (MetaSel (Just "category") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "abiHash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AbiHash)) :*: (S1 (MetaSel (Just "indefinite") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: (S1 (MetaSel (Just "exposed") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "exposedModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ExposedModule])))))) :*: ((((S1 (MetaSel (Just "hiddenModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]) :*: S1 (MetaSel (Just "trusted") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "importDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: (S1 (MetaSel (Just "libraryDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "libraryDynDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))) :*: ((S1 (MetaSel (Just "dataDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "hsLibraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) :*: (S1 (MetaSel (Just "extraLibraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: (S1 (MetaSel (Just "extraGHCiLibraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "includeDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]))))) :*: (((S1 (MetaSel (Just "includes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "depends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId])) :*: (S1 (MetaSel (Just "abiDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [AbiDependency]) :*: (S1 (MetaSel (Just "ccOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "cxxOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])))) :*: ((S1 (MetaSel (Just "ldOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: (S1 (MetaSel (Just "frameworkDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "frameworks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]))) :*: (S1 (MetaSel (Just "haddockInterfaces") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: (S1 (MetaSel (Just "haddockHTMLs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "pkgRoot") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)))))))))
type Key InstalledPackageInfo # 
Instance details

Defined in Distribution.Types.InstalledPackageInfo

type Key InstalledPackageInfo = UnitId

emptyInstalledPackageInfo :: InstalledPackageInfo #

mungedPackageId :: InstalledPackageInfo -> MungedPackageId #

mungedPackageName :: InstalledPackageInfo -> MungedPackageName #

Returns the munged package name, which we write into name for + compatibility with old versions of GHC.

data AbiDependency #

An ABI dependency is a dependency on a library which also + records the ABI hash (abiHash) of the library it depends + on.

The primary utility of this is to enable an extra sanity when + GHC loads libraries: it can check if the dependency has a matching + ABI and if not, refuse to load this library. This information + is critical if we are shadowing libraries; differences in the + ABI hash let us know what packages get shadowed by the new version + of a package.

Constructors

AbiDependency 

Fields

Instances
Eq AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

(==) :: AbiDependency -> AbiDependency -> Bool #

(/=) :: AbiDependency -> AbiDependency -> Bool #

Read AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

readsPrec :: Int -> ReadS AbiDependency #

readList :: ReadS [AbiDependency] #

readPrec :: ReadPrec AbiDependency #

readListPrec :: ReadPrec [AbiDependency] #

Show AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

showsPrec :: Int -> AbiDependency -> ShowS #

show :: AbiDependency -> String #

showList :: [AbiDependency] -> ShowS #

Generic AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Associated Types

type Rep AbiDependency :: * -> * #

Methods

from :: AbiDependency -> Rep AbiDependency x #

to :: Rep AbiDependency x -> AbiDependency #

Binary AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

put :: AbiDependency -> Put #

get :: Get AbiDependency #

putList :: [AbiDependency] -> Put #

NFData AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

rnf :: AbiDependency -> () #

Pretty AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

pretty :: AbiDependency -> Doc #

Parsec AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

parsec :: CabalParsing m => m AbiDependency #

Text AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

disp :: AbiDependency -> Doc #

parse :: ReadP r AbiDependency #

type Rep AbiDependency # 
Instance details

Defined in Distribution.Types.AbiDependency

type Rep AbiDependency = D1 (MetaData "AbiDependency" "Distribution.Types.AbiDependency" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "AbiDependency" PrefixI True) (S1 (MetaSel (Just "depUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId) :*: S1 (MetaSel (Just "depAbiHash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AbiHash)))

data ExposedModule #

Constructors

ExposedModule 

Fields

Instances
Eq ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

(==) :: ExposedModule -> ExposedModule -> Bool #

(/=) :: ExposedModule -> ExposedModule -> Bool #

Read ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

readsPrec :: Int -> ReadS ExposedModule #

readList :: ReadS [ExposedModule] #

readPrec :: ReadPrec ExposedModule #

readListPrec :: ReadPrec [ExposedModule] #

Show ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

showsPrec :: Int -> ExposedModule -> ShowS #

show :: ExposedModule -> String #

showList :: [ExposedModule] -> ShowS #

Generic ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Associated Types

type Rep ExposedModule :: * -> * #

Methods

from :: ExposedModule -> Rep ExposedModule x #

to :: Rep ExposedModule x -> ExposedModule #

Binary ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

put :: ExposedModule -> Put #

get :: Get ExposedModule #

putList :: [ExposedModule] -> Put #

NFData ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

rnf :: ExposedModule -> () #

Pretty ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

pretty :: ExposedModule -> Doc #

Parsec ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

parsec :: CabalParsing m => m ExposedModule #

Text ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

disp :: ExposedModule -> Doc #

parse :: ReadP r ExposedModule #

type Rep ExposedModule # 
Instance details

Defined in Distribution.Types.ExposedModule

type Rep ExposedModule = D1 (MetaData "ExposedModule" "Distribution.Types.ExposedModule" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ExposedModule" PrefixI True) (S1 (MetaSel (Just "exposedName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleName) :*: S1 (MetaSel (Just "exposedReexport") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe OpenModule))))
diff --git a/doc/API/Cabal/Distribution-Types-LegacyExeDependency.html b/doc/API/Cabal/Distribution-Types-LegacyExeDependency.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-LegacyExeDependency.html @@ -0,0 +1,3 @@ +Distribution.Types.LegacyExeDependency

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.LegacyExeDependency

Synopsis

Documentation

data LegacyExeDependency #

Describes a legacy `build-tools`-style dependency on an executable

It is "legacy" because we do not know what the build-tool referred to. It + could refer to a pkg-config executable (PkgconfigName), or an internal + executable (UnqualComponentName). Thus the name is stringly typed.

Since: 2.0.0.2

Constructors

LegacyExeDependency String VersionRange 
Instances
Eq LegacyExeDependency # 
Instance details

Defined in Distribution.Types.LegacyExeDependency

Methods

(==) :: LegacyExeDependency -> LegacyExeDependency -> Bool #

(/=) :: LegacyExeDependency -> LegacyExeDependency -> Bool #

Data LegacyExeDependency # 
Instance details

Defined in Distribution.Types.LegacyExeDependency

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LegacyExeDependency -> c LegacyExeDependency #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LegacyExeDependency #

toConstr :: LegacyExeDependency -> Constr #

dataTypeOf :: LegacyExeDependency -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LegacyExeDependency) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LegacyExeDependency) #

gmapT :: (forall b. Data b => b -> b) -> LegacyExeDependency -> LegacyExeDependency #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LegacyExeDependency -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LegacyExeDependency -> r #

gmapQ :: (forall d. Data d => d -> u) -> LegacyExeDependency -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LegacyExeDependency -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LegacyExeDependency -> m LegacyExeDependency #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LegacyExeDependency -> m LegacyExeDependency #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LegacyExeDependency -> m LegacyExeDependency #

Read LegacyExeDependency # 
Instance details

Defined in Distribution.Types.LegacyExeDependency

Methods

readsPrec :: Int -> ReadS LegacyExeDependency #

readList :: ReadS [LegacyExeDependency] #

readPrec :: ReadPrec LegacyExeDependency #

readListPrec :: ReadPrec [LegacyExeDependency] #

Show LegacyExeDependency # 
Instance details

Defined in Distribution.Types.LegacyExeDependency

Methods

showsPrec :: Int -> LegacyExeDependency -> ShowS #

show :: LegacyExeDependency -> String #

showList :: [LegacyExeDependency] -> ShowS #

Generic LegacyExeDependency # 
Instance details

Defined in Distribution.Types.LegacyExeDependency

Associated Types

type Rep LegacyExeDependency :: * -> * #

Methods

from :: LegacyExeDependency -> Rep LegacyExeDependency x #

to :: Rep LegacyExeDependency x -> LegacyExeDependency #

Binary LegacyExeDependency # 
Instance details

Defined in Distribution.Types.LegacyExeDependency

Methods

put :: LegacyExeDependency -> Put #

get :: Get LegacyExeDependency #

putList :: [LegacyExeDependency] -> Put #

NFData LegacyExeDependency # 
Instance details

Defined in Distribution.Types.LegacyExeDependency

Methods

rnf :: LegacyExeDependency -> () #

Pretty LegacyExeDependency # 
Instance details

Defined in Distribution.Types.LegacyExeDependency

Methods

pretty :: LegacyExeDependency -> Doc #

Parsec LegacyExeDependency # 
Instance details

Defined in Distribution.Types.LegacyExeDependency

Methods

parsec :: CabalParsing m => m LegacyExeDependency #

Text LegacyExeDependency # 
Instance details

Defined in Distribution.Types.LegacyExeDependency

Methods

disp :: LegacyExeDependency -> Doc #

parse :: ReadP r LegacyExeDependency #

type Rep LegacyExeDependency # 
Instance details

Defined in Distribution.Types.LegacyExeDependency

type Rep LegacyExeDependency = D1 (MetaData "LegacyExeDependency" "Distribution.Types.LegacyExeDependency" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "LegacyExeDependency" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange)))
diff --git a/doc/API/Cabal/Distribution-Types-Lens.html b/doc/API/Cabal/Distribution-Types-Lens.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-Lens.html @@ -0,0 +1,1 @@ +Distribution.Types.Lens

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.Lens

Documentation

module Distribution.Types.Benchmark.Lens

module Distribution.Types.BuildInfo.Lens

module Distribution.Types.Executable.Lens

module Distribution.Types.ForeignLib.Lens

module Distribution.Types.GenericPackageDescription.Lens

module Distribution.Types.Library.Lens

module Distribution.Types.PackageDescription.Lens

module Distribution.Types.PackageId.Lens

module Distribution.Types.SetupBuildInfo.Lens

module Distribution.Types.SourceRepo.Lens

module Distribution.Types.TestSuite.Lens

diff --git a/doc/API/Cabal/Distribution-Types-Library-Lens.html b/doc/API/Cabal/Distribution-Types-Library-Lens.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-Library-Lens.html @@ -0,0 +1,1 @@ +Distribution.Types.Library.Lens

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.Library.Lens

Documentation

data Library #

Instances
Eq Library # 
Instance details

Defined in Distribution.Types.Library

Methods

(==) :: Library -> Library -> Bool #

(/=) :: Library -> Library -> Bool #

Data Library # 
Instance details

Defined in Distribution.Types.Library

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Library -> c Library #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Library #

toConstr :: Library -> Constr #

dataTypeOf :: Library -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Library) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Library) #

gmapT :: (forall b. Data b => b -> b) -> Library -> Library #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Library -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Library -> r #

gmapQ :: (forall d. Data d => d -> u) -> Library -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Library -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Library -> m Library #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Library -> m Library #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Library -> m Library #

Read Library # 
Instance details

Defined in Distribution.Types.Library

Methods

readsPrec :: Int -> ReadS Library #

readList :: ReadS [Library] #

readPrec :: ReadPrec Library #

readListPrec :: ReadPrec [Library] #

Show Library # 
Instance details

Defined in Distribution.Types.Library

Methods

showsPrec :: Int -> Library -> ShowS #

show :: Library -> String #

showList :: [Library] -> ShowS #

Generic Library # 
Instance details

Defined in Distribution.Types.Library

Associated Types

type Rep Library :: * -> * #

Methods

from :: Library -> Rep Library x #

to :: Rep Library x -> Library #

Semigroup Library # 
Instance details

Defined in Distribution.Types.Library

Methods

(<>) :: Library -> Library -> Library #

sconcat :: NonEmpty Library -> Library #

stimes :: Integral b => b -> Library -> Library #

Monoid Library # 
Instance details

Defined in Distribution.Types.Library

Methods

mempty :: Library #

mappend :: Library -> Library -> Library #

mconcat :: [Library] -> Library #

Binary Library # 
Instance details

Defined in Distribution.Types.Library

Methods

put :: Library -> Put #

get :: Get Library #

putList :: [Library] -> Put #

NFData Library # 
Instance details

Defined in Distribution.Types.Library

Methods

rnf :: Library -> () #

HasBuildInfo Library # 
Instance details

Defined in Distribution.Types.Library

Methods

buildInfo :: Lens' Library BuildInfo #

buildable :: Lens' Library Bool #

buildTools :: Lens' Library [LegacyExeDependency] #

buildToolDepends :: Lens' Library [ExeDependency] #

cppOptions :: Lens' Library [String] #

asmOptions :: Lens' Library [String] #

cmmOptions :: Lens' Library [String] #

ccOptions :: Lens' Library [String] #

cxxOptions :: Lens' Library [String] #

ldOptions :: Lens' Library [String] #

pkgconfigDepends :: Lens' Library [PkgconfigDependency] #

frameworks :: Lens' Library [String] #

extraFrameworkDirs :: Lens' Library [String] #

asmSources :: Lens' Library [FilePath] #

cmmSources :: Lens' Library [FilePath] #

cSources :: Lens' Library [FilePath] #

cxxSources :: Lens' Library [FilePath] #

jsSources :: Lens' Library [FilePath] #

hsSourceDirs :: Lens' Library [FilePath] #

otherModules :: Lens' Library [ModuleName] #

virtualModules :: Lens' Library [ModuleName] #

autogenModules :: Lens' Library [ModuleName] #

defaultLanguage :: Lens' Library (Maybe Language) #

otherLanguages :: Lens' Library [Language] #

defaultExtensions :: Lens' Library [Extension] #

otherExtensions :: Lens' Library [Extension] #

oldExtensions :: Lens' Library [Extension] #

extraLibs :: Lens' Library [String] #

extraGHCiLibs :: Lens' Library [String] #

extraBundledLibs :: Lens' Library [String] #

extraLibFlavours :: Lens' Library [String] #

extraLibDirs :: Lens' Library [String] #

includeDirs :: Lens' Library [FilePath] #

includes :: Lens' Library [FilePath] #

installIncludes :: Lens' Library [FilePath] #

options :: Lens' Library [(CompilerFlavor, [String])] #

profOptions :: Lens' Library [(CompilerFlavor, [String])] #

sharedOptions :: Lens' Library [(CompilerFlavor, [String])] #

staticOptions :: Lens' Library [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' Library [(String, String)] #

targetBuildDepends :: Lens' Library [Dependency] #

mixins :: Lens' Library [Mixin] #

type Rep Library # 
Instance details

Defined in Distribution.Types.Library

type Rep Library = D1 (MetaData "Library" "Distribution.Types.Library" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Library" PrefixI True) ((S1 (MetaSel (Just "libName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UnqualComponentName)) :*: (S1 (MetaSel (Just "exposedModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]) :*: S1 (MetaSel (Just "reexportedModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleReexport]))) :*: (S1 (MetaSel (Just "signatures") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]) :*: (S1 (MetaSel (Just "libExposed") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "libBuildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BuildInfo)))))

libName :: Lens' Library (Maybe UnqualComponentName) #

exposedModules :: Lens' Library [ModuleName] #

reexportedModules :: Lens' Library [ModuleReexport] #

signatures :: Lens' Library [ModuleName] #

libExposed :: Lens' Library Bool #

libBuildInfo :: Lens' Library BuildInfo #

diff --git a/doc/API/Cabal/Distribution-Types-Library.html b/doc/API/Cabal/Distribution-Types-Library.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-Library.html @@ -0,0 +1,11 @@ +Distribution.Types.Library

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.Library

Synopsis

Documentation

data Library #

Constructors

Library 

Fields

Instances
Eq Library # 
Instance details

Defined in Distribution.Types.Library

Methods

(==) :: Library -> Library -> Bool #

(/=) :: Library -> Library -> Bool #

Data Library # 
Instance details

Defined in Distribution.Types.Library

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Library -> c Library #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Library #

toConstr :: Library -> Constr #

dataTypeOf :: Library -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Library) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Library) #

gmapT :: (forall b. Data b => b -> b) -> Library -> Library #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Library -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Library -> r #

gmapQ :: (forall d. Data d => d -> u) -> Library -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Library -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Library -> m Library #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Library -> m Library #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Library -> m Library #

Read Library # 
Instance details

Defined in Distribution.Types.Library

Methods

readsPrec :: Int -> ReadS Library #

readList :: ReadS [Library] #

readPrec :: ReadPrec Library #

readListPrec :: ReadPrec [Library] #

Show Library # 
Instance details

Defined in Distribution.Types.Library

Methods

showsPrec :: Int -> Library -> ShowS #

show :: Library -> String #

showList :: [Library] -> ShowS #

Generic Library # 
Instance details

Defined in Distribution.Types.Library

Associated Types

type Rep Library :: * -> * #

Methods

from :: Library -> Rep Library x #

to :: Rep Library x -> Library #

Semigroup Library # 
Instance details

Defined in Distribution.Types.Library

Methods

(<>) :: Library -> Library -> Library #

sconcat :: NonEmpty Library -> Library #

stimes :: Integral b => b -> Library -> Library #

Monoid Library # 
Instance details

Defined in Distribution.Types.Library

Methods

mempty :: Library #

mappend :: Library -> Library -> Library #

mconcat :: [Library] -> Library #

Binary Library # 
Instance details

Defined in Distribution.Types.Library

Methods

put :: Library -> Put #

get :: Get Library #

putList :: [Library] -> Put #

NFData Library # 
Instance details

Defined in Distribution.Types.Library

Methods

rnf :: Library -> () #

HasBuildInfo Library # 
Instance details

Defined in Distribution.Types.Library

Methods

buildInfo :: Lens' Library BuildInfo #

buildable :: Lens' Library Bool #

buildTools :: Lens' Library [LegacyExeDependency] #

buildToolDepends :: Lens' Library [ExeDependency] #

cppOptions :: Lens' Library [String] #

asmOptions :: Lens' Library [String] #

cmmOptions :: Lens' Library [String] #

ccOptions :: Lens' Library [String] #

cxxOptions :: Lens' Library [String] #

ldOptions :: Lens' Library [String] #

pkgconfigDepends :: Lens' Library [PkgconfigDependency] #

frameworks :: Lens' Library [String] #

extraFrameworkDirs :: Lens' Library [String] #

asmSources :: Lens' Library [FilePath] #

cmmSources :: Lens' Library [FilePath] #

cSources :: Lens' Library [FilePath] #

cxxSources :: Lens' Library [FilePath] #

jsSources :: Lens' Library [FilePath] #

hsSourceDirs :: Lens' Library [FilePath] #

otherModules :: Lens' Library [ModuleName] #

virtualModules :: Lens' Library [ModuleName] #

autogenModules :: Lens' Library [ModuleName] #

defaultLanguage :: Lens' Library (Maybe Language) #

otherLanguages :: Lens' Library [Language] #

defaultExtensions :: Lens' Library [Extension] #

otherExtensions :: Lens' Library [Extension] #

oldExtensions :: Lens' Library [Extension] #

extraLibs :: Lens' Library [String] #

extraGHCiLibs :: Lens' Library [String] #

extraBundledLibs :: Lens' Library [String] #

extraLibFlavours :: Lens' Library [String] #

extraLibDirs :: Lens' Library [String] #

includeDirs :: Lens' Library [FilePath] #

includes :: Lens' Library [FilePath] #

installIncludes :: Lens' Library [FilePath] #

options :: Lens' Library [(CompilerFlavor, [String])] #

profOptions :: Lens' Library [(CompilerFlavor, [String])] #

sharedOptions :: Lens' Library [(CompilerFlavor, [String])] #

staticOptions :: Lens' Library [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' Library [(String, String)] #

targetBuildDepends :: Lens' Library [Dependency] #

mixins :: Lens' Library [Mixin] #

type Rep Library # 
Instance details

Defined in Distribution.Types.Library

type Rep Library = D1 (MetaData "Library" "Distribution.Types.Library" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Library" PrefixI True) ((S1 (MetaSel (Just "libName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UnqualComponentName)) :*: (S1 (MetaSel (Just "exposedModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]) :*: S1 (MetaSel (Just "reexportedModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleReexport]))) :*: (S1 (MetaSel (Just "signatures") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]) :*: (S1 (MetaSel (Just "libExposed") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "libBuildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BuildInfo)))))

emptyLibrary :: Library #

explicitLibModules :: Library -> [ModuleName] #

Get all the module names from the library (exposed and internal modules) + which are explicitly listed in the package description which would + need to be compiled. (This does not include reexports, which + do not need to be compiled.) This may not include all modules for which + GHC generated interface files (i.e., implicit modules.)

libModulesAutogen :: Library -> [ModuleName] #

Get all the auto generated module names from the library, exposed or not. + This are a subset of libModules.

libModules :: Library -> [ModuleName] #

Deprecated: If you want all modules that are built with a library, use allLibModules. Otherwise, use explicitLibModules for ONLY the modules explicitly mentioned in the package description. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

Backwards-compatibility shim for explicitLibModules. In most cases, + you actually want allLibModules, which returns all modules that will + actually be compiled, as opposed to those which are explicitly listed + in the package description (explicitLibModules); unfortunately, the + type signature for allLibModules is incompatible since we need a + ComponentLocalBuildInfo.

diff --git a/doc/API/Cabal/Distribution-Types-LocalBuildInfo.html b/doc/API/Cabal/Distribution-Types-LocalBuildInfo.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-LocalBuildInfo.html @@ -0,0 +1,53 @@ +Distribution.Types.LocalBuildInfo

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.LocalBuildInfo

Contents

Synopsis

The type

data LocalBuildInfo #

Data cached after configuration step. See also + ConfigFlags.

Constructors

LocalBuildInfo 

Fields

Instances
Read LocalBuildInfo # 
Instance details

Defined in Distribution.Types.LocalBuildInfo

Methods

readsPrec :: Int -> ReadS LocalBuildInfo #

readList :: ReadS [LocalBuildInfo] #

readPrec :: ReadPrec LocalBuildInfo #

readListPrec :: ReadPrec [LocalBuildInfo] #

Show LocalBuildInfo # 
Instance details

Defined in Distribution.Types.LocalBuildInfo

Methods

showsPrec :: Int -> LocalBuildInfo -> ShowS #

show :: LocalBuildInfo -> String #

showList :: [LocalBuildInfo] -> ShowS #

Generic LocalBuildInfo # 
Instance details

Defined in Distribution.Types.LocalBuildInfo

Associated Types

type Rep LocalBuildInfo :: * -> * #

Methods

from :: LocalBuildInfo -> Rep LocalBuildInfo x #

to :: Rep LocalBuildInfo x -> LocalBuildInfo #

Binary LocalBuildInfo # 
Instance details

Defined in Distribution.Types.LocalBuildInfo

Methods

put :: LocalBuildInfo -> Put #

get :: Get LocalBuildInfo #

putList :: [LocalBuildInfo] -> Put #

type Rep LocalBuildInfo # 
Instance details

Defined in Distribution.Types.LocalBuildInfo

type Rep LocalBuildInfo = D1 (MetaData "LocalBuildInfo" "Distribution.Types.LocalBuildInfo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "LocalBuildInfo" PrefixI True) (((((S1 (MetaSel (Just "configFlags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ConfigFlags) :*: S1 (MetaSel (Just "flagAssignment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FlagAssignment)) :*: (S1 (MetaSel (Just "componentEnabledSpec") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentRequestedSpec) :*: S1 (MetaSel (Just "extraConfigArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]))) :*: ((S1 (MetaSel (Just "installDirTemplates") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 InstallDirTemplates) :*: S1 (MetaSel (Just "compiler") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Compiler)) :*: (S1 (MetaSel (Just "hostPlatform") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Platform) :*: (S1 (MetaSel (Just "buildDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "cabalFilePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)))))) :*: (((S1 (MetaSel (Just "componentGraph") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Graph ComponentLocalBuildInfo)) :*: S1 (MetaSel (Just "componentNameMap") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map ComponentName [ComponentLocalBuildInfo]))) :*: (S1 (MetaSel (Just "installedPkgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 InstalledPackageIndex) :*: S1 (MetaSel (Just "pkgDescrFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)))) :*: ((S1 (MetaSel (Just "localPkgDescr") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageDescription) :*: S1 (MetaSel (Just "withPrograms") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ProgramDb)) :*: (S1 (MetaSel (Just "withPackageDB") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageDBStack) :*: (S1 (MetaSel (Just "withVanillaLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "withProfLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))))) :*: ((((S1 (MetaSel (Just "withSharedLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "withStaticLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "withDynExe") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "withProfExe") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :*: ((S1 (MetaSel (Just "withProfLibDetail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ProfDetailLevel) :*: S1 (MetaSel (Just "withProfExeDetail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ProfDetailLevel)) :*: (S1 (MetaSel (Just "withOptimization") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OptimisationLevel) :*: (S1 (MetaSel (Just "withDebugInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 DebugInfoLevel) :*: S1 (MetaSel (Just "withGHCiLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))) :*: (((S1 (MetaSel (Just "splitSections") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "splitObjs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "stripExes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "stripLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :*: ((S1 (MetaSel (Just "exeCoverage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "libCoverage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "progPrefix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PathTemplate) :*: (S1 (MetaSel (Just "progSuffix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PathTemplate) :*: S1 (MetaSel (Just "relocatable") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))))))

Convenience accessors

localComponentId :: LocalBuildInfo -> ComponentId #

Extract the ComponentId from the public library component of a + LocalBuildInfo if it exists, or make a fake component ID based + on the package ID.

localUnitId :: LocalBuildInfo -> UnitId #

Extract the UnitId from the library component of a + LocalBuildInfo if it exists, or make a fake unit ID based on + the package ID.

localCompatPackageKey :: LocalBuildInfo -> String #

Extract the compatibility package key from the public library component of a + LocalBuildInfo if it exists, or make a fake package key based + on the package ID.

localPackage :: LocalBuildInfo -> PackageId #

Extract the PackageIdentifier of a LocalBuildInfo. + This is a "safe" use of localPkgDescr

Build targets of the LocalBuildInfo.

componentNameCLBIs :: LocalBuildInfo -> ComponentName -> [ComponentLocalBuildInfo] #

Return all ComponentLocalBuildInfos associated with ComponentName. + In the presence of Backpack there may be more than one!

componentNameTargets' :: PackageDescription -> LocalBuildInfo -> ComponentName -> [TargetInfo] #

Return all TargetInfos associated with ComponentName. + In the presence of Backpack there may be more than one! + Has a prime because it takes a PackageDescription argument + which may disagree with localPkgDescr in LocalBuildInfo.

unitIdTarget' :: PackageDescription -> LocalBuildInfo -> UnitId -> Maybe TargetInfo #

allTargetsInBuildOrder' :: PackageDescription -> LocalBuildInfo -> [TargetInfo] #

Return the list of default TargetInfos associated with a + configured package, in the order they need to be built. + Has a prime because it takes a PackageDescription argument + which may disagree with localPkgDescr in LocalBuildInfo.

withAllTargetsInBuildOrder' :: PackageDescription -> LocalBuildInfo -> (TargetInfo -> IO ()) -> IO () #

Execute f for every TargetInfo in the package, respecting the + build dependency order. (TODO: We should use Shake!) + Has a prime because it takes a PackageDescription argument + which may disagree with localPkgDescr in LocalBuildInfo.

neededTargetsInBuildOrder' :: PackageDescription -> LocalBuildInfo -> [UnitId] -> [TargetInfo] #

Return the list of all targets needed to build the uids, in + the order they need to be built. + Has a prime because it takes a PackageDescription argument + which may disagree with localPkgDescr in LocalBuildInfo.

withNeededTargetsInBuildOrder' :: PackageDescription -> LocalBuildInfo -> [UnitId] -> (TargetInfo -> IO ()) -> IO () #

Execute f for every TargetInfo needed to build uids, respecting + the build dependency order. + Has a prime because it takes a PackageDescription argument + which may disagree with localPkgDescr in LocalBuildInfo.

testCoverage :: LocalBuildInfo -> Bool #

Is coverage enabled for test suites? In practice, this requires library + and executable profiling to be enabled.

Functions you SHOULD NOT USE (yet), but are defined here to

componentNameTargets :: LocalBuildInfo -> ComponentName -> [TargetInfo] #

Warning: By using this function, you may be introducing a bug where you retrieve a Component which does not have HookedBuildInfo applied to it. See the documentation for HookedBuildInfo for an explanation of the issue. If you have a PakcageDescription handy (NOT from the LocalBuildInfo), try using the primed version of the function, which takes it as an extra argument.

unitIdTarget :: LocalBuildInfo -> UnitId -> Maybe TargetInfo #

Warning: By using this function, you may be introducing a bug where you retrieve a Component which does not have HookedBuildInfo applied to it. See the documentation for HookedBuildInfo for an explanation of the issue. If you have a PakcageDescription handy (NOT from the LocalBuildInfo), try using the primed version of the function, which takes it as an extra argument.

allTargetsInBuildOrder :: LocalBuildInfo -> [TargetInfo] #

Warning: By using this function, you may be introducing a bug where you retrieve a Component which does not have HookedBuildInfo applied to it. See the documentation for HookedBuildInfo for an explanation of the issue. If you have a PakcageDescription handy (NOT from the LocalBuildInfo), try using the primed version of the function, which takes it as an extra argument.

withAllTargetsInBuildOrder :: LocalBuildInfo -> (TargetInfo -> IO ()) -> IO () #

Warning: By using this function, you may be introducing a bug where you retrieve a Component which does not have HookedBuildInfo applied to it. See the documentation for HookedBuildInfo for an explanation of the issue. If you have a PakcageDescription handy (NOT from the LocalBuildInfo), try using the primed version of the function, which takes it as an extra argument.

neededTargetsInBuildOrder :: LocalBuildInfo -> [UnitId] -> [TargetInfo] #

Warning: By using this function, you may be introducing a bug where you retrieve a Component which does not have HookedBuildInfo applied to it. See the documentation for HookedBuildInfo for an explanation of the issue. If you have a PakcageDescription handy (NOT from the LocalBuildInfo), try using the primed version of the function, which takes it as an extra argument.

withNeededTargetsInBuildOrder :: LocalBuildInfo -> [UnitId] -> (TargetInfo -> IO ()) -> IO () #

Warning: By using this function, you may be introducing a bug where you retrieve a Component which does not have HookedBuildInfo applied to it. See the documentation for HookedBuildInfo for an explanation of the issue. If you have a PakcageDescription handy (NOT from the LocalBuildInfo), try using the primed version of the function, which takes it as an extra argument.

Backwards compatibility.

componentsConfigs :: LocalBuildInfo -> [(ComponentName, ComponentLocalBuildInfo, [ComponentName])] #

Deprecated: Use componentGraph instead; you can get a list of ComponentLocalBuildInfo with toList. There's not a good way to get the list of ComponentNames the ComponentLocalBuildInfo depends on because this query doesn't make sense; the graph is indexed by UnitId not ComponentName. Given a UnitId you can lookup the ComponentLocalBuildInfo (getCLBI) and then get the ComponentName ('componentLocalName]). To be removed in Cabal 3.0

externalPackageDeps :: LocalBuildInfo -> [(UnitId, MungedPackageId)] #

Deprecated: You almost certainly don't want this function, which agglomerates the dependencies of ALL enabled components. If you're using this to write out information on your dependencies, read off the dependencies directly from the actual component in question. To be removed in Cabal 3.0

External package dependencies for the package as a whole. This is the + union of the individual componentPackageDeps, less any internal deps.

diff --git a/doc/API/Cabal/Distribution-Types-Mixin.html b/doc/API/Cabal/Distribution-Types-Mixin.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-Mixin.html @@ -0,0 +1,1 @@ +Distribution.Types.Mixin

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.Mixin

Documentation

data Mixin #

Constructors

Mixin 

Fields

Instances
Eq Mixin # 
Instance details

Defined in Distribution.Types.Mixin

Methods

(==) :: Mixin -> Mixin -> Bool #

(/=) :: Mixin -> Mixin -> Bool #

Data Mixin # 
Instance details

Defined in Distribution.Types.Mixin

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Mixin -> c Mixin #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Mixin #

toConstr :: Mixin -> Constr #

dataTypeOf :: Mixin -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Mixin) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Mixin) #

gmapT :: (forall b. Data b => b -> b) -> Mixin -> Mixin #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Mixin -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Mixin -> r #

gmapQ :: (forall d. Data d => d -> u) -> Mixin -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Mixin -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Mixin -> m Mixin #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Mixin -> m Mixin #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Mixin -> m Mixin #

Ord Mixin # 
Instance details

Defined in Distribution.Types.Mixin

Methods

compare :: Mixin -> Mixin -> Ordering #

(<) :: Mixin -> Mixin -> Bool #

(<=) :: Mixin -> Mixin -> Bool #

(>) :: Mixin -> Mixin -> Bool #

(>=) :: Mixin -> Mixin -> Bool #

max :: Mixin -> Mixin -> Mixin #

min :: Mixin -> Mixin -> Mixin #

Read Mixin # 
Instance details

Defined in Distribution.Types.Mixin

Methods

readsPrec :: Int -> ReadS Mixin #

readList :: ReadS [Mixin] #

readPrec :: ReadPrec Mixin #

readListPrec :: ReadPrec [Mixin] #

Show Mixin # 
Instance details

Defined in Distribution.Types.Mixin

Methods

showsPrec :: Int -> Mixin -> ShowS #

show :: Mixin -> String #

showList :: [Mixin] -> ShowS #

Generic Mixin # 
Instance details

Defined in Distribution.Types.Mixin

Associated Types

type Rep Mixin :: * -> * #

Methods

from :: Mixin -> Rep Mixin x #

to :: Rep Mixin x -> Mixin #

Binary Mixin # 
Instance details

Defined in Distribution.Types.Mixin

Methods

put :: Mixin -> Put #

get :: Get Mixin #

putList :: [Mixin] -> Put #

NFData Mixin # 
Instance details

Defined in Distribution.Types.Mixin

Methods

rnf :: Mixin -> () #

Pretty Mixin # 
Instance details

Defined in Distribution.Types.Mixin

Methods

pretty :: Mixin -> Doc #

Parsec Mixin # 
Instance details

Defined in Distribution.Types.Mixin

Methods

parsec :: CabalParsing m => m Mixin #

Text Mixin # 
Instance details

Defined in Distribution.Types.Mixin

Methods

disp :: Mixin -> Doc #

parse :: ReadP r Mixin #

type Rep Mixin # 
Instance details

Defined in Distribution.Types.Mixin

type Rep Mixin = D1 (MetaData "Mixin" "Distribution.Types.Mixin" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Mixin" PrefixI True) (S1 (MetaSel (Just "mixinPackageName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageName) :*: S1 (MetaSel (Just "mixinIncludeRenaming") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 IncludeRenaming)))
diff --git a/doc/API/Cabal/Distribution-Types-Module.html b/doc/API/Cabal/Distribution-Types-Module.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-Module.html @@ -0,0 +1,8 @@ +Distribution.Types.Module

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.Module

Synopsis

Documentation

data Module #

A module identity uniquely identifies a Haskell module by + qualifying a ModuleName with the UnitId which defined + it. This type distinguishes between two packages + which provide a module with the same name, or a module + from the same package compiled with different dependencies. + There are a few cases where Cabal needs to know about + module identities, e.g., when writing out reexported modules in + the InstalledPackageInfo.

Constructors

Module DefUnitId ModuleName 
Instances
Eq Module # 
Instance details

Defined in Distribution.Types.Module

Methods

(==) :: Module -> Module -> Bool #

(/=) :: Module -> Module -> Bool #

Data Module # 
Instance details

Defined in Distribution.Types.Module

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Module -> c Module #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Module #

toConstr :: Module -> Constr #

dataTypeOf :: Module -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Module) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Module) #

gmapT :: (forall b. Data b => b -> b) -> Module -> Module #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Module -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Module -> r #

gmapQ :: (forall d. Data d => d -> u) -> Module -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Module -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Module -> m Module #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Module -> m Module #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Module -> m Module #

Ord Module # 
Instance details

Defined in Distribution.Types.Module

Methods

compare :: Module -> Module -> Ordering #

(<) :: Module -> Module -> Bool #

(<=) :: Module -> Module -> Bool #

(>) :: Module -> Module -> Bool #

(>=) :: Module -> Module -> Bool #

max :: Module -> Module -> Module #

min :: Module -> Module -> Module #

Read Module # 
Instance details

Defined in Distribution.Types.Module

Methods

readsPrec :: Int -> ReadS Module #

readList :: ReadS [Module] #

readPrec :: ReadPrec Module #

readListPrec :: ReadPrec [Module] #

Show Module # 
Instance details

Defined in Distribution.Types.Module

Methods

showsPrec :: Int -> Module -> ShowS #

show :: Module -> String #

showList :: [Module] -> ShowS #

Generic Module # 
Instance details

Defined in Distribution.Types.Module

Associated Types

type Rep Module :: * -> * #

Methods

from :: Module -> Rep Module x #

to :: Rep Module x -> Module #

Binary Module # 
Instance details

Defined in Distribution.Types.Module

Methods

put :: Module -> Put #

get :: Get Module #

putList :: [Module] -> Put #

NFData Module # 
Instance details

Defined in Distribution.Types.Module

Methods

rnf :: Module -> () #

Pretty Module # 
Instance details

Defined in Distribution.Types.Module

Methods

pretty :: Module -> Doc #

Parsec Module # 
Instance details

Defined in Distribution.Types.Module

Methods

parsec :: CabalParsing m => m Module #

Text Module # 
Instance details

Defined in Distribution.Types.Module

Methods

disp :: Module -> Doc #

parse :: ReadP r Module #

type Rep Module # 
Instance details

Defined in Distribution.Types.Module

type Rep Module = D1 (MetaData "Module" "Distribution.Types.Module" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Module" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 DefUnitId) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleName)))
diff --git a/doc/API/Cabal/Distribution-Types-ModuleReexport.html b/doc/API/Cabal/Distribution-Types-ModuleReexport.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-ModuleReexport.html @@ -0,0 +1,1 @@ +Distribution.Types.ModuleReexport

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.ModuleReexport

Documentation

data ModuleReexport #

Constructors

ModuleReexport 

Fields

Instances
Eq ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

(==) :: ModuleReexport -> ModuleReexport -> Bool #

(/=) :: ModuleReexport -> ModuleReexport -> Bool #

Data ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModuleReexport -> c ModuleReexport #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModuleReexport #

toConstr :: ModuleReexport -> Constr #

dataTypeOf :: ModuleReexport -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModuleReexport) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModuleReexport) #

gmapT :: (forall b. Data b => b -> b) -> ModuleReexport -> ModuleReexport #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModuleReexport -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModuleReexport -> r #

gmapQ :: (forall d. Data d => d -> u) -> ModuleReexport -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModuleReexport -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModuleReexport -> m ModuleReexport #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleReexport -> m ModuleReexport #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleReexport -> m ModuleReexport #

Read ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

readsPrec :: Int -> ReadS ModuleReexport #

readList :: ReadS [ModuleReexport] #

readPrec :: ReadPrec ModuleReexport #

readListPrec :: ReadPrec [ModuleReexport] #

Show ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

showsPrec :: Int -> ModuleReexport -> ShowS #

show :: ModuleReexport -> String #

showList :: [ModuleReexport] -> ShowS #

Generic ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Associated Types

type Rep ModuleReexport :: * -> * #

Methods

from :: ModuleReexport -> Rep ModuleReexport x #

to :: Rep ModuleReexport x -> ModuleReexport #

Binary ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

put :: ModuleReexport -> Put #

get :: Get ModuleReexport #

putList :: [ModuleReexport] -> Put #

NFData ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

rnf :: ModuleReexport -> () #

Pretty ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

pretty :: ModuleReexport -> Doc #

Parsec ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

parsec :: CabalParsing m => m ModuleReexport #

Text ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

Methods

disp :: ModuleReexport -> Doc #

parse :: ReadP r ModuleReexport #

type Rep ModuleReexport # 
Instance details

Defined in Distribution.Types.ModuleReexport

type Rep ModuleReexport = D1 (MetaData "ModuleReexport" "Distribution.Types.ModuleReexport" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ModuleReexport" PrefixI True) (S1 (MetaSel (Just "moduleReexportOriginalPackage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe PackageName)) :*: (S1 (MetaSel (Just "moduleReexportOriginalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleName) :*: S1 (MetaSel (Just "moduleReexportName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleName))))
diff --git a/doc/API/Cabal/Distribution-Types-ModuleRenaming.html b/doc/API/Cabal/Distribution-Types-ModuleRenaming.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-ModuleRenaming.html @@ -0,0 +1,13 @@ +Distribution.Types.ModuleRenaming

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.ModuleRenaming

Synopsis

Documentation

data ModuleRenaming #

Renaming applied to the modules provided by a package. + The boolean indicates whether or not to also include all of the + original names of modules. Thus, ModuleRenaming False [] is + "don't expose any modules, and ModuleRenaming True [(Data.Bool, Bool)] + is, "expose all modules, but also expose Data.Bool as Bool". + If a renaming is omitted you get the DefaultRenaming.

(NB: This is a list not a map so that we can preserve order.)

Constructors

ModuleRenaming [(ModuleName, ModuleName)]

A module renaming/thinning; e.g., (A as B, C as C) + brings B and C into scope.

DefaultRenaming

The default renaming, bringing all exported modules + into scope.

HidingRenaming [ModuleName]

Hiding renaming, e.g., hiding (A, B), bringing all + exported modules into scope except the hidden ones.

Instances
Eq ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

(==) :: ModuleRenaming -> ModuleRenaming -> Bool #

(/=) :: ModuleRenaming -> ModuleRenaming -> Bool #

Data ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModuleRenaming -> c ModuleRenaming #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModuleRenaming #

toConstr :: ModuleRenaming -> Constr #

dataTypeOf :: ModuleRenaming -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModuleRenaming) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModuleRenaming) #

gmapT :: (forall b. Data b => b -> b) -> ModuleRenaming -> ModuleRenaming #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModuleRenaming -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModuleRenaming -> r #

gmapQ :: (forall d. Data d => d -> u) -> ModuleRenaming -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModuleRenaming -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModuleRenaming -> m ModuleRenaming #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleRenaming -> m ModuleRenaming #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleRenaming -> m ModuleRenaming #

Ord ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

compare :: ModuleRenaming -> ModuleRenaming -> Ordering #

(<) :: ModuleRenaming -> ModuleRenaming -> Bool #

(<=) :: ModuleRenaming -> ModuleRenaming -> Bool #

(>) :: ModuleRenaming -> ModuleRenaming -> Bool #

(>=) :: ModuleRenaming -> ModuleRenaming -> Bool #

max :: ModuleRenaming -> ModuleRenaming -> ModuleRenaming #

min :: ModuleRenaming -> ModuleRenaming -> ModuleRenaming #

Read ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

readsPrec :: Int -> ReadS ModuleRenaming #

readList :: ReadS [ModuleRenaming] #

readPrec :: ReadPrec ModuleRenaming #

readListPrec :: ReadPrec [ModuleRenaming] #

Show ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

showsPrec :: Int -> ModuleRenaming -> ShowS #

show :: ModuleRenaming -> String #

showList :: [ModuleRenaming] -> ShowS #

Generic ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Associated Types

type Rep ModuleRenaming :: * -> * #

Methods

from :: ModuleRenaming -> Rep ModuleRenaming x #

to :: Rep ModuleRenaming x -> ModuleRenaming #

Binary ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

put :: ModuleRenaming -> Put #

get :: Get ModuleRenaming #

putList :: [ModuleRenaming] -> Put #

NFData ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

rnf :: ModuleRenaming -> () #

Pretty ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

pretty :: ModuleRenaming -> Doc #

Parsec ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

parsec :: CabalParsing m => m ModuleRenaming #

Text ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

Methods

disp :: ModuleRenaming -> Doc #

parse :: ReadP r ModuleRenaming #

type Rep ModuleRenaming # 
Instance details

Defined in Distribution.Types.ModuleRenaming

type Rep ModuleRenaming = D1 (MetaData "ModuleRenaming" "Distribution.Types.ModuleRenaming" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "ModuleRenaming" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(ModuleName, ModuleName)])) :+: (C1 (MetaCons "DefaultRenaming" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "HidingRenaming" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ModuleName]))))

interpModuleRenaming :: ModuleRenaming -> ModuleName -> Maybe ModuleName #

Interpret a ModuleRenaming as a partial map from ModuleName + to ModuleName. For efficiency, you should partially apply it + with ModuleRenaming and then reuse it.

defaultRenaming :: ModuleRenaming #

The default renaming, if something is specified in build-depends + only.

isDefaultRenaming :: ModuleRenaming -> Bool #

Tests if its the default renaming; we can use a more compact syntax + in IncludeRenaming in this case.

diff --git a/doc/API/Cabal/Distribution-Types-MungedPackageId.html b/doc/API/Cabal/Distribution-Types-MungedPackageId.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-MungedPackageId.html @@ -0,0 +1,5 @@ +Distribution.Types.MungedPackageId

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.MungedPackageId

Synopsis

Documentation

data MungedPackageId #

A simple pair of a MungedPackageName and Version. MungedPackageName is to + MungedPackageId as PackageName is to PackageId. See MungedPackageName for more + info.

Constructors

MungedPackageId 

Fields

Instances
Eq MungedPackageId # 
Instance details

Defined in Distribution.Types.MungedPackageId

Methods

(==) :: MungedPackageId -> MungedPackageId -> Bool #

(/=) :: MungedPackageId -> MungedPackageId -> Bool #

Data MungedPackageId # 
Instance details

Defined in Distribution.Types.MungedPackageId

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MungedPackageId -> c MungedPackageId #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MungedPackageId #

toConstr :: MungedPackageId -> Constr #

dataTypeOf :: MungedPackageId -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MungedPackageId) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MungedPackageId) #

gmapT :: (forall b. Data b => b -> b) -> MungedPackageId -> MungedPackageId #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MungedPackageId -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MungedPackageId -> r #

gmapQ :: (forall d. Data d => d -> u) -> MungedPackageId -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> MungedPackageId -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MungedPackageId -> m MungedPackageId #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MungedPackageId -> m MungedPackageId #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MungedPackageId -> m MungedPackageId #

Ord MungedPackageId # 
Instance details

Defined in Distribution.Types.MungedPackageId

Methods

compare :: MungedPackageId -> MungedPackageId -> Ordering #

(<) :: MungedPackageId -> MungedPackageId -> Bool #

(<=) :: MungedPackageId -> MungedPackageId -> Bool #

(>) :: MungedPackageId -> MungedPackageId -> Bool #

(>=) :: MungedPackageId -> MungedPackageId -> Bool #

max :: MungedPackageId -> MungedPackageId -> MungedPackageId #

min :: MungedPackageId -> MungedPackageId -> MungedPackageId #

Read MungedPackageId # 
Instance details

Defined in Distribution.Types.MungedPackageId

Methods

readsPrec :: Int -> ReadS MungedPackageId #

readList :: ReadS [MungedPackageId] #

readPrec :: ReadPrec MungedPackageId #

readListPrec :: ReadPrec [MungedPackageId] #

Show MungedPackageId # 
Instance details

Defined in Distribution.Types.MungedPackageId

Methods

showsPrec :: Int -> MungedPackageId -> ShowS #

show :: MungedPackageId -> String #

showList :: [MungedPackageId] -> ShowS #

Generic MungedPackageId # 
Instance details

Defined in Distribution.Types.MungedPackageId

Associated Types

type Rep MungedPackageId :: * -> * #

Methods

from :: MungedPackageId -> Rep MungedPackageId x #

to :: Rep MungedPackageId x -> MungedPackageId #

Binary MungedPackageId # 
Instance details

Defined in Distribution.Types.MungedPackageId

Methods

put :: MungedPackageId -> Put #

get :: Get MungedPackageId #

putList :: [MungedPackageId] -> Put #

NFData MungedPackageId # 
Instance details

Defined in Distribution.Types.MungedPackageId

Methods

rnf :: MungedPackageId -> () #

Text MungedPackageId # 
Instance details

Defined in Distribution.Types.MungedPackageId

Methods

disp :: MungedPackageId -> Doc #

parse :: ReadP r MungedPackageId #

HasMungedPackageId MungedPackageId # 
Instance details

Defined in Distribution.Package

Methods

mungedId :: MungedPackageId -> MungedPackageId #

type Rep MungedPackageId # 
Instance details

Defined in Distribution.Types.MungedPackageId

type Rep MungedPackageId = D1 (MetaData "MungedPackageId" "Distribution.Types.MungedPackageId" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "MungedPackageId" PrefixI True) (S1 (MetaSel (Just "mungedName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MungedPackageName) :*: S1 (MetaSel (Just "mungedVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)))

computeCompatPackageId :: PackageId -> Maybe UnqualComponentName -> MungedPackageId #

See docs for computeCompatPackageId. this + is a thin wrapper around that.

diff --git a/doc/API/Cabal/Distribution-Types-MungedPackageName.html b/doc/API/Cabal/Distribution-Types-MungedPackageName.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-MungedPackageName.html @@ -0,0 +1,23 @@ +Distribution.Types.MungedPackageName

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.MungedPackageName

Synopsis

Documentation

data MungedPackageName #

A combination of a package and component name used in various legacy + interfaces, chiefly bundled with a version as MungedPackageId. It's generally + better to use a UnitId to opaquely refer to some compilation/packing unit, + but that doesn't always work, e.g. where a "name" is needed, in which case + this can be used as a fallback.

Use mkMungedPackageName and unMungedPackageName to convert from/to a String.

Since: 2.0.0.2

Instances
Eq MungedPackageName # 
Instance details

Defined in Distribution.Types.MungedPackageName

Methods

(==) :: MungedPackageName -> MungedPackageName -> Bool #

(/=) :: MungedPackageName -> MungedPackageName -> Bool #

Data MungedPackageName # 
Instance details

Defined in Distribution.Types.MungedPackageName

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MungedPackageName -> c MungedPackageName #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MungedPackageName #

toConstr :: MungedPackageName -> Constr #

dataTypeOf :: MungedPackageName -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MungedPackageName) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MungedPackageName) #

gmapT :: (forall b. Data b => b -> b) -> MungedPackageName -> MungedPackageName #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MungedPackageName -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MungedPackageName -> r #

gmapQ :: (forall d. Data d => d -> u) -> MungedPackageName -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> MungedPackageName -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MungedPackageName -> m MungedPackageName #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MungedPackageName -> m MungedPackageName #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MungedPackageName -> m MungedPackageName #

Ord MungedPackageName # 
Instance details

Defined in Distribution.Types.MungedPackageName

Methods

compare :: MungedPackageName -> MungedPackageName -> Ordering #

(<) :: MungedPackageName -> MungedPackageName -> Bool #

(<=) :: MungedPackageName -> MungedPackageName -> Bool #

(>) :: MungedPackageName -> MungedPackageName -> Bool #

(>=) :: MungedPackageName -> MungedPackageName -> Bool #

max :: MungedPackageName -> MungedPackageName -> MungedPackageName #

min :: MungedPackageName -> MungedPackageName -> MungedPackageName #

Read MungedPackageName # 
Instance details

Defined in Distribution.Types.MungedPackageName

Methods

readsPrec :: Int -> ReadS MungedPackageName #

readList :: ReadS [MungedPackageName] #

readPrec :: ReadPrec MungedPackageName #

readListPrec :: ReadPrec [MungedPackageName] #

Show MungedPackageName # 
Instance details

Defined in Distribution.Types.MungedPackageName

Methods

showsPrec :: Int -> MungedPackageName -> ShowS #

show :: MungedPackageName -> String #

showList :: [MungedPackageName] -> ShowS #

IsString MungedPackageName #

mkMungedPackageName

Since: 2.0.0.2

Instance details

Defined in Distribution.Types.MungedPackageName

Methods

fromString :: String -> MungedPackageName #

Generic MungedPackageName # 
Instance details

Defined in Distribution.Types.MungedPackageName

Associated Types

type Rep MungedPackageName :: * -> * #

Methods

from :: MungedPackageName -> Rep MungedPackageName x #

to :: Rep MungedPackageName x -> MungedPackageName #

Binary MungedPackageName # 
Instance details

Defined in Distribution.Types.MungedPackageName

Methods

put :: MungedPackageName -> Put #

get :: Get MungedPackageName #

putList :: [MungedPackageName] -> Put #

NFData MungedPackageName # 
Instance details

Defined in Distribution.Types.MungedPackageName

Methods

rnf :: MungedPackageName -> () #

Pretty MungedPackageName # 
Instance details

Defined in Distribution.Types.MungedPackageName

Methods

pretty :: MungedPackageName -> Doc #

Parsec MungedPackageName # 
Instance details

Defined in Distribution.Types.MungedPackageName

Methods

parsec :: CabalParsing m => m MungedPackageName #

Text MungedPackageName # 
Instance details

Defined in Distribution.Types.MungedPackageName

Methods

disp :: MungedPackageName -> Doc #

parse :: ReadP r MungedPackageName #

type Rep MungedPackageName # 
Instance details

Defined in Distribution.Types.MungedPackageName

type Rep MungedPackageName = D1 (MetaData "MungedPackageName" "Distribution.Types.MungedPackageName" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "MungedPackageName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ShortText)))

unMungedPackageName :: MungedPackageName -> String #

Convert MungedPackageName to String

mkMungedPackageName :: String -> MungedPackageName #

Construct a MungedPackageName from a String

mkMungedPackageName is the inverse to unMungedPackageName

Note: No validations are performed to ensure that the resulting + MungedPackageName is valid

Since: 2.0.0.2

computeCompatPackageName :: PackageName -> Maybe UnqualComponentName -> MungedPackageName #

Computes the package name for a library. If this is the public + library, it will just be the original package name; otherwise, + it will be a munged package name recording the original package + name as well as the name of the internal library.

A lot of tooling in the Haskell ecosystem assumes that if something + is installed to the package database with the package name foo, + then it actually is an entry for the (only public) library in package + foo. With internal packages, this is not necessarily true: + a public library as well as arbitrarily many internal libraries may + come from the same package. To prevent tools from getting confused + in this case, the package name of these internal libraries is munged + so that they do not conflict the public library proper. A particular + case where this matters is ghc-pkg: if we don't munge the package + name, the inplace registration will OVERRIDE a different internal + library.

We munge into a reserved namespace, "z-", and encode both the + component name and the package name of an internal library using the + following format:

compat-pkg-name ::= "z-" package-name "-z-" library-name

where package-name and library-name have "-" ( "z" + ) "-" + segments encoded by adding an extra "z".

When we have the public library, the compat-pkg-name is just the + package-name, no surprises there!

decodeCompatPackageName :: MungedPackageName -> (PackageName, Maybe UnqualComponentName) #

diff --git a/doc/API/Cabal/Distribution-Types-PackageDescription-Lens.html b/doc/API/Cabal/Distribution-Types-PackageDescription-Lens.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-PackageDescription-Lens.html @@ -0,0 +1,5 @@ +Distribution.Types.PackageDescription.Lens

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.PackageDescription.Lens

Synopsis

Documentation

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.

Instances
Eq PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

(==) :: PackageDescription -> PackageDescription -> Bool #

(/=) :: PackageDescription -> PackageDescription -> Bool #

Data PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PackageDescription -> c PackageDescription #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PackageDescription #

toConstr :: PackageDescription -> Constr #

dataTypeOf :: PackageDescription -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PackageDescription) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PackageDescription) #

gmapT :: (forall b. Data b => b -> b) -> PackageDescription -> PackageDescription #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PackageDescription -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PackageDescription -> r #

gmapQ :: (forall d. Data d => d -> u) -> PackageDescription -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PackageDescription -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PackageDescription -> m PackageDescription #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageDescription -> m PackageDescription #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageDescription -> m PackageDescription #

Read PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

readsPrec :: Int -> ReadS PackageDescription #

readList :: ReadS [PackageDescription] #

readPrec :: ReadPrec PackageDescription #

readListPrec :: ReadPrec [PackageDescription] #

Show PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

showsPrec :: Int -> PackageDescription -> ShowS #

show :: PackageDescription -> String #

showList :: [PackageDescription] -> ShowS #

Generic PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Associated Types

type Rep PackageDescription :: * -> * #

Methods

from :: PackageDescription -> Rep PackageDescription x #

to :: Rep PackageDescription x -> PackageDescription #

Binary PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

put :: PackageDescription -> Put #

get :: Get PackageDescription #

putList :: [PackageDescription] -> Put #

NFData PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

rnf :: PackageDescription -> () #

Package PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

packageId :: PackageDescription -> PackageIdentifier #

HasBuildInfos PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

traverseBuildInfos :: Traversal' PackageDescription BuildInfo #

type Rep PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

type Rep PackageDescription = D1 (MetaData "PackageDescription" "Distribution.Types.PackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "PackageDescription" PrefixI True) ((((S1 (MetaSel (Just "specVersionRaw") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Either Version VersionRange)) :*: (S1 (MetaSel (Just "package") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageIdentifier) :*: S1 (MetaSel (Just "licenseRaw") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Either License License)))) :*: ((S1 (MetaSel (Just "licenseFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "copyright") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :*: (S1 (MetaSel (Just "maintainer") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "author") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))) :*: (((S1 (MetaSel (Just "stability") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "testedWith") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(CompilerFlavor, VersionRange)])) :*: (S1 (MetaSel (Just "homepage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "pkgUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))) :*: ((S1 (MetaSel (Just "bugReports") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "sourceRepos") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [SourceRepo])) :*: (S1 (MetaSel (Just "synopsis") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "description") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))) :*: (((S1 (MetaSel (Just "category") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: (S1 (MetaSel (Just "customFieldsPD") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, String)]) :*: S1 (MetaSel (Just "buildTypeRaw") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe BuildType)))) :*: ((S1 (MetaSel (Just "setupBuildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe SetupBuildInfo)) :*: S1 (MetaSel (Just "library") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Library))) :*: (S1 (MetaSel (Just "subLibraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Library]) :*: S1 (MetaSel (Just "executables") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Executable])))) :*: (((S1 (MetaSel (Just "foreignLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ForeignLib]) :*: S1 (MetaSel (Just "testSuites") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [TestSuite])) :*: (S1 (MetaSel (Just "benchmarks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Benchmark]) :*: S1 (MetaSel (Just "dataFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]))) :*: ((S1 (MetaSel (Just "dataDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "extraSrcFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])) :*: (S1 (MetaSel (Just "extraTmpFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "extraDocFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))))))

package :: Lens' PackageDescription PackageIdentifier #

licenseRaw :: Lens' PackageDescription (Either License License) #

licenseFiles :: Lens' PackageDescription [String] #

copyright :: Lens' PackageDescription String #

maintainer :: Lens' PackageDescription String #

author :: Lens' PackageDescription String #

stability :: Lens' PackageDescription String #

testedWith :: Lens' PackageDescription [(CompilerFlavor, VersionRange)] #

homepage :: Lens' PackageDescription String #

pkgUrl :: Lens' PackageDescription String #

bugReports :: Lens' PackageDescription String #

sourceRepos :: Lens' PackageDescription [SourceRepo] #

synopsis :: Lens' PackageDescription String #

description :: Lens' PackageDescription String #

category :: Lens' PackageDescription String #

customFieldsPD :: Lens' PackageDescription [(String, String)] #

specVersionRaw :: Lens' PackageDescription (Either Version VersionRange) #

buildTypeRaw :: Lens' PackageDescription (Maybe BuildType) #

setupBuildInfo :: Lens' PackageDescription (Maybe SetupBuildInfo) #

library :: Lens' PackageDescription (Maybe Library) #

subLibraries :: Lens' PackageDescription [Library] #

executables :: Lens' PackageDescription [Executable] #

foreignLibs :: Lens' PackageDescription [ForeignLib] #

testSuites :: Lens' PackageDescription [TestSuite] #

benchmarks :: Lens' PackageDescription [Benchmark] #

dataFiles :: Lens' PackageDescription [FilePath] #

dataDir :: Lens' PackageDescription FilePath #

extraSrcFiles :: Lens' PackageDescription [String] #

extraTmpFiles :: Lens' PackageDescription [String] #

extraDocFiles :: Lens' PackageDescription [String] #

componentModules :: Monoid r => ComponentName -> Getting r PackageDescription [ModuleName] #

Since: 2.4

componentBuildInfo :: ComponentName -> Traversal' PackageDescription BuildInfo #

Since: 2.4

diff --git a/doc/API/Cabal/Distribution-Types-PackageDescription.html b/doc/API/Cabal/Distribution-Types-PackageDescription.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-PackageDescription.html @@ -0,0 +1,57 @@ +Distribution.Types.PackageDescription

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2005
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Types.PackageDescription

Description

This defines the data structure for the .cabal file format. There are + several parts to this structure. It has top level info and then Library, + Executable, TestSuite, and Benchmark sections each of which have + associated BuildInfo data that's used to build the library, exe, test, or + benchmark. To further complicate things there is both a PackageDescription + and a GenericPackageDescription. This distinction relates to cabal + configurations. When we initially read a .cabal file we get a + GenericPackageDescription which has all the conditional sections. + Before actually building a package we have to decide + on each conditional. Once we've done that we get a PackageDescription. + It was done this way initially to avoid breaking too much stuff when the + feature was introduced. It could probably do with being rationalised at some + point to make it simpler.

Synopsis

Documentation

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 

Fields

Instances
Eq PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

(==) :: PackageDescription -> PackageDescription -> Bool #

(/=) :: PackageDescription -> PackageDescription -> Bool #

Data PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PackageDescription -> c PackageDescription #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PackageDescription #

toConstr :: PackageDescription -> Constr #

dataTypeOf :: PackageDescription -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PackageDescription) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PackageDescription) #

gmapT :: (forall b. Data b => b -> b) -> PackageDescription -> PackageDescription #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PackageDescription -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PackageDescription -> r #

gmapQ :: (forall d. Data d => d -> u) -> PackageDescription -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PackageDescription -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PackageDescription -> m PackageDescription #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageDescription -> m PackageDescription #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageDescription -> m PackageDescription #

Read PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

readsPrec :: Int -> ReadS PackageDescription #

readList :: ReadS [PackageDescription] #

readPrec :: ReadPrec PackageDescription #

readListPrec :: ReadPrec [PackageDescription] #

Show PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

showsPrec :: Int -> PackageDescription -> ShowS #

show :: PackageDescription -> String #

showList :: [PackageDescription] -> ShowS #

Generic PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Associated Types

type Rep PackageDescription :: * -> * #

Methods

from :: PackageDescription -> Rep PackageDescription x #

to :: Rep PackageDescription x -> PackageDescription #

Binary PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

put :: PackageDescription -> Put #

get :: Get PackageDescription #

putList :: [PackageDescription] -> Put #

NFData PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

rnf :: PackageDescription -> () #

Package PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

packageId :: PackageDescription -> PackageIdentifier #

HasBuildInfos PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

Methods

traverseBuildInfos :: Traversal' PackageDescription BuildInfo #

type Rep PackageDescription # 
Instance details

Defined in Distribution.Types.PackageDescription

type Rep PackageDescription = D1 (MetaData "PackageDescription" "Distribution.Types.PackageDescription" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "PackageDescription" PrefixI True) ((((S1 (MetaSel (Just "specVersionRaw") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Either Version VersionRange)) :*: (S1 (MetaSel (Just "package") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageIdentifier) :*: S1 (MetaSel (Just "licenseRaw") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Either License License)))) :*: ((S1 (MetaSel (Just "licenseFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "copyright") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :*: (S1 (MetaSel (Just "maintainer") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "author") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))) :*: (((S1 (MetaSel (Just "stability") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "testedWith") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(CompilerFlavor, VersionRange)])) :*: (S1 (MetaSel (Just "homepage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "pkgUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))) :*: ((S1 (MetaSel (Just "bugReports") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "sourceRepos") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [SourceRepo])) :*: (S1 (MetaSel (Just "synopsis") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "description") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))) :*: (((S1 (MetaSel (Just "category") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: (S1 (MetaSel (Just "customFieldsPD") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, String)]) :*: S1 (MetaSel (Just "buildTypeRaw") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe BuildType)))) :*: ((S1 (MetaSel (Just "setupBuildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe SetupBuildInfo)) :*: S1 (MetaSel (Just "library") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Library))) :*: (S1 (MetaSel (Just "subLibraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Library]) :*: S1 (MetaSel (Just "executables") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Executable])))) :*: (((S1 (MetaSel (Just "foreignLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ForeignLib]) :*: S1 (MetaSel (Just "testSuites") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [TestSuite])) :*: (S1 (MetaSel (Just "benchmarks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Benchmark]) :*: S1 (MetaSel (Just "dataFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]))) :*: ((S1 (MetaSel (Just "dataDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "extraSrcFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])) :*: (S1 (MetaSel (Just "extraTmpFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "extraDocFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))))))

specVersion :: PackageDescription -> Version #

The version of the Cabal spec that this package should be interpreted + against.

Historically we used a version range but we are switching to using a single + version. Currently we accept either. This function converts into a single + version by ignoring upper bounds in the version range.

specVersion' :: Either Version VersionRange -> Version #

Since: 2.2.0.0

license :: PackageDescription -> License #

The SPDX LicenseExpression of the package.

Since: 2.2.0.0

license' :: Either License License -> License #

See license.

Since: 2.2.0.0

descCabalVersion :: PackageDescription -> VersionRange #

Deprecated: Use specVersion instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

The range of versions of the Cabal tools that this package is intended to + work with.

This function is deprecated and should not be used for new purposes, only to + support old packages that rely on the old interpretation.

buildType :: PackageDescription -> BuildType #

The effective build-type after applying defaulting rules.

The original build-type value parsed is stored in the + buildTypeRaw field. However, the build-type field is optional + and can therefore be empty in which case we need to compute the + effective build-type. This function implements the following + defaulting rules:

  • For cabal-version:2.0 and below, default to the Custom + build-type unconditionally.
  • Otherwise, if a custom-setup stanza is defined, default to + the Custom build-type; else default to Simple build-type.

Since: 2.2

emptyPackageDescription :: PackageDescription #

hasPublicLib :: PackageDescription -> Bool #

Does this package have a buildable PUBLIC library?

hasLibs :: PackageDescription -> Bool #

Does this package have any libraries?

allLibraries :: PackageDescription -> [Library] #

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

If the package description has a buildable library section, + call the given function with the library build info as argument. + You probably want withLibLBI if you have a LocalBuildInfo, + see the note in + Distribution.Types.ComponentRequestedSpec + for more information.

hasExes :: PackageDescription -> Bool #

does this package have any executables?

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

Perform the action on each buildable Executable in the package + description. You probably want withExeLBI if you have a + LocalBuildInfo, see the note in + Distribution.Types.ComponentRequestedSpec + for more information.

hasTests :: PackageDescription -> Bool #

Does this package have any test suites?

withTest :: PackageDescription -> (TestSuite -> IO ()) -> IO () #

Perform an action on each buildable TestSuite in a package. + You probably want withTestLBI if you have a LocalBuildInfo, see the note in + Distribution.Types.ComponentRequestedSpec + for more information.

hasBenchmarks :: PackageDescription -> Bool #

Does this package have any benchmarks?

withBenchmark :: PackageDescription -> (Benchmark -> IO ()) -> IO () #

Perform an action on each buildable Benchmark in a package. + You probably want withBenchLBI if you have a LocalBuildInfo, see the note in + Distribution.Types.ComponentRequestedSpec + for more information.

hasForeignLibs :: PackageDescription -> Bool #

Does this package have any foreign libraries?

withForeignLib :: PackageDescription -> (ForeignLib -> IO ()) -> IO () #

Perform the action on each buildable ForeignLib in the package + description.

allBuildInfo :: PackageDescription -> [BuildInfo] #

All BuildInfo in the PackageDescription: + libraries, executables, test-suites and benchmarks.

Useful for implementing package checks.

enabledBuildInfos :: PackageDescription -> ComponentRequestedSpec -> [BuildInfo] #

Return all of the BuildInfos of enabled components, i.e., all of + the ones that would be built if you run ./Setup build.

allBuildDepends :: PackageDescription -> [Dependency] #

Get the combined build-depends entries of all components.

enabledBuildDepends :: PackageDescription -> ComponentRequestedSpec -> [Dependency] #

Get the combined build-depends entries of all enabled components, per the + given request spec.

updatePackageDescription :: HookedBuildInfo -> PackageDescription -> PackageDescription #

pkgComponents :: PackageDescription -> [Component] #

All the components in the package.

pkgBuildableComponents :: PackageDescription -> [Component] #

A list of all components in the package that are buildable, + i.e., were not marked with buildable: False. This does NOT + indicate if we are actually going to build the component, + see enabledComponents instead.

Since: 2.0.0.2

enabledComponents :: PackageDescription -> ComponentRequestedSpec -> [Component] #

A list of all components in the package that are enabled.

Since: 2.0.0.2

lookupComponent :: PackageDescription -> ComponentName -> Maybe Component #

getComponent :: PackageDescription -> ComponentName -> Component #

diff --git a/doc/API/Cabal/Distribution-Types-PackageId-Lens.html b/doc/API/Cabal/Distribution-Types-PackageId-Lens.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-PackageId-Lens.html @@ -0,0 +1,1 @@ +Distribution.Types.PackageId.Lens

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.PackageId.Lens

Synopsis

Documentation

data PackageIdentifier #

The name and version of a package.

Instances
Eq PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

(==) :: PackageIdentifier -> PackageIdentifier -> Bool #

(/=) :: PackageIdentifier -> PackageIdentifier -> Bool #

Data PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PackageIdentifier -> c PackageIdentifier #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PackageIdentifier #

toConstr :: PackageIdentifier -> Constr #

dataTypeOf :: PackageIdentifier -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PackageIdentifier) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PackageIdentifier) #

gmapT :: (forall b. Data b => b -> b) -> PackageIdentifier -> PackageIdentifier #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PackageIdentifier -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PackageIdentifier -> r #

gmapQ :: (forall d. Data d => d -> u) -> PackageIdentifier -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PackageIdentifier -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PackageIdentifier -> m PackageIdentifier #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageIdentifier -> m PackageIdentifier #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageIdentifier -> m PackageIdentifier #

Ord PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

compare :: PackageIdentifier -> PackageIdentifier -> Ordering #

(<) :: PackageIdentifier -> PackageIdentifier -> Bool #

(<=) :: PackageIdentifier -> PackageIdentifier -> Bool #

(>) :: PackageIdentifier -> PackageIdentifier -> Bool #

(>=) :: PackageIdentifier -> PackageIdentifier -> Bool #

max :: PackageIdentifier -> PackageIdentifier -> PackageIdentifier #

min :: PackageIdentifier -> PackageIdentifier -> PackageIdentifier #

Read PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

readsPrec :: Int -> ReadS PackageIdentifier #

readList :: ReadS [PackageIdentifier] #

readPrec :: ReadPrec PackageIdentifier #

readListPrec :: ReadPrec [PackageIdentifier] #

Show PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

showsPrec :: Int -> PackageIdentifier -> ShowS #

show :: PackageIdentifier -> String #

showList :: [PackageIdentifier] -> ShowS #

Generic PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Associated Types

type Rep PackageIdentifier :: * -> * #

Methods

from :: PackageIdentifier -> Rep PackageIdentifier x #

to :: Rep PackageIdentifier x -> PackageIdentifier #

Binary PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

put :: PackageIdentifier -> Put #

get :: Get PackageIdentifier #

putList :: [PackageIdentifier] -> Put #

NFData PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

rnf :: PackageIdentifier -> () #

Pretty PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

pretty :: PackageIdentifier -> Doc #

Parsec PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

parsec :: CabalParsing m => m PackageIdentifier #

Text PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

disp :: PackageIdentifier -> Doc #

parse :: ReadP r PackageIdentifier #

Package PackageIdentifier # 
Instance details

Defined in Distribution.Package

Methods

packageId :: PackageIdentifier -> PackageIdentifier #

type Rep PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

type Rep PackageIdentifier = D1 (MetaData "PackageIdentifier" "Distribution.Types.PackageId" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "PackageIdentifier" PrefixI True) (S1 (MetaSel (Just "pkgName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageName) :*: S1 (MetaSel (Just "pkgVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)))

pkgName :: Lens' PackageIdentifier PackageName #

pkgVersion :: Lens' PackageIdentifier Version #

diff --git a/doc/API/Cabal/Distribution-Types-PackageId.html b/doc/API/Cabal/Distribution-Types-PackageId.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-PackageId.html @@ -0,0 +1,1 @@ +Distribution.Types.PackageId

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.PackageId

Synopsis

Documentation

data PackageIdentifier #

The name and version of a package.

Constructors

PackageIdentifier 

Fields

Instances
Eq PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

(==) :: PackageIdentifier -> PackageIdentifier -> Bool #

(/=) :: PackageIdentifier -> PackageIdentifier -> Bool #

Data PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PackageIdentifier -> c PackageIdentifier #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PackageIdentifier #

toConstr :: PackageIdentifier -> Constr #

dataTypeOf :: PackageIdentifier -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PackageIdentifier) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PackageIdentifier) #

gmapT :: (forall b. Data b => b -> b) -> PackageIdentifier -> PackageIdentifier #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PackageIdentifier -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PackageIdentifier -> r #

gmapQ :: (forall d. Data d => d -> u) -> PackageIdentifier -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PackageIdentifier -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PackageIdentifier -> m PackageIdentifier #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageIdentifier -> m PackageIdentifier #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageIdentifier -> m PackageIdentifier #

Ord PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

compare :: PackageIdentifier -> PackageIdentifier -> Ordering #

(<) :: PackageIdentifier -> PackageIdentifier -> Bool #

(<=) :: PackageIdentifier -> PackageIdentifier -> Bool #

(>) :: PackageIdentifier -> PackageIdentifier -> Bool #

(>=) :: PackageIdentifier -> PackageIdentifier -> Bool #

max :: PackageIdentifier -> PackageIdentifier -> PackageIdentifier #

min :: PackageIdentifier -> PackageIdentifier -> PackageIdentifier #

Read PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

readsPrec :: Int -> ReadS PackageIdentifier #

readList :: ReadS [PackageIdentifier] #

readPrec :: ReadPrec PackageIdentifier #

readListPrec :: ReadPrec [PackageIdentifier] #

Show PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

showsPrec :: Int -> PackageIdentifier -> ShowS #

show :: PackageIdentifier -> String #

showList :: [PackageIdentifier] -> ShowS #

Generic PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Associated Types

type Rep PackageIdentifier :: * -> * #

Methods

from :: PackageIdentifier -> Rep PackageIdentifier x #

to :: Rep PackageIdentifier x -> PackageIdentifier #

Binary PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

put :: PackageIdentifier -> Put #

get :: Get PackageIdentifier #

putList :: [PackageIdentifier] -> Put #

NFData PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

rnf :: PackageIdentifier -> () #

Pretty PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

pretty :: PackageIdentifier -> Doc #

Parsec PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

parsec :: CabalParsing m => m PackageIdentifier #

Text PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

Methods

disp :: PackageIdentifier -> Doc #

parse :: ReadP r PackageIdentifier #

Package PackageIdentifier # 
Instance details

Defined in Distribution.Package

Methods

packageId :: PackageIdentifier -> PackageIdentifier #

type Rep PackageIdentifier # 
Instance details

Defined in Distribution.Types.PackageId

type Rep PackageIdentifier = D1 (MetaData "PackageIdentifier" "Distribution.Types.PackageId" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "PackageIdentifier" PrefixI True) (S1 (MetaSel (Just "pkgName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageName) :*: S1 (MetaSel (Just "pkgVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)))

type PackageId = PackageIdentifier #

Type alias so we can use the shorter name PackageId.

diff --git a/doc/API/Cabal/Distribution-Types-PackageName.html b/doc/API/Cabal/Distribution-Types-PackageName.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-PackageName.html @@ -0,0 +1,3 @@ +Distribution.Types.PackageName

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.PackageName

Synopsis

Documentation

data PackageName #

A package name.

Use mkPackageName and unPackageName to convert from/to a + String.

This type is opaque since Cabal-2.0

Since: 2.0.0.2

Instances
Eq PackageName # 
Instance details

Defined in Distribution.Types.PackageName

Methods

(==) :: PackageName -> PackageName -> Bool #

(/=) :: PackageName -> PackageName -> Bool #

Data PackageName # 
Instance details

Defined in Distribution.Types.PackageName

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PackageName -> c PackageName #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PackageName #

toConstr :: PackageName -> Constr #

dataTypeOf :: PackageName -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PackageName) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PackageName) #

gmapT :: (forall b. Data b => b -> b) -> PackageName -> PackageName #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PackageName -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PackageName -> r #

gmapQ :: (forall d. Data d => d -> u) -> PackageName -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PackageName -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PackageName -> m PackageName #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageName -> m PackageName #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageName -> m PackageName #

Ord PackageName # 
Instance details

Defined in Distribution.Types.PackageName

Methods

compare :: PackageName -> PackageName -> Ordering #

(<) :: PackageName -> PackageName -> Bool #

(<=) :: PackageName -> PackageName -> Bool #

(>) :: PackageName -> PackageName -> Bool #

(>=) :: PackageName -> PackageName -> Bool #

max :: PackageName -> PackageName -> PackageName #

min :: PackageName -> PackageName -> PackageName #

Read PackageName # 
Instance details

Defined in Distribution.Types.PackageName

Methods

readsPrec :: Int -> ReadS PackageName #

readList :: ReadS [PackageName] #

readPrec :: ReadPrec PackageName #

readListPrec :: ReadPrec [PackageName] #

Show PackageName # 
Instance details

Defined in Distribution.Types.PackageName

Methods

showsPrec :: Int -> PackageName -> ShowS #

show :: PackageName -> String #

showList :: [PackageName] -> ShowS #

IsString PackageName #

mkPackageName

Since: 2.0.0.2

Instance details

Defined in Distribution.Types.PackageName

Methods

fromString :: String -> PackageName #

Generic PackageName # 
Instance details

Defined in Distribution.Types.PackageName

Associated Types

type Rep PackageName :: * -> * #

Methods

from :: PackageName -> Rep PackageName x #

to :: Rep PackageName x -> PackageName #

Binary PackageName # 
Instance details

Defined in Distribution.Types.PackageName

Methods

put :: PackageName -> Put #

get :: Get PackageName #

putList :: [PackageName] -> Put #

NFData PackageName # 
Instance details

Defined in Distribution.Types.PackageName

Methods

rnf :: PackageName -> () #

Pretty PackageName # 
Instance details

Defined in Distribution.Types.PackageName

Methods

pretty :: PackageName -> Doc #

Parsec PackageName # 
Instance details

Defined in Distribution.Types.PackageName

Methods

parsec :: CabalParsing m => m PackageName #

Text PackageName # 
Instance details

Defined in Distribution.Types.PackageName

Methods

disp :: PackageName -> Doc #

parse :: ReadP r PackageName #

type Rep PackageName # 
Instance details

Defined in Distribution.Types.PackageName

type Rep PackageName = D1 (MetaData "PackageName" "Distribution.Types.PackageName" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "PackageName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ShortText)))

unPackageName :: PackageName -> String #

Convert PackageName to String

mkPackageName :: String -> PackageName #

Construct a PackageName from a String

mkPackageName is the inverse to unPackageName

Note: No validations are performed to ensure that the resulting + PackageName is valid

Since: 2.0.0.2

diff --git a/doc/API/Cabal/Distribution-Types-PkgconfigDependency.html b/doc/API/Cabal/Distribution-Types-PkgconfigDependency.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-PkgconfigDependency.html @@ -0,0 +1,1 @@ +Distribution.Types.PkgconfigDependency

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.PkgconfigDependency

Synopsis

Documentation

data PkgconfigDependency #

Describes a dependency on a pkg-config library

Since: 2.0.0.2

Constructors

PkgconfigDependency PkgconfigName VersionRange 
Instances
Eq PkgconfigDependency # 
Instance details

Defined in Distribution.Types.PkgconfigDependency

Methods

(==) :: PkgconfigDependency -> PkgconfigDependency -> Bool #

(/=) :: PkgconfigDependency -> PkgconfigDependency -> Bool #

Data PkgconfigDependency # 
Instance details

Defined in Distribution.Types.PkgconfigDependency

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PkgconfigDependency -> c PkgconfigDependency #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PkgconfigDependency #

toConstr :: PkgconfigDependency -> Constr #

dataTypeOf :: PkgconfigDependency -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PkgconfigDependency) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PkgconfigDependency) #

gmapT :: (forall b. Data b => b -> b) -> PkgconfigDependency -> PkgconfigDependency #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PkgconfigDependency -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PkgconfigDependency -> r #

gmapQ :: (forall d. Data d => d -> u) -> PkgconfigDependency -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PkgconfigDependency -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PkgconfigDependency -> m PkgconfigDependency #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PkgconfigDependency -> m PkgconfigDependency #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PkgconfigDependency -> m PkgconfigDependency #

Read PkgconfigDependency # 
Instance details

Defined in Distribution.Types.PkgconfigDependency

Methods

readsPrec :: Int -> ReadS PkgconfigDependency #

readList :: ReadS [PkgconfigDependency] #

readPrec :: ReadPrec PkgconfigDependency #

readListPrec :: ReadPrec [PkgconfigDependency] #

Show PkgconfigDependency # 
Instance details

Defined in Distribution.Types.PkgconfigDependency

Methods

showsPrec :: Int -> PkgconfigDependency -> ShowS #

show :: PkgconfigDependency -> String #

showList :: [PkgconfigDependency] -> ShowS #

Generic PkgconfigDependency # 
Instance details

Defined in Distribution.Types.PkgconfigDependency

Associated Types

type Rep PkgconfigDependency :: * -> * #

Methods

from :: PkgconfigDependency -> Rep PkgconfigDependency x #

to :: Rep PkgconfigDependency x -> PkgconfigDependency #

Binary PkgconfigDependency # 
Instance details

Defined in Distribution.Types.PkgconfigDependency

Methods

put :: PkgconfigDependency -> Put #

get :: Get PkgconfigDependency #

putList :: [PkgconfigDependency] -> Put #

NFData PkgconfigDependency # 
Instance details

Defined in Distribution.Types.PkgconfigDependency

Methods

rnf :: PkgconfigDependency -> () #

Pretty PkgconfigDependency # 
Instance details

Defined in Distribution.Types.PkgconfigDependency

Methods

pretty :: PkgconfigDependency -> Doc #

Parsec PkgconfigDependency # 
Instance details

Defined in Distribution.Types.PkgconfigDependency

Methods

parsec :: CabalParsing m => m PkgconfigDependency #

Text PkgconfigDependency # 
Instance details

Defined in Distribution.Types.PkgconfigDependency

Methods

disp :: PkgconfigDependency -> Doc #

parse :: ReadP r PkgconfigDependency #

type Rep PkgconfigDependency # 
Instance details

Defined in Distribution.Types.PkgconfigDependency

type Rep PkgconfigDependency = D1 (MetaData "PkgconfigDependency" "Distribution.Types.PkgconfigDependency" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "PkgconfigDependency" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PkgconfigName) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange)))
diff --git a/doc/API/Cabal/Distribution-Types-PkgconfigName.html b/doc/API/Cabal/Distribution-Types-PkgconfigName.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-PkgconfigName.html @@ -0,0 +1,2 @@ +Distribution.Types.PkgconfigName

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.PkgconfigName

Synopsis

Documentation

data PkgconfigName #

A pkg-config library name

This is parsed as any valid argument to the pkg-config utility.

Since: 2.0.0.2

Instances
Eq PkgconfigName # 
Instance details

Defined in Distribution.Types.PkgconfigName

Methods

(==) :: PkgconfigName -> PkgconfigName -> Bool #

(/=) :: PkgconfigName -> PkgconfigName -> Bool #

Data PkgconfigName # 
Instance details

Defined in Distribution.Types.PkgconfigName

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PkgconfigName -> c PkgconfigName #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PkgconfigName #

toConstr :: PkgconfigName -> Constr #

dataTypeOf :: PkgconfigName -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PkgconfigName) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PkgconfigName) #

gmapT :: (forall b. Data b => b -> b) -> PkgconfigName -> PkgconfigName #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PkgconfigName -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PkgconfigName -> r #

gmapQ :: (forall d. Data d => d -> u) -> PkgconfigName -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PkgconfigName -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PkgconfigName -> m PkgconfigName #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PkgconfigName -> m PkgconfigName #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PkgconfigName -> m PkgconfigName #

Ord PkgconfigName # 
Instance details

Defined in Distribution.Types.PkgconfigName

Methods

compare :: PkgconfigName -> PkgconfigName -> Ordering #

(<) :: PkgconfigName -> PkgconfigName -> Bool #

(<=) :: PkgconfigName -> PkgconfigName -> Bool #

(>) :: PkgconfigName -> PkgconfigName -> Bool #

(>=) :: PkgconfigName -> PkgconfigName -> Bool #

max :: PkgconfigName -> PkgconfigName -> PkgconfigName #

min :: PkgconfigName -> PkgconfigName -> PkgconfigName #

Read PkgconfigName # 
Instance details

Defined in Distribution.Types.PkgconfigName

Methods

readsPrec :: Int -> ReadS PkgconfigName #

readList :: ReadS [PkgconfigName] #

readPrec :: ReadPrec PkgconfigName #

readListPrec :: ReadPrec [PkgconfigName] #

Show PkgconfigName # 
Instance details

Defined in Distribution.Types.PkgconfigName

Methods

showsPrec :: Int -> PkgconfigName -> ShowS #

show :: PkgconfigName -> String #

showList :: [PkgconfigName] -> ShowS #

IsString PkgconfigName #

mkPkgconfigName

Since: 2.0.0.2

Instance details

Defined in Distribution.Types.PkgconfigName

Methods

fromString :: String -> PkgconfigName #

Generic PkgconfigName # 
Instance details

Defined in Distribution.Types.PkgconfigName

Associated Types

type Rep PkgconfigName :: * -> * #

Methods

from :: PkgconfigName -> Rep PkgconfigName x #

to :: Rep PkgconfigName x -> PkgconfigName #

Binary PkgconfigName # 
Instance details

Defined in Distribution.Types.PkgconfigName

Methods

put :: PkgconfigName -> Put #

get :: Get PkgconfigName #

putList :: [PkgconfigName] -> Put #

NFData PkgconfigName # 
Instance details

Defined in Distribution.Types.PkgconfigName

Methods

rnf :: PkgconfigName -> () #

Pretty PkgconfigName # 
Instance details

Defined in Distribution.Types.PkgconfigName

Methods

pretty :: PkgconfigName -> Doc #

Parsec PkgconfigName # 
Instance details

Defined in Distribution.Types.PkgconfigName

Methods

parsec :: CabalParsing m => m PkgconfigName #

Text PkgconfigName # 
Instance details

Defined in Distribution.Types.PkgconfigName

Methods

disp :: PkgconfigName -> Doc #

parse :: ReadP r PkgconfigName #

type Rep PkgconfigName # 
Instance details

Defined in Distribution.Types.PkgconfigName

type Rep PkgconfigName = D1 (MetaData "PkgconfigName" "Distribution.Types.PkgconfigName" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "PkgconfigName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ShortText)))

unPkgconfigName :: PkgconfigName -> String #

Convert PkgconfigName to String

Since: 2.0.0.2

mkPkgconfigName :: String -> PkgconfigName #

Construct a PkgconfigName from a String

mkPkgconfigName is the inverse to unPkgconfigName

Note: No validations are performed to ensure that the resulting + PkgconfigName is valid

Since: 2.0.0.2

diff --git a/doc/API/Cabal/Distribution-Types-SetupBuildInfo-Lens.html b/doc/API/Cabal/Distribution-Types-SetupBuildInfo-Lens.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-SetupBuildInfo-Lens.html @@ -0,0 +1,1 @@ +Distribution.Types.SetupBuildInfo.Lens

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.SetupBuildInfo.Lens

Documentation

data SetupBuildInfo #

Instances
Eq SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

(==) :: SetupBuildInfo -> SetupBuildInfo -> Bool #

(/=) :: SetupBuildInfo -> SetupBuildInfo -> Bool #

Data SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetupBuildInfo -> c SetupBuildInfo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetupBuildInfo #

toConstr :: SetupBuildInfo -> Constr #

dataTypeOf :: SetupBuildInfo -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SetupBuildInfo) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetupBuildInfo) #

gmapT :: (forall b. Data b => b -> b) -> SetupBuildInfo -> SetupBuildInfo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetupBuildInfo -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetupBuildInfo -> r #

gmapQ :: (forall d. Data d => d -> u) -> SetupBuildInfo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SetupBuildInfo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetupBuildInfo -> m SetupBuildInfo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetupBuildInfo -> m SetupBuildInfo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetupBuildInfo -> m SetupBuildInfo #

Read SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

readsPrec :: Int -> ReadS SetupBuildInfo #

readList :: ReadS [SetupBuildInfo] #

readPrec :: ReadPrec SetupBuildInfo #

readListPrec :: ReadPrec [SetupBuildInfo] #

Show SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

showsPrec :: Int -> SetupBuildInfo -> ShowS #

show :: SetupBuildInfo -> String #

showList :: [SetupBuildInfo] -> ShowS #

Generic SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Associated Types

type Rep SetupBuildInfo :: * -> * #

Methods

from :: SetupBuildInfo -> Rep SetupBuildInfo x #

to :: Rep SetupBuildInfo x -> SetupBuildInfo #

Semigroup SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

(<>) :: SetupBuildInfo -> SetupBuildInfo -> SetupBuildInfo #

sconcat :: NonEmpty SetupBuildInfo -> SetupBuildInfo #

stimes :: Integral b => b -> SetupBuildInfo -> SetupBuildInfo #

Monoid SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

mempty :: SetupBuildInfo #

mappend :: SetupBuildInfo -> SetupBuildInfo -> SetupBuildInfo #

mconcat :: [SetupBuildInfo] -> SetupBuildInfo #

Binary SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

put :: SetupBuildInfo -> Put #

get :: Get SetupBuildInfo #

putList :: [SetupBuildInfo] -> Put #

NFData SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

rnf :: SetupBuildInfo -> () #

type Rep SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

type Rep SetupBuildInfo = D1 (MetaData "SetupBuildInfo" "Distribution.Types.SetupBuildInfo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "SetupBuildInfo" PrefixI True) (S1 (MetaSel (Just "setupDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Dependency]) :*: S1 (MetaSel (Just "defaultSetupDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))

setupDepends :: Lens' SetupBuildInfo [Dependency] #

defaultSetupDepends :: Lens' SetupBuildInfo Bool #

diff --git a/doc/API/Cabal/Distribution-Types-SetupBuildInfo.html b/doc/API/Cabal/Distribution-Types-SetupBuildInfo.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-SetupBuildInfo.html @@ -0,0 +1,4 @@ +Distribution.Types.SetupBuildInfo

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.SetupBuildInfo

Documentation

data SetupBuildInfo #

Constructors

SetupBuildInfo 

Fields

  • setupDepends :: [Dependency]
     
  • defaultSetupDepends :: Bool

    Is this a default 'custom-setup' section added by the cabal-install + code (as opposed to user-provided)? This field is only used + internally, and doesn't correspond to anything in the .cabal + file. See #3199.

Instances
Eq SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

(==) :: SetupBuildInfo -> SetupBuildInfo -> Bool #

(/=) :: SetupBuildInfo -> SetupBuildInfo -> Bool #

Data SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetupBuildInfo -> c SetupBuildInfo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetupBuildInfo #

toConstr :: SetupBuildInfo -> Constr #

dataTypeOf :: SetupBuildInfo -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SetupBuildInfo) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetupBuildInfo) #

gmapT :: (forall b. Data b => b -> b) -> SetupBuildInfo -> SetupBuildInfo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetupBuildInfo -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetupBuildInfo -> r #

gmapQ :: (forall d. Data d => d -> u) -> SetupBuildInfo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SetupBuildInfo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetupBuildInfo -> m SetupBuildInfo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetupBuildInfo -> m SetupBuildInfo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetupBuildInfo -> m SetupBuildInfo #

Read SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

readsPrec :: Int -> ReadS SetupBuildInfo #

readList :: ReadS [SetupBuildInfo] #

readPrec :: ReadPrec SetupBuildInfo #

readListPrec :: ReadPrec [SetupBuildInfo] #

Show SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

showsPrec :: Int -> SetupBuildInfo -> ShowS #

show :: SetupBuildInfo -> String #

showList :: [SetupBuildInfo] -> ShowS #

Generic SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Associated Types

type Rep SetupBuildInfo :: * -> * #

Methods

from :: SetupBuildInfo -> Rep SetupBuildInfo x #

to :: Rep SetupBuildInfo x -> SetupBuildInfo #

Semigroup SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

(<>) :: SetupBuildInfo -> SetupBuildInfo -> SetupBuildInfo #

sconcat :: NonEmpty SetupBuildInfo -> SetupBuildInfo #

stimes :: Integral b => b -> SetupBuildInfo -> SetupBuildInfo #

Monoid SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

mempty :: SetupBuildInfo #

mappend :: SetupBuildInfo -> SetupBuildInfo -> SetupBuildInfo #

mconcat :: [SetupBuildInfo] -> SetupBuildInfo #

Binary SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

put :: SetupBuildInfo -> Put #

get :: Get SetupBuildInfo #

putList :: [SetupBuildInfo] -> Put #

NFData SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

Methods

rnf :: SetupBuildInfo -> () #

type Rep SetupBuildInfo # 
Instance details

Defined in Distribution.Types.SetupBuildInfo

type Rep SetupBuildInfo = D1 (MetaData "SetupBuildInfo" "Distribution.Types.SetupBuildInfo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "SetupBuildInfo" PrefixI True) (S1 (MetaSel (Just "setupDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Dependency]) :*: S1 (MetaSel (Just "defaultSetupDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))
diff --git a/doc/API/Cabal/Distribution-Types-SourceRepo-Lens.html b/doc/API/Cabal/Distribution-Types-SourceRepo-Lens.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-SourceRepo-Lens.html @@ -0,0 +1,9 @@ +Distribution.Types.SourceRepo.Lens

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.SourceRepo.Lens

Synopsis

Documentation

data SourceRepo #

Information about the source revision control system for a package.

When specifying a repo it is useful to know the meaning or intention of the + information as doing so enables automation. There are two obvious common + purposes: one is to find the repo for the latest development version, the + other is to find the repo for this specific release. The ReopKind + specifies which one we mean (or another custom one).

A package can specify one or the other kind or both. Most will specify just + a head repo but some may want to specify a repo to reconstruct the sources + for this package release.

The required information is the RepoType which tells us if it's using + Darcs, Git for example. The repoLocation and other details are + interpreted according to the repo type.

Instances
Eq SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

(==) :: SourceRepo -> SourceRepo -> Bool #

(/=) :: SourceRepo -> SourceRepo -> Bool #

Data SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SourceRepo -> c SourceRepo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SourceRepo #

toConstr :: SourceRepo -> Constr #

dataTypeOf :: SourceRepo -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SourceRepo) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SourceRepo) #

gmapT :: (forall b. Data b => b -> b) -> SourceRepo -> SourceRepo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SourceRepo -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SourceRepo -> r #

gmapQ :: (forall d. Data d => d -> u) -> SourceRepo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SourceRepo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SourceRepo -> m SourceRepo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SourceRepo -> m SourceRepo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SourceRepo -> m SourceRepo #

Ord SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

compare :: SourceRepo -> SourceRepo -> Ordering #

(<) :: SourceRepo -> SourceRepo -> Bool #

(<=) :: SourceRepo -> SourceRepo -> Bool #

(>) :: SourceRepo -> SourceRepo -> Bool #

(>=) :: SourceRepo -> SourceRepo -> Bool #

max :: SourceRepo -> SourceRepo -> SourceRepo #

min :: SourceRepo -> SourceRepo -> SourceRepo #

Read SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

readsPrec :: Int -> ReadS SourceRepo #

readList :: ReadS [SourceRepo] #

readPrec :: ReadPrec SourceRepo #

readListPrec :: ReadPrec [SourceRepo] #

Show SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

showsPrec :: Int -> SourceRepo -> ShowS #

show :: SourceRepo -> String #

showList :: [SourceRepo] -> ShowS #

Generic SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Associated Types

type Rep SourceRepo :: * -> * #

Methods

from :: SourceRepo -> Rep SourceRepo x #

to :: Rep SourceRepo x -> SourceRepo #

Binary SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

put :: SourceRepo -> Put #

get :: Get SourceRepo #

putList :: [SourceRepo] -> Put #

NFData SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

rnf :: SourceRepo -> () #

type Rep SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

type Rep SourceRepo = D1 (MetaData "SourceRepo" "Distribution.Types.SourceRepo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "SourceRepo" PrefixI True) ((S1 (MetaSel (Just "repoKind") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RepoKind) :*: (S1 (MetaSel (Just "repoType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe RepoType)) :*: S1 (MetaSel (Just "repoLocation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)))) :*: ((S1 (MetaSel (Just "repoModule") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :*: S1 (MetaSel (Just "repoBranch") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String))) :*: (S1 (MetaSel (Just "repoTag") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :*: S1 (MetaSel (Just "repoSubdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))))))

repoKind :: Lens' SourceRepo RepoKind #

repoType :: Lens' SourceRepo (Maybe RepoType) #

repoLocation :: Lens' SourceRepo (Maybe String) #

repoModule :: Lens' SourceRepo (Maybe String) #

repoBranch :: Lens' SourceRepo (Maybe String) #

repoTag :: Lens' SourceRepo (Maybe String) #

repoSubdir :: Lens' SourceRepo (Maybe FilePath) #

diff --git a/doc/API/Cabal/Distribution-Types-SourceRepo.html b/doc/API/Cabal/Distribution-Types-SourceRepo.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-SourceRepo.html @@ -0,0 +1,31 @@ +Distribution.Types.SourceRepo

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.SourceRepo

Synopsis

Documentation

data SourceRepo #

Information about the source revision control system for a package.

When specifying a repo it is useful to know the meaning or intention of the + information as doing so enables automation. There are two obvious common + purposes: one is to find the repo for the latest development version, the + other is to find the repo for this specific release. The ReopKind + specifies which one we mean (or another custom one).

A package can specify one or the other kind or both. Most will specify just + a head repo but some may want to specify a repo to reconstruct the sources + for this package release.

The required information is the RepoType which tells us if it's using + Darcs, Git for example. The repoLocation and other details are + interpreted according to the repo type.

Constructors

SourceRepo 

Fields

  • repoKind :: RepoKind

    The kind of repo. This field is required.

  • repoType :: Maybe RepoType

    The type of the source repository system for this repo, eg Darcs or + Git. This field is required.

  • repoLocation :: Maybe String

    The location of the repository. For most RepoTypes this is a URL. + This field is required.

  • repoModule :: Maybe String

    CVS can put multiple "modules" on one server and requires a + module name in addition to the location to identify a particular repo. + Logically this is part of the location but unfortunately has to be + specified separately. This field is required for the CVS RepoType and + should not be given otherwise.

  • repoBranch :: Maybe String

    The name or identifier of the branch, if any. Many source control + systems have the notion of multiple branches in a repo that exist in the + same location. For example Git and CVS use this while systems like + Darcs use different locations for different branches. This field is + optional but should be used if necessary to identify the sources, + especially for the RepoThis repo kind.

  • repoTag :: Maybe String

    The tag identify a particular state of the repository. This should be + given for the RepoThis repo kind and not for RepoHead kind.

  • repoSubdir :: Maybe FilePath

    Some repositories contain multiple projects in different subdirectories + This field specifies the subdirectory where this packages sources can be + found, eg the subdirectory containing the .cabal file. It is interpreted + relative to the root of the repository. This field is optional. If not + given the default is "." ie no subdirectory.

Instances
Eq SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

(==) :: SourceRepo -> SourceRepo -> Bool #

(/=) :: SourceRepo -> SourceRepo -> Bool #

Data SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SourceRepo -> c SourceRepo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SourceRepo #

toConstr :: SourceRepo -> Constr #

dataTypeOf :: SourceRepo -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SourceRepo) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SourceRepo) #

gmapT :: (forall b. Data b => b -> b) -> SourceRepo -> SourceRepo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SourceRepo -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SourceRepo -> r #

gmapQ :: (forall d. Data d => d -> u) -> SourceRepo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SourceRepo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SourceRepo -> m SourceRepo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SourceRepo -> m SourceRepo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SourceRepo -> m SourceRepo #

Ord SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

compare :: SourceRepo -> SourceRepo -> Ordering #

(<) :: SourceRepo -> SourceRepo -> Bool #

(<=) :: SourceRepo -> SourceRepo -> Bool #

(>) :: SourceRepo -> SourceRepo -> Bool #

(>=) :: SourceRepo -> SourceRepo -> Bool #

max :: SourceRepo -> SourceRepo -> SourceRepo #

min :: SourceRepo -> SourceRepo -> SourceRepo #

Read SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

readsPrec :: Int -> ReadS SourceRepo #

readList :: ReadS [SourceRepo] #

readPrec :: ReadPrec SourceRepo #

readListPrec :: ReadPrec [SourceRepo] #

Show SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

showsPrec :: Int -> SourceRepo -> ShowS #

show :: SourceRepo -> String #

showList :: [SourceRepo] -> ShowS #

Generic SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Associated Types

type Rep SourceRepo :: * -> * #

Methods

from :: SourceRepo -> Rep SourceRepo x #

to :: Rep SourceRepo x -> SourceRepo #

Binary SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

put :: SourceRepo -> Put #

get :: Get SourceRepo #

putList :: [SourceRepo] -> Put #

NFData SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

rnf :: SourceRepo -> () #

type Rep SourceRepo # 
Instance details

Defined in Distribution.Types.SourceRepo

type Rep SourceRepo = D1 (MetaData "SourceRepo" "Distribution.Types.SourceRepo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "SourceRepo" PrefixI True) ((S1 (MetaSel (Just "repoKind") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RepoKind) :*: (S1 (MetaSel (Just "repoType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe RepoType)) :*: S1 (MetaSel (Just "repoLocation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)))) :*: ((S1 (MetaSel (Just "repoModule") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :*: S1 (MetaSel (Just "repoBranch") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String))) :*: (S1 (MetaSel (Just "repoTag") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :*: S1 (MetaSel (Just "repoSubdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))))))

data RepoKind #

What this repo info is for, what it represents.

Constructors

RepoHead

The repository for the "head" or development version of the project. + This repo is where we should track the latest development activity or + the usual repo people should get to contribute patches.

RepoThis

The repository containing the sources for this exact package version + or release. For this kind of repo a tag should be given to give enough + information to re-create the exact sources.

RepoKindUnknown String 
Instances
Eq RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

(==) :: RepoKind -> RepoKind -> Bool #

(/=) :: RepoKind -> RepoKind -> Bool #

Data RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RepoKind -> c RepoKind #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RepoKind #

toConstr :: RepoKind -> Constr #

dataTypeOf :: RepoKind -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RepoKind) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RepoKind) #

gmapT :: (forall b. Data b => b -> b) -> RepoKind -> RepoKind #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RepoKind -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RepoKind -> r #

gmapQ :: (forall d. Data d => d -> u) -> RepoKind -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RepoKind -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RepoKind -> m RepoKind #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RepoKind -> m RepoKind #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RepoKind -> m RepoKind #

Ord RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

compare :: RepoKind -> RepoKind -> Ordering #

(<) :: RepoKind -> RepoKind -> Bool #

(<=) :: RepoKind -> RepoKind -> Bool #

(>) :: RepoKind -> RepoKind -> Bool #

(>=) :: RepoKind -> RepoKind -> Bool #

max :: RepoKind -> RepoKind -> RepoKind #

min :: RepoKind -> RepoKind -> RepoKind #

Read RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

readsPrec :: Int -> ReadS RepoKind #

readList :: ReadS [RepoKind] #

readPrec :: ReadPrec RepoKind #

readListPrec :: ReadPrec [RepoKind] #

Show RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

showsPrec :: Int -> RepoKind -> ShowS #

show :: RepoKind -> String #

showList :: [RepoKind] -> ShowS #

Generic RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Associated Types

type Rep RepoKind :: * -> * #

Methods

from :: RepoKind -> Rep RepoKind x #

to :: Rep RepoKind x -> RepoKind #

Binary RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

put :: RepoKind -> Put #

get :: Get RepoKind #

putList :: [RepoKind] -> Put #

NFData RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

rnf :: RepoKind -> () #

Pretty RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

pretty :: RepoKind -> Doc #

Parsec RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

parsec :: CabalParsing m => m RepoKind #

Text RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

disp :: RepoKind -> Doc #

parse :: ReadP r RepoKind #

type Rep RepoKind # 
Instance details

Defined in Distribution.Types.SourceRepo

type Rep RepoKind = D1 (MetaData "RepoKind" "Distribution.Types.SourceRepo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "RepoHead" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "RepoThis" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "RepoKindUnknown" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))

data RepoType #

An enumeration of common source control systems. The fields used in the + SourceRepo depend on the type of repo. The tools and methods used to + obtain and track the repo depend on the repo type.

Constructors

Darcs 
Git 
SVN 
CVS 
Mercurial 
GnuArch 
Bazaar 
Monotone 
OtherRepoType String 
Instances
Eq RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

(==) :: RepoType -> RepoType -> Bool #

(/=) :: RepoType -> RepoType -> Bool #

Data RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RepoType -> c RepoType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RepoType #

toConstr :: RepoType -> Constr #

dataTypeOf :: RepoType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RepoType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RepoType) #

gmapT :: (forall b. Data b => b -> b) -> RepoType -> RepoType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RepoType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RepoType -> r #

gmapQ :: (forall d. Data d => d -> u) -> RepoType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RepoType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RepoType -> m RepoType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RepoType -> m RepoType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RepoType -> m RepoType #

Ord RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

compare :: RepoType -> RepoType -> Ordering #

(<) :: RepoType -> RepoType -> Bool #

(<=) :: RepoType -> RepoType -> Bool #

(>) :: RepoType -> RepoType -> Bool #

(>=) :: RepoType -> RepoType -> Bool #

max :: RepoType -> RepoType -> RepoType #

min :: RepoType -> RepoType -> RepoType #

Read RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

readsPrec :: Int -> ReadS RepoType #

readList :: ReadS [RepoType] #

readPrec :: ReadPrec RepoType #

readListPrec :: ReadPrec [RepoType] #

Show RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

showsPrec :: Int -> RepoType -> ShowS #

show :: RepoType -> String #

showList :: [RepoType] -> ShowS #

Generic RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Associated Types

type Rep RepoType :: * -> * #

Methods

from :: RepoType -> Rep RepoType x #

to :: Rep RepoType x -> RepoType #

Binary RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

put :: RepoType -> Put #

get :: Get RepoType #

putList :: [RepoType] -> Put #

NFData RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

rnf :: RepoType -> () #

Pretty RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

pretty :: RepoType -> Doc #

Parsec RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

parsec :: CabalParsing m => m RepoType #

Text RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

disp :: RepoType -> Doc #

parse :: ReadP r RepoType #

type Rep RepoType # 
Instance details

Defined in Distribution.Types.SourceRepo

type Rep RepoType = D1 (MetaData "RepoType" "Distribution.Types.SourceRepo" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (((C1 (MetaCons "Darcs" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Git" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "SVN" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CVS" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "Mercurial" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "GnuArch" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Bazaar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Monotone" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OtherRepoType" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))))

knownRepoTypes :: [RepoType] #

emptySourceRepo :: RepoKind -> SourceRepo #

classifyRepoType :: String -> RepoType #

classifyRepoKind :: String -> RepoKind #

diff --git a/doc/API/Cabal/Distribution-Types-TargetInfo.html b/doc/API/Cabal/Distribution-Types-TargetInfo.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-TargetInfo.html @@ -0,0 +1,5 @@ +Distribution.Types.TargetInfo

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.TargetInfo

Synopsis

Documentation

data TargetInfo #

The TargetInfo contains all the information necessary to build a + specific target (e.g., componentmodulefile) in a package. In + principle, one can get the Component from a + ComponentLocalBuildInfo and LocalBuildInfo, but it is much more + convenient to have the component in hand.

Constructors

TargetInfo 

Fields

Instances
IsNode TargetInfo # 
Instance details

Defined in Distribution.Types.TargetInfo

Associated Types

type Key TargetInfo :: * #

Methods

nodeKey :: TargetInfo -> Key TargetInfo #

nodeNeighbors :: TargetInfo -> [Key TargetInfo] #

type Key TargetInfo # 
Instance details

Defined in Distribution.Types.TargetInfo

type Key TargetInfo = UnitId
diff --git a/doc/API/Cabal/Distribution-Types-TestSuite-Lens.html b/doc/API/Cabal/Distribution-Types-TestSuite-Lens.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-TestSuite-Lens.html @@ -0,0 +1,1 @@ +Distribution.Types.TestSuite.Lens

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.TestSuite.Lens

Synopsis

Documentation

data TestSuite #

A "test-suite" stanza in a cabal file.

Instances
Eq TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

(==) :: TestSuite -> TestSuite -> Bool #

(/=) :: TestSuite -> TestSuite -> Bool #

Data TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TestSuite -> c TestSuite #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TestSuite #

toConstr :: TestSuite -> Constr #

dataTypeOf :: TestSuite -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TestSuite) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TestSuite) #

gmapT :: (forall b. Data b => b -> b) -> TestSuite -> TestSuite #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TestSuite -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TestSuite -> r #

gmapQ :: (forall d. Data d => d -> u) -> TestSuite -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> TestSuite -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TestSuite -> m TestSuite #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TestSuite -> m TestSuite #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TestSuite -> m TestSuite #

Read TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

readsPrec :: Int -> ReadS TestSuite #

readList :: ReadS [TestSuite] #

readPrec :: ReadPrec TestSuite #

readListPrec :: ReadPrec [TestSuite] #

Show TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

showsPrec :: Int -> TestSuite -> ShowS #

show :: TestSuite -> String #

showList :: [TestSuite] -> ShowS #

Generic TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Associated Types

type Rep TestSuite :: * -> * #

Methods

from :: TestSuite -> Rep TestSuite x #

to :: Rep TestSuite x -> TestSuite #

Semigroup TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

(<>) :: TestSuite -> TestSuite -> TestSuite #

sconcat :: NonEmpty TestSuite -> TestSuite #

stimes :: Integral b => b -> TestSuite -> TestSuite #

Monoid TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

mempty :: TestSuite #

mappend :: TestSuite -> TestSuite -> TestSuite #

mconcat :: [TestSuite] -> TestSuite #

Binary TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

put :: TestSuite -> Put #

get :: Get TestSuite #

putList :: [TestSuite] -> Put #

NFData TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

rnf :: TestSuite -> () #

HasBuildInfo TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

buildInfo :: Lens' TestSuite BuildInfo #

buildable :: Lens' TestSuite Bool #

buildTools :: Lens' TestSuite [LegacyExeDependency] #

buildToolDepends :: Lens' TestSuite [ExeDependency] #

cppOptions :: Lens' TestSuite [String] #

asmOptions :: Lens' TestSuite [String] #

cmmOptions :: Lens' TestSuite [String] #

ccOptions :: Lens' TestSuite [String] #

cxxOptions :: Lens' TestSuite [String] #

ldOptions :: Lens' TestSuite [String] #

pkgconfigDepends :: Lens' TestSuite [PkgconfigDependency] #

frameworks :: Lens' TestSuite [String] #

extraFrameworkDirs :: Lens' TestSuite [String] #

asmSources :: Lens' TestSuite [FilePath] #

cmmSources :: Lens' TestSuite [FilePath] #

cSources :: Lens' TestSuite [FilePath] #

cxxSources :: Lens' TestSuite [FilePath] #

jsSources :: Lens' TestSuite [FilePath] #

hsSourceDirs :: Lens' TestSuite [FilePath] #

otherModules :: Lens' TestSuite [ModuleName] #

virtualModules :: Lens' TestSuite [ModuleName] #

autogenModules :: Lens' TestSuite [ModuleName] #

defaultLanguage :: Lens' TestSuite (Maybe Language) #

otherLanguages :: Lens' TestSuite [Language] #

defaultExtensions :: Lens' TestSuite [Extension] #

otherExtensions :: Lens' TestSuite [Extension] #

oldExtensions :: Lens' TestSuite [Extension] #

extraLibs :: Lens' TestSuite [String] #

extraGHCiLibs :: Lens' TestSuite [String] #

extraBundledLibs :: Lens' TestSuite [String] #

extraLibFlavours :: Lens' TestSuite [String] #

extraLibDirs :: Lens' TestSuite [String] #

includeDirs :: Lens' TestSuite [FilePath] #

includes :: Lens' TestSuite [FilePath] #

installIncludes :: Lens' TestSuite [FilePath] #

options :: Lens' TestSuite [(CompilerFlavor, [String])] #

profOptions :: Lens' TestSuite [(CompilerFlavor, [String])] #

sharedOptions :: Lens' TestSuite [(CompilerFlavor, [String])] #

staticOptions :: Lens' TestSuite [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' TestSuite [(String, String)] #

targetBuildDepends :: Lens' TestSuite [Dependency] #

mixins :: Lens' TestSuite [Mixin] #

type Rep TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

type Rep TestSuite = D1 (MetaData "TestSuite" "Distribution.Types.TestSuite" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "TestSuite" PrefixI True) (S1 (MetaSel (Just "testName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName) :*: (S1 (MetaSel (Just "testInterface") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TestSuiteInterface) :*: S1 (MetaSel (Just "testBuildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BuildInfo))))

testName :: Lens' TestSuite UnqualComponentName #

testInterface :: Lens' TestSuite TestSuiteInterface #

testBuildInfo :: Lens' TestSuite BuildInfo #

diff --git a/doc/API/Cabal/Distribution-Types-TestSuite.html b/doc/API/Cabal/Distribution-Types-TestSuite.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-TestSuite.html @@ -0,0 +1,2 @@ +Distribution.Types.TestSuite

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.TestSuite

Synopsis

Documentation

data TestSuite #

A "test-suite" stanza in a cabal file.

Constructors

TestSuite 

Fields

Instances
Eq TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

(==) :: TestSuite -> TestSuite -> Bool #

(/=) :: TestSuite -> TestSuite -> Bool #

Data TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TestSuite -> c TestSuite #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TestSuite #

toConstr :: TestSuite -> Constr #

dataTypeOf :: TestSuite -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TestSuite) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TestSuite) #

gmapT :: (forall b. Data b => b -> b) -> TestSuite -> TestSuite #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TestSuite -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TestSuite -> r #

gmapQ :: (forall d. Data d => d -> u) -> TestSuite -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> TestSuite -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TestSuite -> m TestSuite #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TestSuite -> m TestSuite #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TestSuite -> m TestSuite #

Read TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

readsPrec :: Int -> ReadS TestSuite #

readList :: ReadS [TestSuite] #

readPrec :: ReadPrec TestSuite #

readListPrec :: ReadPrec [TestSuite] #

Show TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

showsPrec :: Int -> TestSuite -> ShowS #

show :: TestSuite -> String #

showList :: [TestSuite] -> ShowS #

Generic TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Associated Types

type Rep TestSuite :: * -> * #

Methods

from :: TestSuite -> Rep TestSuite x #

to :: Rep TestSuite x -> TestSuite #

Semigroup TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

(<>) :: TestSuite -> TestSuite -> TestSuite #

sconcat :: NonEmpty TestSuite -> TestSuite #

stimes :: Integral b => b -> TestSuite -> TestSuite #

Monoid TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

mempty :: TestSuite #

mappend :: TestSuite -> TestSuite -> TestSuite #

mconcat :: [TestSuite] -> TestSuite #

Binary TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

put :: TestSuite -> Put #

get :: Get TestSuite #

putList :: [TestSuite] -> Put #

NFData TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

rnf :: TestSuite -> () #

HasBuildInfo TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

Methods

buildInfo :: Lens' TestSuite BuildInfo #

buildable :: Lens' TestSuite Bool #

buildTools :: Lens' TestSuite [LegacyExeDependency] #

buildToolDepends :: Lens' TestSuite [ExeDependency] #

cppOptions :: Lens' TestSuite [String] #

asmOptions :: Lens' TestSuite [String] #

cmmOptions :: Lens' TestSuite [String] #

ccOptions :: Lens' TestSuite [String] #

cxxOptions :: Lens' TestSuite [String] #

ldOptions :: Lens' TestSuite [String] #

pkgconfigDepends :: Lens' TestSuite [PkgconfigDependency] #

frameworks :: Lens' TestSuite [String] #

extraFrameworkDirs :: Lens' TestSuite [String] #

asmSources :: Lens' TestSuite [FilePath] #

cmmSources :: Lens' TestSuite [FilePath] #

cSources :: Lens' TestSuite [FilePath] #

cxxSources :: Lens' TestSuite [FilePath] #

jsSources :: Lens' TestSuite [FilePath] #

hsSourceDirs :: Lens' TestSuite [FilePath] #

otherModules :: Lens' TestSuite [ModuleName] #

virtualModules :: Lens' TestSuite [ModuleName] #

autogenModules :: Lens' TestSuite [ModuleName] #

defaultLanguage :: Lens' TestSuite (Maybe Language) #

otherLanguages :: Lens' TestSuite [Language] #

defaultExtensions :: Lens' TestSuite [Extension] #

otherExtensions :: Lens' TestSuite [Extension] #

oldExtensions :: Lens' TestSuite [Extension] #

extraLibs :: Lens' TestSuite [String] #

extraGHCiLibs :: Lens' TestSuite [String] #

extraBundledLibs :: Lens' TestSuite [String] #

extraLibFlavours :: Lens' TestSuite [String] #

extraLibDirs :: Lens' TestSuite [String] #

includeDirs :: Lens' TestSuite [FilePath] #

includes :: Lens' TestSuite [FilePath] #

installIncludes :: Lens' TestSuite [FilePath] #

options :: Lens' TestSuite [(CompilerFlavor, [String])] #

profOptions :: Lens' TestSuite [(CompilerFlavor, [String])] #

sharedOptions :: Lens' TestSuite [(CompilerFlavor, [String])] #

staticOptions :: Lens' TestSuite [(CompilerFlavor, [String])] #

customFieldsBI :: Lens' TestSuite [(String, String)] #

targetBuildDepends :: Lens' TestSuite [Dependency] #

mixins :: Lens' TestSuite [Mixin] #

type Rep TestSuite # 
Instance details

Defined in Distribution.Types.TestSuite

type Rep TestSuite = D1 (MetaData "TestSuite" "Distribution.Types.TestSuite" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "TestSuite" PrefixI True) (S1 (MetaSel (Just "testName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName) :*: (S1 (MetaSel (Just "testInterface") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TestSuiteInterface) :*: S1 (MetaSel (Just "testBuildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BuildInfo))))

emptyTestSuite :: TestSuite #

testType :: TestSuite -> TestType #

testModules :: TestSuite -> [ModuleName] #

Get all the module names from a test suite.

testModulesAutogen :: TestSuite -> [ModuleName] #

Get all the auto generated module names from a test suite. + This are a subset of testModules.

diff --git a/doc/API/Cabal/Distribution-Types-TestSuiteInterface.html b/doc/API/Cabal/Distribution-Types-TestSuiteInterface.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-TestSuiteInterface.html @@ -0,0 +1,8 @@ +Distribution.Types.TestSuiteInterface

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.TestSuiteInterface

Synopsis

Documentation

data TestSuiteInterface #

The test suite interfaces that are currently defined. Each test suite must + specify which interface it supports.

More interfaces may be defined in future, either new revisions or totally + new interfaces.

Constructors

TestSuiteExeV10 Version FilePath

Test interface "exitcode-stdio-1.0". The test-suite takes the form + of an executable. It returns a zero exit code for success, non-zero for + failure. The stdout and stderr channels may be logged. It takes no + command line parameters and nothing on stdin.

TestSuiteLibV09 Version ModuleName

Test interface "detailed-0.9". The test-suite takes the form of a + library containing a designated module that exports "tests :: [Test]".

TestSuiteUnsupported TestType

A test suite that does not conform to one of the above interfaces for + the given reason (e.g. unknown test type).

Instances
Eq TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

(==) :: TestSuiteInterface -> TestSuiteInterface -> Bool #

(/=) :: TestSuiteInterface -> TestSuiteInterface -> Bool #

Data TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TestSuiteInterface -> c TestSuiteInterface #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TestSuiteInterface #

toConstr :: TestSuiteInterface -> Constr #

dataTypeOf :: TestSuiteInterface -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TestSuiteInterface) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TestSuiteInterface) #

gmapT :: (forall b. Data b => b -> b) -> TestSuiteInterface -> TestSuiteInterface #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TestSuiteInterface -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TestSuiteInterface -> r #

gmapQ :: (forall d. Data d => d -> u) -> TestSuiteInterface -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> TestSuiteInterface -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TestSuiteInterface -> m TestSuiteInterface #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TestSuiteInterface -> m TestSuiteInterface #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TestSuiteInterface -> m TestSuiteInterface #

Read TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

readsPrec :: Int -> ReadS TestSuiteInterface #

readList :: ReadS [TestSuiteInterface] #

readPrec :: ReadPrec TestSuiteInterface #

readListPrec :: ReadPrec [TestSuiteInterface] #

Show TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

showsPrec :: Int -> TestSuiteInterface -> ShowS #

show :: TestSuiteInterface -> String #

showList :: [TestSuiteInterface] -> ShowS #

Generic TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Associated Types

type Rep TestSuiteInterface :: * -> * #

Methods

from :: TestSuiteInterface -> Rep TestSuiteInterface x #

to :: Rep TestSuiteInterface x -> TestSuiteInterface #

Semigroup TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

(<>) :: TestSuiteInterface -> TestSuiteInterface -> TestSuiteInterface #

sconcat :: NonEmpty TestSuiteInterface -> TestSuiteInterface #

stimes :: Integral b => b -> TestSuiteInterface -> TestSuiteInterface #

Monoid TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

mempty :: TestSuiteInterface #

mappend :: TestSuiteInterface -> TestSuiteInterface -> TestSuiteInterface #

mconcat :: [TestSuiteInterface] -> TestSuiteInterface #

Binary TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

put :: TestSuiteInterface -> Put #

get :: Get TestSuiteInterface #

putList :: [TestSuiteInterface] -> Put #

NFData TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

Methods

rnf :: TestSuiteInterface -> () #

type Rep TestSuiteInterface # 
Instance details

Defined in Distribution.Types.TestSuiteInterface

type Rep TestSuiteInterface = D1 (MetaData "TestSuiteInterface" "Distribution.Types.TestSuiteInterface" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "TestSuiteExeV10" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :+: (C1 (MetaCons "TestSuiteLibV09" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleName)) :+: C1 (MetaCons "TestSuiteUnsupported" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TestType))))
diff --git a/doc/API/Cabal/Distribution-Types-TestType.html b/doc/API/Cabal/Distribution-Types-TestType.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-TestType.html @@ -0,0 +1,1 @@ +Distribution.Types.TestType

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.TestType

Synopsis

Documentation

data TestType #

The "test-type" field in the test suite stanza.

Constructors

TestTypeExe Version

"type: exitcode-stdio-x.y"

TestTypeLib Version

"type: detailed-x.y"

TestTypeUnknown String Version

Some unknown test type e.g. "type: foo"

Instances
Eq TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

(==) :: TestType -> TestType -> Bool #

(/=) :: TestType -> TestType -> Bool #

Data TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TestType -> c TestType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TestType #

toConstr :: TestType -> Constr #

dataTypeOf :: TestType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TestType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TestType) #

gmapT :: (forall b. Data b => b -> b) -> TestType -> TestType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TestType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TestType -> r #

gmapQ :: (forall d. Data d => d -> u) -> TestType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> TestType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TestType -> m TestType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TestType -> m TestType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TestType -> m TestType #

Read TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

readsPrec :: Int -> ReadS TestType #

readList :: ReadS [TestType] #

readPrec :: ReadPrec TestType #

readListPrec :: ReadPrec [TestType] #

Show TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

showsPrec :: Int -> TestType -> ShowS #

show :: TestType -> String #

showList :: [TestType] -> ShowS #

Generic TestType # 
Instance details

Defined in Distribution.Types.TestType

Associated Types

type Rep TestType :: * -> * #

Methods

from :: TestType -> Rep TestType x #

to :: Rep TestType x -> TestType #

Binary TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

put :: TestType -> Put #

get :: Get TestType #

putList :: [TestType] -> Put #

NFData TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

rnf :: TestType -> () #

Pretty TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

pretty :: TestType -> Doc #

Parsec TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

parsec :: CabalParsing m => m TestType #

Text TestType # 
Instance details

Defined in Distribution.Types.TestType

Methods

disp :: TestType -> Doc #

parse :: ReadP r TestType #

type Rep TestType # 
Instance details

Defined in Distribution.Types.TestType

type Rep TestType = D1 (MetaData "TestType" "Distribution.Types.TestType" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "TestTypeExe" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: (C1 (MetaCons "TestTypeLib" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: C1 (MetaCons "TestTypeUnknown" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version))))

knownTestTypes :: [TestType] #

diff --git a/doc/API/Cabal/Distribution-Types-UnitId.html b/doc/API/Cabal/Distribution-Types-UnitId.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-UnitId.html @@ -0,0 +1,32 @@ +Distribution.Types.UnitId

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.UnitId

Synopsis

Documentation

data UnitId #

A unit identifier identifies a (possibly instantiated) + package/component that can be installed the installed package + database. There are several types of components that can be + installed:

  • A traditional library with no holes, so that unitIdHash + is Nothing. In the absence of Backpack, UnitId + is the same as a ComponentId.
  • An indefinite, Backpack library with holes. In this case, + unitIdHash is still Nothing, but in the install, + there are only interfaces, no compiled objects.
  • An instantiated Backpack library with all the holes + filled in. unitIdHash is a Just a hash of the + instantiating mapping.

A unit is a component plus the additional information on how the + holes are filled in. Thus there is a one to many relationship: for a + particular component there are many different ways of filling in the + holes, and each different combination is a unit (and has a separate + UnitId).

UnitId is distinct from OpenUnitId, in that it is always + installed, whereas OpenUnitId are intermediate unit identities + that arise during mixin linking, and don't necessarily correspond + to any actually installed unit. Since the mapping is not actually + recorded in a UnitId, you can't actually substitute over them + (but you can substitute over OpenUnitId). See also + Distribution.Backpack.FullUnitId for a mechanism for expanding an + instantiated UnitId to retrieve its mapping.

Backwards compatibility note: if you need to get the string + representation of a UnitId to pass, e.g., as a -package-id + flag, use the display function, which will work on all + versions of Cabal.

Instances
Eq UnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

(==) :: UnitId -> UnitId -> Bool #

(/=) :: UnitId -> UnitId -> Bool #

Data UnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UnitId -> c UnitId #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UnitId #

toConstr :: UnitId -> Constr #

dataTypeOf :: UnitId -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UnitId) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UnitId) #

gmapT :: (forall b. Data b => b -> b) -> UnitId -> UnitId #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UnitId -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UnitId -> r #

gmapQ :: (forall d. Data d => d -> u) -> UnitId -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UnitId -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UnitId -> m UnitId #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UnitId -> m UnitId #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UnitId -> m UnitId #

Ord UnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

compare :: UnitId -> UnitId -> Ordering #

(<) :: UnitId -> UnitId -> Bool #

(<=) :: UnitId -> UnitId -> Bool #

(>) :: UnitId -> UnitId -> Bool #

(>=) :: UnitId -> UnitId -> Bool #

max :: UnitId -> UnitId -> UnitId #

min :: UnitId -> UnitId -> UnitId #

Read UnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

readsPrec :: Int -> ReadS UnitId #

readList :: ReadS [UnitId] #

readPrec :: ReadPrec UnitId #

readListPrec :: ReadPrec [UnitId] #

Show UnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

showsPrec :: Int -> UnitId -> ShowS #

show :: UnitId -> String #

showList :: [UnitId] -> ShowS #

IsString UnitId #

mkUnitId

Since: 2.0.0.2

Instance details

Defined in Distribution.Types.UnitId

Methods

fromString :: String -> UnitId #

Generic UnitId # 
Instance details

Defined in Distribution.Types.UnitId

Associated Types

type Rep UnitId :: * -> * #

Methods

from :: UnitId -> Rep UnitId x #

to :: Rep UnitId x -> UnitId #

Binary UnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

put :: UnitId -> Put #

get :: Get UnitId #

putList :: [UnitId] -> Put #

NFData UnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

rnf :: UnitId -> () #

Pretty UnitId #

The textual format for UnitId coincides with the format + GHC accepts for -package-id.

Instance details

Defined in Distribution.Types.UnitId

Methods

pretty :: UnitId -> Doc #

Parsec UnitId #

The textual format for UnitId coincides with the format + GHC accepts for -package-id.

Instance details

Defined in Distribution.Types.UnitId

Methods

parsec :: CabalParsing m => m UnitId #

Text UnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

disp :: UnitId -> Doc #

parse :: ReadP r UnitId #

type Rep UnitId # 
Instance details

Defined in Distribution.Types.UnitId

type Rep UnitId = D1 (MetaData "UnitId" "Distribution.Types.UnitId" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "UnitId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ShortText)))

unUnitId :: UnitId -> String #

If you need backwards compatibility, consider using display + instead, which is supported by all versions of Cabal.

mkUnitId :: String -> UnitId #

data DefUnitId #

A UnitId for a definite package. The DefUnitId invariant says + that a UnitId identified this way is definite; i.e., it has no + unfilled holes.

Instances
Eq DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

(==) :: DefUnitId -> DefUnitId -> Bool #

(/=) :: DefUnitId -> DefUnitId -> Bool #

Data DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DefUnitId -> c DefUnitId #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DefUnitId #

toConstr :: DefUnitId -> Constr #

dataTypeOf :: DefUnitId -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DefUnitId) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DefUnitId) #

gmapT :: (forall b. Data b => b -> b) -> DefUnitId -> DefUnitId #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DefUnitId -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DefUnitId -> r #

gmapQ :: (forall d. Data d => d -> u) -> DefUnitId -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DefUnitId -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DefUnitId -> m DefUnitId #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DefUnitId -> m DefUnitId #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DefUnitId -> m DefUnitId #

Ord DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

compare :: DefUnitId -> DefUnitId -> Ordering #

(<) :: DefUnitId -> DefUnitId -> Bool #

(<=) :: DefUnitId -> DefUnitId -> Bool #

(>) :: DefUnitId -> DefUnitId -> Bool #

(>=) :: DefUnitId -> DefUnitId -> Bool #

max :: DefUnitId -> DefUnitId -> DefUnitId #

min :: DefUnitId -> DefUnitId -> DefUnitId #

Read DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

readsPrec :: Int -> ReadS DefUnitId #

readList :: ReadS [DefUnitId] #

readPrec :: ReadPrec DefUnitId #

readListPrec :: ReadPrec [DefUnitId] #

Show DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

showsPrec :: Int -> DefUnitId -> ShowS #

show :: DefUnitId -> String #

showList :: [DefUnitId] -> ShowS #

Generic DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Associated Types

type Rep DefUnitId :: * -> * #

Methods

from :: DefUnitId -> Rep DefUnitId x #

to :: Rep DefUnitId x -> DefUnitId #

Binary DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

put :: DefUnitId -> Put #

get :: Get DefUnitId #

putList :: [DefUnitId] -> Put #

NFData DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

rnf :: DefUnitId -> () #

Pretty DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

pretty :: DefUnitId -> Doc #

Parsec DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

parsec :: CabalParsing m => m DefUnitId #

Text DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

Methods

disp :: DefUnitId -> Doc #

parse :: ReadP r DefUnitId #

type Rep DefUnitId # 
Instance details

Defined in Distribution.Types.UnitId

type Rep DefUnitId = D1 (MetaData "DefUnitId" "Distribution.Types.UnitId" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "DefUnitId" PrefixI True) (S1 (MetaSel (Just "unDefUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId)))

unsafeMkDefUnitId :: UnitId -> DefUnitId #

Unsafely create a DefUnitId from a UnitId. Your responsibility + is to ensure that the DefUnitId invariant holds.

unDefUnitId :: DefUnitId -> UnitId #

newSimpleUnitId :: ComponentId -> UnitId #

Create a unit identity with no associated hash directly + from a ComponentId.

mkLegacyUnitId :: PackageId -> UnitId #

Make an old-style UnitId from a package identifier. + Assumed to be for the public library

getHSLibraryName :: UnitId -> String #

Returns library name prefixed with HS, suitable for filenames

type InstalledPackageId = UnitId #

Deprecated: Use UnitId instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

diff --git a/doc/API/Cabal/Distribution-Types-UnqualComponentName.html b/doc/API/Cabal/Distribution-Types-UnqualComponentName.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-UnqualComponentName.html @@ -0,0 +1,7 @@ +Distribution.Types.UnqualComponentName

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.UnqualComponentName

Synopsis

Documentation

data UnqualComponentName #

An unqualified component name, for any kind of component.

This is distinguished from a ComponentName and ComponentId. The former + also states which of a library, executable, etc the name refers too. The + later uniquely identifiers a component and its closure.

Since: 2.0.0.2

Instances
Eq UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

(==) :: UnqualComponentName -> UnqualComponentName -> Bool #

(/=) :: UnqualComponentName -> UnqualComponentName -> Bool #

Data UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UnqualComponentName -> c UnqualComponentName #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UnqualComponentName #

toConstr :: UnqualComponentName -> Constr #

dataTypeOf :: UnqualComponentName -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UnqualComponentName) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UnqualComponentName) #

gmapT :: (forall b. Data b => b -> b) -> UnqualComponentName -> UnqualComponentName #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UnqualComponentName -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UnqualComponentName -> r #

gmapQ :: (forall d. Data d => d -> u) -> UnqualComponentName -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UnqualComponentName -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UnqualComponentName -> m UnqualComponentName #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UnqualComponentName -> m UnqualComponentName #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UnqualComponentName -> m UnqualComponentName #

Ord UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

compare :: UnqualComponentName -> UnqualComponentName -> Ordering #

(<) :: UnqualComponentName -> UnqualComponentName -> Bool #

(<=) :: UnqualComponentName -> UnqualComponentName -> Bool #

(>) :: UnqualComponentName -> UnqualComponentName -> Bool #

(>=) :: UnqualComponentName -> UnqualComponentName -> Bool #

max :: UnqualComponentName -> UnqualComponentName -> UnqualComponentName #

min :: UnqualComponentName -> UnqualComponentName -> UnqualComponentName #

Read UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

readsPrec :: Int -> ReadS UnqualComponentName #

readList :: ReadS [UnqualComponentName] #

readPrec :: ReadPrec UnqualComponentName #

readListPrec :: ReadPrec [UnqualComponentName] #

Show UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

showsPrec :: Int -> UnqualComponentName -> ShowS #

show :: UnqualComponentName -> String #

showList :: [UnqualComponentName] -> ShowS #

IsString UnqualComponentName #

mkUnqualComponentName

Since: 2.0.0.2

Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

fromString :: String -> UnqualComponentName #

Generic UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Associated Types

type Rep UnqualComponentName :: * -> * #

Methods

from :: UnqualComponentName -> Rep UnqualComponentName x #

to :: Rep UnqualComponentName x -> UnqualComponentName #

Semigroup UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

(<>) :: UnqualComponentName -> UnqualComponentName -> UnqualComponentName #

sconcat :: NonEmpty UnqualComponentName -> UnqualComponentName #

stimes :: Integral b => b -> UnqualComponentName -> UnqualComponentName #

Monoid UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

mempty :: UnqualComponentName #

mappend :: UnqualComponentName -> UnqualComponentName -> UnqualComponentName #

mconcat :: [UnqualComponentName] -> UnqualComponentName #

Binary UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

put :: UnqualComponentName -> Put #

get :: Get UnqualComponentName #

putList :: [UnqualComponentName] -> Put #

NFData UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

rnf :: UnqualComponentName -> () #

Pretty UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

pretty :: UnqualComponentName -> Doc #

Parsec UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

parsec :: CabalParsing m => m UnqualComponentName #

Text UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

disp :: UnqualComponentName -> Doc #

parse :: ReadP r UnqualComponentName #

type Rep UnqualComponentName # 
Instance details

Defined in Distribution.Types.UnqualComponentName

type Rep UnqualComponentName = D1 (MetaData "UnqualComponentName" "Distribution.Types.UnqualComponentName" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "UnqualComponentName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ShortText)))

unUnqualComponentName :: UnqualComponentName -> String #

Convert UnqualComponentName to String

Since: 2.0.0.2

mkUnqualComponentName :: String -> UnqualComponentName #

Construct a UnqualComponentName from a String

mkUnqualComponentName is the inverse to unUnqualComponentName

Note: No validations are performed to ensure that the resulting + UnqualComponentName is valid

Since: 2.0.0.2

packageNameToUnqualComponentName :: PackageName -> UnqualComponentName #

Converts a package name to an unqualified component name

Useful in legacy situations where a package name may refer to an internal + component, if one is defined with that name.

Since: 2.0.0.2

unqualComponentNameToPackageName :: UnqualComponentName -> PackageName #

Converts an unqualified component name to a package name

packageNameToUnqualComponentName is the inverse of + unqualComponentNameToPackageName.

Useful in legacy situations where a package name may refer to an internal + component, if one is defined with that name.

Since: 2.0.0.2

diff --git a/doc/API/Cabal/Distribution-Types-Version.html b/doc/API/Cabal/Distribution-Types-Version.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-Version.html @@ -0,0 +1,9 @@ +Distribution.Types.Version

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.Version

Contents

Synopsis

Package versions

data Version #

A Version represents the version of a software entity.

Instances of Eq and Ord are provided, which gives exact + equality and lexicographic ordering of the version number + components (i.e. 2.1 > 2.0, 1.2.3 > 1.2.2, etc.).

This type is opaque and distinct from the Version type in + Data.Version since Cabal-2.0. The difference extends to the + Binary instance using a different (and more compact) encoding.

Since: 2.0.0.2

Instances
Eq Version # 
Instance details

Defined in Distribution.Types.Version

Methods

(==) :: Version -> Version -> Bool #

(/=) :: Version -> Version -> Bool #

Data Version # 
Instance details

Defined in Distribution.Types.Version

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Version -> c Version #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Version #

toConstr :: Version -> Constr #

dataTypeOf :: Version -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Version) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Version) #

gmapT :: (forall b. Data b => b -> b) -> Version -> Version #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r #

gmapQ :: (forall d. Data d => d -> u) -> Version -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Version -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Version -> m Version #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version #

Ord Version # 
Instance details

Defined in Distribution.Types.Version

Methods

compare :: Version -> Version -> Ordering #

(<) :: Version -> Version -> Bool #

(<=) :: Version -> Version -> Bool #

(>) :: Version -> Version -> Bool #

(>=) :: Version -> Version -> Bool #

max :: Version -> Version -> Version #

min :: Version -> Version -> Version #

Read Version # 
Instance details

Defined in Distribution.Types.Version

Methods

readsPrec :: Int -> ReadS Version #

readList :: ReadS [Version] #

readPrec :: ReadPrec Version #

readListPrec :: ReadPrec [Version] #

Show Version # 
Instance details

Defined in Distribution.Types.Version

Methods

showsPrec :: Int -> Version -> ShowS #

show :: Version -> String #

showList :: [Version] -> ShowS #

Generic Version # 
Instance details

Defined in Distribution.Types.Version

Associated Types

type Rep Version :: * -> * #

Methods

from :: Version -> Rep Version x #

to :: Rep Version x -> Version #

Binary Version # 
Instance details

Defined in Distribution.Types.Version

Methods

put :: Version -> Put #

get :: Get Version #

putList :: [Version] -> Put #

NFData Version # 
Instance details

Defined in Distribution.Types.Version

Methods

rnf :: Version -> () #

Pretty Version # 
Instance details

Defined in Distribution.Types.Version

Methods

pretty :: Version -> Doc #

Parsec Version # 
Instance details

Defined in Distribution.Types.Version

Methods

parsec :: CabalParsing m => m Version #

Text Version # 
Instance details

Defined in Distribution.Types.Version

Methods

disp :: Version -> Doc #

parse :: ReadP r Version #

Newtype SpecVersion (Either Version VersionRange) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: Either Version VersionRange -> SpecVersion #

unpack :: SpecVersion -> Either Version VersionRange #

type Rep Version # 
Instance details

Defined in Distribution.Types.Version

type Rep Version = D1 (MetaData "Version" "Distribution.Types.Version" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "PV0" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Word64)) :+: C1 (MetaCons "PV1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Int])))

mkVersion :: [Int] -> Version #

Construct Version from list of version number components.

For instance, mkVersion [3,2,1] constructs a Version + representing the version 3.2.1.

All version components must be non-negative. mkVersion [] + currently represents the special null version; see also nullVersion.

Since: 2.0.0.2

mkVersion' :: Version -> Version #

Variant of mkVersion which converts a Data.Version + Version into Cabal's Version type.

Since: 2.0.0.2

versionNumbers :: Version -> [Int] #

Unpack Version into list of version number components.

This is the inverse to mkVersion, so the following holds:

(versionNumbers . mkVersion) vs == vs

Since: 2.0.0.2

nullVersion :: Version #

Constant representing the special null Version

The nullVersion compares (via Ord) as less than every proper + Version value.

Since: 2.0.0.2

alterVersion :: ([Int] -> [Int]) -> Version -> Version #

Apply function to list of version number components

alterVersion f == mkVersion . f . versionNumbers

Since: 2.0.0.2

version0 :: Version #

Version 0. A lower bound of Version.

Since: 2.2

Backwards compatibility

showVersion :: Version -> String #

Deprecated: Use prettyShow. This function will be removed in Cabal-3.0 (estimated Oct 2018)

Internal

validVersion :: Version -> Bool #

diff --git a/doc/API/Cabal/Distribution-Types-VersionInterval.html b/doc/API/Cabal/Distribution-Types-VersionInterval.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-VersionInterval.html @@ -0,0 +1,22 @@ +Distribution.Types.VersionInterval

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.VersionInterval

Contents

Synopsis

Version intervals

data VersionIntervals #

A complementary representation of a VersionRange. Instead of a boolean + version predicate it uses an increasing sequence of non-overlapping, + non-empty intervals.

The key point is that this representation gives a canonical representation + for the semantics of VersionRanges. This makes it easier to check things + like whether a version range is empty, covers all versions, or requires a + certain minimum or maximum version. It also makes it easy to check equality + or containment. It also makes it easier to identify 'simple' version + predicates for translation into foreign packaging systems that do not + support complex version range expressions.

Instances
Eq VersionIntervals # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

(==) :: VersionIntervals -> VersionIntervals -> Bool #

(/=) :: VersionIntervals -> VersionIntervals -> Bool #

Show VersionIntervals # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

showsPrec :: Int -> VersionIntervals -> ShowS #

show :: VersionIntervals -> String #

showList :: [VersionIntervals] -> ShowS #

toVersionIntervals :: VersionRange -> VersionIntervals #

Convert a VersionRange to a sequence of version intervals.

fromVersionIntervals :: VersionIntervals -> VersionRange #

Convert a VersionIntervals value back into a VersionRange expression + representing the version intervals.

withinIntervals :: Version -> VersionIntervals -> Bool #

Test if a version falls within the version intervals.

It exists mostly for completeness and testing. It satisfies the following + properties:

withinIntervals v (toVersionIntervals vr) = withinRange v vr
+withinIntervals v ivs = withinRange v (fromVersionIntervals ivs)

versionIntervals :: VersionIntervals -> [VersionInterval] #

Inspect the list of version intervals.

mkVersionIntervals :: [VersionInterval] -> VersionIntervals #

Directly construct a VersionIntervals from a list of intervals.

In Cabal-2.2 the Maybe is dropped from the result type.

unionVersionIntervals :: VersionIntervals -> VersionIntervals -> VersionIntervals #

intersectVersionIntervals :: VersionIntervals -> VersionIntervals -> VersionIntervals #

invertVersionIntervals :: VersionIntervals -> VersionIntervals #

relaxLastInterval :: VersionIntervals -> VersionIntervals #

relaxHeadInterval :: VersionIntervals -> VersionIntervals #

Version intervals view

asVersionIntervals :: VersionRange -> [VersionInterval] #

View a VersionRange as a union of intervals.

This provides a canonical view of the semantics of a VersionRange as + opposed to the syntax of the expression used to define it. For the syntactic + view use foldVersionRange.

Each interval is non-empty. The sequence is in increasing order and no + intervals overlap or touch. Therefore only the first and last can be + unbounded. The sequence can be empty if the range is empty + (e.g. a range expression like && 2).

Other checks are trivial to implement using this view. For example:

isNoVersion vr | [] <- asVersionIntervals vr = True
+               | otherwise                   = False
isSpecificVersion vr
+   | [(LowerBound v  InclusiveBound
+      ,UpperBound v' InclusiveBound)] <- asVersionIntervals vr
+   , v == v'   = Just v
+   | otherwise = Nothing

type VersionInterval = (LowerBound, UpperBound) #

data LowerBound #

Constructors

LowerBound Version !Bound 
Instances
Eq LowerBound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

(==) :: LowerBound -> LowerBound -> Bool #

(/=) :: LowerBound -> LowerBound -> Bool #

Ord LowerBound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

compare :: LowerBound -> LowerBound -> Ordering #

(<) :: LowerBound -> LowerBound -> Bool #

(<=) :: LowerBound -> LowerBound -> Bool #

(>) :: LowerBound -> LowerBound -> Bool #

(>=) :: LowerBound -> LowerBound -> Bool #

max :: LowerBound -> LowerBound -> LowerBound #

min :: LowerBound -> LowerBound -> LowerBound #

Show LowerBound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

showsPrec :: Int -> LowerBound -> ShowS #

show :: LowerBound -> String #

showList :: [LowerBound] -> ShowS #

data UpperBound #

Constructors

NoUpperBound 
UpperBound Version !Bound 
Instances
Eq UpperBound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

(==) :: UpperBound -> UpperBound -> Bool #

(/=) :: UpperBound -> UpperBound -> Bool #

Ord UpperBound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

compare :: UpperBound -> UpperBound -> Ordering #

(<) :: UpperBound -> UpperBound -> Bool #

(<=) :: UpperBound -> UpperBound -> Bool #

(>) :: UpperBound -> UpperBound -> Bool #

(>=) :: UpperBound -> UpperBound -> Bool #

max :: UpperBound -> UpperBound -> UpperBound #

min :: UpperBound -> UpperBound -> UpperBound #

Show UpperBound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

showsPrec :: Int -> UpperBound -> ShowS #

show :: UpperBound -> String #

showList :: [UpperBound] -> ShowS #

data Bound #

Constructors

ExclusiveBound 
InclusiveBound 
Instances
Eq Bound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

(==) :: Bound -> Bound -> Bool #

(/=) :: Bound -> Bound -> Bool #

Show Bound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

showsPrec :: Int -> Bound -> ShowS #

show :: Bound -> String #

showList :: [Bound] -> ShowS #

diff --git a/doc/API/Cabal/Distribution-Types-VersionRange.html b/doc/API/Cabal/Distribution-Types-VersionRange.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Types-VersionRange.html @@ -0,0 +1,13 @@ +Distribution.Types.VersionRange

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Types.VersionRange

Contents

Synopsis

Version ranges

data VersionRange #

Constructors

AnyVersion

Deprecated: Use anyVersion, foldVersionRange or asVersionIntervals

ThisVersion Version

Deprecated: Use thisVersion, foldVersionRange or asVersionIntervals

LaterVersion Version

Deprecated: Use laterVersion, foldVersionRange or asVersionIntervals

OrLaterVersion Version 
EarlierVersion Version

Deprecated: Use earlierVersion, foldVersionRange or asVersionIntervals

OrEarlierVersion Version 
WildcardVersion Version

Deprecated: Use anyVersion, foldVersionRange or asVersionIntervals

MajorBoundVersion Version 
UnionVersionRanges VersionRange VersionRange

Deprecated: Use unionVersionRanges, foldVersionRange or asVersionIntervals

IntersectVersionRanges VersionRange VersionRange

Deprecated: Use intersectVersionRanges, foldVersionRange or asVersionIntervals

VersionRangeParens VersionRange 
Instances
Eq VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

(==) :: VersionRange -> VersionRange -> Bool #

(/=) :: VersionRange -> VersionRange -> Bool #

Data VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> VersionRange -> c VersionRange #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c VersionRange #

toConstr :: VersionRange -> Constr #

dataTypeOf :: VersionRange -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c VersionRange) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c VersionRange) #

gmapT :: (forall b. Data b => b -> b) -> VersionRange -> VersionRange #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> VersionRange -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> VersionRange -> r #

gmapQ :: (forall d. Data d => d -> u) -> VersionRange -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> VersionRange -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> VersionRange -> m VersionRange #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> VersionRange -> m VersionRange #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> VersionRange -> m VersionRange #

Read VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

readsPrec :: Int -> ReadS VersionRange #

readList :: ReadS [VersionRange] #

readPrec :: ReadPrec VersionRange #

readListPrec :: ReadPrec [VersionRange] #

Show VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

showsPrec :: Int -> VersionRange -> ShowS #

show :: VersionRange -> String #

showList :: [VersionRange] -> ShowS #

Generic VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Associated Types

type Rep VersionRange :: * -> * #

Methods

from :: VersionRange -> Rep VersionRange x #

to :: Rep VersionRange x -> VersionRange #

Binary VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

put :: VersionRange -> Put #

get :: Get VersionRange #

putList :: [VersionRange] -> Put #

NFData VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

rnf :: VersionRange -> () #

Pretty VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

pretty :: VersionRange -> Doc #

Parsec VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

parsec :: CabalParsing m => m VersionRange #

Text VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

disp :: VersionRange -> Doc #

parse :: ReadP r VersionRange #

Newtype TestedWith (CompilerFlavor, VersionRange) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: (CompilerFlavor, VersionRange) -> TestedWith #

unpack :: TestedWith -> (CompilerFlavor, VersionRange) #

Newtype SpecVersion (Either Version VersionRange) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: Either Version VersionRange -> SpecVersion #

unpack :: SpecVersion -> Either Version VersionRange #

type Rep VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

type Rep VersionRange = D1 (MetaData "VersionRange" "Distribution.Types.VersionRange" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (((C1 (MetaCons "AnyVersion" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ThisVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version))) :+: (C1 (MetaCons "LaterVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: (C1 (MetaCons "OrLaterVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: C1 (MetaCons "EarlierVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version))))) :+: ((C1 (MetaCons "OrEarlierVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: (C1 (MetaCons "WildcardVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: C1 (MetaCons "MajorBoundVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)))) :+: (C1 (MetaCons "UnionVersionRanges" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange)) :+: (C1 (MetaCons "IntersectVersionRanges" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange)) :+: C1 (MetaCons "VersionRangeParens" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange))))))

Constructing

anyVersion :: VersionRange #

The version range -any. That is, a version range containing all + versions.

withinRange v anyVersion = True

noVersion :: VersionRange #

The empty version range, that is a version range containing no versions.

This can be constructed using any unsatisfiable version range expression, + for example > 1 && < 1.

withinRange v noVersion = False

thisVersion :: Version -> VersionRange #

The version range == v

withinRange v' (thisVersion v) = v' == v

notThisVersion :: Version -> VersionRange #

The version range || v

withinRange v' (notThisVersion v) = v' /= v

laterVersion :: Version -> VersionRange #

The version range > v

withinRange v' (laterVersion v) = v' > v

earlierVersion :: Version -> VersionRange #

The version range < v

withinRange v' (earlierVersion v) = v' < v

orLaterVersion :: Version -> VersionRange #

The version range >= v

withinRange v' (orLaterVersion v) = v' >= v

orEarlierVersion :: Version -> VersionRange #

The version range <= v

withinRange v' (orEarlierVersion v) = v' <= v

unionVersionRanges :: VersionRange -> VersionRange -> VersionRange #

The version range vr1 || vr2

  withinRange v' (unionVersionRanges vr1 vr2)
+= withinRange v' vr1 || withinRange v' vr2

intersectVersionRanges :: VersionRange -> VersionRange -> VersionRange #

The version range vr1 && vr2

  withinRange v' (intersectVersionRanges vr1 vr2)
+= withinRange v' vr1 && withinRange v' vr2

withinVersion :: Version -> VersionRange #

The version range == v.*.

For example, for version 1.2, the version range == 1.2.* is the same as + >= 1.2 && < 1.3

withinRange v' (laterVersion v) = v' >= v && v' < upper v
+  where
+    upper (Version lower t) = Version (init lower ++ [last lower + 1]) t

majorBoundVersion :: Version -> VersionRange #

The version range ^>= v.

For example, for version 1.2.3.4, the version range ^>= 1.2.3.4 is the same as + >= 1.2.3.4 && < 1.3.

Note that ^>= 1 is equivalent to >= 1 && < 1.1.

Since: 2.0.0.2

Inspection

withinRange :: Version -> VersionRange -> Bool #

Does this version fall within the given range?

This is the evaluation function for the VersionRange type.

foldVersionRange #

Arguments

:: a

"-any" version

-> (Version -> a)
"== v"
-> (Version -> a)
"> v"
-> (Version -> a)
"< v"
-> (a -> a -> a)

"_ || _" union

-> (a -> a -> a)

"_ && _" intersection

-> VersionRange 
-> a 

Fold over the basic syntactic structure of a VersionRange.

This provides a syntactic view of the expression defining the version range. + The syntactic sugar ">= v", "<= v" and "== v.*" is presented + in terms of the other basic syntax.

For a semantic view use asVersionIntervals.

normaliseVersionRange :: VersionRange -> VersionRange #

Normalise VersionRange.

In particular collapse (== v || > v) into >= v, and so on.

stripParensVersionRange :: VersionRange -> VersionRange #

Remove VersionRangeParens constructors.

Since: 2.2

hasUpperBound :: VersionRange -> Bool #

Does the version range have an upper bound?

Since: 1.24.0.0

hasLowerBound :: VersionRange -> Bool #

Does the version range have an explicit lower bound?

Note: this function only considers the user-specified lower bounds, but not + the implicit >=0 lower bound.

Since: 1.24.0.0

Cata & ana

data VersionRangeF a #

F-Algebra of VersionRange. See cataVersionRange.

Since: 2.2

Constructors

AnyVersionF 
ThisVersionF Version 
LaterVersionF Version 
OrLaterVersionF Version 
EarlierVersionF Version 
OrEarlierVersionF Version 
WildcardVersionF Version 
MajorBoundVersionF Version 
UnionVersionRangesF a a 
IntersectVersionRangesF a a 
VersionRangeParensF a 
Instances
Functor VersionRangeF # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

fmap :: (a -> b) -> VersionRangeF a -> VersionRangeF b #

(<$) :: a -> VersionRangeF b -> VersionRangeF a #

Foldable VersionRangeF # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

fold :: Monoid m => VersionRangeF m -> m #

foldMap :: Monoid m => (a -> m) -> VersionRangeF a -> m #

foldr :: (a -> b -> b) -> b -> VersionRangeF a -> b #

foldr' :: (a -> b -> b) -> b -> VersionRangeF a -> b #

foldl :: (b -> a -> b) -> b -> VersionRangeF a -> b #

foldl' :: (b -> a -> b) -> b -> VersionRangeF a -> b #

foldr1 :: (a -> a -> a) -> VersionRangeF a -> a #

foldl1 :: (a -> a -> a) -> VersionRangeF a -> a #

toList :: VersionRangeF a -> [a] #

null :: VersionRangeF a -> Bool #

length :: VersionRangeF a -> Int #

elem :: Eq a => a -> VersionRangeF a -> Bool #

maximum :: Ord a => VersionRangeF a -> a #

minimum :: Ord a => VersionRangeF a -> a #

sum :: Num a => VersionRangeF a -> a #

product :: Num a => VersionRangeF a -> a #

Traversable VersionRangeF # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

traverse :: Applicative f => (a -> f b) -> VersionRangeF a -> f (VersionRangeF b) #

sequenceA :: Applicative f => VersionRangeF (f a) -> f (VersionRangeF a) #

mapM :: Monad m => (a -> m b) -> VersionRangeF a -> m (VersionRangeF b) #

sequence :: Monad m => VersionRangeF (m a) -> m (VersionRangeF a) #

Eq a => Eq (VersionRangeF a) # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

(==) :: VersionRangeF a -> VersionRangeF a -> Bool #

(/=) :: VersionRangeF a -> VersionRangeF a -> Bool #

Data a => Data (VersionRangeF a) # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> VersionRangeF a -> c (VersionRangeF a) #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (VersionRangeF a) #

toConstr :: VersionRangeF a -> Constr #

dataTypeOf :: VersionRangeF a -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (VersionRangeF a)) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (VersionRangeF a)) #

gmapT :: (forall b. Data b => b -> b) -> VersionRangeF a -> VersionRangeF a #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> VersionRangeF a -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> VersionRangeF a -> r #

gmapQ :: (forall d. Data d => d -> u) -> VersionRangeF a -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> VersionRangeF a -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> VersionRangeF a -> m (VersionRangeF a) #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> VersionRangeF a -> m (VersionRangeF a) #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> VersionRangeF a -> m (VersionRangeF a) #

Read a => Read (VersionRangeF a) # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

readsPrec :: Int -> ReadS (VersionRangeF a) #

readList :: ReadS [VersionRangeF a] #

readPrec :: ReadPrec (VersionRangeF a) #

readListPrec :: ReadPrec [VersionRangeF a] #

Show a => Show (VersionRangeF a) # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

showsPrec :: Int -> VersionRangeF a -> ShowS #

show :: VersionRangeF a -> String #

showList :: [VersionRangeF a] -> ShowS #

Generic (VersionRangeF a) # 
Instance details

Defined in Distribution.Types.VersionRange

Associated Types

type Rep (VersionRangeF a) :: * -> * #

Methods

from :: VersionRangeF a -> Rep (VersionRangeF a) x #

to :: Rep (VersionRangeF a) x -> VersionRangeF a #

type Rep (VersionRangeF a) # 
Instance details

Defined in Distribution.Types.VersionRange

type Rep (VersionRangeF a) = D1 (MetaData "VersionRangeF" "Distribution.Types.VersionRange" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (((C1 (MetaCons "AnyVersionF" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ThisVersionF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version))) :+: (C1 (MetaCons "LaterVersionF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: (C1 (MetaCons "OrLaterVersionF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: C1 (MetaCons "EarlierVersionF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version))))) :+: ((C1 (MetaCons "OrEarlierVersionF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: (C1 (MetaCons "WildcardVersionF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: C1 (MetaCons "MajorBoundVersionF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)))) :+: (C1 (MetaCons "UnionVersionRangesF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)) :+: (C1 (MetaCons "IntersectVersionRangesF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)) :+: C1 (MetaCons "VersionRangeParensF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))))))

cataVersionRange :: (VersionRangeF a -> a) -> VersionRange -> a #

Fold VersionRange.

Since: 2.2

anaVersionRange :: (a -> VersionRangeF a) -> a -> VersionRange #

Unfold VersionRange.

Since: 2.2

hyloVersionRange :: (VersionRangeF VersionRange -> VersionRange) -> (VersionRange -> VersionRangeF VersionRange) -> VersionRange -> VersionRange #

Refold VersionRange

Since: 2.2

projectVersionRange :: VersionRange -> VersionRangeF VersionRange #

Since: 2.2

embedVersionRange :: VersionRangeF VersionRange -> VersionRange #

Since: 2.2

Utilities

wildcardUpperBound :: Version -> Version #

Since: 2.2

majorUpperBound :: Version -> Version #

Compute next greater major version to be used as upper bound

Example: 0.4.1 produces the version 0.5 which then can be used + to construct a range >= 0.4.1 && < 0.5

Since: 2.2

isWildcardRange :: Version -> Version -> Bool #

diff --git a/doc/API/Cabal/Distribution-Utils-Generic.html b/doc/API/Cabal/Distribution-Utils-Generic.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Utils-Generic.html @@ -0,0 +1,81 @@ +Distribution.Utils.Generic

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones Simon Marlow 2003-2004
LicenseBSD3 + portions Copyright (c) 2007, Galois Inc.
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Utils.Generic

Contents

Description

A large and somewhat miscellaneous collection of utility functions used + throughout the rest of the Cabal lib and in other tools that use the Cabal + lib like cabal-install. It has a very simple set of logging actions. It + has low level functions for running programs, a bunch of wrappers for + various directory and file functions that do extra logging.

Synopsis

reading and writing files safely

withFileContents :: FilePath -> (String -> NoCallStackIO a) -> NoCallStackIO a #

Gets the contents of a file, but guarantee that it gets closed.

The file is read lazily but if it is not fully consumed by the action then + the remaining input is truncated and the file is closed.

writeFileAtomic :: FilePath -> ByteString -> NoCallStackIO () #

Writes a file atomically.

The file is either written successfully or an IO exception is raised and + the original file is left unchanged.

On windows it is not possible to delete a file that is open by a process. + This case will give an IO exception but the atomic property is not affected.

Unicode

Conversions

fromUTF8BS :: ByteString -> String #

Decode String from UTF8-encoded ByteString

Invalid data in the UTF8 stream (this includes code-points U+D800 + through U+DFFF) will be decoded as the replacement character (U+FFFD).

fromUTF8LBS :: ByteString -> String #

Variant of fromUTF8BS for lazy ByteStrings

toUTF8BS :: String -> ByteString #

Encode String to to UTF8-encoded ByteString

Code-points in the U+D800-U+DFFF range will be encoded + as the replacement character (i.e. U+FFFD).

toUTF8LBS :: String -> ByteString #

Variant of toUTF8BS for lazy ByteStrings

validateUTF8 :: ByteString -> Maybe Int #

Check that strict ByteString is valid UTF8. Returns 'Just offset' if it's not.

File I/O

readUTF8File :: FilePath -> NoCallStackIO String #

Reads a UTF8 encoded text file as a Unicode String

Reads lazily using ordinary readFile.

withUTF8FileContents :: FilePath -> (String -> IO a) -> IO a #

Reads a UTF8 encoded text file as a Unicode String

Same behaviour as withFileContents.

writeUTF8File :: FilePath -> String -> NoCallStackIO () #

Writes a Unicode String as a UTF8 encoded text file.

Uses writeFileAtomic, so provides the same guarantees.

BOM

ignoreBOM :: String -> String #

Ignore a Unicode byte order mark (BOM) at the beginning of the input

Misc

normaliseLineEndings :: String -> String #

Fix different systems silly line ending conventions

generic utils

dropWhileEndLE :: (a -> Bool) -> [a] -> [a] #

dropWhileEndLE p is equivalent to reverse . dropWhile p . reverse, but + quite a bit faster. The difference between "Data.List.dropWhileEnd" and this + version is that the one in Data.List is strict in elements, but spine-lazy, + while this one is spine-strict but lazy in elements. That's what LE stands + for - "lazy in elements".

Example:

>>> tail $ Data.List.dropWhileEnd (<3) [undefined, 5, 4, 3, 2, 1]
+*** Exception: Prelude.undefined
+...
+
>>> tail $ dropWhileEndLE (<3) [undefined, 5, 4, 3, 2, 1]
+[5,4,3]
+
>>> take 3 $ Data.List.dropWhileEnd (<3) [5, 4, 3, 2, 1, undefined]
+[5,4,3]
+
>>> take 3 $ dropWhileEndLE (<3) [5, 4, 3, 2, 1, undefined]
+*** Exception: Prelude.undefined
+...
+

takeWhileEndLE :: (a -> Bool) -> [a] -> [a] #

takeWhileEndLE p is equivalent to reverse . takeWhile p . reverse, but + is usually faster (as well as being easier to read).

equating :: Eq a => (b -> a) -> b -> b -> Bool #

comparing :: Ord a => (b -> a) -> b -> b -> Ordering #

comparing p x y = compare (p x) (p y)

Useful combinator for use in conjunction with the xxxBy family + of functions from Data.List, for example:

  ... sortBy (comparing fst) ...

isInfixOf :: Eq a => [a] -> [a] -> Bool #

The isInfixOf function takes two lists and returns True + iff the first list is contained, wholly and intact, + anywhere within the second.

>>> isInfixOf "Haskell" "I really like Haskell."
+True
+
>>> isInfixOf "Ial" "I really like Haskell."
+False
+

intercalate :: [a] -> [[a]] -> [a] #

intercalate xs xss is equivalent to (concat (intersperse xs xss)). + It inserts the list xs in between the lists in xss and concatenates the + result.

>>> intercalate ", " ["Lorem", "ipsum", "dolor"]
+"Lorem, ipsum, dolor"
+

lowercase :: String -> String #

Lower case string

>>> lowercase "Foobar"
+"foobar"
+

isAscii :: Char -> Bool #

Ascii characters

isAsciiAlpha :: Char -> Bool #

Ascii letters.

isAsciiAlphaNum :: Char -> Bool #

Ascii letters and digits.

>>> isAsciiAlphaNum 'a'
+True
+
>>> isAsciiAlphaNum 'ä'
+False
+

listUnion :: Ord a => [a] -> [a] -> [a] #

Like "Data.List.union", but has O(n log n) complexity instead of + O(n^2).

listUnionRight :: Ord a => [a] -> [a] -> [a] #

A right-biased version of listUnion.

Example:

>>> listUnion [1,2,3,4,3] [2,1,1]
+[1,2,3,4,3]
+
>>> listUnionRight [1,2,3,4,3] [2,1,1]
+[4,3,2,1,1]
+

ordNub :: Ord a => [a] -> [a] #

Like nub, but has O(n log n) complexity instead of + O(n^2). Code for ordNub and listUnion taken from Niklas Hambüchen's + ordnub package.

ordNubBy :: Ord b => (a -> b) -> [a] -> [a] #

Like ordNub and nubBy. Selects a key for each element and + takes the nub based on that key.

ordNubRight :: Ord a => [a] -> [a] #

A right-biased version of ordNub.

Example:

>>> ordNub [1,2,1] :: [Int]
+[1,2]
+
>>> ordNubRight [1,2,1] :: [Int]
+[2,1]
+

safeTail :: [a] -> [a] #

A total variant of tail.

unintersperse :: Char -> String -> [String] #

wrapText :: String -> String #

Wraps text to the default line width. Existing newlines are preserved.

wrapLine :: Int -> [String] -> [[String]] #

Wraps a list of words to a list of lines of words of a particular width.

unfoldrM :: Monad m => (b -> m (Maybe (a, b))) -> b -> m [a] #

unfoldr with monadic action.

>>> take 5 $ unfoldrM (\b r -> Just (r + b, b + 1)) (1 :: Int) 2
+[3,4,5,6,7]
+

Since: 2.2

spanMaybe :: (a -> Maybe b) -> [a] -> ([b], [a]) #

Like span but with Maybe predicate

>>> spanMaybe listToMaybe [[1,2],[3],[],[4,5],[6,7]]
+([1,3],[[],[4,5],[6,7]])
+
>>> spanMaybe (readMaybe :: String -> Maybe Int) ["1", "2", "foo"]
+([1,2],["foo"])
+

Since: 2.2

breakMaybe :: (a -> Maybe b) -> [a] -> ([a], Maybe (b, [a])) #

Like break, but with Maybe predicate

>>> breakMaybe (readMaybe :: String -> Maybe Int) ["foo", "bar", "1", "2", "quu"]
+(["foo","bar"],Just (1,["2","quu"]))
+
>>> breakMaybe (readMaybe :: String -> Maybe Int) ["foo", "bar"]
+(["foo","bar"],Nothing)
+

Since: 2.2

FilePath stuff

isAbsoluteOnAnyPlatform :: FilePath -> Bool #

isAbsoluteOnAnyPlatform and isRelativeOnAnyPlatform are like + isAbsolute and isRelative but have + platform independent heuristics. + The System.FilePath exists in two versions, Windows and Posix. The two + versions don't agree on what is a relative path and we don't know if we're + given Windows or Posix paths. + This results in false positives when running on Posix and inspecting + Windows paths, like the hackage server does. + System.FilePath.Posix.isAbsolute "C:\hello" == False + System.FilePath.Windows.isAbsolute "/hello" == False + This means that we would treat paths that start with "/" to be absolute. + On Posix they are indeed absolute, while on Windows they are not.

The portable versions should be used when we might deal with paths that + are from another OS than the host OS. For example, the Hackage Server + deals with both Windows and Posix paths while performing the + PackageDescription checks. In contrast, when we run 'cabal configure' we + do expect the paths to be correct for our OS and we should not have to use + the platform independent heuristics.

isRelativeOnAnyPlatform :: FilePath -> Bool #

isRelativeOnAnyPlatform = not . isAbsoluteOnAnyPlatform
diff --git a/doc/API/Cabal/Distribution-Utils-IOData.html b/doc/API/Cabal/Distribution-Utils-IOData.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Utils-IOData.html @@ -0,0 +1,5 @@ +Distribution.Utils.IOData

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Utils.IOData

Contents

Description

Since: 2.2.0

Synopsis

IOData & IODataMode type

data IOData #

Represents either textual or binary data passed via I/O functions + which support binary/text mode

Since: 2.2.0

Constructors

IODataText String

How Text gets encoded is usually locale-dependent.

IODataBinary ByteString

Raw binary which gets read/written in binary mode.

Instances
NFData IOData # 
Instance details

Defined in Distribution.Utils.IOData

Methods

rnf :: IOData -> () #

data IODataMode #

Constructors

IODataModeText 
IODataModeBinary 

null :: IOData -> Bool #

Test whether IOData is empty

Since: 2.2.0

hGetContents :: Handle -> IODataMode -> IO IOData #

IOData Wrapper for hGetContents

Note: This operation uses lazy I/O. Use NFData to force all + data to be read and consequently the internal file handle to be + closed.

Since: 2.2.0

hPutContents :: Handle -> IOData -> IO () #

IOData Wrapper for hPutStr and hClose

This is the dual operation ot ioDataHGetContents, + and consequently the handle is closed with hClose.

Since: 2.2.0

diff --git a/doc/API/Cabal/Distribution-Utils-LogProgress.html b/doc/API/Cabal/Distribution-Utils-LogProgress.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Utils-LogProgress.html @@ -0,0 +1,3 @@ +Distribution.Utils.LogProgress

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Utils.LogProgress

Synopsis

Documentation

data LogProgress a #

The Progress monad with specialized logging and + error messages.

Instances
Monad LogProgress # 
Instance details

Defined in Distribution.Utils.LogProgress

Methods

(>>=) :: LogProgress a -> (a -> LogProgress b) -> LogProgress b #

(>>) :: LogProgress a -> LogProgress b -> LogProgress b #

return :: a -> LogProgress a #

fail :: String -> LogProgress a #

Functor LogProgress # 
Instance details

Defined in Distribution.Utils.LogProgress

Methods

fmap :: (a -> b) -> LogProgress a -> LogProgress b #

(<$) :: a -> LogProgress b -> LogProgress a #

Applicative LogProgress # 
Instance details

Defined in Distribution.Utils.LogProgress

Methods

pure :: a -> LogProgress a #

(<*>) :: LogProgress (a -> b) -> LogProgress a -> LogProgress b #

liftA2 :: (a -> b -> c) -> LogProgress a -> LogProgress b -> LogProgress c #

(*>) :: LogProgress a -> LogProgress b -> LogProgress b #

(<*) :: LogProgress a -> LogProgress b -> LogProgress a #

runLogProgress :: Verbosity -> LogProgress a -> NoCallStackIO a #

Run LogProgress, outputting traces according to Verbosity, + die if there is an error.

warnProgress :: Doc -> LogProgress () #

Output a warning trace message in LogProgress.

infoProgress :: Doc -> LogProgress () #

Output an informational trace message in LogProgress.

dieProgress :: Doc -> LogProgress a #

Fail the computation with an error message.

addProgressCtx :: CtxMsg -> LogProgress a -> LogProgress a #

Add a message to the error/warning context.

diff --git a/doc/API/Cabal/Distribution-Utils-MapAccum.html b/doc/API/Cabal/Distribution-Utils-MapAccum.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Utils-MapAccum.html @@ -0,0 +1,1 @@ +Distribution.Utils.MapAccum

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Utils.MapAccum

Synopsis

Documentation

mapAccumM :: (Monad m, Traversable t) => (a -> b -> m (a, c)) -> a -> t b -> m (a, t c) #

Monadic variant of mapAccumL.

diff --git a/doc/API/Cabal/Distribution-Utils-NubList.html b/doc/API/Cabal/Distribution-Utils-NubList.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Utils-NubList.html @@ -0,0 +1,12 @@ +Distribution.Utils.NubList

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Utils.NubList

Synopsis

Documentation

data NubList a #

NubList : A de-duplicated list that maintains the original order.

Instances
Eq a => Eq (NubList a) # 
Instance details

Defined in Distribution.Utils.NubList

Methods

(==) :: NubList a -> NubList a -> Bool #

(/=) :: NubList a -> NubList a -> Bool #

(Ord a, Read a) => Read (NubList a) # 
Instance details

Defined in Distribution.Utils.NubList

Methods

readsPrec :: Int -> ReadS (NubList a) #

readList :: ReadS [NubList a] #

readPrec :: ReadPrec (NubList a) #

readListPrec :: ReadPrec [NubList a] #

Show a => Show (NubList a) # 
Instance details

Defined in Distribution.Utils.NubList

Methods

showsPrec :: Int -> NubList a -> ShowS #

show :: NubList a -> String #

showList :: [NubList a] -> ShowS #

Ord a => Semigroup (NubList a) # 
Instance details

Defined in Distribution.Utils.NubList

Methods

(<>) :: NubList a -> NubList a -> NubList a #

sconcat :: NonEmpty (NubList a) -> NubList a #

stimes :: Integral b => b -> NubList a -> NubList a #

Ord a => Monoid (NubList a) #

Monoid operations on NubLists. + For a valid Monoid instance we need to satistfy the required monoid laws; + identity, associativity and closure.

Identity : by inspection: + mempty mappend NubList xs == NubList xs mappend mempty

Associativity : by inspection: + (NubList xs mappend NubList ys) mappend NubList zs + == NubList xs mappend (NubList ys mappend NubList zs)

Closure : appending two lists of type a and removing duplicates obviously + does not change the type.

Instance details

Defined in Distribution.Utils.NubList

Methods

mempty :: NubList a #

mappend :: NubList a -> NubList a -> NubList a #

mconcat :: [NubList a] -> NubList a #

(Ord a, Binary a) => Binary (NubList a) #

Binary instance for 'NubList a' is the same as for '[a]'. For put, we + just pull off constructor and put the list. For get, we get the list and + make a NubList out of it using toNubList.

Instance details

Defined in Distribution.Utils.NubList

Methods

put :: NubList a -> Put #

get :: Get (NubList a) #

putList :: [NubList a] -> Put #

toNubList :: Ord a => [a] -> NubList a #

Smart constructor for the NubList type.

fromNubList :: NubList a -> [a] #

overNubList :: Ord a => ([a] -> [a]) -> NubList a -> NubList a #

Lift a function over lists to a function over NubLists.

data NubListR a #

NubListR : A right-biased version of NubList. That is toNubListR + ["-XNoFoo", "-XFoo", "-XNoFoo"] will result in ["-XFoo", "-XNoFoo"], + unlike the normal NubList, which is left-biased. Built on top of + ordNubRight and listUnionRight.

Instances
Eq a => Eq (NubListR a) # 
Instance details

Defined in Distribution.Utils.NubList

Methods

(==) :: NubListR a -> NubListR a -> Bool #

(/=) :: NubListR a -> NubListR a -> Bool #

(Ord a, Read a) => Read (NubListR a) # 
Instance details

Defined in Distribution.Utils.NubList

Methods

readsPrec :: Int -> ReadS (NubListR a) #

readList :: ReadS [NubListR a] #

readPrec :: ReadPrec (NubListR a) #

readListPrec :: ReadPrec [NubListR a] #

Show a => Show (NubListR a) # 
Instance details

Defined in Distribution.Utils.NubList

Methods

showsPrec :: Int -> NubListR a -> ShowS #

show :: NubListR a -> String #

showList :: [NubListR a] -> ShowS #

Ord a => Semigroup (NubListR a) # 
Instance details

Defined in Distribution.Utils.NubList

Methods

(<>) :: NubListR a -> NubListR a -> NubListR a #

sconcat :: NonEmpty (NubListR a) -> NubListR a #

stimes :: Integral b => b -> NubListR a -> NubListR a #

Ord a => Monoid (NubListR a) # 
Instance details

Defined in Distribution.Utils.NubList

Methods

mempty :: NubListR a #

mappend :: NubListR a -> NubListR a -> NubListR a #

mconcat :: [NubListR a] -> NubListR a #

toNubListR :: Ord a => [a] -> NubListR a #

Smart constructor for the NubListR type.

fromNubListR :: NubListR a -> [a] #

overNubListR :: Ord a => ([a] -> [a]) -> NubListR a -> NubListR a #

Lift a function over lists to a function over NubListRs.

diff --git a/doc/API/Cabal/Distribution-Utils-Progress.html b/doc/API/Cabal/Distribution-Utils-Progress.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Utils-Progress.html @@ -0,0 +1,8 @@ +Distribution.Utils.Progress

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Utils.Progress

Description

A progress monad, which we use to report failure and logging from + otherwise pure code.

Synopsis

Documentation

data Progress step fail done #

A type to represent the unfolding of an expensive long running + calculation that may fail (or maybe not expensive, but complicated!) + We may get intermediate steps before the final + result which may be used to indicate progress and/or logging messages.

TODO: Apply Codensity to avoid left-associativity problem. + See http://comonad.com/reader/2011/free-monads-for-less/ and + http://blog.ezyang.com/2012/01/problem-set-the-codensity-transformation/

Instances
Monad (Progress step fail) # 
Instance details

Defined in Distribution.Utils.Progress

Methods

(>>=) :: Progress step fail a -> (a -> Progress step fail b) -> Progress step fail b #

(>>) :: Progress step fail a -> Progress step fail b -> Progress step fail b #

return :: a -> Progress step fail a #

fail :: String -> Progress step fail a #

Functor (Progress step fail) # 
Instance details

Defined in Distribution.Utils.Progress

Methods

fmap :: (a -> b) -> Progress step fail a -> Progress step fail b #

(<$) :: a -> Progress step fail b -> Progress step fail a #

Applicative (Progress step fail) # 
Instance details

Defined in Distribution.Utils.Progress

Methods

pure :: a -> Progress step fail a #

(<*>) :: Progress step fail (a -> b) -> Progress step fail a -> Progress step fail b #

liftA2 :: (a -> b -> c) -> Progress step fail a -> Progress step fail b -> Progress step fail c #

(*>) :: Progress step fail a -> Progress step fail b -> Progress step fail b #

(<*) :: Progress step fail a -> Progress step fail b -> Progress step fail a #

Monoid fail => Alternative (Progress step fail) # 
Instance details

Defined in Distribution.Utils.Progress

Methods

empty :: Progress step fail a #

(<|>) :: Progress step fail a -> Progress step fail a -> Progress step fail a #

some :: Progress step fail a -> Progress step fail [a] #

many :: Progress step fail a -> Progress step fail [a] #

stepProgress :: step -> Progress step fail () #

Emit a step and then continue.

failProgress :: fail -> Progress step fail done #

Fail the computation.

foldProgress :: (step -> a -> a) -> (fail -> a) -> (done -> a) -> Progress step fail done -> a #

Consume a Progress calculation. Much like foldr for lists but with two + base cases, one for a final result and one for failure.

Eg to convert into a simple Either result use:

foldProgress (flip const) Left Right
diff --git a/doc/API/Cabal/Distribution-Utils-ShortText.html b/doc/API/Cabal/Distribution-Utils-ShortText.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Utils-ShortText.html @@ -0,0 +1,7 @@ +Distribution.Utils.ShortText

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe HaskellNone
LanguageHaskell2010

Distribution.Utils.ShortText

Contents

Synopsis

ShortText type

data ShortText #

Compact representation of short Strings

The data is stored internally as UTF8 in an + ShortByteString when compiled against bytestring >= + 0.10.4, and otherwise the fallback is to use plain old non-compat + '[Char]'.

Note: This type is for internal uses (such as e.g. PackageName) + and shall not be exposed in Cabal's API

Since: 2.0.0.2

Instances
Eq ShortText # 
Instance details

Defined in Distribution.Utils.ShortText

Methods

(==) :: ShortText -> ShortText -> Bool #

(/=) :: ShortText -> ShortText -> Bool #

Data ShortText # 
Instance details

Defined in Distribution.Utils.ShortText

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ShortText -> c ShortText #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ShortText #

toConstr :: ShortText -> Constr #

dataTypeOf :: ShortText -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ShortText) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ShortText) #

gmapT :: (forall b. Data b => b -> b) -> ShortText -> ShortText #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ShortText -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ShortText -> r #

gmapQ :: (forall d. Data d => d -> u) -> ShortText -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ShortText -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ShortText -> m ShortText #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ShortText -> m ShortText #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ShortText -> m ShortText #

Ord ShortText # 
Instance details

Defined in Distribution.Utils.ShortText

Methods

compare :: ShortText -> ShortText -> Ordering #

(<) :: ShortText -> ShortText -> Bool #

(<=) :: ShortText -> ShortText -> Bool #

(>) :: ShortText -> ShortText -> Bool #

(>=) :: ShortText -> ShortText -> Bool #

max :: ShortText -> ShortText -> ShortText #

min :: ShortText -> ShortText -> ShortText #

Read ShortText # 
Instance details

Defined in Distribution.Utils.ShortText

Methods

readsPrec :: Int -> ReadS ShortText #

readList :: ReadS [ShortText] #

readPrec :: ReadPrec ShortText #

readListPrec :: ReadPrec [ShortText] #

Show ShortText # 
Instance details

Defined in Distribution.Utils.ShortText

Methods

showsPrec :: Int -> ShortText -> ShowS #

show :: ShortText -> String #

showList :: [ShortText] -> ShowS #

IsString ShortText # 
Instance details

Defined in Distribution.Utils.ShortText

Methods

fromString :: String -> ShortText #

Generic ShortText # 
Instance details

Defined in Distribution.Utils.ShortText

Associated Types

type Rep ShortText :: * -> * #

Methods

from :: ShortText -> Rep ShortText x #

to :: Rep ShortText x -> ShortText #

Semigroup ShortText # 
Instance details

Defined in Distribution.Utils.ShortText

Methods

(<>) :: ShortText -> ShortText -> ShortText #

sconcat :: NonEmpty ShortText -> ShortText #

stimes :: Integral b => b -> ShortText -> ShortText #

Monoid ShortText # 
Instance details

Defined in Distribution.Utils.ShortText

Methods

mempty :: ShortText #

mappend :: ShortText -> ShortText -> ShortText #

mconcat :: [ShortText] -> ShortText #

Binary ShortText # 
Instance details

Defined in Distribution.Utils.ShortText

Methods

put :: ShortText -> Put #

get :: Get ShortText #

putList :: [ShortText] -> Put #

NFData ShortText # 
Instance details

Defined in Distribution.Utils.ShortText

Methods

rnf :: ShortText -> () #

type Rep ShortText # 
Instance details

Defined in Distribution.Utils.ShortText

type Rep ShortText = D1 (MetaData "ShortText" "Distribution.Utils.ShortText" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" True) (C1 (MetaCons "ST" PrefixI True) (S1 (MetaSel (Just "unST") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ShortByteString)))

toShortText :: String -> ShortText #

Construct ShortText from String

fromShortText :: ShortText -> String #

Convert ShortText to String

internal utilities

decodeStringUtf8 :: [Word8] -> String #

Decode String from UTF8-encoded octets.

Invalid data in the UTF8 stream (this includes code-points U+D800 + through U+DFFF) will be decoded as the replacement character (U+FFFD).

See also encodeStringUtf8

encodeStringUtf8 :: String -> [Word8] #

Encode String to a list of UTF8-encoded octets

Code-points in the U+D800-U+DFFF range will be encoded + as the replacement character (i.e. U+FFFD).

See also decodeUtf8

diff --git a/doc/API/Cabal/Distribution-Verbosity.html b/doc/API/Cabal/Distribution-Verbosity.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Verbosity.html @@ -0,0 +1,10 @@ +Distribution.Verbosity

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIan Lynagh 2007
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Verbosity

Contents

Description

A Verbosity type with associated utilities.

There are 4 standard verbosity levels from silent, normal, + verbose up to deafening. This is used for deciding what logging + messages to print.

Verbosity also is equipped with some internal settings which can be + used to control at a fine granularity the verbosity of specific + settings (e.g., so that you can trace only particular things you + are interested in.) It's important to note that the instances + for Verbosity assume that this does not exist.

Synopsis

Verbosity

data Verbosity #

Instances
Bounded Verbosity # 
Instance details

Defined in Distribution.Verbosity

Methods

minBound :: Verbosity #

maxBound :: Verbosity #

Enum Verbosity # 
Instance details

Defined in Distribution.Verbosity

Methods

succ :: Verbosity -> Verbosity #

pred :: Verbosity -> Verbosity #

toEnum :: Int -> Verbosity #

fromEnum :: Verbosity -> Int #

enumFrom :: Verbosity -> [Verbosity] #

enumFromThen :: Verbosity -> Verbosity -> [Verbosity] #

enumFromTo :: Verbosity -> Verbosity -> [Verbosity] #

enumFromThenTo :: Verbosity -> Verbosity -> Verbosity -> [Verbosity] #

Eq Verbosity # 
Instance details

Defined in Distribution.Verbosity

Methods

(==) :: Verbosity -> Verbosity -> Bool #

(/=) :: Verbosity -> Verbosity -> Bool #

Ord Verbosity # 
Instance details

Defined in Distribution.Verbosity

Methods

compare :: Verbosity -> Verbosity -> Ordering #

(<) :: Verbosity -> Verbosity -> Bool #

(<=) :: Verbosity -> Verbosity -> Bool #

(>) :: Verbosity -> Verbosity -> Bool #

(>=) :: Verbosity -> Verbosity -> Bool #

max :: Verbosity -> Verbosity -> Verbosity #

min :: Verbosity -> Verbosity -> Verbosity #

Read Verbosity # 
Instance details

Defined in Distribution.Verbosity

Methods

readsPrec :: Int -> ReadS Verbosity #

readList :: ReadS [Verbosity] #

readPrec :: ReadPrec Verbosity #

readListPrec :: ReadPrec [Verbosity] #

Show Verbosity # 
Instance details

Defined in Distribution.Verbosity

Methods

showsPrec :: Int -> Verbosity -> ShowS #

show :: Verbosity -> String #

showList :: [Verbosity] -> ShowS #

Generic Verbosity # 
Instance details

Defined in Distribution.Verbosity

Associated Types

type Rep Verbosity :: * -> * #

Methods

from :: Verbosity -> Rep Verbosity x #

to :: Rep Verbosity x -> Verbosity #

Binary Verbosity # 
Instance details

Defined in Distribution.Verbosity

Methods

put :: Verbosity -> Put #

get :: Get Verbosity #

putList :: [Verbosity] -> Put #

type Rep Verbosity # 
Instance details

Defined in Distribution.Verbosity

type Rep Verbosity

silent :: Verbosity #

normal :: Verbosity #

verbose :: Verbosity #

deafening :: Verbosity #

moreVerbose :: Verbosity -> Verbosity #

lessVerbose :: Verbosity -> Verbosity #

isVerboseQuiet :: Verbosity -> Bool #

Test if we had called lessVerbose on the verbosity

intToVerbosity :: Int -> Maybe Verbosity #

flagToVerbosity :: ReadE Verbosity #

showForCabal :: Verbosity -> String #

showForGHC :: Verbosity -> String #

verboseNoFlags :: Verbosity -> Verbosity #

Turn off all flags

verboseHasFlags :: Verbosity -> Bool #

modifyVerbosity :: (Verbosity -> Verbosity) -> Verbosity -> Verbosity #

Combinator for transforming verbosity level while retaining the + original hidden state.

For instance, the following property holds

isVerboseNoWrap (modifyVerbosity (max verbose) v) == isVerboseNoWrap v

Note: you can use modifyVerbosity (const v1) v0 to overwrite + v1's flags with v0's flags.

Since: 2.0.1.0

Call stacks

verboseCallSite :: Verbosity -> Verbosity #

Turn on verbose call-site printing when we log.

verboseCallStack :: Verbosity -> Verbosity #

Turn on verbose call-stack printing when we log.

isVerboseCallSite :: Verbosity -> Bool #

Test if we should output call sites when we log.

isVerboseCallStack :: Verbosity -> Bool #

Test if we should output call stacks when we log.

Output markets

verboseMarkOutput :: Verbosity -> Verbosity #

Turn on -----BEGIN CABAL OUTPUT----- markers for output + from Cabal (as opposed to GHC, or system dependent).

isVerboseMarkOutput :: Verbosity -> Bool #

Test if we should output markets.

verboseUnmarkOutput :: Verbosity -> Verbosity #

Turn off marking; useful for suppressing nondeterministic output.

line-wrapping

verboseNoWrap :: Verbosity -> Verbosity #

Disable line-wrapping for log messages.

isVerboseNoWrap :: Verbosity -> Bool #

Test if line-wrapping is disabled for log messages.

timestamps

verboseTimestamp :: Verbosity -> Verbosity #

Turn on timestamps for log messages.

isVerboseTimestamp :: Verbosity -> Bool #

Test if if we should output timestamps when we log.

verboseNoTimestamp :: Verbosity -> Verbosity #

Turn off timestamps for log messages.

diff --git a/doc/API/Cabal/Distribution-Version.html b/doc/API/Cabal/Distribution-Version.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Version.html @@ -0,0 +1,74 @@ +Distribution.Version

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones Simon Marlow 2003-2004
Duncan Coutts 2008
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Version

Contents

Description

Exports the Version type along with a parser and pretty printer. A version + is something like "1.3.3". It also defines the VersionRange data + types. Version ranges are like ">= 1.2 && < 2".

Synopsis

Package versions

data Version #

A Version represents the version of a software entity.

Instances of Eq and Ord are provided, which gives exact + equality and lexicographic ordering of the version number + components (i.e. 2.1 > 2.0, 1.2.3 > 1.2.2, etc.).

This type is opaque and distinct from the Version type in + Data.Version since Cabal-2.0. The difference extends to the + Binary instance using a different (and more compact) encoding.

Since: 2.0.0.2

Instances
Eq Version # 
Instance details

Defined in Distribution.Types.Version

Methods

(==) :: Version -> Version -> Bool #

(/=) :: Version -> Version -> Bool #

Data Version # 
Instance details

Defined in Distribution.Types.Version

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Version -> c Version #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Version #

toConstr :: Version -> Constr #

dataTypeOf :: Version -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Version) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Version) #

gmapT :: (forall b. Data b => b -> b) -> Version -> Version #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r #

gmapQ :: (forall d. Data d => d -> u) -> Version -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Version -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Version -> m Version #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version #

Ord Version # 
Instance details

Defined in Distribution.Types.Version

Methods

compare :: Version -> Version -> Ordering #

(<) :: Version -> Version -> Bool #

(<=) :: Version -> Version -> Bool #

(>) :: Version -> Version -> Bool #

(>=) :: Version -> Version -> Bool #

max :: Version -> Version -> Version #

min :: Version -> Version -> Version #

Read Version # 
Instance details

Defined in Distribution.Types.Version

Methods

readsPrec :: Int -> ReadS Version #

readList :: ReadS [Version] #

readPrec :: ReadPrec Version #

readListPrec :: ReadPrec [Version] #

Show Version # 
Instance details

Defined in Distribution.Types.Version

Methods

showsPrec :: Int -> Version -> ShowS #

show :: Version -> String #

showList :: [Version] -> ShowS #

Generic Version # 
Instance details

Defined in Distribution.Types.Version

Associated Types

type Rep Version :: * -> * #

Methods

from :: Version -> Rep Version x #

to :: Rep Version x -> Version #

Binary Version # 
Instance details

Defined in Distribution.Types.Version

Methods

put :: Version -> Put #

get :: Get Version #

putList :: [Version] -> Put #

NFData Version # 
Instance details

Defined in Distribution.Types.Version

Methods

rnf :: Version -> () #

Pretty Version # 
Instance details

Defined in Distribution.Types.Version

Methods

pretty :: Version -> Doc #

Parsec Version # 
Instance details

Defined in Distribution.Types.Version

Methods

parsec :: CabalParsing m => m Version #

Text Version # 
Instance details

Defined in Distribution.Types.Version

Methods

disp :: Version -> Doc #

parse :: ReadP r Version #

Newtype SpecVersion (Either Version VersionRange) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: Either Version VersionRange -> SpecVersion #

unpack :: SpecVersion -> Either Version VersionRange #

type Rep Version # 
Instance details

Defined in Distribution.Types.Version

type Rep Version = D1 (MetaData "Version" "Distribution.Types.Version" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "PV0" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedStrict) (Rec0 Word64)) :+: C1 (MetaCons "PV1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Int])))

version0 :: Version #

Version 0. A lower bound of Version.

Since: 2.2

mkVersion :: [Int] -> Version #

Construct Version from list of version number components.

For instance, mkVersion [3,2,1] constructs a Version + representing the version 3.2.1.

All version components must be non-negative. mkVersion [] + currently represents the special null version; see also nullVersion.

Since: 2.0.0.2

mkVersion' :: Version -> Version #

Variant of mkVersion which converts a Data.Version + Version into Cabal's Version type.

Since: 2.0.0.2

versionNumbers :: Version -> [Int] #

Unpack Version into list of version number components.

This is the inverse to mkVersion, so the following holds:

(versionNumbers . mkVersion) vs == vs

Since: 2.0.0.2

nullVersion :: Version #

Constant representing the special null Version

The nullVersion compares (via Ord) as less than every proper + Version value.

Since: 2.0.0.2

alterVersion :: ([Int] -> [Int]) -> Version -> Version #

Apply function to list of version number components

alterVersion f == mkVersion . f . versionNumbers

Since: 2.0.0.2

Backwards compatibility

showVersion :: Version -> String #

Deprecated: Use prettyShow. This function will be removed in Cabal-3.0 (estimated Oct 2018)

Version ranges

data VersionRange #

Constructors

AnyVersion

Deprecated: Use anyVersion, foldVersionRange or asVersionIntervals

ThisVersion Version

Deprecated: Use thisVersion, foldVersionRange or asVersionIntervals

LaterVersion Version

Deprecated: Use laterVersion, foldVersionRange or asVersionIntervals

OrLaterVersion Version 
EarlierVersion Version

Deprecated: Use earlierVersion, foldVersionRange or asVersionIntervals

OrEarlierVersion Version 
WildcardVersion Version

Deprecated: Use anyVersion, foldVersionRange or asVersionIntervals

MajorBoundVersion Version 
UnionVersionRanges VersionRange VersionRange

Deprecated: Use unionVersionRanges, foldVersionRange or asVersionIntervals

IntersectVersionRanges VersionRange VersionRange

Deprecated: Use intersectVersionRanges, foldVersionRange or asVersionIntervals

VersionRangeParens VersionRange 
Instances
Eq VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

(==) :: VersionRange -> VersionRange -> Bool #

(/=) :: VersionRange -> VersionRange -> Bool #

Data VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> VersionRange -> c VersionRange #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c VersionRange #

toConstr :: VersionRange -> Constr #

dataTypeOf :: VersionRange -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c VersionRange) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c VersionRange) #

gmapT :: (forall b. Data b => b -> b) -> VersionRange -> VersionRange #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> VersionRange -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> VersionRange -> r #

gmapQ :: (forall d. Data d => d -> u) -> VersionRange -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> VersionRange -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> VersionRange -> m VersionRange #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> VersionRange -> m VersionRange #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> VersionRange -> m VersionRange #

Read VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

readsPrec :: Int -> ReadS VersionRange #

readList :: ReadS [VersionRange] #

readPrec :: ReadPrec VersionRange #

readListPrec :: ReadPrec [VersionRange] #

Show VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

showsPrec :: Int -> VersionRange -> ShowS #

show :: VersionRange -> String #

showList :: [VersionRange] -> ShowS #

Generic VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Associated Types

type Rep VersionRange :: * -> * #

Methods

from :: VersionRange -> Rep VersionRange x #

to :: Rep VersionRange x -> VersionRange #

Binary VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

put :: VersionRange -> Put #

get :: Get VersionRange #

putList :: [VersionRange] -> Put #

NFData VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

rnf :: VersionRange -> () #

Pretty VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

pretty :: VersionRange -> Doc #

Parsec VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

parsec :: CabalParsing m => m VersionRange #

Text VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

disp :: VersionRange -> Doc #

parse :: ReadP r VersionRange #

Newtype TestedWith (CompilerFlavor, VersionRange) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: (CompilerFlavor, VersionRange) -> TestedWith #

unpack :: TestedWith -> (CompilerFlavor, VersionRange) #

Newtype SpecVersion (Either Version VersionRange) # 
Instance details

Defined in Distribution.Parsec.Newtypes

Methods

pack :: Either Version VersionRange -> SpecVersion #

unpack :: SpecVersion -> Either Version VersionRange #

type Rep VersionRange # 
Instance details

Defined in Distribution.Types.VersionRange

type Rep VersionRange = D1 (MetaData "VersionRange" "Distribution.Types.VersionRange" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (((C1 (MetaCons "AnyVersion" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ThisVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version))) :+: (C1 (MetaCons "LaterVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: (C1 (MetaCons "OrLaterVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: C1 (MetaCons "EarlierVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version))))) :+: ((C1 (MetaCons "OrEarlierVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: (C1 (MetaCons "WildcardVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: C1 (MetaCons "MajorBoundVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)))) :+: (C1 (MetaCons "UnionVersionRanges" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange)) :+: (C1 (MetaCons "IntersectVersionRanges" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange)) :+: C1 (MetaCons "VersionRangeParens" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange))))))

Constructing

anyVersion :: VersionRange #

The version range -any. That is, a version range containing all + versions.

withinRange v anyVersion = True

noVersion :: VersionRange #

The empty version range, that is a version range containing no versions.

This can be constructed using any unsatisfiable version range expression, + for example > 1 && < 1.

withinRange v noVersion = False

thisVersion :: Version -> VersionRange #

The version range == v

withinRange v' (thisVersion v) = v' == v

notThisVersion :: Version -> VersionRange #

The version range || v

withinRange v' (notThisVersion v) = v' /= v

laterVersion :: Version -> VersionRange #

The version range > v

withinRange v' (laterVersion v) = v' > v

earlierVersion :: Version -> VersionRange #

The version range < v

withinRange v' (earlierVersion v) = v' < v

orLaterVersion :: Version -> VersionRange #

The version range >= v

withinRange v' (orLaterVersion v) = v' >= v

orEarlierVersion :: Version -> VersionRange #

The version range <= v

withinRange v' (orEarlierVersion v) = v' <= v

unionVersionRanges :: VersionRange -> VersionRange -> VersionRange #

The version range vr1 || vr2

  withinRange v' (unionVersionRanges vr1 vr2)
+= withinRange v' vr1 || withinRange v' vr2

intersectVersionRanges :: VersionRange -> VersionRange -> VersionRange #

The version range vr1 && vr2

  withinRange v' (intersectVersionRanges vr1 vr2)
+= withinRange v' vr1 && withinRange v' vr2

differenceVersionRanges :: VersionRange -> VersionRange -> VersionRange #

The difference of two version ranges

  withinRange v' (differenceVersionRanges vr1 vr2)
+= withinRange v' vr1 && not (withinRange v' vr2)

Since: 1.24.1.0

invertVersionRange :: VersionRange -> VersionRange #

The inverse of a version range

  withinRange v' (invertVersionRange vr)
+= not (withinRange v' vr)

withinVersion :: Version -> VersionRange #

The version range == v.*.

For example, for version 1.2, the version range == 1.2.* is the same as + >= 1.2 && < 1.3

withinRange v' (laterVersion v) = v' >= v && v' < upper v
+  where
+    upper (Version lower t) = Version (init lower ++ [last lower + 1]) t

majorBoundVersion :: Version -> VersionRange #

The version range ^>= v.

For example, for version 1.2.3.4, the version range ^>= 1.2.3.4 is the same as + >= 1.2.3.4 && < 1.3.

Note that ^>= 1 is equivalent to >= 1 && < 1.1.

Since: 2.0.0.2

betweenVersionsInclusive :: Version -> Version -> VersionRange #

Deprecated: In practice this is not very useful because we normally use inclusive lower bounds and exclusive upper bounds

Inspection

withinRange :: Version -> VersionRange -> Bool #

Does this version fall within the given range?

This is the evaluation function for the VersionRange type.

isAnyVersion :: VersionRange -> Bool #

Does this VersionRange place any restriction on the Version or is it + in fact equivalent to AnyVersion.

Note this is a semantic check, not simply a syntactic check. So for example + the following is True (for all v).

isAnyVersion (EarlierVersion v `UnionVersionRanges` orLaterVersion v)

isNoVersion :: VersionRange -> Bool #

This is the converse of isAnyVersion. It check if the version range is + empty, if there is no possible version that satisfies the version range.

For example this is True (for all v):

isNoVersion (EarlierVersion v `IntersectVersionRanges` LaterVersion v)

isSpecificVersion :: VersionRange -> Maybe Version #

Is this version range in fact just a specific version?

For example the version range ">= 3 && <= 3" contains only the version + 3.

simplifyVersionRange :: VersionRange -> VersionRange #

Simplify a VersionRange expression. For non-empty version ranges + this produces a canonical form. Empty or inconsistent version ranges + are left as-is because that provides more information.

If you need a canonical form use + fromVersionIntervals . toVersionIntervals

It satisfies the following properties:

withinRange v (simplifyVersionRange r) = withinRange v r
    withinRange v r = withinRange v r'
+==> simplifyVersionRange r = simplifyVersionRange r'
+ || isNoVersion r
+ || isNoVersion r'

foldVersionRange #

Arguments

:: a

"-any" version

-> (Version -> a)
"== v"
-> (Version -> a)
"> v"
-> (Version -> a)
"< v"
-> (a -> a -> a)

"_ || _" union

-> (a -> a -> a)

"_ && _" intersection

-> VersionRange 
-> a 

Fold over the basic syntactic structure of a VersionRange.

This provides a syntactic view of the expression defining the version range. + The syntactic sugar ">= v", "<= v" and "== v.*" is presented + in terms of the other basic syntax.

For a semantic view use asVersionIntervals.

foldVersionRange' #

Arguments

:: a

"-any" version

-> (Version -> a)
"== v"
-> (Version -> a)
"> v"
-> (Version -> a)
"< v"
-> (Version -> a)
">= v"
-> (Version -> a)
"<= v"
-> (Version -> Version -> a)

"== v.*" wildcard. The + function is passed the + inclusive lower bound and the + exclusive upper bounds of the + range defined by the wildcard.

-> (Version -> Version -> a)

"^>= v" major upper bound + The function is passed the + inclusive lower bound and the + exclusive major upper bounds + of the range defined by this + operator.

-> (a -> a -> a)

"_ || _" union

-> (a -> a -> a)

"_ && _" intersection

-> (a -> a)

"(_)" parentheses

-> VersionRange 
-> a 

Deprecated: Use cataVersionRange & normaliseVersionRange for more principled folding

An extended variant of foldVersionRange that also provides a view of the + expression in which the syntactic sugar ">= v", "<= v" and "== + v.*" is presented explicitly rather than in terms of the other basic + syntax.

normaliseVersionRange :: VersionRange -> VersionRange #

Normalise VersionRange.

In particular collapse (== v || > v) into >= v, and so on.

stripParensVersionRange :: VersionRange -> VersionRange #

Remove VersionRangeParens constructors.

Since: 2.2

hasUpperBound :: VersionRange -> Bool #

Does the version range have an upper bound?

Since: 1.24.0.0

hasLowerBound :: VersionRange -> Bool #

Does the version range have an explicit lower bound?

Note: this function only considers the user-specified lower bounds, but not + the implicit >=0 lower bound.

Since: 1.24.0.0

Cata & ana

data VersionRangeF a #

F-Algebra of VersionRange. See cataVersionRange.

Since: 2.2

Constructors

AnyVersionF 
ThisVersionF Version 
LaterVersionF Version 
OrLaterVersionF Version 
EarlierVersionF Version 
OrEarlierVersionF Version 
WildcardVersionF Version 
MajorBoundVersionF Version 
UnionVersionRangesF a a 
IntersectVersionRangesF a a 
VersionRangeParensF a 
Instances
Functor VersionRangeF # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

fmap :: (a -> b) -> VersionRangeF a -> VersionRangeF b #

(<$) :: a -> VersionRangeF b -> VersionRangeF a #

Foldable VersionRangeF # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

fold :: Monoid m => VersionRangeF m -> m #

foldMap :: Monoid m => (a -> m) -> VersionRangeF a -> m #

foldr :: (a -> b -> b) -> b -> VersionRangeF a -> b #

foldr' :: (a -> b -> b) -> b -> VersionRangeF a -> b #

foldl :: (b -> a -> b) -> b -> VersionRangeF a -> b #

foldl' :: (b -> a -> b) -> b -> VersionRangeF a -> b #

foldr1 :: (a -> a -> a) -> VersionRangeF a -> a #

foldl1 :: (a -> a -> a) -> VersionRangeF a -> a #

toList :: VersionRangeF a -> [a] #

null :: VersionRangeF a -> Bool #

length :: VersionRangeF a -> Int #

elem :: Eq a => a -> VersionRangeF a -> Bool #

maximum :: Ord a => VersionRangeF a -> a #

minimum :: Ord a => VersionRangeF a -> a #

sum :: Num a => VersionRangeF a -> a #

product :: Num a => VersionRangeF a -> a #

Traversable VersionRangeF # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

traverse :: Applicative f => (a -> f b) -> VersionRangeF a -> f (VersionRangeF b) #

sequenceA :: Applicative f => VersionRangeF (f a) -> f (VersionRangeF a) #

mapM :: Monad m => (a -> m b) -> VersionRangeF a -> m (VersionRangeF b) #

sequence :: Monad m => VersionRangeF (m a) -> m (VersionRangeF a) #

Eq a => Eq (VersionRangeF a) # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

(==) :: VersionRangeF a -> VersionRangeF a -> Bool #

(/=) :: VersionRangeF a -> VersionRangeF a -> Bool #

Data a => Data (VersionRangeF a) # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> VersionRangeF a -> c (VersionRangeF a) #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (VersionRangeF a) #

toConstr :: VersionRangeF a -> Constr #

dataTypeOf :: VersionRangeF a -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (VersionRangeF a)) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (VersionRangeF a)) #

gmapT :: (forall b. Data b => b -> b) -> VersionRangeF a -> VersionRangeF a #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> VersionRangeF a -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> VersionRangeF a -> r #

gmapQ :: (forall d. Data d => d -> u) -> VersionRangeF a -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> VersionRangeF a -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> VersionRangeF a -> m (VersionRangeF a) #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> VersionRangeF a -> m (VersionRangeF a) #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> VersionRangeF a -> m (VersionRangeF a) #

Read a => Read (VersionRangeF a) # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

readsPrec :: Int -> ReadS (VersionRangeF a) #

readList :: ReadS [VersionRangeF a] #

readPrec :: ReadPrec (VersionRangeF a) #

readListPrec :: ReadPrec [VersionRangeF a] #

Show a => Show (VersionRangeF a) # 
Instance details

Defined in Distribution.Types.VersionRange

Methods

showsPrec :: Int -> VersionRangeF a -> ShowS #

show :: VersionRangeF a -> String #

showList :: [VersionRangeF a] -> ShowS #

Generic (VersionRangeF a) # 
Instance details

Defined in Distribution.Types.VersionRange

Associated Types

type Rep (VersionRangeF a) :: * -> * #

Methods

from :: VersionRangeF a -> Rep (VersionRangeF a) x #

to :: Rep (VersionRangeF a) x -> VersionRangeF a #

type Rep (VersionRangeF a) # 
Instance details

Defined in Distribution.Types.VersionRange

type Rep (VersionRangeF a) = D1 (MetaData "VersionRangeF" "Distribution.Types.VersionRange" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (((C1 (MetaCons "AnyVersionF" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ThisVersionF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version))) :+: (C1 (MetaCons "LaterVersionF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: (C1 (MetaCons "OrLaterVersionF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: C1 (MetaCons "EarlierVersionF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version))))) :+: ((C1 (MetaCons "OrEarlierVersionF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: (C1 (MetaCons "WildcardVersionF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)) :+: C1 (MetaCons "MajorBoundVersionF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)))) :+: (C1 (MetaCons "UnionVersionRangesF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)) :+: (C1 (MetaCons "IntersectVersionRangesF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)) :+: C1 (MetaCons "VersionRangeParensF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))))))

cataVersionRange :: (VersionRangeF a -> a) -> VersionRange -> a #

Fold VersionRange.

Since: 2.2

anaVersionRange :: (a -> VersionRangeF a) -> a -> VersionRange #

Unfold VersionRange.

Since: 2.2

hyloVersionRange :: (VersionRangeF VersionRange -> VersionRange) -> (VersionRange -> VersionRangeF VersionRange) -> VersionRange -> VersionRange #

Refold VersionRange

Since: 2.2

projectVersionRange :: VersionRange -> VersionRangeF VersionRange #

Since: 2.2

embedVersionRange :: VersionRangeF VersionRange -> VersionRange #

Since: 2.2

Utilities

wildcardUpperBound :: Version -> Version #

Since: 2.2

majorUpperBound :: Version -> Version #

Compute next greater major version to be used as upper bound

Example: 0.4.1 produces the version 0.5 which then can be used + to construct a range >= 0.4.1 && < 0.5

Since: 2.2

Modification

removeUpperBound :: VersionRange -> VersionRange #

Given a version range, remove the highest upper bound. Example: (>= 1 && < + 3) || (>= 4 && < 5) is converted to (>= 1 && || (= 4).

removeLowerBound :: VersionRange -> VersionRange #

Given a version range, remove the lowest lower bound. + Example: (>= 1 && || (= 4 && < 5) is converted to + (>= 0 && || (= 4 && < 5).

Version intervals view

asVersionIntervals :: VersionRange -> [VersionInterval] #

View a VersionRange as a union of intervals.

This provides a canonical view of the semantics of a VersionRange as + opposed to the syntax of the expression used to define it. For the syntactic + view use foldVersionRange.

Each interval is non-empty. The sequence is in increasing order and no + intervals overlap or touch. Therefore only the first and last can be + unbounded. The sequence can be empty if the range is empty + (e.g. a range expression like && 2).

Other checks are trivial to implement using this view. For example:

isNoVersion vr | [] <- asVersionIntervals vr = True
+               | otherwise                   = False
isSpecificVersion vr
+   | [(LowerBound v  InclusiveBound
+      ,UpperBound v' InclusiveBound)] <- asVersionIntervals vr
+   , v == v'   = Just v
+   | otherwise = Nothing

type VersionInterval = (LowerBound, UpperBound) #

data LowerBound #

Constructors

LowerBound Version !Bound 
Instances
Eq LowerBound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

(==) :: LowerBound -> LowerBound -> Bool #

(/=) :: LowerBound -> LowerBound -> Bool #

Ord LowerBound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

compare :: LowerBound -> LowerBound -> Ordering #

(<) :: LowerBound -> LowerBound -> Bool #

(<=) :: LowerBound -> LowerBound -> Bool #

(>) :: LowerBound -> LowerBound -> Bool #

(>=) :: LowerBound -> LowerBound -> Bool #

max :: LowerBound -> LowerBound -> LowerBound #

min :: LowerBound -> LowerBound -> LowerBound #

Show LowerBound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

showsPrec :: Int -> LowerBound -> ShowS #

show :: LowerBound -> String #

showList :: [LowerBound] -> ShowS #

data UpperBound #

Constructors

NoUpperBound 
UpperBound Version !Bound 
Instances
Eq UpperBound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

(==) :: UpperBound -> UpperBound -> Bool #

(/=) :: UpperBound -> UpperBound -> Bool #

Ord UpperBound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

compare :: UpperBound -> UpperBound -> Ordering #

(<) :: UpperBound -> UpperBound -> Bool #

(<=) :: UpperBound -> UpperBound -> Bool #

(>) :: UpperBound -> UpperBound -> Bool #

(>=) :: UpperBound -> UpperBound -> Bool #

max :: UpperBound -> UpperBound -> UpperBound #

min :: UpperBound -> UpperBound -> UpperBound #

Show UpperBound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

showsPrec :: Int -> UpperBound -> ShowS #

show :: UpperBound -> String #

showList :: [UpperBound] -> ShowS #

data Bound #

Constructors

ExclusiveBound 
InclusiveBound 
Instances
Eq Bound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

(==) :: Bound -> Bound -> Bool #

(/=) :: Bound -> Bound -> Bool #

Show Bound # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

showsPrec :: Int -> Bound -> ShowS #

show :: Bound -> String #

showList :: [Bound] -> ShowS #

VersionIntervals abstract type

The VersionIntervals type and the accompanying functions are exposed + primarily for completeness and testing purposes. In practice + asVersionIntervals is the main function to use to + view a VersionRange as a bunch of VersionIntervals.

data VersionIntervals #

A complementary representation of a VersionRange. Instead of a boolean + version predicate it uses an increasing sequence of non-overlapping, + non-empty intervals.

The key point is that this representation gives a canonical representation + for the semantics of VersionRanges. This makes it easier to check things + like whether a version range is empty, covers all versions, or requires a + certain minimum or maximum version. It also makes it easy to check equality + or containment. It also makes it easier to identify 'simple' version + predicates for translation into foreign packaging systems that do not + support complex version range expressions.

Instances
Eq VersionIntervals # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

(==) :: VersionIntervals -> VersionIntervals -> Bool #

(/=) :: VersionIntervals -> VersionIntervals -> Bool #

Show VersionIntervals # 
Instance details

Defined in Distribution.Types.VersionInterval

Methods

showsPrec :: Int -> VersionIntervals -> ShowS #

show :: VersionIntervals -> String #

showList :: [VersionIntervals] -> ShowS #

toVersionIntervals :: VersionRange -> VersionIntervals #

Convert a VersionRange to a sequence of version intervals.

fromVersionIntervals :: VersionIntervals -> VersionRange #

Convert a VersionIntervals value back into a VersionRange expression + representing the version intervals.

withinIntervals :: Version -> VersionIntervals -> Bool #

Test if a version falls within the version intervals.

It exists mostly for completeness and testing. It satisfies the following + properties:

withinIntervals v (toVersionIntervals vr) = withinRange v vr
+withinIntervals v ivs = withinRange v (fromVersionIntervals ivs)

versionIntervals :: VersionIntervals -> [VersionInterval] #

Inspect the list of version intervals.

mkVersionIntervals :: [VersionInterval] -> VersionIntervals #

Directly construct a VersionIntervals from a list of intervals.

In Cabal-2.2 the Maybe is dropped from the result type.

unionVersionIntervals :: VersionIntervals -> VersionIntervals -> VersionIntervals #

intersectVersionIntervals :: VersionIntervals -> VersionIntervals -> VersionIntervals #

invertVersionIntervals :: VersionIntervals -> VersionIntervals #

diff --git a/doc/API/Cabal/Language-Haskell-Extension.html b/doc/API/Cabal/Language-Haskell-Extension.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Language-Haskell-Extension.html @@ -0,0 +1,114 @@ +Language.Haskell.Extension

Cabal-2.4.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2004
LicenseBSD3
Maintainerlibraries@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Language.Haskell.Extension

Description

Haskell language dialects and extensions

Synopsis

Documentation

data Language #

This represents a Haskell language dialect.

Language Extensions are interpreted relative to one of these base + languages.

Constructors

Haskell98

The Haskell 98 language as defined by the Haskell 98 report. + http://haskell.org/onlinereport/

Haskell2010

The Haskell 2010 language as defined by the Haskell 2010 report. + http://www.haskell.org/onlinereport/haskell2010

UnknownLanguage String

An unknown language, identified by its name.

Instances
Eq Language # 
Instance details

Defined in Language.Haskell.Extension

Methods

(==) :: Language -> Language -> Bool #

(/=) :: Language -> Language -> Bool #

Data Language # 
Instance details

Defined in Language.Haskell.Extension

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Language -> c Language #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Language #

toConstr :: Language -> Constr #

dataTypeOf :: Language -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Language) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Language) #

gmapT :: (forall b. Data b => b -> b) -> Language -> Language #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Language -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Language -> r #

gmapQ :: (forall d. Data d => d -> u) -> Language -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Language -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Language -> m Language #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Language -> m Language #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Language -> m Language #

Read Language # 
Instance details

Defined in Language.Haskell.Extension

Methods

readsPrec :: Int -> ReadS Language #

readList :: ReadS [Language] #

readPrec :: ReadPrec Language #

readListPrec :: ReadPrec [Language] #

Show Language # 
Instance details

Defined in Language.Haskell.Extension

Methods

showsPrec :: Int -> Language -> ShowS #

show :: Language -> String #

showList :: [Language] -> ShowS #

Generic Language # 
Instance details

Defined in Language.Haskell.Extension

Associated Types

type Rep Language :: * -> * #

Methods

from :: Language -> Rep Language x #

to :: Rep Language x -> Language #

Binary Language # 
Instance details

Defined in Language.Haskell.Extension

Methods

put :: Language -> Put #

get :: Get Language #

putList :: [Language] -> Put #

NFData Language # 
Instance details

Defined in Language.Haskell.Extension

Methods

rnf :: Language -> () #

Pretty Language # 
Instance details

Defined in Language.Haskell.Extension

Methods

pretty :: Language -> Doc #

Parsec Language # 
Instance details

Defined in Language.Haskell.Extension

Methods

parsec :: CabalParsing m => m Language #

Text Language # 
Instance details

Defined in Language.Haskell.Extension

Methods

disp :: Language -> Doc #

parse :: ReadP r Language #

type Rep Language # 
Instance details

Defined in Language.Haskell.Extension

type Rep Language = D1 (MetaData "Language" "Language.Haskell.Extension" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "Haskell98" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Haskell2010" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "UnknownLanguage" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))

knownLanguages :: [Language] #

classifyLanguage :: String -> Language #

data Extension #

This represents language extensions beyond a base Language definition + (such as Haskell98) that are supported by some implementations, usually + in some special mode.

Where applicable, references are given to an implementation's + official documentation.

Constructors

EnableExtension KnownExtension

Enable a known extension

DisableExtension KnownExtension

Disable a known extension

UnknownExtension String

An unknown extension, identified by the name of its LANGUAGE + pragma.

Instances
Eq Extension # 
Instance details

Defined in Language.Haskell.Extension

Methods

(==) :: Extension -> Extension -> Bool #

(/=) :: Extension -> Extension -> Bool #

Data Extension # 
Instance details

Defined in Language.Haskell.Extension

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Extension -> c Extension #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Extension #

toConstr :: Extension -> Constr #

dataTypeOf :: Extension -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Extension) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Extension) #

gmapT :: (forall b. Data b => b -> b) -> Extension -> Extension #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Extension -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Extension -> r #

gmapQ :: (forall d. Data d => d -> u) -> Extension -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Extension -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Extension -> m Extension #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Extension -> m Extension #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Extension -> m Extension #

Ord Extension # 
Instance details

Defined in Language.Haskell.Extension

Methods

compare :: Extension -> Extension -> Ordering #

(<) :: Extension -> Extension -> Bool #

(<=) :: Extension -> Extension -> Bool #

(>) :: Extension -> Extension -> Bool #

(>=) :: Extension -> Extension -> Bool #

max :: Extension -> Extension -> Extension #

min :: Extension -> Extension -> Extension #

Read Extension # 
Instance details

Defined in Language.Haskell.Extension

Methods

readsPrec :: Int -> ReadS Extension #

readList :: ReadS [Extension] #

readPrec :: ReadPrec Extension #

readListPrec :: ReadPrec [Extension] #

Show Extension # 
Instance details

Defined in Language.Haskell.Extension

Methods

showsPrec :: Int -> Extension -> ShowS #

show :: Extension -> String #

showList :: [Extension] -> ShowS #

Generic Extension # 
Instance details

Defined in Language.Haskell.Extension

Associated Types

type Rep Extension :: * -> * #

Methods

from :: Extension -> Rep Extension x #

to :: Rep Extension x -> Extension #

Binary Extension # 
Instance details

Defined in Language.Haskell.Extension

Methods

put :: Extension -> Put #

get :: Get Extension #

putList :: [Extension] -> Put #

NFData Extension # 
Instance details

Defined in Language.Haskell.Extension

Methods

rnf :: Extension -> () #

Pretty Extension # 
Instance details

Defined in Language.Haskell.Extension

Methods

pretty :: Extension -> Doc #

Parsec Extension # 
Instance details

Defined in Language.Haskell.Extension

Methods

parsec :: CabalParsing m => m Extension #

Text Extension # 
Instance details

Defined in Language.Haskell.Extension

Methods

disp :: Extension -> Doc #

parse :: ReadP r Extension #

type Rep Extension # 
Instance details

Defined in Language.Haskell.Extension

type Rep Extension = D1 (MetaData "Extension" "Language.Haskell.Extension" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) (C1 (MetaCons "EnableExtension" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 KnownExtension)) :+: (C1 (MetaCons "DisableExtension" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 KnownExtension)) :+: C1 (MetaCons "UnknownExtension" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))

data KnownExtension #

Constructors

OverlappingInstances

Allow overlapping class instances, provided there is a unique + most specific instance for each use.

UndecidableInstances

Ignore structural rules guaranteeing the termination of class + instance resolution. Termination is guaranteed by a fixed-depth + recursion stack, and compilation may fail if this depth is + exceeded.

IncoherentInstances

Implies OverlappingInstances. Allow the implementation to + choose an instance even when it is possible that further + instantiation of types will lead to a more specific instance + being applicable.

DoRec

(deprecated) Deprecated in favour of RecursiveDo.

Old description: Allow recursive bindings in do blocks, using + the rec keyword. See also RecursiveDo.

RecursiveDo

Allow recursive bindings in do blocks, using the rec + keyword, or mdo, a variant of do.

ParallelListComp

Provide syntax for writing list comprehensions which iterate + over several lists together, like the zipWith family of + functions.

MultiParamTypeClasses

Allow multiple parameters in a type class.

MonomorphismRestriction

Enable the dreaded monomorphism restriction.

FunctionalDependencies

Allow a specification attached to a multi-parameter type class + which indicates that some parameters are entirely determined by + others. The implementation will check that this property holds + for the declared instances, and will use this property to reduce + ambiguity in instance resolution.

Rank2Types

(deprecated) A synonym for RankNTypes.

Old description: Like RankNTypes but does not allow a + higher-rank type to itself appear on the left of a function + arrow.

RankNTypes

Allow a universally-quantified type to occur on the left of a + function arrow.

PolymorphicComponents

(deprecated) A synonym for RankNTypes.

Old description: Allow data constructors to have polymorphic + arguments. Unlike RankNTypes, does not allow this for ordinary + functions.

ExistentialQuantification

Allow existentially-quantified data constructors.

ScopedTypeVariables

Cause a type variable in a signature, which has an explicit + forall quantifier, to scope over the definition of the + accompanying value declaration.

PatternSignatures

Deprecated, use ScopedTypeVariables instead.

ImplicitParams

Enable implicit function parameters with dynamic scope.

FlexibleContexts

Relax some restrictions on the form of the context of a type + signature.

FlexibleInstances

Relax some restrictions on the form of the context of an + instance declaration.

EmptyDataDecls

Allow data type declarations with no constructors.

CPP

Run the C preprocessor on Haskell source code.

KindSignatures

Allow an explicit kind signature giving the kind of types over + which a type variable ranges.

BangPatterns

Enable a form of pattern which forces evaluation before an + attempted match, and a form of strict let/where binding.

TypeSynonymInstances

Allow type synonyms in instance heads.

TemplateHaskell

Enable Template Haskell, a system for compile-time + metaprogramming.

ForeignFunctionInterface

Enable the Foreign Function Interface. In GHC, implements the + standard Haskell 98 Foreign Function Interface Addendum, plus + some GHC-specific extensions.

Arrows

Enable arrow notation.

Generics

(deprecated) Enable generic type classes, with default instances defined in + terms of the algebraic structure of a type.

ImplicitPrelude

Enable the implicit importing of the module Prelude. When + disabled, when desugaring certain built-in syntax into ordinary + identifiers, use whatever is in scope rather than the Prelude + -- version.

NamedFieldPuns

Enable syntax for implicitly binding local names corresponding + to the field names of a record. Puns bind specific names, unlike + RecordWildCards.

PatternGuards

Enable a form of guard which matches a pattern and binds + variables.

GeneralizedNewtypeDeriving

Allow a type declared with newtype to use deriving for any + class with an instance for the underlying type.

ExtensibleRecords

Enable the "Trex" extensible records system.

RestrictedTypeSynonyms

Enable type synonyms which are transparent in some definitions + and opaque elsewhere, as a way of implementing abstract + datatypes.

HereDocuments

Enable an alternate syntax for string literals, + with string templating.

MagicHash

Allow the character # as a postfix modifier on identifiers. + Also enables literal syntax for unboxed values.

TypeFamilies

Allow data types and type synonyms which are indexed by types, + i.e. ad-hoc polymorphism for types.

StandaloneDeriving

Allow a standalone declaration which invokes the type class + deriving mechanism.

UnicodeSyntax

Allow certain Unicode characters to stand for certain ASCII + character sequences, e.g. keywords and punctuation.

UnliftedFFITypes

Allow the use of unboxed types as foreign types, e.g. in + foreign import and foreign export.

InterruptibleFFI

Enable interruptible FFI.

CApiFFI

Allow use of CAPI FFI calling convention (foreign import capi).

LiberalTypeSynonyms

Defer validity checking of types until after expanding type + synonyms, relaxing the constraints on how synonyms may be used.

TypeOperators

Allow the name of a type constructor, type class, or type + variable to be an infix operator. + * https://www.haskell.org/ghc/docs/latest/html/users_guide/glasgow_exts.html#ghc-flag--XTypeOperators

RecordWildCards

Enable syntax for implicitly binding local names corresponding + to the field names of a record. A wildcard binds all unmentioned + names, unlike NamedFieldPuns.

RecordPuns

Deprecated, use NamedFieldPuns instead.

DisambiguateRecordFields

Allow a record field name to be disambiguated by the type of + the record it's in.

TraditionalRecordSyntax

Enable traditional record syntax (as supported by Haskell 98)

OverloadedStrings

Enable overloading of string literals using a type class, much + like integer literals.

GADTs

Enable generalized algebraic data types, in which type + variables may be instantiated on a per-constructor basis. Implies + GADTSyntax.

GADTSyntax

Enable GADT syntax for declaring ordinary algebraic datatypes.

MonoPatBinds

(deprecated) Has no effect.

Old description: Make pattern bindings monomorphic.

RelaxedPolyRec

Relax the requirements on mutually-recursive polymorphic + functions.

ExtendedDefaultRules

Allow default instantiation of polymorphic types in more + situations.

UnboxedTuples

Enable unboxed tuples.

DeriveDataTypeable

Enable deriving for classes Typeable and + Data.

DeriveGeneric

Enable deriving for Generic and Generic1.

DefaultSignatures

Enable support for default signatures.

InstanceSigs

Allow type signatures to be specified in instance declarations.

ConstrainedClassMethods

Allow a class method's type to place additional constraints on + a class type variable.

PackageImports

Allow imports to be qualified by the package name the module is + intended to be imported from, e.g.

import "network" Network.Socket
ImpredicativeTypes

(deprecated) Allow a type variable to be instantiated at a + polymorphic type.

NewQualifiedOperators

(deprecated) Change the syntax for qualified infix operators.

PostfixOperators

Relax the interpretation of left operator sections to allow + unary postfix operators.

QuasiQuotes

Enable quasi-quotation, a mechanism for defining new concrete + syntax for expressions and patterns.

TransformListComp

Enable generalized list comprehensions, supporting operations + such as sorting and grouping.

MonadComprehensions

Enable monad comprehensions, which generalise the list + comprehension syntax to work for any monad.

ViewPatterns

Enable view patterns, which match a value by applying a + function and matching on the result.

XmlSyntax

Allow concrete XML syntax to be used in expressions and patterns, + as per the Haskell Server Pages extension language: + http://www.haskell.org/haskellwiki/HSP. The ideas behind it are + discussed in the paper "Haskell Server Pages through Dynamic Loading" + by Niklas Broberg, from Haskell Workshop '05.

RegularPatterns

Allow regular pattern matching over lists, as discussed in the + paper "Regular Expression Patterns" by Niklas Broberg, Andreas Farre + and Josef Svenningsson, from ICFP '04.

TupleSections

Enable the use of tuple sections, e.g. (, True) desugars into + x -> (x, True).

GHCForeignImportPrim

Allow GHC primops, written in C--, to be imported into a Haskell + file.

NPlusKPatterns

Support for patterns of the form n + k, where k is an + integer literal.

DoAndIfThenElse

Improve the layout rule when if expressions are used in a do + block.

MultiWayIf

Enable support for multi-way if-expressions.

LambdaCase

Enable support lambda-case expressions.

RebindableSyntax

Makes much of the Haskell sugar be desugared into calls to the + function with a particular name that is in scope.

ExplicitForAll

Make forall a keyword in types, which can be used to give the + generalisation explicitly.

DatatypeContexts

Allow contexts to be put on datatypes, e.g. the Eq a in + data Eq a => Set a = NilSet | ConsSet a (Set a).

MonoLocalBinds

Local (let and where) bindings are monomorphic.

DeriveFunctor

Enable deriving for the Functor class.

DeriveTraversable

Enable deriving for the Traversable class.

DeriveFoldable

Enable deriving for the Foldable class.

NondecreasingIndentation

Enable non-decreasing indentation for do blocks.

SafeImports

Allow imports to be qualified with a safe keyword that requires + the imported module be trusted as according to the Safe Haskell + definition of trust.

import safe Network.Socket
Safe

Compile a module in the Safe, Safe Haskell mode -- a restricted + form of the Haskell language to ensure type safety.

Trustworthy

Compile a module in the Trustworthy, Safe Haskell mode -- no + restrictions apply but the module is marked as trusted as long as + the package the module resides in is trusted.

Unsafe

Compile a module in the Unsafe, Safe Haskell mode so that + modules compiled using Safe, Safe Haskell mode can't import it.

ConstraintKinds

Allow type classimplicit parameterequality constraints to be + used as types with the special kind constraint. Also generalise + the (ctxt => ty) syntax so that any type of kind constraint can + occur before the arrow.

PolyKinds

Enable kind polymorphism.

DataKinds

Enable datatype promotion.

ParallelArrays

Enable parallel arrays syntax ([:, :]) for Data Parallel Haskell.

RoleAnnotations

Enable explicit role annotations, like in (type role Foo representational representational).

OverloadedLists

Enable overloading of list literals, arithmetic sequences and + list patterns using the IsList type class.

EmptyCase

Enable case expressions that have no alternatives. Also applies to lambda-case expressions if they are enabled.

AutoDeriveTypeable

(deprecated) Deprecated in favour of DeriveDataTypeable.

Old description: Triggers the generation of derived Typeable + instances for every datatype and type class declaration.

NegativeLiterals

Desugars negative literals directly (without using negate).

BinaryLiterals

Allow the use of binary integer literal syntax (e.g. 0b11001001 to denote 201).

NumDecimals

Allow the use of floating literal syntax for all instances of Num, including Int and Integer.

NullaryTypeClasses

Enable support for type classes with no type parameter.

ExplicitNamespaces

Enable explicit namespaces in module import/export lists.

AllowAmbiguousTypes

Allow the user to write ambiguous types, and the type inference engine to infer them.

JavaScriptFFI

Enable foreign import javascript.

PatternSynonyms

Allow giving names to and abstracting over patterns.

PartialTypeSignatures

Allow anonymous placeholders (underscore) inside type signatures. The + type inference engine will generate a message describing the type inferred + at the hole's location.

NamedWildCards

Allow named placeholders written with a leading underscore inside type + signatures. Wildcards with the same name unify to the same type.

DeriveAnyClass

Enable deriving for any class.

DeriveLift

Enable deriving for the Lift class.

StaticPointers

Enable support for 'static pointers' (and the static + keyword) to refer to globally stable names, even across + different programs.

StrictData

Switches data type declarations to be strict by default (as if + they had a bang using BangPatterns), and allow opt-in field + laziness using ~.

Strict

Switches all pattern bindings to be strict by default (as if + they had a bang using BangPatterns), ordinary patterns are + recovered using ~. Implies StrictData.

ApplicativeDo

Allows do-notation for types that are Applicative as well + as Monad. When enabled, desugaring do notation tries to use + (*) and fmap and join as far as possible.

DuplicateRecordFields

Allow records to use duplicated field labels for accessors.

TypeApplications

Enable explicit type applications with the syntax id @Int.

TypeInType

Dissolve the distinction between types and kinds, allowing the compiler + to reason about kind equality and therefore enabling GADTs to be promoted + to the type-level.

UndecidableSuperClasses

Allow recursive (and therefore undecideable) super-class relationships.

MonadFailDesugaring

A temporary extension to help library authors check if their + code will compile with the new planned desugaring of fail.

TemplateHaskellQuotes

A subset of TemplateHaskell including only quoting.

OverloadedLabels

Allows use of the #label syntax.

TypeFamilyDependencies

Allow functional dependency annotations on type families to declare them + as injective.

DerivingStrategies

Allow multiple deriving clauses, each optionally qualified with a + strategy.

UnboxedSums

Enable the use of unboxed sum syntax.

HexFloatLiterals

Allow use of hexadecimal literal notation for floating-point values.

BlockArguments

Allow do blocks etc. in argument position.

NumericUnderscores

Allow use of underscores in numeric literals.

QuantifiedConstraints

Allow forall in constraints.

StarIsType

Have * refer to Type.

Instances
Bounded KnownExtension # 
Instance details

Defined in Language.Haskell.Extension

Methods

minBound :: KnownExtension #

maxBound :: KnownExtension #

Enum KnownExtension # 
Instance details

Defined in Language.Haskell.Extension

Methods

succ :: KnownExtension -> KnownExtension #

pred :: KnownExtension -> KnownExtension #

toEnum :: Int -> KnownExtension #

fromEnum :: KnownExtension -> Int #

enumFrom :: KnownExtension -> [KnownExtension] #

enumFromThen :: KnownExtension -> KnownExtension -> [KnownExtension] #

enumFromTo :: KnownExtension -> KnownExtension -> [KnownExtension] #

enumFromThenTo :: KnownExtension -> KnownExtension -> KnownExtension -> [KnownExtension] #

Eq KnownExtension # 
Instance details

Defined in Language.Haskell.Extension

Methods

(==) :: KnownExtension -> KnownExtension -> Bool #

(/=) :: KnownExtension -> KnownExtension -> Bool #

Data KnownExtension # 
Instance details

Defined in Language.Haskell.Extension

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> KnownExtension -> c KnownExtension #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c KnownExtension #

toConstr :: KnownExtension -> Constr #

dataTypeOf :: KnownExtension -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c KnownExtension) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c KnownExtension) #

gmapT :: (forall b. Data b => b -> b) -> KnownExtension -> KnownExtension #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> KnownExtension -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> KnownExtension -> r #

gmapQ :: (forall d. Data d => d -> u) -> KnownExtension -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> KnownExtension -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> KnownExtension -> m KnownExtension #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> KnownExtension -> m KnownExtension #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> KnownExtension -> m KnownExtension #

Ord KnownExtension # 
Instance details

Defined in Language.Haskell.Extension

Methods

compare :: KnownExtension -> KnownExtension -> Ordering #

(<) :: KnownExtension -> KnownExtension -> Bool #

(<=) :: KnownExtension -> KnownExtension -> Bool #

(>) :: KnownExtension -> KnownExtension -> Bool #

(>=) :: KnownExtension -> KnownExtension -> Bool #

max :: KnownExtension -> KnownExtension -> KnownExtension #

min :: KnownExtension -> KnownExtension -> KnownExtension #

Read KnownExtension # 
Instance details

Defined in Language.Haskell.Extension

Methods

readsPrec :: Int -> ReadS KnownExtension #

readList :: ReadS [KnownExtension] #

readPrec :: ReadPrec KnownExtension #

readListPrec :: ReadPrec [KnownExtension] #

Show KnownExtension # 
Instance details

Defined in Language.Haskell.Extension

Methods

showsPrec :: Int -> KnownExtension -> ShowS #

show :: KnownExtension -> String #

showList :: [KnownExtension] -> ShowS #

Generic KnownExtension # 
Instance details

Defined in Language.Haskell.Extension

Associated Types

type Rep KnownExtension :: * -> * #

Methods

from :: KnownExtension -> Rep KnownExtension x #

to :: Rep KnownExtension x -> KnownExtension #

Binary KnownExtension # 
Instance details

Defined in Language.Haskell.Extension

Methods

put :: KnownExtension -> Put #

get :: Get KnownExtension #

putList :: [KnownExtension] -> Put #

NFData KnownExtension # 
Instance details

Defined in Language.Haskell.Extension

Methods

rnf :: KnownExtension -> () #

Pretty KnownExtension # 
Instance details

Defined in Language.Haskell.Extension

Methods

pretty :: KnownExtension -> Doc #

Text KnownExtension # 
Instance details

Defined in Language.Haskell.Extension

Methods

disp :: KnownExtension -> Doc #

parse :: ReadP r KnownExtension #

type Rep KnownExtension # 
Instance details

Defined in Language.Haskell.Extension

type Rep KnownExtension = D1 (MetaData "KnownExtension" "Language.Haskell.Extension" "Cabal-2.4.0.1-4dDrY0nmi936kgccwkOPil" False) ((((((C1 (MetaCons "OverlappingInstances" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "UndecidableInstances" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "IncoherentInstances" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "DoRec" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "RecursiveDo" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "ParallelListComp" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MultiParamTypeClasses" PrefixI False) (U1 :: * -> *)))) :+: (((C1 (MetaCons "MonomorphismRestriction" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "FunctionalDependencies" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Rank2Types" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "RankNTypes" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "PolymorphicComponents" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ExistentialQuantification" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "ScopedTypeVariables" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PatternSignatures" PrefixI False) (U1 :: * -> *))))) :+: ((((C1 (MetaCons "ImplicitParams" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "FlexibleContexts" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "FlexibleInstances" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "EmptyDataDecls" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "CPP" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "KindSignatures" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "BangPatterns" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "TypeSynonymInstances" PrefixI False) (U1 :: * -> *)))) :+: (((C1 (MetaCons "TemplateHaskell" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ForeignFunctionInterface" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Arrows" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Generics" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "ImplicitPrelude" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NamedFieldPuns" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "PatternGuards" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "GeneralizedNewtypeDeriving" PrefixI False) (U1 :: * -> *)))))) :+: (((((C1 (MetaCons "ExtensibleRecords" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "RestrictedTypeSynonyms" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "HereDocuments" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MagicHash" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "TypeFamilies" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "StandaloneDeriving" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "UnicodeSyntax" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "UnliftedFFITypes" PrefixI False) (U1 :: * -> *)))) :+: (((C1 (MetaCons "InterruptibleFFI" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CApiFFI" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "LiberalTypeSynonyms" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "TypeOperators" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "RecordWildCards" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "RecordPuns" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "DisambiguateRecordFields" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "TraditionalRecordSyntax" PrefixI False) (U1 :: * -> *))))) :+: ((((C1 (MetaCons "OverloadedStrings" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "GADTs" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "GADTSyntax" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MonoPatBinds" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "RelaxedPolyRec" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ExtendedDefaultRules" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "UnboxedTuples" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DeriveDataTypeable" PrefixI False) (U1 :: * -> *)))) :+: (((C1 (MetaCons "DeriveGeneric" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DefaultSignatures" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "InstanceSigs" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ConstrainedClassMethods" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "PackageImports" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ImpredicativeTypes" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "NewQualifiedOperators" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PostfixOperators" PrefixI False) (U1 :: * -> *))))))) :+: (((((C1 (MetaCons "QuasiQuotes" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "TransformListComp" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MonadComprehensions" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "ViewPatterns" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "XmlSyntax" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "RegularPatterns" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "TupleSections" PrefixI False) (U1 :: * -> *)))) :+: (((C1 (MetaCons "GHCForeignImportPrim" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NPlusKPatterns" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "DoAndIfThenElse" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MultiWayIf" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "LambdaCase" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "RebindableSyntax" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "ExplicitForAll" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DatatypeContexts" PrefixI False) (U1 :: * -> *))))) :+: ((((C1 (MetaCons "MonoLocalBinds" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DeriveFunctor" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "DeriveTraversable" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DeriveFoldable" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "NondecreasingIndentation" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SafeImports" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Safe" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Trustworthy" PrefixI False) (U1 :: * -> *)))) :+: (((C1 (MetaCons "Unsafe" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ConstraintKinds" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "PolyKinds" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DataKinds" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "ParallelArrays" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "RoleAnnotations" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "OverloadedLists" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "EmptyCase" PrefixI False) (U1 :: * -> *)))))) :+: (((((C1 (MetaCons "AutoDeriveTypeable" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NegativeLiterals" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "BinaryLiterals" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NumDecimals" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "NullaryTypeClasses" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ExplicitNamespaces" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "AllowAmbiguousTypes" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "JavaScriptFFI" PrefixI False) (U1 :: * -> *)))) :+: (((C1 (MetaCons "PatternSynonyms" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PartialTypeSignatures" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "NamedWildCards" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DeriveAnyClass" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "DeriveLift" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "StaticPointers" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "StrictData" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Strict" PrefixI False) (U1 :: * -> *))))) :+: ((((C1 (MetaCons "ApplicativeDo" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DuplicateRecordFields" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "TypeApplications" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "TypeInType" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "UndecidableSuperClasses" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "MonadFailDesugaring" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "TemplateHaskellQuotes" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "OverloadedLabels" PrefixI False) (U1 :: * -> *)))) :+: (((C1 (MetaCons "TypeFamilyDependencies" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DerivingStrategies" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "UnboxedSums" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "HexFloatLiterals" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "BlockArguments" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NumericUnderscores" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "QuantifiedConstraints" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "StarIsType" PrefixI False) (U1 :: * -> *))))))))

knownExtensions :: [KnownExtension] #

Deprecated: KnownExtension is an instance of Enum and Bounded, use those instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

deprecatedExtensions :: [(Extension, Maybe Extension)] #

Extensions that have been deprecated, possibly paired with another + extension that replaces it.

classifyExtension :: String -> Extension #

diff --git a/doc/API/Cabal/doc-index-124.html b/doc/API/Cabal/doc-index-124.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-124.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - |)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - |

||Distribution.Compat.Prelude.Internal
diff --git a/doc/API/Cabal/doc-index-33.html b/doc/API/Cabal/doc-index-33.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-33.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - !)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - !

!!Distribution.Compat.Prelude.Internal
diff --git a/doc/API/Cabal/doc-index-35.html b/doc/API/Cabal/doc-index-35.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-35.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - #)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - #

#%~Distribution.Compat.Lens
#~Distribution.Compat.Lens
diff --git a/doc/API/Cabal/doc-index-36.html b/doc/API/Cabal/doc-index-36.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-36.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - $)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - $

$Distribution.Compat.Prelude.Internal
$!Distribution.Compat.Prelude.Internal
diff --git a/doc/API/Cabal/doc-index-37.html b/doc/API/Cabal/doc-index-37.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-37.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - %)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - %

%=Distribution.Compat.Lens
%~Distribution.Compat.Lens
diff --git a/doc/API/Cabal/doc-index-38.html b/doc/API/Cabal/doc-index-38.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-38.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - &)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - &

&Distribution.Compat.Lens
&&Distribution.Compat.Prelude.Internal
diff --git a/doc/API/Cabal/doc-index-42.html b/doc/API/Cabal/doc-index-42.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-42.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - *)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - *

*Distribution.Compat.Prelude.Internal
**Distribution.Compat.Prelude.Internal
*>Distribution.Compat.Prelude.Internal
diff --git a/doc/API/Cabal/doc-index-43.html b/doc/API/Cabal/doc-index-43.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-43.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - +)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - +

+Distribution.Compat.Prelude.Internal
++Distribution.Compat.Prelude.Internal
+++Distribution.Compat.ReadP
diff --git a/doc/API/Cabal/doc-index-45.html b/doc/API/Cabal/doc-index-45.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-45.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - -)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - -

-Distribution.Compat.Prelude.Internal
diff --git a/doc/API/Cabal/doc-index-46.html b/doc/API/Cabal/doc-index-46.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-46.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - .)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - .

.Distribution.Compat.Prelude.Internal
.=Distribution.Compat.Lens
.~Distribution.Compat.Lens
diff --git a/doc/API/Cabal/doc-index-47.html b/doc/API/Cabal/doc-index-47.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-47.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - /)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - /

/Distribution.Compat.Prelude.Internal
/=Distribution.Compat.Prelude.Internal
diff --git a/doc/API/Cabal/doc-index-60.html b/doc/API/Cabal/doc-index-60.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-60.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - <)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - <

<Distribution.Compat.Prelude.Internal
<$Distribution.Compat.Prelude.Internal
<$>Distribution.Compat.Prelude.Internal
<*Distribution.Compat.Prelude.Internal
<*>Distribution.Compat.Prelude.Internal
<++Distribution.Compat.ReadP
<<>>Distribution.Compat.Prelude.Internal
<=Distribution.Compat.Prelude.Internal
<>Distribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
<?>Distribution.Compat.Parsing, Distribution.Compat.CharParsing
<|>Distribution.Compat.Prelude.Internal
diff --git a/doc/API/Cabal/doc-index-61.html b/doc/API/Cabal/doc-index-61.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-61.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - =)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - =

=<<Distribution.Compat.Prelude.Internal
==Distribution.Compat.Prelude.Internal
diff --git a/doc/API/Cabal/doc-index-62.html b/doc/API/Cabal/doc-index-62.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-62.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - >)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - >

>Distribution.Compat.Prelude.Internal
>=Distribution.Compat.Prelude.Internal
>>Distribution.Compat.Prelude.Internal
>>=Distribution.Compat.Prelude.Internal
diff --git a/doc/API/Cabal/doc-index-63.html b/doc/API/Cabal/doc-index-63.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-63.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - ?)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - ?

?=Distribution.Compat.Lens
?~Distribution.Compat.Lens
diff --git a/doc/API/Cabal/doc-index-94.html b/doc/API/Cabal/doc-index-94.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-94.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - ^)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - ^

^Distribution.Compat.Prelude.Internal
^#Distribution.Compat.Lens
^.Distribution.Compat.Lens
^^Distribution.Compat.Prelude.Internal
^^^Distribution.FieldGrammar
diff --git a/doc/API/Cabal/doc-index-95.html b/doc/API/Cabal/doc-index-95.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-95.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - _)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - _

_1Distribution.Compat.Lens
_2Distribution.Compat.Lens
_ArchDistribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
_benchmarkStanzaBenchmarkModuleDistribution.PackageDescription.FieldGrammar
_benchmarkStanzaBenchmarkTypeDistribution.PackageDescription.FieldGrammar
_benchmarkStanzaBuildInfoDistribution.PackageDescription.FieldGrammar
_benchmarkStanzaMainIsDistribution.PackageDescription.FieldGrammar
_FlagDistribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
_ImplDistribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
_OSDistribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
_testStanzaBuildInfoDistribution.PackageDescription.FieldGrammar
_testStanzaMainIsDistribution.PackageDescription.FieldGrammar
_testStanzaTestModuleDistribution.PackageDescription.FieldGrammar
_testStanzaTestTypeDistribution.PackageDescription.FieldGrammar
diff --git a/doc/API/Cabal/doc-index-A.html b/doc/API/Cabal/doc-index-A.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-A.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - A)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - A

AALDistribution.SPDX.LicenseId, Distribution.SPDX
AArch64Distribution.System
AbiDependency 
1 (Type/Class)Distribution.Types.AbiDependency, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Data Constructor)Distribution.Types.AbiDependency, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
abiDepends 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
AbiHashDistribution.Types.AbiHash, Distribution.Package, Distribution.Make, Distribution.Simple
abiHash 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
3 (Function)Distribution.Simple.Register
AbiTag 
1 (Type/Class)Distribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
2 (Data Constructor)Distribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
abiTagStringDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
AbiTagVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
abiTemplateEnvDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
AbiVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
absDistribution.Compat.Prelude.Internal
absoluteComponentInstallDirsDistribution.Simple.LocalBuildInfo
absoluteInstallDirs 
1 (Function)Distribution.Simple.InstallDirs
2 (Function)Distribution.Simple.LocalBuildInfo
absoluteInstalledPackageInfoDistribution.Simple.Register
absolutePackageDBPathDistribution.Simple.Compiler, Distribution.Simple
absolutePackageDBPathsDistribution.Simple.Compiler, Distribution.Simple
abstractUnitIdDistribution.Backpack
AbstylesDistribution.SPDX.LicenseId, Distribution.SPDX
acosDistribution.Compat.Prelude.Internal
acoshDistribution.Compat.Prelude.Internal
AcyclicSCCDistribution.Compat.Graph
addBuildableConditionDistribution.PackageDescription.Configuration
addKnownProgramDistribution.Simple.Program.Db, Distribution.Simple.Program
addKnownProgramsDistribution.Simple.Program.Db, Distribution.Simple.Program
addLibraryPathDistribution.Simple.Utils
addProgressCtxDistribution.Utils.LogProgress
addWarningDistribution.Parsec.LexerMonad
adjustPosDistribution.Parsec.LexerMonad
Adobe_2006Distribution.SPDX.LicenseId, Distribution.SPDX
Adobe_GlyphDistribution.SPDX.LicenseId, Distribution.SPDX
ADSLDistribution.SPDX.LicenseId, Distribution.SPDX
AFL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
AFL_1_2Distribution.SPDX.LicenseId, Distribution.SPDX
AFL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
AFL_2_1Distribution.SPDX.LicenseId, Distribution.SPDX
AFL_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
AfmparseDistribution.SPDX.LicenseId, Distribution.SPDX
AGetterDistribution.Compat.Lens
AGPLDistribution.License, Distribution.Make, Distribution.Simple
AGPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
AGPL_1_0_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
AGPL_1_0_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
AGPL_3_0_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
AGPL_3_0_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
AIXDistribution.System
alaDistribution.Compat.Newtype
AladdinDistribution.SPDX.LicenseId, Distribution.SPDX
alafDistribution.Compat.Newtype
alaListDistribution.Parsec.Newtypes
alaList'Distribution.Parsec.Newtypes
ALensDistribution.Compat.Lens
ALens'Distribution.Compat.Lens
alexProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
All 
1 (Data Constructor)Distribution.Compat.Semigroup
2 (Type/Class)Distribution.Compat.Semigroup
allDistribution.Compat.Prelude.Internal
allBuildDependsDistribution.Types.PackageDescription, Distribution.PackageDescription
allBuildInfoDistribution.Types.PackageDescription, Distribution.PackageDescription
allComponentsInBuildOrderDistribution.Simple.LocalBuildInfo
allCondTreesDistribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
allExtensionsDistribution.Types.BuildInfo, Distribution.PackageDescription
allFlagsDistribution.Simple.Flag
allLanguagesDistribution.Types.BuildInfo, Distribution.PackageDescription
allLibModulesDistribution.Simple.LocalBuildInfo
allLibrariesDistribution.Types.PackageDescription, Distribution.PackageDescription
AllowAmbiguousTypesLanguage.Haskell.Extension, Distribution.Simple
allPackagesDistribution.Simple.PackageIndex
allPackagesByNameDistribution.Simple.PackageIndex
allPackagesBySourcePackageIdDistribution.Simple.PackageIndex
allPackagesBySourcePackageIdAndLibNameDistribution.Simple.PackageIndex
AllRightsReservedDistribution.License, Distribution.Make, Distribution.Simple
allTargetsInBuildOrderDistribution.Types.LocalBuildInfo
allTargetsInBuildOrder'Distribution.Types.LocalBuildInfo
AlphaDistribution.System
alphaNumDistribution.Compat.CharParsing
AlternativeDistribution.Compat.Prelude.Internal
alterVersionDistribution.Types.Version, Distribution.Version, Distribution.Simple
AlwaysDistribution.Simple.Setup
alwaysNondecIndentDistribution.Simple.GHC
AmbiguousDistribution.Simple.PackageIndex
AmbiguousParseDistribution.InstalledPackageInfo
AMDPLPADistribution.SPDX.LicenseId, Distribution.SPDX
AMLDistribution.SPDX.LicenseId, Distribution.SPDX
AMPASDistribution.SPDX.LicenseId, Distribution.SPDX
anaVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
andDistribution.Compat.Prelude.Internal
AndroidDistribution.System
annotateCallStackIODistribution.Compat.Stack
AnnotatedId 
1 (Type/Class)Distribution.Types.AnnotatedId
2 (Data Constructor)Distribution.Types.AnnotatedId
annotateIODistribution.Simple.Utils
ann_cnameDistribution.Types.AnnotatedId
ann_idDistribution.Types.AnnotatedId
ann_pidDistribution.Types.AnnotatedId
ANTLR_PDDistribution.SPDX.LicenseId, Distribution.SPDX
Any 
1 (Data Constructor)Distribution.Compat.Semigroup
2 (Type/Class)Distribution.Compat.Semigroup
anyDistribution.Compat.Prelude.Internal
anyCharDistribution.Compat.CharParsing
AnyVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
anyVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
AnyVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
apDistribution.Compat.Prelude.Internal
ApacheDistribution.License, Distribution.Make, Distribution.Simple
Apache_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
Apache_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
Apache_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
APAFMLDistribution.SPDX.LicenseId, Distribution.SPDX
APL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
appendFileDistribution.Compat.Prelude.Internal
ApplicativeDistribution.Compat.Prelude.Internal
ApplicativeDoLanguage.Haskell.Extension, Distribution.Simple
APSL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
APSL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
APSL_1_2Distribution.SPDX.LicenseId, Distribution.SPDX
APSL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
Arch 
1 (Type/Class)Distribution.System
2 (Data Constructor)Distribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
ArchVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
ArgPlaceHolderDistribution.Simple.Command
ArgsDistribution.Simple.UserHooks, Distribution.Simple
ArmDistribution.System
arProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
arResponseFilesSupportedDistribution.Simple.Compiler, Distribution.Simple
ArrowsLanguage.Haskell.Extension, Distribution.Simple
Artistic_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
Artistic_1_0_cl8Distribution.SPDX.LicenseId, Distribution.SPDX
Artistic_1_0_PerlDistribution.SPDX.LicenseId, Distribution.SPDX
Artistic_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
asBoolDistribution.Simple.Flag, Distribution.Simple.Setup
ASetterDistribution.Compat.Lens
asinDistribution.Compat.Prelude.Internal
asinhDistribution.Compat.Prelude.Internal
askCabalSpecVersionDistribution.Parsec.Class
asmOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
asmSources 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
asTypeOfDistribution.Compat.Prelude.Internal
asVersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
atanDistribution.Compat.Prelude.Internal
atan2Distribution.Compat.Prelude.Internal
atanhDistribution.Compat.Prelude.Internal
author 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
autoconfUserHooksDistribution.Simple
Autoconf_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
Autoconf_exception_3_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
AutoDeriveTypeableLanguage.Haskell.Extension, Distribution.Simple
autogenComponentModulesDirDistribution.Simple.BuildPaths
autogenModuleNameDistribution.Simple.BuildPaths
autogenModules 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
autogenModulesDirDistribution.Simple.BuildPaths
autogenPackageModulesDirDistribution.Simple.BuildPaths
autogenPathsModuleNameDistribution.Simple.BuildPaths
availableSinceDistribution.FieldGrammar.Class, Distribution.FieldGrammar
aviewDistribution.Compat.Lens
diff --git a/doc/API/Cabal/doc-index-All.html b/doc/API/Cabal/doc-index-All.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-All.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index

!!Distribution.Compat.Prelude.Internal
#%~Distribution.Compat.Lens
#~Distribution.Compat.Lens
$Distribution.Compat.Prelude.Internal
$!Distribution.Compat.Prelude.Internal
%=Distribution.Compat.Lens
%~Distribution.Compat.Lens
&Distribution.Compat.Lens
&&Distribution.Compat.Prelude.Internal
*Distribution.Compat.Prelude.Internal
**Distribution.Compat.Prelude.Internal
*>Distribution.Compat.Prelude.Internal
+Distribution.Compat.Prelude.Internal
++Distribution.Compat.Prelude.Internal
+++Distribution.Compat.ReadP
-Distribution.Compat.Prelude.Internal
.Distribution.Compat.Prelude.Internal
.=Distribution.Compat.Lens
.~Distribution.Compat.Lens
/Distribution.Compat.Prelude.Internal
/=Distribution.Compat.Prelude.Internal
<Distribution.Compat.Prelude.Internal
<$Distribution.Compat.Prelude.Internal
<$>Distribution.Compat.Prelude.Internal
<*Distribution.Compat.Prelude.Internal
<*>Distribution.Compat.Prelude.Internal
<++Distribution.Compat.ReadP
<<>>Distribution.Compat.Prelude.Internal
<=Distribution.Compat.Prelude.Internal
<>Distribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
<?>Distribution.Compat.Parsing, Distribution.Compat.CharParsing
<|>Distribution.Compat.Prelude.Internal
=<<Distribution.Compat.Prelude.Internal
==Distribution.Compat.Prelude.Internal
>Distribution.Compat.Prelude.Internal
>=Distribution.Compat.Prelude.Internal
>>Distribution.Compat.Prelude.Internal
>>=Distribution.Compat.Prelude.Internal
?=Distribution.Compat.Lens
?~Distribution.Compat.Lens
AALDistribution.SPDX.LicenseId, Distribution.SPDX
AArch64Distribution.System
AbiDependency 
1 (Type/Class)Distribution.Types.AbiDependency, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Data Constructor)Distribution.Types.AbiDependency, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
abiDepends 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
AbiHashDistribution.Types.AbiHash, Distribution.Package, Distribution.Make, Distribution.Simple
abiHash 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
3 (Function)Distribution.Simple.Register
AbiTag 
1 (Type/Class)Distribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
2 (Data Constructor)Distribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
abiTagStringDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
AbiTagVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
abiTemplateEnvDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
AbiVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
absDistribution.Compat.Prelude.Internal
absoluteComponentInstallDirsDistribution.Simple.LocalBuildInfo
absoluteInstallDirs 
1 (Function)Distribution.Simple.InstallDirs
2 (Function)Distribution.Simple.LocalBuildInfo
absoluteInstalledPackageInfoDistribution.Simple.Register
absolutePackageDBPathDistribution.Simple.Compiler, Distribution.Simple
absolutePackageDBPathsDistribution.Simple.Compiler, Distribution.Simple
abstractUnitIdDistribution.Backpack
AbstylesDistribution.SPDX.LicenseId, Distribution.SPDX
acosDistribution.Compat.Prelude.Internal
acoshDistribution.Compat.Prelude.Internal
AcyclicSCCDistribution.Compat.Graph
addBuildableConditionDistribution.PackageDescription.Configuration
addKnownProgramDistribution.Simple.Program.Db, Distribution.Simple.Program
addKnownProgramsDistribution.Simple.Program.Db, Distribution.Simple.Program
addLibraryPathDistribution.Simple.Utils
addProgressCtxDistribution.Utils.LogProgress
addWarningDistribution.Parsec.LexerMonad
adjustPosDistribution.Parsec.LexerMonad
Adobe_2006Distribution.SPDX.LicenseId, Distribution.SPDX
Adobe_GlyphDistribution.SPDX.LicenseId, Distribution.SPDX
ADSLDistribution.SPDX.LicenseId, Distribution.SPDX
AFL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
AFL_1_2Distribution.SPDX.LicenseId, Distribution.SPDX
AFL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
AFL_2_1Distribution.SPDX.LicenseId, Distribution.SPDX
AFL_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
AfmparseDistribution.SPDX.LicenseId, Distribution.SPDX
AGetterDistribution.Compat.Lens
AGPLDistribution.License, Distribution.Make, Distribution.Simple
AGPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
AGPL_1_0_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
AGPL_1_0_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
AGPL_3_0_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
AGPL_3_0_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
AIXDistribution.System
alaDistribution.Compat.Newtype
AladdinDistribution.SPDX.LicenseId, Distribution.SPDX
alafDistribution.Compat.Newtype
alaListDistribution.Parsec.Newtypes
alaList'Distribution.Parsec.Newtypes
ALensDistribution.Compat.Lens
ALens'Distribution.Compat.Lens
alexProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
All 
1 (Data Constructor)Distribution.Compat.Semigroup
2 (Type/Class)Distribution.Compat.Semigroup
allDistribution.Compat.Prelude.Internal
allBuildDependsDistribution.Types.PackageDescription, Distribution.PackageDescription
allBuildInfoDistribution.Types.PackageDescription, Distribution.PackageDescription
allComponentsInBuildOrderDistribution.Simple.LocalBuildInfo
allCondTreesDistribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
allExtensionsDistribution.Types.BuildInfo, Distribution.PackageDescription
allFlagsDistribution.Simple.Flag
allLanguagesDistribution.Types.BuildInfo, Distribution.PackageDescription
allLibModulesDistribution.Simple.LocalBuildInfo
allLibrariesDistribution.Types.PackageDescription, Distribution.PackageDescription
AllowAmbiguousTypesLanguage.Haskell.Extension, Distribution.Simple
allPackagesDistribution.Simple.PackageIndex
allPackagesByNameDistribution.Simple.PackageIndex
allPackagesBySourcePackageIdDistribution.Simple.PackageIndex
allPackagesBySourcePackageIdAndLibNameDistribution.Simple.PackageIndex
AllRightsReservedDistribution.License, Distribution.Make, Distribution.Simple
allTargetsInBuildOrderDistribution.Types.LocalBuildInfo
allTargetsInBuildOrder'Distribution.Types.LocalBuildInfo
AlphaDistribution.System
alphaNumDistribution.Compat.CharParsing
AlternativeDistribution.Compat.Prelude.Internal
alterVersionDistribution.Types.Version, Distribution.Version, Distribution.Simple
AlwaysDistribution.Simple.Setup
alwaysNondecIndentDistribution.Simple.GHC
AmbiguousDistribution.Simple.PackageIndex
AmbiguousParseDistribution.InstalledPackageInfo
AMDPLPADistribution.SPDX.LicenseId, Distribution.SPDX
AMLDistribution.SPDX.LicenseId, Distribution.SPDX
AMPASDistribution.SPDX.LicenseId, Distribution.SPDX
anaVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
andDistribution.Compat.Prelude.Internal
AndroidDistribution.System
annotateCallStackIODistribution.Compat.Stack
AnnotatedId 
1 (Type/Class)Distribution.Types.AnnotatedId
2 (Data Constructor)Distribution.Types.AnnotatedId
annotateIODistribution.Simple.Utils
ann_cnameDistribution.Types.AnnotatedId
ann_idDistribution.Types.AnnotatedId
ann_pidDistribution.Types.AnnotatedId
ANTLR_PDDistribution.SPDX.LicenseId, Distribution.SPDX
Any 
1 (Data Constructor)Distribution.Compat.Semigroup
2 (Type/Class)Distribution.Compat.Semigroup
anyDistribution.Compat.Prelude.Internal
anyCharDistribution.Compat.CharParsing
AnyVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
anyVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
AnyVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
apDistribution.Compat.Prelude.Internal
ApacheDistribution.License, Distribution.Make, Distribution.Simple
Apache_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
Apache_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
Apache_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
APAFMLDistribution.SPDX.LicenseId, Distribution.SPDX
APL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
appendFileDistribution.Compat.Prelude.Internal
ApplicativeDistribution.Compat.Prelude.Internal
ApplicativeDoLanguage.Haskell.Extension, Distribution.Simple
APSL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
APSL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
APSL_1_2Distribution.SPDX.LicenseId, Distribution.SPDX
APSL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
Arch 
1 (Type/Class)Distribution.System
2 (Data Constructor)Distribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
ArchVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
ArgPlaceHolderDistribution.Simple.Command
ArgsDistribution.Simple.UserHooks, Distribution.Simple
ArmDistribution.System
arProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
arResponseFilesSupportedDistribution.Simple.Compiler, Distribution.Simple
ArrowsLanguage.Haskell.Extension, Distribution.Simple
Artistic_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
Artistic_1_0_cl8Distribution.SPDX.LicenseId, Distribution.SPDX
Artistic_1_0_PerlDistribution.SPDX.LicenseId, Distribution.SPDX
Artistic_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
asBoolDistribution.Simple.Flag, Distribution.Simple.Setup
ASetterDistribution.Compat.Lens
asinDistribution.Compat.Prelude.Internal
asinhDistribution.Compat.Prelude.Internal
askCabalSpecVersionDistribution.Parsec.Class
asmOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
asmSources 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
asTypeOfDistribution.Compat.Prelude.Internal
asVersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
atanDistribution.Compat.Prelude.Internal
atan2Distribution.Compat.Prelude.Internal
atanhDistribution.Compat.Prelude.Internal
author 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
autoconfUserHooksDistribution.Simple
Autoconf_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
Autoconf_exception_3_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
AutoDeriveTypeableLanguage.Haskell.Extension, Distribution.Simple
autogenComponentModulesDirDistribution.Simple.BuildPaths
autogenModuleNameDistribution.Simple.BuildPaths
autogenModules 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
autogenModulesDirDistribution.Simple.BuildPaths
autogenPackageModulesDirDistribution.Simple.BuildPaths
autogenPathsModuleNameDistribution.Simple.BuildPaths
availableSinceDistribution.FieldGrammar.Class, Distribution.FieldGrammar
aviewDistribution.Compat.Lens
backpackSupportedDistribution.Simple.Compiler, Distribution.Simple
BahyphDistribution.SPDX.LicenseId, Distribution.SPDX
BangPatternsLanguage.Haskell.Extension, Distribution.Simple
BarrDistribution.SPDX.LicenseId, Distribution.SPDX
BazaarDistribution.Types.SourceRepo, Distribution.PackageDescription
BeerwareDistribution.SPDX.LicenseId, Distribution.SPDX
benchDistribution.Simple.Bench
BenchComponentLocalBuildInfoDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
benchHookDistribution.Simple.UserHooks, Distribution.Simple
Benchmark 
1 (Type/Class)Distribution.Types.Benchmark, Distribution.Types.Benchmark.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.Benchmark, Distribution.PackageDescription
benchmarkBuildInfo 
1 (Function)Distribution.Types.Benchmark, Distribution.PackageDescription
2 (Function)Distribution.Types.Benchmark.Lens, Distribution.Types.Lens
benchmarkCommandDistribution.Simple.Setup
benchmarkDistPrefDistribution.Simple.Setup
BenchmarkExeV10Distribution.Types.BenchmarkInterface, Distribution.PackageDescription
benchmarkFieldGrammarDistribution.PackageDescription.FieldGrammar
BenchmarkFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
BenchmarkInterfaceDistribution.Types.BenchmarkInterface, Distribution.PackageDescription
benchmarkInterface 
1 (Function)Distribution.Types.Benchmark, Distribution.PackageDescription
2 (Function)Distribution.Types.Benchmark.Lens, Distribution.Types.Lens
benchmarkModulesDistribution.Types.Benchmark, Distribution.PackageDescription
benchmarkModulesAutogenDistribution.Types.Benchmark, Distribution.PackageDescription
benchmarkName 
1 (Function)Distribution.Types.Benchmark, Distribution.PackageDescription
2 (Function)Distribution.Types.Benchmark.Lens, Distribution.Types.Lens
BenchmarkNameVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
benchmarkOptionsDistribution.Simple.Setup
benchmarks 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
benchmarksRequestedDistribution.Types.ComponentRequestedSpec
BenchmarkStanza 
1 (Type/Class)Distribution.PackageDescription.FieldGrammar
2 (Data Constructor)Distribution.PackageDescription.FieldGrammar
benchmarkStanzaBenchmarkModuleDistribution.PackageDescription.FieldGrammar
benchmarkStanzaBenchmarkTypeDistribution.PackageDescription.FieldGrammar
benchmarkStanzaBuildInfoDistribution.PackageDescription.FieldGrammar
benchmarkStanzaMainIsDistribution.PackageDescription.FieldGrammar
BenchmarkTypeDistribution.Types.BenchmarkType, Distribution.PackageDescription
benchmarkTypeDistribution.Types.Benchmark, Distribution.PackageDescription
BenchmarkTypeExeDistribution.Types.BenchmarkType, Distribution.PackageDescription
BenchmarkTypeUnknownDistribution.Types.BenchmarkType, Distribution.PackageDescription
BenchmarkUnsupportedDistribution.Types.BenchmarkInterface, Distribution.PackageDescription
benchmarkVerbosityDistribution.Simple.Setup
between 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
betweenVersionsInclusiveDistribution.Version, Distribution.Simple
BinaryDistribution.Compat.Binary, Distribution.Compat.Prelude.Internal
BinaryLiteralsLanguage.Haskell.Extension, Distribution.Simple
bindirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
BindirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
Bison_exception_2_2Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
BitTorrent_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
BitTorrent_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
BlockArgumentsLanguage.Haskell.Extension, Distribution.Simple
blurFieldGrammarDistribution.FieldGrammar.Class, Distribution.FieldGrammar
bol_sectionDistribution.Parsec.Lexer
BoolDistribution.Compat.Prelude.Internal
booleanFieldDefDistribution.FieldGrammar.Class, Distribution.FieldGrammar
BooleanFlagDistribution.Simple.Flag, Distribution.Simple.Setup
BoolOptDistribution.Simple.Command
boolOpt 
1 (Function)Distribution.Simple.Command
2 (Function)Distribution.Simple.Setup
boolOpt' 
1 (Function)Distribution.Simple.Command
2 (Function)Distribution.Simple.Setup
Bootloader_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
BorceuxDistribution.SPDX.LicenseId, Distribution.SPDX
BoundDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
BoundedDistribution.Compat.Prelude.Internal
breakDistribution.Compat.Prelude.Internal
breakMaybeDistribution.Utils.Generic
brokenDistribution.Compat.Graph
brokenPackagesDistribution.Simple.PackageIndex
BSD2Distribution.License, Distribution.Make, Distribution.Simple
BSD3Distribution.License, Distribution.Make, Distribution.Simple
BSD4Distribution.License, Distribution.Make, Distribution.Simple
BSD_1_ClauseDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_2_ClauseDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_2_Clause_FreeBSDDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_2_Clause_NetBSDDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_2_Clause_PatentDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_3_ClauseDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_3_Clause_AttributionDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_3_Clause_ClearDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_3_Clause_LBNLDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_3_Clause_No_Nuclear_LicenseDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_3_Clause_No_Nuclear_License_2014Distribution.SPDX.LicenseId, Distribution.SPDX
BSD_3_Clause_No_Nuclear_WarrantyDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_4_ClauseDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_4_Clause_UCDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_ProtectionDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_Source_CodeDistribution.SPDX.LicenseId, Distribution.SPDX
BSL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
bugReports 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
buildDistribution.Simple.Build
buildable 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
buildArchDistribution.System
buildArgsDistribution.Simple.Setup
buildCabalFilePathDistribution.Simple.Setup
buildCommandDistribution.Simple.Setup
buildCompilerFlavorDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
buildCompilerIdDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
buildDirDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
buildDistPrefDistribution.Simple.Setup
buildExe 
1 (Function)Distribution.Simple.UHC
2 (Function)Distribution.Simple.GHCJS
3 (Function)Distribution.Simple.GHC
BuildFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
buildFLibDistribution.Simple.GHC
buildHookDistribution.Simple.UserHooks, Distribution.Simple
BuildInfo 
1 (Type/Class)Distribution.Types.BuildInfo, Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.BuildInfo, Distribution.PackageDescription
buildInfo 
1 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
2 (Function)Distribution.Types.Executable, Distribution.PackageDescription
buildInfoFieldGrammarDistribution.PackageDescription.FieldGrammar
buildLib 
1 (Function)Distribution.Simple.UHC
2 (Function)Distribution.Simple.HaskellSuite
3 (Function)Distribution.Simple.GHCJS
4 (Function)Distribution.Simple.GHC
buildNumJobsDistribution.Simple.Setup
buildOptionsDistribution.Simple.Setup
buildOSDistribution.System
buildPlatformDistribution.System
buildProgramArgsDistribution.Simple.Setup
buildProgramPathsDistribution.Simple.Setup
BuildTargetDistribution.Simple.BuildTarget
BuildTargetAmbiguousDistribution.Simple.BuildTarget
BuildTargetComponentDistribution.Simple.BuildTarget
buildTargetComponentNameDistribution.Simple.BuildTarget
BuildTargetExpectedDistribution.Simple.BuildTarget
BuildTargetFileDistribution.Simple.BuildTarget
BuildTargetModuleDistribution.Simple.BuildTarget
BuildTargetNoSuchDistribution.Simple.BuildTarget
BuildTargetProblemDistribution.Simple.BuildTarget
buildToolDepends 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
buildTools 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
BuildTypeDistribution.Types.BuildType, Distribution.PackageDescription
buildTypeDistribution.Types.PackageDescription, Distribution.PackageDescription
buildTypeRaw 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
buildVerboseDistribution.Simple.Setup
buildVerbosityDistribution.Simple.Setup
builtinProgramsDistribution.Simple.Program.Builtin, Distribution.Simple.Program
byteSwap16Distribution.Compat.Binary
byteSwap32Distribution.Compat.Binary
byteSwap64Distribution.Compat.Binary
Bzip2_1_0_5Distribution.SPDX.LicenseId, Distribution.SPDX
Bzip2_1_0_6Distribution.SPDX.LicenseId, Distribution.SPDX
CDistribution.Simple.CCompiler
c2hsProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
cabalBugDistribution.PackageDescription.Utils
CabalFeatureDistribution.CabalSpecVersion
cabalFilePathDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
CabalParsingDistribution.Parsec.Class
cabalSpecFeaturesDistribution.CabalSpecVersion
cabalSpecLatestDistribution.CabalSpecVersion
CabalSpecOldDistribution.CabalSpecVersion
cabalSpecSupportsDistribution.CabalSpecVersion
CabalSpecV1_22Distribution.CabalSpecVersion
CabalSpecV1_24Distribution.CabalSpecVersion
CabalSpecV2_0Distribution.CabalSpecVersion
CabalSpecV2_2Distribution.CabalSpecVersion
CabalSpecV2_4Distribution.CabalSpecVersion
CabalSpecVersionDistribution.CabalSpecVersion
cabalSpecVersionToSPDXListVersionDistribution.SPDX.LicenseListVersion, Distribution.SPDX
cabalVersionDistribution.Simple.Utils
CalderaDistribution.SPDX.LicenseId, Distribution.SPDX
calibrateMtimeChangeDelayDistribution.Compat.Time
CallStackDistribution.Compat.Stack
callStackDistribution.Compat.Stack
CAndDistribution.Types.Condition, Distribution.PackageDescription
cAndDistribution.Types.Condition, Distribution.PackageDescription
CApiFFILanguage.Haskell.Extension, Distribution.Simple
cataVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
catchExitDistribution.Compat.Exception
catchIODistribution.Compat.Exception
category 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
catMaybesDistribution.Compat.Prelude.Internal
CATOSL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
CBenchDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
CBenchNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
CC0_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
ccLdOptionsBuildInfoDistribution.Simple.Configure
ccOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
cc_ann_idDistribution.Backpack.ConfiguredComponent
CC_BY_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_2_5Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_4_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_2_5Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_4_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_ND_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_ND_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_ND_2_5Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_ND_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_ND_4_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_SA_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_SA_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_SA_2_5Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_SA_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_SA_4_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_ND_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_ND_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_ND_2_5Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_ND_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_ND_4_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_SA_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_SA_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_SA_2_5Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_SA_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_SA_4_0Distribution.SPDX.LicenseId, Distribution.SPDX
cc_cidDistribution.Backpack.ConfiguredComponent
cc_componentDistribution.Backpack.ConfiguredComponent
cc_exe_depsDistribution.Backpack.ConfiguredComponent
cc_includesDistribution.Backpack.ConfiguredComponent
cc_nameDistribution.Backpack.ConfiguredComponent
cc_pkgidDistribution.Backpack.ConfiguredComponent
cc_publicDistribution.Backpack.ConfiguredComponent
CDDL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CDDL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
CDialectDistribution.Simple.CCompiler
cDialectFilenameExtensionDistribution.Simple.CCompiler
CDLA_Permissive_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CDLA_Sharing_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CECILL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CECILL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
CECILL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
CECILL_2_1Distribution.SPDX.LicenseId, Distribution.SPDX
CECILL_BDistribution.SPDX.LicenseId, Distribution.SPDX
CECILL_CDistribution.SPDX.LicenseId, Distribution.SPDX
ceilingDistribution.Compat.Prelude.Internal
CExeDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
CExeNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
CFLibDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
CFLibNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
chainl 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
chainl1 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
chainr 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
chainr1 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
CharDistribution.Compat.Prelude.Internal
char 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.CharParsing
CharParsingDistribution.Compat.CharParsing
chattyTryDistribution.Simple.Utils
checkConfiguredPackageDistribution.PackageDescription.Check
checkForeignDepsDistribution.Simple.Configure
checkPackageDistribution.PackageDescription.Check
checkPackageContentDistribution.PackageDescription.Check
CheckPackageContentOps 
1 (Type/Class)Distribution.PackageDescription.Check
2 (Data Constructor)Distribution.PackageDescription.Check
checkPackageFileNamesDistribution.PackageDescription.Check
checkPackageFilesDistribution.PackageDescription.Check
checkPersistBuildConfigOutdatedDistribution.Simple.Configure
choice 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
ChoiceOptDistribution.Simple.Command
choiceOptDistribution.Simple.Command
choiceOptFromEnumDistribution.Simple.Command
chrDistribution.Compat.Prelude.Internal
ci_ann_idDistribution.Types.ComponentInclude
ci_cnameDistribution.Types.ComponentInclude
ci_idDistribution.Types.ComponentInclude
ci_implicitDistribution.Types.ComponentInclude
ci_pkgidDistribution.Types.ComponentInclude
ci_renamingDistribution.Types.ComponentInclude
ClArtisticDistribution.SPDX.LicenseId, Distribution.SPDX
ClassificationStrictnessDistribution.System
classifyArchDistribution.System
classifyCompilerFlavorDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
classifyExtensionLanguage.Haskell.Extension, Distribution.Simple
classifyLanguageLanguage.Haskell.Extension, Distribution.Simple
classifyOSDistribution.System
classifyRepoKindDistribution.Types.SourceRepo
classifyRepoTypeDistribution.Types.SourceRepo
Classpath_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
cleanCabalFilePathDistribution.Simple.Setup
cleanCommandDistribution.Simple.Setup
cleanDistPrefDistribution.Simple.Setup
CleanFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
cleanHookDistribution.Simple.UserHooks, Distribution.Simple
cleanSaveConfDistribution.Simple.Setup
cleanVerbosityDistribution.Simple.Setup
CLibDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
CLibNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
CLISP_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
cloneLensDistribution.Compat.Lens
CloseBraceDistribution.Parsec.Lexer
closureDistribution.Compat.Graph
cmmOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
cmmSources 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
CNotDistribution.Types.Condition, Distribution.PackageDescription
cNotDistribution.Types.Condition, Distribution.PackageDescription
CNRI_JythonDistribution.SPDX.LicenseId, Distribution.SPDX
CNRI_PythonDistribution.SPDX.LicenseId, Distribution.SPDX
CNRI_Python_GPL_CompatibleDistribution.SPDX.LicenseId, Distribution.SPDX
ColonDistribution.Parsec.Lexer
combineInstallDirsDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
combineObjectFilesDistribution.Simple.Program.Ld
combinePathTemplateDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
CommaFSep 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
CommandDistribution.Simple.Command
commandAddActionDistribution.Simple.Command
commandDefaultFlagsDistribution.Simple.Command
commandDescriptionDistribution.Simple.Command
CommandErrorsDistribution.Simple.Command
commandFromSpecDistribution.Simple.Command
CommandHelpDistribution.Simple.Command
CommandListDistribution.Simple.Command
commandNameDistribution.Simple.Command
commandNotesDistribution.Simple.Command
commandOptionsDistribution.Simple.Command
CommandParseDistribution.Simple.Command
commandParseArgsDistribution.Simple.Command
CommandReadyToGoDistribution.Simple.Command
commandShowOptionsDistribution.Simple.Command
CommandSpec 
1 (Type/Class)Distribution.Simple.Command
2 (Data Constructor)Distribution.Simple.Command
commandsRunDistribution.Simple.Command
commandSynopsisDistribution.Simple.Command
CommandTypeDistribution.Simple.Command
CommandUI 
1 (Type/Class)Distribution.Simple.Command
2 (Data Constructor)Distribution.Simple.Command
commandUsageDistribution.Simple.Command
CommaVCat 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
CommonStanzasDistribution.CabalSpecVersion
compareDistribution.Compat.Prelude.Internal
comparingDistribution.Utils.Generic, Distribution.Simple.Utils
CompatDistribution.System
compatPackageKey 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
Compiler 
1 (Type/Class)Distribution.Simple.Compiler, Distribution.Simple
2 (Data Constructor)Distribution.Simple.Compiler, Distribution.Simple
compiler 
1 (Function)Distribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
2 (Function)Distribution.Simple.Test.Log
compilerAbiTagDistribution.Simple.Compiler, Distribution.Simple
compilerCompatDistribution.Simple.Compiler, Distribution.Simple
compilerCompatFlavorDistribution.Simple.Compiler, Distribution.Simple
compilerCompatVersionDistribution.Simple.Compiler, Distribution.Simple
compilerExtensionsDistribution.Simple.Compiler, Distribution.Simple
CompilerFlavorDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerFlavorDistribution.Simple.Compiler, Distribution.Simple
CompilerId 
1 (Type/Class)Distribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
2 (Data Constructor)Distribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerIdDistribution.Simple.Compiler, Distribution.Simple
CompilerInfo 
1 (Type/Class)Distribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
2 (Data Constructor)Distribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerInfoDistribution.Simple.Compiler, Distribution.Simple
compilerInfoAbiTagDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerInfoCompatDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerInfoExtensionsDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerInfoIdDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerInfoLanguagesDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerLanguagesDistribution.Simple.Compiler, Distribution.Simple
compilerPropertiesDistribution.Simple.Compiler, Distribution.Simple
compilerTemplateEnvDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
CompilerVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
compilerVersionDistribution.Simple.Compiler, Distribution.Simple
ComponentDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
componentBuildableDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
componentBuildDirDistribution.Simple.LocalBuildInfo
componentBuildInfo 
1 (Function)Distribution.Types.Component, Distribution.Simple.LocalBuildInfo
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
componentCcGhcOptionsDistribution.Simple.GHC
componentCompatPackageKeyDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentCompatPackageNameDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentComponentIdDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentCycleMsgDistribution.Backpack.ComponentsGraph
ComponentDisabledReasonDistribution.Types.ComponentRequestedSpec
componentDisabledReasonDistribution.Types.ComponentRequestedSpec
componentEnabledDistribution.Types.ComponentRequestedSpec
componentEnabledSpecDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentExeDepsDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentExposedModulesDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentGhcOptions 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
componentGraphDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
ComponentIdDistribution.Types.ComponentId, Distribution.Package, Distribution.Make, Distribution.Simple
ComponentInclude 
1 (Type/Class)Distribution.Types.ComponentInclude
2 (Data Constructor)Distribution.Types.ComponentInclude
componentIncludesDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentInitialBuildStepsDistribution.Simple.Build
componentInstantiatedWithDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentInternalDepsDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentIsIndefiniteDistribution.Types.ComponentLocalBuildInfo
componentIsIndefinite_Distribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentIsPublicDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
ComponentLocalBuildInfoDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentLocalNameDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentModulesDistribution.Types.PackageDescription.Lens, Distribution.Types.Lens
ComponentNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
componentNameDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
componentNameCLBIsDistribution.Types.LocalBuildInfo
componentNameMapDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentNameRequestedDistribution.Types.ComponentRequestedSpec
componentNameStanzaDistribution.Types.ComponentName
componentNameStringDistribution.Types.ComponentName, Distribution.Simple.LocalBuildInfo
componentNameTargetsDistribution.Types.LocalBuildInfo
componentNameTargets'Distribution.Types.LocalBuildInfo
componentPackageDepsDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
ComponentRequestedSpec 
1 (Type/Class)Distribution.Types.ComponentRequestedSpec
2 (Data Constructor)Distribution.Types.ComponentRequestedSpec
componentsDistribution.ModuleName
componentsConfigsDistribution.Types.LocalBuildInfo
ComponentsGraphDistribution.Backpack.ComponentsGraph
componentsGraphToListDistribution.Backpack.ComponentsGraph
componentsInBuildOrderDistribution.Simple.LocalBuildInfo
ComponentsWithDepsDistribution.Backpack.ComponentsGraph
componentUnitIdDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
computeCompatPackageIdDistribution.Types.MungedPackageId
computeCompatPackageKeyDistribution.Simple.Configure
computeCompatPackageNameDistribution.Types.MungedPackageName, Distribution.Simple.Configure
computeComponentIdDistribution.Simple.Configure
computeEffectiveProfilingDistribution.Simple.Configure
concatDistribution.Compat.Prelude.Internal
concatMapDistribution.Compat.Prelude.Internal
concurrentlyDistribution.TestSuite
condBenchmarks 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
CondBranch 
1 (Type/Class)Distribution.Types.CondTree
2 (Data Constructor)Distribution.Types.CondTree
condBranchConditionDistribution.Types.CondTree
condBranchIfFalseDistribution.Types.CondTree
condBranchIfTrueDistribution.Types.CondTree
condExecutables 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
condForeignLibs 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
condIfThenDistribution.Types.CondTree
condIfThenElseDistribution.Types.CondTree
ConditionDistribution.Types.Condition, Distribution.PackageDescription
condLibrary 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
CondNodeDistribution.Types.CondTree, Distribution.PackageDescription
Condor_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
condSubLibraries 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
condTestSuites 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
CondTreeDistribution.Types.CondTree, Distribution.PackageDescription
condTreeComponentsDistribution.Types.CondTree, Distribution.PackageDescription
condTreeConstraintsDistribution.Types.CondTree, Distribution.PackageDescription
condTreeDataDistribution.Types.CondTree, Distribution.PackageDescription
confHookDistribution.Simple.UserHooks, Distribution.Simple
configAbsolutePathsDistribution.Simple.Setup
configArgsDistribution.Simple.Setup
configBenchmarksDistribution.Simple.Setup
configCabalFilePathDistribution.Simple.Setup
configCIDDistribution.Simple.Setup
configCompilerDistribution.Simple.Configure
configCompilerAuxDistribution.Simple.Configure
configCompilerAuxExDistribution.Simple.Configure
configCompilerExDistribution.Simple.Configure
configConfigurationsFlagsDistribution.Simple.Setup
configConfigureArgsDistribution.Simple.Setup
configConstraintsDistribution.Simple.Setup
configCoverageDistribution.Simple.Setup
configDebugInfoDistribution.Simple.Setup
configDependenciesDistribution.Simple.Setup
configDeterministicDistribution.Simple.Setup
configDistPrefDistribution.Simple.Setup
configDynExeDistribution.Simple.Setup
configExactConfigurationDistribution.Simple.Setup
configExtraFrameworkDirsDistribution.Simple.Setup
configExtraIncludeDirsDistribution.Simple.Setup
configExtraLibDirsDistribution.Simple.Setup
configFlagErrorDistribution.Simple.Setup
ConfigFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
configFlagsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
configGHCiLibDistribution.Simple.Setup
configHcFlavorDistribution.Simple.Setup
configHcPathDistribution.Simple.Setup
configHcPkgDistribution.Simple.Setup
configInstallDirsDistribution.Simple.Setup
configInstantiateWithDistribution.Simple.Setup
configIPIDDistribution.Simple.Setup
configLibCoverageDistribution.Simple.Setup
configOptimizationDistribution.Simple.Setup
configPackageDBsDistribution.Simple.Setup
configProfDistribution.Simple.Setup
configProfDetailDistribution.Simple.Setup
configProfExeDistribution.Simple.Setup
configProfLibDistribution.Simple.Setup
configProfLibDetailDistribution.Simple.Setup
configProgPrefixDistribution.Simple.Setup
configProgramArgsDistribution.Simple.Setup
configProgramPathExtraDistribution.Simple.Setup
configProgramPathsDistribution.Simple.Setup
configProgramsDistribution.Simple.Setup
configPrograms_Distribution.Simple.Setup
configProgSuffixDistribution.Simple.Setup
configRelocatableDistribution.Simple.Setup
configScratchDirDistribution.Simple.Setup
configSharedLibDistribution.Simple.Setup
configSplitObjsDistribution.Simple.Setup
configSplitSectionsDistribution.Simple.Setup
ConfigStateFileBadHeaderDistribution.Simple.Configure
ConfigStateFileBadVersionDistribution.Simple.Configure
ConfigStateFileErrorDistribution.Simple.Configure
ConfigStateFileMissingDistribution.Simple.Configure
ConfigStateFileNoHeaderDistribution.Simple.Configure
ConfigStateFileNoParseDistribution.Simple.Configure
configStaticLibDistribution.Simple.Setup
configStripExesDistribution.Simple.Setup
configStripLibsDistribution.Simple.Setup
configTestsDistribution.Simple.Setup
ConfigureDistribution.Types.BuildType, Distribution.PackageDescription
configure 
1 (Function)Distribution.Simple.UHC
2 (Function)Distribution.Simple.HaskellSuite
3 (Function)Distribution.Simple.GHCJS
4 (Function)Distribution.Simple.GHC
5 (Function)Distribution.Simple.Configure
configureAllKnownProgramsDistribution.Simple.Program.Db, Distribution.Simple.Program
configureArgsDistribution.Simple.Setup
configureCCompilerDistribution.Simple.Setup
configureCommandDistribution.Simple.Setup
configureComponentLocalBuildInfosDistribution.Backpack.Configure
ConfiguredComponent 
1 (Type/Class)Distribution.Backpack.ConfiguredComponent
2 (Data Constructor)Distribution.Backpack.ConfiguredComponent
ConfiguredComponentMapDistribution.Backpack.ConfiguredComponent
ConfiguredProgram 
1 (Type/Class)Distribution.Simple.Program.Types, Distribution.Simple.Program
2 (Data Constructor)Distribution.Simple.Program.Types, Distribution.Simple.Program
configuredProgramsDistribution.Simple.Program.Db
configureLinkerDistribution.Simple.Setup
configureOptionsDistribution.Simple.Setup
configureProgramDistribution.Simple.Program.Db, Distribution.Simple.Program
configUseResponseFilesDistribution.Simple.Setup
configUserInstallDistribution.Simple.Setup
configVanillaLibDistribution.Simple.Setup
configVerbosityDistribution.Simple.Setup
ConfVarDistribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
constDistribution.Compat.Prelude.Internal
constrainByDistribution.Types.DependencyMap
ConstrainedClassMethodsLanguage.Haskell.Extension, Distribution.Simple
ConstraintKindsLanguage.Haskell.Extension, Distribution.Simple
copyArgsDistribution.Simple.Setup
copyCabalFilePathDistribution.Simple.Setup
copyCommandDistribution.Simple.Setup
CopyDestDistribution.Simple.InstallDirs, Distribution.Simple.Setup, Distribution.Simple.LocalBuildInfo
copyDestDistribution.Simple.Setup
copyDirectoryRecursiveDistribution.Simple.Utils
copyDirectoryRecursiveVerboseDistribution.Simple.Utils
copyDistPrefDistribution.Simple.Setup
copyFilesDistribution.Simple.Utils
copyFileToDistribution.Simple.Utils
copyFileVerboseDistribution.Simple.Utils
CopyFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
copyHookDistribution.Simple.UserHooks, Distribution.Simple
copyright 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
CopyToDistribution.Simple.InstallDirs, Distribution.Simple.Setup, Distribution.Simple.LocalBuildInfo
CopyToDbDistribution.Simple.InstallDirs, Distribution.Simple.Setup, Distribution.Simple.LocalBuildInfo
copyVerbosityDistribution.Simple.Setup
COrDistribution.Types.Condition, Distribution.PackageDescription
cOrDistribution.Types.Condition, Distribution.PackageDescription
cosDistribution.Compat.Prelude.Internal
coshDistribution.Compat.Prelude.Internal
count 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
countTestResultsDistribution.Simple.Test.Log
coverageSupportedDistribution.Simple.Compiler, Distribution.Simple
CPAL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CPlusPlusDistribution.Simple.CCompiler
CPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CPOL_1_02Distribution.SPDX.LicenseId, Distribution.SPDX
CPPLanguage.Haskell.Extension, Distribution.Simple
cppHeaderNameDistribution.Simple.BuildPaths
cpphsProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
cppOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
cppProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
createArchiveDistribution.Simple.SrcDist
createArLibArchiveDistribution.Simple.Program.Ar
createDirectoryIfMissingVerboseDistribution.Simple.Utils
createInternalPackageDBDistribution.Simple.Build
createPackageDBDistribution.Simple.Register
createPipeDistribution.Compat.CreatePipe
createProcessWithEnvDistribution.Simple.Utils
createTempDirectoryDistribution.Simple.Utils
CrosswordDistribution.SPDX.LicenseId, Distribution.SPDX
CrystalStackerDistribution.SPDX.LicenseId, Distribution.SPDX
cSourceExtensionsDistribution.Simple.CCompiler
cSources 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
CSubLibNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
CTestDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
CTestNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
CUA_OPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CubeDistribution.SPDX.LicenseId, Distribution.SPDX
curCodeDistribution.Parsec.LexerMonad
curInputDistribution.Parsec.LexerMonad
CurlDistribution.SPDX.LicenseId, Distribution.SPDX
curPosDistribution.Parsec.LexerMonad
currentDirDistribution.Simple.Utils
curryDistribution.Compat.Prelude.Internal
CustomDistribution.Types.BuildType, Distribution.PackageDescription
customFieldsBI 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
customFieldsPD 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
CVSDistribution.Types.SourceRepo, Distribution.PackageDescription
cxxOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
cxxSources 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
cycleDistribution.Compat.Prelude.Internal
cyclesDistribution.Compat.Graph
CyclicSCCDistribution.Compat.Graph
DarcsDistribution.Types.SourceRepo, Distribution.PackageDescription
DataDistribution.Compat.Prelude.Internal
dataDir 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
datadirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
DatadirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
dataFiles 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
DataKindsLanguage.Haskell.Extension, Distribution.Simple
datasubdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
DatasubdirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
DatatypeContextsLanguage.Haskell.Extension, Distribution.Simple
dateToSnapshotNumberDistribution.Simple.SrcDist
deafeningDistribution.Verbosity
debugDistribution.Simple.Utils
DebugInfoLevelDistribution.Simple.Compiler, Distribution.Simple
debugNoWrapDistribution.Simple.Utils
decodeDistribution.Compat.Binary
decodeCompatPackageNameDistribution.Types.MungedPackageName
decodeFileDistribution.Compat.Binary
decodeFileOrFailDistribution.Compat.Binary
decodeFileOrFail'Distribution.Compat.Binary
decodeFloatDistribution.Compat.Prelude.Internal
decodeOrFailDistribution.Compat.Binary
decodeOrFailIODistribution.Compat.Binary
decodeStringUtf8Distribution.Utils.ShortText
defaultBenchmarkFlagsDistribution.Simple.Setup
defaultBuildFlagsDistribution.Simple.Setup
defaultCleanFlagsDistribution.Simple.Setup
defaultCompilerFlavorDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
defaultComponentRequestedSpecDistribution.Types.ComponentRequestedSpec
defaultConfigFlagsDistribution.Simple.Setup
defaultCopyFlagsDistribution.Simple.Setup
defaultDistPrefDistribution.Simple.Setup, Distribution.Simple.BuildPaths
defaultDoctestFlagsDistribution.Simple.Setup
defaultExtensions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
defaultGlobalFlagsDistribution.Simple.Setup
defaultHaddockFlagsDistribution.Simple.Setup
defaultHookedPackageDescDistribution.Simple.Utils, Distribution.Simple
defaultHscolourFlagsDistribution.Simple.Setup
defaultIncludeRenamingDistribution.Types.IncludeRenaming
defaultInstallDirsDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
defaultInstallDirs'Distribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
defaultInstallFlagsDistribution.Simple.Setup
defaultLanguage 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
defaultLibNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
defaultMain 
1 (Function)Distribution.Make
2 (Function)Distribution.Simple
defaultMainArgs 
1 (Function)Distribution.Make
2 (Function)Distribution.Simple
defaultMainNoRead 
1 (Function)Distribution.Make
2 (Function)Distribution.Simple
defaultMainWithHooksDistribution.Simple
defaultMainWithHooksArgsDistribution.Simple
defaultMainWithHooksNoReadDistribution.Simple
defaultMainWithHooksNoReadArgsDistribution.Simple
defaultPackageDescDistribution.Simple.Utils
defaultProgramConfigurationDistribution.Simple.Program
defaultProgramDbDistribution.Simple.Program.Db, Distribution.Simple.Program
defaultProgramSearchPathDistribution.Simple.Program.Find, Distribution.Simple.Program
defaultRegisterFlagsDistribution.Simple.Setup
defaultRegisterOptionsDistribution.Simple.Program.HcPkg, Distribution.Simple.Register
DefaultRenamingDistribution.Types.ModuleRenaming, Distribution.PackageDescription
defaultRenamingDistribution.Types.ModuleRenaming, Distribution.PackageDescription
defaultReplFlagsDistribution.Simple.Setup
defaultSDistFlagsDistribution.Simple.Setup
defaultSetupDepends 
1 (Function)Distribution.Types.SetupBuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.SetupBuildInfo.Lens, Distribution.Types.Lens
DefaultSignaturesLanguage.Haskell.Extension, Distribution.Simple
defaultStyleDistribution.Pretty, Distribution.Text
defaultTempFileOptionsDistribution.Simple.Utils
defaultTestFlagsDistribution.Simple.Setup
defaultUserHooksDistribution.Simple
DefiniteUnitIdDistribution.Backpack
DefUnitIdDistribution.Types.UnitId, Distribution.Backpack, Distribution.Package, Distribution.Make, Distribution.Simple
deleteInstalledPackageIdDistribution.Simple.PackageIndex
deleteKeyDistribution.Compat.Graph
deleteLookupDistribution.Compat.Graph
deletePackageDBDistribution.Simple.Register
deletePackageNameDistribution.Simple.PackageIndex
deleteSourcePackageIdDistribution.Simple.PackageIndex
deleteUnitIdDistribution.Simple.PackageIndex
depAbiHashDistribution.Types.AbiDependency, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
Dependency 
1 (Type/Class)Distribution.Types.Dependency, Distribution.Package, Distribution.Make, Distribution.Simple
2 (Data Constructor)Distribution.Types.Dependency, Distribution.Package, Distribution.Make, Distribution.Simple
dependencyClosureDistribution.Simple.PackageIndex
dependencyCyclesDistribution.Simple.PackageIndex
dependencyGraphDistribution.Simple.PackageIndex
dependencyInconsistenciesDistribution.Simple.PackageIndex
DependencyMapDistribution.Types.DependencyMap
depends 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
depLibraryPathsDistribution.Simple.LocalBuildInfo
depPkgNameDistribution.Types.Dependency, Distribution.Package, Distribution.Make, Distribution.Simple
deprecatedExtensionsLanguage.Haskell.Extension, Distribution.Simple
deprecatedField'Distribution.FieldGrammar.Class, Distribution.FieldGrammar
deprecatedSinceDistribution.FieldGrammar.Class, Distribution.FieldGrammar
depUnitIdDistribution.Types.AbiDependency, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
depVerRangeDistribution.Types.Dependency, Distribution.Package, Distribution.Make, Distribution.Simple
DeriveAnyClassLanguage.Haskell.Extension, Distribution.Simple
DeriveDataTypeableLanguage.Haskell.Extension, Distribution.Simple
DeriveFoldableLanguage.Haskell.Extension, Distribution.Simple
DeriveFunctorLanguage.Haskell.Extension, Distribution.Simple
DeriveGenericLanguage.Haskell.Extension, Distribution.Simple
DeriveLiftLanguage.Haskell.Extension, Distribution.Simple
DeriveTraversableLanguage.Haskell.Extension, Distribution.Simple
DerivingStrategiesLanguage.Haskell.Extension, Distribution.Simple
descCabalVersionDistribution.Types.PackageDescription, Distribution.PackageDescription
describeDistribution.Simple.Program.HcPkg
describeInvocationDistribution.Simple.Program.HcPkg
DescriptionDistribution.Simple.Command
description 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
desugarBuildToolDistribution.Simple.BuildToolDepends
dieDistribution.Simple.Utils
die'Distribution.Simple.Utils
dieNoVerbosityDistribution.Simple.Utils
dieNoWrapDistribution.Simple.Utils
dieProgressDistribution.Utils.LogProgress
dieWithLocationDistribution.Simple.Utils
dieWithLocation'Distribution.Simple.Utils
differenceVersionRangesDistribution.Version, Distribution.Simple
diffFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
DiffmarkDistribution.SPDX.LicenseId, Distribution.SPDX
DigiRule_FOSS_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
digitDistribution.Compat.CharParsing
DirectDistribution.Simple.Setup
DisabledAllBenchmarksDistribution.Types.ComponentRequestedSpec
DisabledAllButOneDistribution.Types.ComponentRequestedSpec
DisabledAllTestsDistribution.Types.ComponentRequestedSpec
DisabledComponentDistribution.Types.ComponentRequestedSpec
DisableExtensionLanguage.Haskell.Extension, Distribution.Simple
DisambiguateRecordFieldsLanguage.Haskell.Extension, Distribution.Simple
dispDistribution.Text
dispComponentsWithDepsDistribution.Backpack.ComponentsGraph
dispConfiguredComponentDistribution.Backpack.ConfiguredComponent
dispFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
displayDistribution.Text
displayExceptionDistribution.Compat.Exception
dispLinkedComponentDistribution.Backpack.LinkedComponent
dispOpenModuleSubstDistribution.Backpack
dispOpenModuleSubstEntryDistribution.Backpack
divDistribution.Compat.Prelude.Internal
divModDistribution.Compat.Prelude.Internal
DListDistribution.Compat.DList
dllExtensionDistribution.Simple.BuildPaths
DoAndIfThenElseLanguage.Haskell.Extension, Distribution.Simple
DOCDistribution.SPDX.LicenseId, Distribution.SPDX
docdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
DocdirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
doctestDistribution.Simple.Doctest
doctestCommandDistribution.Simple.Setup
doctestDistPrefDistribution.Simple.Setup
DoctestFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
doctestHookDistribution.Simple.UserHooks, Distribution.Simple
doctestProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
doctestProgramArgsDistribution.Simple.Setup
doctestProgramPathsDistribution.Simple.Setup
doctestVerbosityDistribution.Simple.Setup
doesDirectoryExistDistribution.PackageDescription.Check
doesExecutableExistDistribution.Simple.Utils
doesFileExistDistribution.PackageDescription.Check
doesPackageDBExistDistribution.Simple.Register
DoRecLanguage.Haskell.Extension, Distribution.Simple
DotseqnDistribution.SPDX.LicenseId, Distribution.SPDX
DoubleDistribution.Compat.Prelude.Internal
DragonFlyDistribution.System
dropDistribution.Compat.Prelude.Internal
dropExeExtensionDistribution.Simple.Utils
dropWhileDistribution.Compat.Prelude.Internal
dropWhileEndLEDistribution.Utils.Generic, Distribution.Simple.Utils
DS389_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
DSDPDistribution.SPDX.LicenseId, Distribution.SPDX
dumpDistribution.Simple.Program.HcPkg
dumpInvocationDistribution.Simple.Program.HcPkg
DuplicateRecordFieldsLanguage.Haskell.Extension, Distribution.Simple
DvipdfmDistribution.SPDX.LicenseId, Distribution.SPDX
DynDistribution.Simple.Hpc
dynlibdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
DynlibdirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
D_FSL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
EAndDistribution.SPDX.LicenseExpression, Distribution.SPDX
EarlierVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
earlierVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
EarlierVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
ECL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
ECL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
ECos_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
EFL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
EFL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
EGenixDistribution.SPDX.LicenseId, Distribution.SPDX
EitherDistribution.Compat.Prelude.Internal
eitherDistribution.Compat.Prelude.Internal
eitherParsecDistribution.Parsec.Class
elemDistribution.Compat.Prelude.Internal
ELicenseDistribution.SPDX.LicenseExpression, Distribution.SPDX
ELicenseIdDistribution.SPDX.LicenseExpression, Distribution.SPDX
ELicenseIdPlusDistribution.SPDX.LicenseExpression, Distribution.SPDX
ELicenseRefDistribution.SPDX.LicenseExpression, Distribution.SPDX
ElifDistribution.CabalSpecVersion
embedVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
empty 
1 (Function)Distribution.Compat.Prelude.Internal
2 (Function)Distribution.Compat.Graph
emptyBenchmarkDistribution.Types.Benchmark, Distribution.PackageDescription
emptyBenchmarkFlagsDistribution.Simple.Setup
emptyBuildFlagsDistribution.Simple.Setup
emptyBuildInfoDistribution.Types.BuildInfo, Distribution.PackageDescription
EmptyCaseLanguage.Haskell.Extension, Distribution.Simple
emptyCleanFlagsDistribution.Simple.Setup
emptyConfigFlagsDistribution.Simple.Setup
emptyCopyFlagsDistribution.Simple.Setup
EmptyDataDeclsLanguage.Haskell.Extension, Distribution.Simple
emptyDoctestFlagsDistribution.Simple.Setup
emptyExecutableDistribution.Types.Executable, Distribution.PackageDescription
emptyFlagDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
emptyForeignLibDistribution.Types.ForeignLib
emptyGenericPackageDescriptionDistribution.Types.GenericPackageDescription
EmptyGlobDistribution.Simple.Glob
emptyGlobalFlagsDistribution.Simple.Setup
emptyHaddockFlagsDistribution.Simple.Setup
emptyHookedBuildInfoDistribution.Types.HookedBuildInfo, Distribution.PackageDescription
emptyHscolourFlagsDistribution.Simple.Setup
emptyInstalledPackageInfoDistribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
emptyInstallFlagsDistribution.Simple.Setup
emptyLibraryDistribution.Types.Library, Distribution.PackageDescription
emptyModuleShapeDistribution.Backpack.ModuleShape
emptyPackageDescriptionDistribution.Types.PackageDescription, Distribution.PackageDescription
emptyProgramConfigurationDistribution.Simple.Program
emptyProgramDbDistribution.Simple.Program.Db, Distribution.Simple.Program
emptyProgramInvocationDistribution.Simple.Program.Run, Distribution.Simple.Program
emptyRegisterFlagsDistribution.Simple.Setup
emptySDistFlagsDistribution.Simple.Setup
emptySourceRepoDistribution.Types.SourceRepo, Distribution.PackageDescription
emptyTestFlagsDistribution.Simple.Setup
emptyTestSuiteDistribution.Types.TestSuite, Distribution.PackageDescription
emptyUserHooksDistribution.Simple.UserHooks, Distribution.Simple
enabledBenchLBIsDistribution.Simple.LocalBuildInfo
enabledBuildDependsDistribution.Types.PackageDescription, Distribution.PackageDescription
enabledBuildInfosDistribution.Types.PackageDescription
enabledComponentsDistribution.Types.PackageDescription
enabledTestLBIsDistribution.Simple.LocalBuildInfo
EnableExtensionLanguage.Haskell.Extension, Distribution.Simple
encodeDistribution.Compat.Binary
encodeFileDistribution.Compat.Binary
encodeFloatDistribution.Compat.Prelude.Internal
encodeStringUtf8Distribution.Utils.ShortText
endBy 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
endBy1 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
EntessaDistribution.SPDX.LicenseId, Distribution.SPDX
EnumDistribution.Compat.Prelude.Internal
enumFromDistribution.Compat.Prelude.Internal
enumFromThenDistribution.Compat.Prelude.Internal
enumFromThenToDistribution.Compat.Prelude.Internal
enumFromToDistribution.Compat.Prelude.Internal
EOFDistribution.Parsec.Lexer
eof 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
EOrDistribution.SPDX.LicenseExpression, Distribution.SPDX
EPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
EPL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
EQDistribution.Compat.Prelude.Internal
EqDistribution.Compat.Prelude.Internal
equatingDistribution.Utils.Generic, Distribution.Simple.Utils
ErlPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
ErrorDistribution.TestSuite
errorDistribution.Compat.Prelude.Internal
errorWithoutStackTraceDistribution.Compat.Prelude.Internal
EtaDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
EUDatagridDistribution.SPDX.LicenseId, Distribution.SPDX
EUPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
EUPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
EUPL_1_2Distribution.SPDX.LicenseId, Distribution.SPDX
EurosymDistribution.SPDX.LicenseId, Distribution.SPDX
evenDistribution.Compat.Prelude.Internal
ExclusiveBoundDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
exeBuildDirDistribution.Simple.BuildPaths
exeBuildInfoDistribution.Types.Executable.Lens, Distribution.Types.Lens
execLexerDistribution.Parsec.LexerMonad
ExeComponentLocalBuildInfoDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
exeCoverageDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
Executable 
1 (Type/Class)Distribution.Types.Executable, Distribution.Types.Executable.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.Executable, Distribution.PackageDescription
executableFieldGrammarDistribution.PackageDescription.FieldGrammar
ExecutableNameVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
ExecutablePrivateDistribution.Types.ExecutableScope
ExecutablePublicDistribution.Types.ExecutableScope
executables 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
ExecutableScopeDistribution.Types.ExecutableScope
ExeDependency 
1 (Type/Class)Distribution.Types.ExeDependency
2 (Data Constructor)Distribution.Types.ExeDependency
exeExtensionDistribution.Simple.BuildPaths
exeExtensionsDistribution.Simple.Utils
exeModulesDistribution.Types.Executable, Distribution.PackageDescription
exeModulesAutogenDistribution.Types.Executable, Distribution.PackageDescription
exeName 
1 (Function)Distribution.Types.Executable, Distribution.PackageDescription
2 (Function)Distribution.Types.Executable.Lens, Distribution.Types.Lens
exeScope 
1 (Function)Distribution.Types.Executable, Distribution.PackageDescription
2 (Function)Distribution.Types.Executable.Lens, Distribution.Types.Lens
ExistentialQuantificationLanguage.Haskell.Extension, Distribution.Simple
existsAndIsMoreRecentThanDistribution.Simple.Utils
expDistribution.Compat.Prelude.Internal
expandOpenUnitIdDistribution.Backpack.FullUnitId
expandUnitIdDistribution.Backpack.FullUnitId
explainGlobSyntaxErrorDistribution.Simple.Glob
explanationDistribution.PackageDescription.Check
explicitEitherParsecDistribution.Parsec.Class
ExplicitForAllLanguage.Haskell.Extension, Distribution.Simple
explicitLibModulesDistribution.Types.Library, Distribution.PackageDescription
ExplicitNamespacesLanguage.Haskell.Extension, Distribution.Simple
exponentDistribution.Compat.Prelude.Internal
exposeDistribution.Simple.Program.HcPkg
exposed 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
ExposedModule 
1 (Type/Class)Distribution.Types.ExposedModule, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Data Constructor)Distribution.Types.ExposedModule, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
exposedModules 
1 (Function)Distribution.Types.Library, Distribution.PackageDescription
2 (Function)Distribution.Types.Library.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
exposedNameDistribution.Types.ExposedModule, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
exposedReexportDistribution.Types.ExposedModule, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
exposeInvocationDistribution.Simple.Program.HcPkg
extendConfiguredComponentMapDistribution.Backpack.ConfiguredComponent
ExtendedDefaultRulesLanguage.Haskell.Extension, Distribution.Simple
extendLinkedComponentMapDistribution.Backpack.LinkedComponent
ExtensibleRecordsLanguage.Haskell.Extension, Distribution.Simple
ExtensionLanguage.Haskell.Extension, Distribution.Simple
extensionsToFlagsDistribution.Simple.Compiler, Distribution.Simple
externalPackageDepsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
extraBundledLibs 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
extraConfigArgsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
extractConditionDistribution.Types.CondTree, Distribution.PackageDescription.Configuration
extractConditionsDistribution.PackageDescription.Configuration
extraDocFiles 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
extraFrameworkDirs 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
extraGHCiLibraries 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
extraGHCiLibs 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
extraLibDirs 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
extraLibFlavours 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
extraLibraries 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
extraLibs 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
ExtraOptionsDistribution.TestSuite
extraSrcFiles 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
extraTmpFiles 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
FailDistribution.TestSuite
failDistribution.Compat.Prelude.Internal
failProgressDistribution.Utils.Progress
failReadEDistribution.ReadE
FailuresDistribution.Simple.Setup
FairDistribution.SPDX.LicenseId, Distribution.SPDX
FalseDistribution.Compat.Prelude.Internal
falseArgDistribution.Simple.Setup
Fawkes_Runtime_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
Field 
1 (Type/Class)Distribution.Parsec.Field, Distribution.Parsec.Parser
2 (Data Constructor)Distribution.Parsec.Field, Distribution.Parsec.Parser
fieldAnnDistribution.Parsec.Field
fieldDescrParseDistribution.FieldGrammar.FieldDescrs
fieldDescrPrettyDistribution.FieldGrammar.FieldDescrs
FieldDescrsDistribution.FieldGrammar.FieldDescrs
fieldDescrsToListDistribution.FieldGrammar.FieldDescrs
FieldGrammarDistribution.FieldGrammar.Class, Distribution.FieldGrammar
fieldGrammarKnownFieldListDistribution.FieldGrammar.Parsec, Distribution.FieldGrammar
FieldLine 
1 (Type/Class)Distribution.Parsec.Field, Distribution.Parsec.Parser
2 (Data Constructor)Distribution.Parsec.Field, Distribution.Parsec.Parser
fieldLinesToStreamDistribution.Parsec.FieldLineStream
FieldLineStreamDistribution.Parsec.FieldLineStream
fieldLineStreamFromBSDistribution.Parsec.FieldLineStream
fieldLineStreamFromStringDistribution.Parsec.FieldLineStream
FieldNameDistribution.Parsec.Field
fieldNameDistribution.Parsec.Field
FieldsDistribution.FieldGrammar.Parsec, Distribution.FieldGrammar
fieldUniverseDistribution.Parsec.Field
fileGlobMatchesDistribution.Simple.Glob
filenameCDialectDistribution.Simple.CCompiler
FilePathDistribution.Compat.Prelude.Internal
FilePathNT 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
filterDistribution.Compat.Prelude.Internal
filterMDistribution.Compat.Prelude.Internal
finalizePackageDescriptionDistribution.PackageDescription.Configuration
finalizePDDistribution.PackageDescription.Configuration
findDistribution.Compat.Prelude.Internal
findAllFilesWithExtensionDistribution.Simple.Utils
findDistPrefDistribution.Simple.Configure
findDistPrefOrDefaultDistribution.Simple.Configure
findDuplicateFlagAssignmentsDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
findFileDistribution.Simple.Utils
findFileWithExtensionDistribution.Simple.Utils
findFileWithExtension'Distribution.Simple.Utils
findFirstFileDistribution.Simple.Utils
findHookedPackageDescDistribution.Simple.Utils
findModuleFileDistribution.Simple.Utils
findModuleFilesDistribution.Simple.Utils
findPackageDescDistribution.Simple.Utils
findProgramLocationDistribution.Simple.Utils, Distribution.Simple.Program
findProgramOnPathDistribution.Simple.Program
findProgramOnSearchPathDistribution.Simple.Program.Find, Distribution.Simple.Program
findProgramVersionDistribution.Simple.Utils, Distribution.Simple.Program
FinishedDistribution.TestSuite
firstDistribution.Compat.Prelude.Internal
Flag 
1 (Type/Class)Distribution.Simple.Flag, Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Flag, Distribution.Simple.Setup
3 (Data Constructor)Distribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
4 (Type/Class)Distribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
5 (Type/Class)Distribution.Simple.Compiler
FlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
flagAssignmentDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
flagDebugInfoDistribution.Simple.GHC
flagDefault 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
flagDescription 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
flagFieldGrammarDistribution.PackageDescription.FieldGrammar
flagGhciScriptDistribution.Simple.GHC
flagManual 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
FlagNameDistribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
flagName 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
flagPackageConf 
1 (Function)Distribution.Simple.GHC
2 (Function)Distribution.Simple.Program.HcPkg
flagProfAutoDistribution.Simple.GHC
flagToDebugInfoLevelDistribution.Simple.Compiler, Distribution.Simple
flagToListDistribution.Simple.Flag, Distribution.Simple.Setup
flagToMaybeDistribution.Simple.Flag, Distribution.Simple.Setup
flagToOptimisationLevelDistribution.Simple.Compiler, Distribution.Simple
flagToProfDetailLevelDistribution.Simple.Compiler, Distribution.Simple
flagToVerbosityDistribution.Verbosity
flagWarnMissingHomeModulesDistribution.Simple.GHC
flatStyleDistribution.Pretty, Distribution.Text
flattenPackageDescriptionDistribution.PackageDescription.Configuration
FlexibleContextsLanguage.Haskell.Extension, Distribution.Simple
FlexibleInstancesLanguage.Haskell.Extension, Distribution.Simple
flibBuildDirDistribution.Simple.BuildPaths
FLibComponentLocalBuildInfoDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
flibdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
flipDistribution.Compat.Prelude.Internal
FloatDistribution.Compat.Prelude.Internal
floatDigitsDistribution.Compat.Prelude.Internal
FloatingDistribution.Compat.Prelude.Internal
floatRadixDistribution.Compat.Prelude.Internal
floatRangeDistribution.Compat.Prelude.Internal
floorDistribution.Compat.Prelude.Internal
FLSConsDistribution.Parsec.FieldLineStream
FLSLastDistribution.Parsec.FieldLineStream
FLTK_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
fmapDistribution.Compat.Prelude.Internal
FoldableDistribution.Compat.Prelude.Internal
foldComponentDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
foldlDistribution.Compat.Prelude.Internal
foldl'Distribution.Compat.Prelude.Internal
foldl1Distribution.Compat.Prelude.Internal
foldMDistribution.Compat.Prelude.Internal
foldMapDistribution.Compat.Prelude.Internal
foldProgressDistribution.Utils.Progress
foldrDistribution.Compat.Prelude.Internal
foldr1Distribution.Compat.Prelude.Internal
foldVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
foldVersionRange'Distribution.Version, Distribution.Simple
Font_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
forDistribution.Compat.Prelude.Internal
ForDevelopmentDistribution.Simple.Setup
ForeignFunctionInterfaceLanguage.Haskell.Extension, Distribution.Simple
ForeignLib 
1 (Type/Class)Distribution.Types.ForeignLib, Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
2 (Data Constructor)Distribution.Types.ForeignLib
foreignLibBuildInfo 
1 (Function)Distribution.Types.ForeignLib
2 (Function)Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
foreignLibFieldGrammarDistribution.PackageDescription.FieldGrammar
foreignLibIsSharedDistribution.Types.ForeignLib
foreignLibModDefFile 
1 (Function)Distribution.Types.ForeignLib
2 (Function)Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
foreignLibModulesDistribution.Types.ForeignLib
foreignLibName 
1 (Function)Distribution.Types.ForeignLib
2 (Function)Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
ForeignLibNativeSharedDistribution.Types.ForeignLibType
ForeignLibNativeStaticDistribution.Types.ForeignLibType
ForeignLibOptionDistribution.Types.ForeignLibOption
foreignLibOptions 
1 (Function)Distribution.Types.ForeignLib
2 (Function)Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
foreignLibs 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
ForeignLibStandaloneDistribution.Types.ForeignLibOption
ForeignLibTypeDistribution.Types.ForeignLibType
foreignLibType 
1 (Function)Distribution.Types.ForeignLib
2 (Function)Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
foreignLibTypeIsSharedDistribution.Types.ForeignLibType
ForeignLibTypeUnknownDistribution.Types.ForeignLibType
foreignLibVersionDistribution.Types.ForeignLib
foreignLibVersionInfo 
1 (Function)Distribution.Types.ForeignLib
2 (Function)Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
foreignLibVersionLinux 
1 (Function)Distribution.Types.ForeignLib
2 (Function)Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
ForHackageDistribution.Simple.Setup
for_Distribution.Compat.Prelude.Internal
FoundOnSystemDistribution.Simple.Program.Types, Distribution.Simple.Program
FractionalDistribution.Compat.Prelude.Internal
frameworkDirs 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
frameworks 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
Frameworx_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
FreeBSDDistribution.System
FreeImageDistribution.SPDX.LicenseId, Distribution.SPDX
Freertos_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
FreeText 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
freeVarsDistribution.PackageDescription.Configuration
fromComponentsDistribution.ModuleName
fromDepMapDistribution.Types.DependencyMap
fromDistinctListDistribution.Compat.Graph
fromEnumDistribution.Compat.Prelude.Internal
fromFlagDistribution.Simple.Flag, Distribution.Simple.Setup
fromFlagOrDefaultDistribution.Simple.Flag, Distribution.Simple.Setup
fromIntegerDistribution.Compat.Prelude.Internal
fromIntegralDistribution.Compat.Prelude.Internal
fromList 
1 (Function)Distribution.Compat.DList
2 (Function)Distribution.Simple.PackageIndex
fromMaybeDistribution.Compat.Prelude.Internal
fromNubListDistribution.Utils.NubList
fromNubListRDistribution.Utils.NubList
fromPathTemplateDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
fromRationalDistribution.Compat.Prelude.Internal
fromShortTextDistribution.Utils.ShortText
FromStringDistribution.InstalledPackageInfo
fromStringDistribution.Compat.Prelude.Internal, Distribution.ModuleName
fromUTF8BSDistribution.Utils.Generic, Distribution.Simple.Utils
fromUTF8LBSDistribution.Utils.Generic, Distribution.Simple.Utils
fromVersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
FSep 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
FSFAPDistribution.SPDX.LicenseId, Distribution.SPDX
FSFULDistribution.SPDX.LicenseId, Distribution.SPDX
FSFULLRDistribution.SPDX.LicenseId, Distribution.SPDX
fstDistribution.Compat.Prelude.Internal
FTLDistribution.SPDX.LicenseId, Distribution.SPDX
FullDbDistribution.Backpack.FullUnitId
FullUnitId 
1 (Type/Class)Distribution.Backpack.FullUnitId
2 (Data Constructor)Distribution.Backpack.FullUnitId
FunctionalDependenciesLanguage.Haskell.Extension, Distribution.Simple
FunctorDistribution.Compat.Prelude.Internal
GADTsLanguage.Haskell.Extension, Distribution.Simple
GADTSyntaxLanguage.Haskell.Extension, Distribution.Simple
gatherDistribution.Compat.ReadP
GBinaryGetDistribution.Compat.Binary
GBinaryPutDistribution.Compat.Binary
gccProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
GCC_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
GCC_exception_3_1Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
gcdDistribution.Compat.Prelude.Internal
generalInstalledPackageInfoDistribution.Simple.Register
GeneralizedNewtypeDerivingLanguage.Haskell.Extension, Distribution.Simple
generate 
1 (Function)Distribution.Simple.Build.PathsModule
2 (Function)Distribution.Simple.Build.Macros
generatePackageVersionMacrosDistribution.Simple.Build.Macros
generateRegistrationInfoDistribution.Simple.Register
GenericDistribution.Compat.Prelude.Internal
GenericPackageDescription 
1 (Type/Class)Distribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
genericRnfDistribution.Compat.Prelude.Internal
GenericsLanguage.Haskell.Extension, Distribution.Simple
genPackageFlags 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
GetDistribution.Compat.Binary
get 
1 (Function)Distribution.Compat.Binary, Distribution.Compat.Prelude.Internal
2 (Function)Distribution.Compat.ReadP
getAllDistribution.Compat.Semigroup
getAllInternalToolDependenciesDistribution.Simple.BuildToolDepends
getAllToolDependenciesDistribution.Simple.BuildToolDepends
getAnyDistribution.Compat.Semigroup
getCabalSpecVersionDistribution.Parsec.ParseResult
getCharDistribution.Compat.Prelude.Internal
getCompilerVersionDistribution.Simple.HaskellSuite
getComponentDistribution.Types.PackageDescription, Distribution.Simple.LocalBuildInfo
getComponentLocalBuildInfoDistribution.Simple.LocalBuildInfo
getConfigStateFileDistribution.Simple.Configure
getContentsDistribution.Compat.Prelude.Internal
getCurTimeDistribution.Compat.Time
getDbProgramOutputDistribution.Simple.Program
getDirectoryContentsDistribution.PackageDescription.Check
getDirectoryContentsRecursiveDistribution.Simple.Utils
getEffectiveEnvironmentDistribution.Simple.Program.Run
getExeSourceFilesDistribution.Simple.BuildPaths
getExtensionsDistribution.Simple.HaskellSuite
getFileAgeDistribution.Compat.Time
getFileContentsDistribution.PackageDescription.Check
getFilePathNTDistribution.Parsec.Newtypes
getFLibSourceFilesDistribution.Simple.BuildPaths
getFreeTextDistribution.Parsec.Newtypes
getGhcInfoDistribution.Simple.GHC
getGlobalPackageDB 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
getHSLibraryNameDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
getImplInfoDistribution.Simple.GHC
getInputDistribution.Parsec.LexerMonad
getInstalledPackages 
1 (Function)Distribution.Simple.UHC
2 (Function)Distribution.Simple.HaskellSuite
3 (Function)Distribution.Simple.GHCJS
4 (Function)Distribution.Simple.GHC
5 (Function)Distribution.Simple.Configure
getInstalledPackagesMonitorFiles 
1 (Function)Distribution.Simple.GHC
2 (Function)Distribution.Simple.Configure
getInternalPackagesDistribution.Simple.Configure
getLanguagesDistribution.Simple.HaskellSuite
getLast'Distribution.Compat.Semigroup
getLibDir 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
getLibSourceFilesDistribution.Simple.BuildPaths
getLineDistribution.Compat.Prelude.Internal
getModTimeDistribution.Compat.Time
getMQuotedDistribution.Parsec.Newtypes
getNameDistribution.Parsec.Field
getNormalCommandDescriptionsDistribution.Simple.Command
getPackageDBContents 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
3 (Function)Distribution.Simple.Configure
getPersistBuildConfigDistribution.Simple.Configure
getPosDistribution.Parsec.LexerMonad
getProgramInvocationOutputDistribution.Simple.Program.Run, Distribution.Simple.Program
getProgramInvocationOutputAndErrorsDistribution.Simple.Program.Run
getProgramOutputDistribution.Simple.Program
getProgramSearchPathDistribution.Simple.Program.Db, Distribution.Simple.Program
getSourceFilesDistribution.Simple.BuildPaths
getSpecLicenseDistribution.Parsec.Newtypes
getSpecVersionDistribution.Parsec.Newtypes
getStartCodeDistribution.Parsec.LexerMonad
getSystemSearchPathDistribution.Simple.Program.Find
getTestedWithDistribution.Parsec.Newtypes
GettingDistribution.Compat.Lens
gettingDistribution.Compat.Lens
getTokenDistribution.Parsec.Newtypes
getToken'Distribution.Parsec.Newtypes
getWord8Distribution.Compat.Binary
GFDL_1_1_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
GFDL_1_1_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
GFDL_1_2_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
GFDL_1_2_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
GFDL_1_3_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
GFDL_1_3_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
ggetDistribution.Compat.Binary
GHCDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
GhcDynamicOnlyDistribution.Simple.Program.GHC
GhcDynLinkModeDistribution.Simple.Program.GHC
GhcEnvFileClearPackageDbStackDistribution.Simple.GHC
GhcEnvFileCommentDistribution.Simple.GHC
GhcEnvFilePackageDbDistribution.Simple.GHC
GhcEnvFilePackageIdDistribution.Simple.GHC
GhcEnvironmentFileEntryDistribution.Simple.GHC
GHCForeignImportPrimLanguage.Haskell.Extension, Distribution.Simple
GhcImplInfo 
1 (Type/Class)Distribution.Simple.GHC
2 (Data Constructor)Distribution.Simple.GHC
ghcInvocationDistribution.Simple.Program.GHC
GHCJSDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
GhcjsDistribution.System
ghcjsPkgProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
ghcjsProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
GhcMaximumOptimisationDistribution.Simple.Program.GHC
GhcModeDistribution.Simple.Program.GHC
GhcModeAbiHashDistribution.Simple.Program.GHC
GhcModeCompileDistribution.Simple.Program.GHC
GhcModeInteractiveDistribution.Simple.Program.GHC
GhcModeLinkDistribution.Simple.Program.GHC
GhcModeMakeDistribution.Simple.Program.GHC
GhcNoOptimisationDistribution.Simple.Program.GHC
GhcNormalOptimisationDistribution.Simple.Program.GHC
ghcOptCabalDistribution.Simple.Program.GHC
ghcOptCcOptionsDistribution.Simple.Program.GHC
ghcOptCppIncludePathDistribution.Simple.Program.GHC
ghcOptCppIncludesDistribution.Simple.Program.GHC
ghcOptCppOptionsDistribution.Simple.Program.GHC
ghcOptCxxOptionsDistribution.Simple.Program.GHC
ghcOptDebugInfoDistribution.Simple.Program.GHC
ghcOptDylibNameDistribution.Simple.Program.GHC
ghcOptDynHiSuffixDistribution.Simple.Program.GHC
ghcOptDynLinkModeDistribution.Simple.Program.GHC
ghcOptDynObjSuffixDistribution.Simple.Program.GHC
ghcOptExtensionMapDistribution.Simple.Program.GHC
ghcOptExtensionsDistribution.Simple.Program.GHC
ghcOptExtraDistribution.Simple.Program.GHC
ghcOptExtraDefaultDistribution.Simple.Program.GHC
ghcOptExtraPathDistribution.Simple.Program.GHC
ghcOptFfiIncludesDistribution.Simple.Program.GHC
ghcOptFPicDistribution.Simple.Program.GHC
ghcOptGHCiScriptsDistribution.Simple.Program.GHC
ghcOptHideAllPackagesDistribution.Simple.Program.GHC
ghcOptHiDirDistribution.Simple.Program.GHC
ghcOptHiSuffixDistribution.Simple.Program.GHC
ghcOptHPCDirDistribution.Simple.Program.GHC
GhcOptimisationDistribution.Simple.Program.GHC
ghcOptInputFilesDistribution.Simple.Program.GHC
ghcOptInputModulesDistribution.Simple.Program.GHC
ghcOptInstantiatedWithDistribution.Simple.Program.GHC
GhcOptions 
1 (Type/Class)Distribution.Simple.Program.GHC
2 (Data Constructor)Distribution.Simple.Program.GHC
ghcOptLanguageDistribution.Simple.Program.GHC
ghcOptLinkFrameworkDirsDistribution.Simple.Program.GHC
ghcOptLinkFrameworksDistribution.Simple.Program.GHC
ghcOptLinkLibPathDistribution.Simple.Program.GHC
ghcOptLinkLibsDistribution.Simple.Program.GHC
ghcOptLinkModDefFilesDistribution.Simple.Program.GHC
ghcOptLinkNoHsMainDistribution.Simple.Program.GHC
ghcOptLinkOptionsDistribution.Simple.Program.GHC
ghcOptModeDistribution.Simple.Program.GHC
ghcOptNoAutoLinkPackagesDistribution.Simple.Program.GHC
ghcOptNoCodeDistribution.Simple.Program.GHC
ghcOptNoLinkDistribution.Simple.Program.GHC
ghcOptNumJobsDistribution.Simple.Program.GHC
ghcOptObjDirDistribution.Simple.Program.GHC
ghcOptObjSuffixDistribution.Simple.Program.GHC
ghcOptOptimisationDistribution.Simple.Program.GHC
ghcOptOutputDirDistribution.Simple.Program.GHC
ghcOptOutputDynFileDistribution.Simple.Program.GHC
ghcOptOutputFileDistribution.Simple.Program.GHC
ghcOptPackageDBsDistribution.Simple.Program.GHC
ghcOptPackagesDistribution.Simple.Program.GHC
ghcOptProfilingAutoDistribution.Simple.Program.GHC
ghcOptProfilingModeDistribution.Simple.Program.GHC
ghcOptRPathsDistribution.Simple.Program.GHC
ghcOptSharedDistribution.Simple.Program.GHC
ghcOptSourcePathDistribution.Simple.Program.GHC
ghcOptSourcePathClearDistribution.Simple.Program.GHC
ghcOptSplitObjsDistribution.Simple.Program.GHC
ghcOptSplitSectionsDistribution.Simple.Program.GHC
ghcOptStaticLibDistribution.Simple.Program.GHC
ghcOptStubDirDistribution.Simple.Program.GHC
ghcOptThisComponentIdDistribution.Simple.Program.GHC
ghcOptThisUnitIdDistribution.Simple.Program.GHC
ghcOptVerbosityDistribution.Simple.Program.GHC
ghcOptWarnMissingHomeModulesDistribution.Simple.Program.GHC
ghcPkgProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
ghcPlatformAndVersionStringDistribution.Simple.GHC
GhcProfAutoDistribution.Simple.Program.GHC
GhcProfAutoAllDistribution.Simple.Program.GHC
GhcProfAutoExportedDistribution.Simple.Program.GHC
GhcProfAutoToplevelDistribution.Simple.Program.GHC
ghcProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
GhcSpecialOptimisationDistribution.Simple.Program.GHC
GhcStaticAndDynamicDistribution.Simple.Program.GHC
GhcStaticOnlyDistribution.Simple.Program.GHC
GiftwareDistribution.SPDX.LicenseId, Distribution.SPDX
GitDistribution.Types.SourceRepo, Distribution.PackageDescription
GL2PSDistribution.SPDX.LicenseId, Distribution.SPDX
GlideDistribution.SPDX.LicenseId, Distribution.SPDX
GlobDistribution.Simple.Glob
globalCommandDistribution.Simple.Setup
GlobalFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
globalNumericVersionDistribution.Simple.Setup
GlobalPackageDBDistribution.Simple.Compiler, Distribution.Simple
globalVersionDistribution.Simple.Setup
GlobMatchDistribution.Simple.Glob
GlobMissingDirectoryDistribution.Simple.Glob
GlobResultDistribution.Simple.Glob
GlobstarDistribution.CabalSpecVersion
GlobSyntaxErrorDistribution.Simple.Glob
GlobWarnMultiDotDistribution.Simple.Glob
GlulxeDistribution.SPDX.LicenseId, Distribution.SPDX
gmappendDistribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
gmemptyDistribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
GnuArchDistribution.Types.SourceRepo, Distribution.PackageDescription
GnuplotDistribution.SPDX.LicenseId, Distribution.SPDX
Gnu_javamail_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
GPLDistribution.License, Distribution.Make, Distribution.Simple
GPL_1_0_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
GPL_1_0_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
GPL_2_0_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
GPL_2_0_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
GPL_3_0_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
GPL_3_0_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
gputDistribution.Compat.Binary
GraphDistribution.Compat.Graph
greencardProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
GroupDistribution.TestSuite
GroupLogsDistribution.Simple.Test.Log
groupNameDistribution.TestSuite
groupTestsDistribution.TestSuite
GSOAP_1_3bDistribution.SPDX.LicenseId, Distribution.SPDX
GTDistribution.Compat.Prelude.Internal
guessWayDistribution.Simple.Hpc
haddockDistribution.Simple.Haddock
haddockArgsDistribution.Simple.Setup
haddockBenchmarksDistribution.Simple.Setup
haddockCabalFilePathDistribution.Simple.Setup
haddockCommandDistribution.Simple.Setup
haddockContentsDistribution.Simple.Setup
haddockCssDistribution.Simple.Setup
haddockdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
haddockDirNameDistribution.Simple.BuildPaths
haddockDistPrefDistribution.Simple.Setup
haddockExecutablesDistribution.Simple.Setup
HaddockFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
haddockForeignLibsDistribution.Simple.Setup
haddockForHackageDistribution.Simple.Setup
haddockHoogleDistribution.Simple.Setup
haddockHookDistribution.Simple.UserHooks, Distribution.Simple
haddockHscolourCssDistribution.Simple.Setup
haddockHtmlDistribution.Simple.Setup
haddockHtmlLocationDistribution.Simple.Setup
haddockHTMLs 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
haddockInterfaces 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
haddockInternalDistribution.Simple.Setup
haddockKeepTempFilesDistribution.Simple.Setup
haddockLinkedSourceDistribution.Simple.Setup
haddockNameDistribution.Simple.BuildPaths
haddockOptionsDistribution.Simple.Setup
haddockPackagePathsDistribution.Simple.Haddock
haddockPrefDistribution.Simple.BuildPaths
haddockProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
haddockProgramArgsDistribution.Simple.Setup
haddockProgramPathsDistribution.Simple.Setup
haddockQuickJumpDistribution.Simple.Setup
HaddockTargetDistribution.Simple.Setup
haddockTestSuitesDistribution.Simple.Setup
haddockVerbosityDistribution.Simple.Setup
HaLVMDistribution.System
handleDoesNotExistDistribution.Simple.Utils
happyProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
hasBenchmarksDistribution.Types.PackageDescription, Distribution.PackageDescription
HasBuildInfoDistribution.Types.BuildInfo.Lens, Distribution.Types.Lens
HasBuildInfosDistribution.Types.BuildInfo.Lens, Distribution.Types.Lens
HasCommonStanzas 
1 (Type/Class)Distribution.CabalSpecVersion
2 (Data Constructor)Distribution.CabalSpecVersion
HasElif 
1 (Type/Class)Distribution.CabalSpecVersion
2 (Data Constructor)Distribution.CabalSpecVersion
hasExesDistribution.Types.PackageDescription, Distribution.PackageDescription
hasForeignLibsDistribution.Types.PackageDescription
HasGlobstar 
1 (Type/Class)Distribution.CabalSpecVersion
2 (Data Constructor)Distribution.CabalSpecVersion
hashModuleSubstDistribution.Backpack
Haskell2010Language.Haskell.Extension, Distribution.Simple
Haskell98Language.Haskell.Extension, Distribution.Simple
HaskellReportDistribution.SPDX.LicenseId, Distribution.SPDX
HaskellSuiteDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
haskellSuitePkgProgramDistribution.Simple.Program.Builtin
haskellSuiteProgramDistribution.Simple.Program.Builtin
hasLibsDistribution.Types.PackageDescription, Distribution.PackageDescription
hasLowerBoundDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
HasMungedPackageIdDistribution.Package, Distribution.Make, Distribution.Simple
hasPublicLibDistribution.Types.PackageDescription, Distribution.PackageDescription
hasTestsDistribution.Types.PackageDescription, Distribution.PackageDescription
HasUnitIdDistribution.Package, Distribution.Make, Distribution.Simple
hasUpperBoundDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
HBCDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
hcOptionsDistribution.Types.BuildInfo, Distribution.PackageDescription
HcPkgInfo 
1 (Type/Class)Distribution.Simple.Program.HcPkg
2 (Data Constructor)Distribution.Simple.Program.HcPkg
hcPkgInfo 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
hcPkgProgramDistribution.Simple.Program.HcPkg
hcProfOptionsDistribution.Types.BuildInfo, Distribution.PackageDescription
hcSharedOptionsDistribution.Types.BuildInfo, Distribution.PackageDescription
hcStaticOptionsDistribution.Types.BuildInfo, Distribution.PackageDescription
headDistribution.Compat.Prelude.Internal
HeliumDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
helpCommandUIDistribution.Simple.Command
HereDocumentsLanguage.Haskell.Extension, Distribution.Simple
hexDigitDistribution.Compat.CharParsing
HexFloatLiteralsLanguage.Haskell.Extension, Distribution.Simple
hGetContentsDistribution.Utils.IOData
HiddenCommandDistribution.Simple.Command
hiddenCommandDistribution.Simple.Command
hiddenFieldDistribution.FieldGrammar.Class, Distribution.FieldGrammar
hiddenModules 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
hideDistribution.Simple.Program.HcPkg
hideInvocationDistribution.Simple.Program.HcPkg
HidingRenamingDistribution.Types.ModuleRenaming, Distribution.PackageDescription
hmakeProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
homepage 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
HookedBuildInfoDistribution.Types.HookedBuildInfo, Distribution.PackageDescription
hookedPreProcessorsDistribution.Simple.UserHooks, Distribution.Simple
hookedProgramsDistribution.Simple.UserHooks, Distribution.Simple
hostPlatformDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
hpcProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
HPNDDistribution.SPDX.LicenseId, Distribution.SPDX
HppaDistribution.System
hPutContentsDistribution.Utils.IOData
HPUXDistribution.System
hsc2hsProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
hscolourDistribution.Simple.Haddock
hscolourBenchmarksDistribution.Simple.Setup
hscolourCabalFilePathDistribution.Simple.Setup
hscolourCommandDistribution.Simple.Setup
hscolourCSSDistribution.Simple.Setup
hscolourDistPrefDistribution.Simple.Setup
hscolourExecutablesDistribution.Simple.Setup
HscolourFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
hscolourForeignLibsDistribution.Simple.Setup
hscolourHookDistribution.Simple.UserHooks, Distribution.Simple
hscolourPrefDistribution.Simple.BuildPaths
hscolourProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
hscolourTestSuitesDistribution.Simple.Setup
hscolourVerbosityDistribution.Simple.Setup
hsLibraries 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
hsSourceDirs 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
hstoolVersionDistribution.Simple.HaskellSuite
htmlDirDistribution.Simple.Hpc
htmldirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
HtmldirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
HugsDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
HurdDistribution.System
hyloVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
I2p_gpl_java_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
I386Distribution.System
IA64Distribution.System
IBM_pibsDistribution.SPDX.LicenseId, Distribution.SPDX
ICUDistribution.SPDX.LicenseId, Distribution.SPDX
idDistribution.Compat.Prelude.Internal
ignoreBOMDistribution.Utils.Generic, Distribution.Simple.Utils
ignoreConditionsDistribution.Types.CondTree
IJGDistribution.SPDX.LicenseId, Distribution.SPDX
ImageMagickDistribution.SPDX.LicenseId, Distribution.SPDX
IMatixDistribution.SPDX.LicenseId, Distribution.SPDX
Imlib2Distribution.SPDX.LicenseId, Distribution.SPDX
ImplDistribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
ImplicitParamsLanguage.Haskell.Extension, Distribution.Simple
ImplicitPreludeLanguage.Haskell.Extension, Distribution.Simple
importDirs 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
ImpredicativeTypesLanguage.Haskell.Extension, Distribution.Simple
includedirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
includeDirs 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
includeProvidesRnDistribution.Types.IncludeRenaming
IncludeRenaming 
1 (Type/Class)Distribution.Types.IncludeRenaming
2 (Data Constructor)Distribution.Types.IncludeRenaming
includeRequiresRnDistribution.Types.IncludeRenaming
includes 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
InclusiveBoundDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
IncoherentInstancesLanguage.Haskell.Extension, Distribution.Simple
incPosDistribution.Parsec.Common
IndefFullUnitIdDistribution.Backpack
indefinite 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
IndentDistribution.Parsec.Lexer
indentWithDistribution.Pretty
infoDistribution.Simple.Utils
infoNoWrapDistribution.Simple.Utils
infoProgressDistribution.Utils.LogProgress
Info_ZIPDistribution.SPDX.LicenseId, Distribution.SPDX
init 
1 (Function)Distribution.Compat.Prelude.Internal
2 (Function)Distribution.Simple.Program.HcPkg
initialBuildStepsDistribution.Simple.Build
initialPathTemplateEnvDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
initInvocationDistribution.Simple.Program.HcPkg
initPackageDB 
1 (Function)Distribution.Simple.HaskellSuite
2 (Function)Distribution.Simple.Register
inplaceInstalledPackageInfoDistribution.Simple.Register
inplacePackageDbPathDistribution.Simple.UHC
InputStreamDistribution.Parsec.LexerMonad
insert 
1 (Function)Distribution.Compat.Graph
2 (Function)Distribution.Simple.PackageIndex
insertFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
installDistribution.Simple.Install
installCabalFilePathDistribution.Simple.Setup
installCommandDistribution.Simple.Setup
installDestDistribution.Simple.Setup
installDirectoryContentsDistribution.Simple.Utils
InstallDirs 
1 (Type/Class)Distribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
2 (Data Constructor)Distribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
installDirsOptionsDistribution.Simple.Setup
installDirsTemplateEnvDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
InstallDirTemplatesDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
installDirTemplatesDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
installDistPrefDistribution.Simple.Setup
installedComponentIdDistribution.InstalledPackageInfo
installedComponentId_ 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
installedDependsDistribution.Package, Distribution.Make, Distribution.Simple
installedOpenUnitIdDistribution.InstalledPackageInfo
InstalledPackageIdDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
installedPackageId 
1 (Function)Distribution.Package, Distribution.Make, Distribution.Simple
2 (Function)Distribution.InstalledPackageInfo
InstalledPackageIndexDistribution.Simple.PackageIndex
InstalledPackageInfo 
1 (Type/Class)Distribution.Types.InstalledPackageInfo, Distribution.Types.InstalledPackageInfo.Lens, Distribution.InstalledPackageInfo
2 (Data Constructor)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
installedPkgsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
installedUnitId 
1 (Function)Distribution.Package, Distribution.Make, Distribution.Simple
2 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
3 (Function)Distribution.Types.InstalledPackageInfo.Lens
installExe 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
installExecutableFileDistribution.Simple.Utils
installExecutableFilesDistribution.Simple.Utils
InstallFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
installFLibDistribution.Simple.GHC
installIncludes 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
installInPlaceDistribution.Simple.Setup
installLib 
1 (Function)Distribution.Simple.UHC
2 (Function)Distribution.Simple.HaskellSuite
3 (Function)Distribution.Simple.GHCJS
4 (Function)Distribution.Simple.GHC
installMaybeExecutableFileDistribution.Simple.Utils
installMaybeExecutableFilesDistribution.Simple.Utils
installOrdinaryFileDistribution.Simple.Utils
installOrdinaryFilesDistribution.Simple.Utils
installPackageDBDistribution.Simple.Setup
installUseWrapperDistribution.Simple.Setup
installVerbosityDistribution.Simple.Setup
InstanceSigsLanguage.Haskell.Extension, Distribution.Simple
instantiatedWith 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
instHookDistribution.Simple.UserHooks, Distribution.Simple
IntDistribution.Compat.Prelude.Internal
Int16Distribution.Compat.Prelude.Internal
Int32Distribution.Compat.Prelude.Internal
Int64Distribution.Compat.Prelude.Internal
Int8Distribution.Compat.Prelude.Internal
IntegerDistribution.Compat.Prelude.Internal
IntegralDistribution.Compat.Prelude.Internal
integralDistribution.Compat.CharParsing
IntelDistribution.SPDX.LicenseId, Distribution.SPDX
Intel_ACPIDistribution.SPDX.LicenseId, Distribution.SPDX
interactDistribution.Compat.Prelude.Internal
Interbase_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
intercalateDistribution.Compat.Prelude.Internal, Distribution.Utils.Generic, Distribution.Simple.Utils
internalPackageDBPathDistribution.Simple.Register
interpModuleRenamingDistribution.Types.ModuleRenaming
interpretPackageDbFlagsDistribution.Simple.Configure
InterruptibleFFILanguage.Haskell.Extension, Distribution.Simple
intersectVersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
IntersectVersionRangesDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
intersectVersionRangesDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
IntersectVersionRangesFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
intersperseDistribution.Compat.Prelude.Internal
intToVerbosityDistribution.Verbosity
invertVersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
invertVersionRangeDistribution.Version, Distribution.Simple
invocationAsBatchFileDistribution.Simple.Program.Script
invocationAsShellScriptDistribution.Simple.Program.Script
invocationAsSystemScriptDistribution.Simple.Program.Script
invokeDistribution.Simple.Program.HcPkg
invokeHcPkgDistribution.Simple.Register
in_field_bracesDistribution.Parsec.Lexer
in_field_layoutDistribution.Parsec.Lexer
in_sectionDistribution.Parsec.Lexer
IODistribution.Compat.Prelude.Internal
IODataDistribution.Utils.IOData, Distribution.Simple.Utils
IODataBinaryDistribution.Utils.IOData, Distribution.Simple.Utils
IODataModeDistribution.Utils.IOData, Distribution.Simple.Utils
IODataModeBinaryDistribution.Utils.IOData, Distribution.Simple.Utils
IODataModeTextDistribution.Utils.IOData, Distribution.Simple.Utils
IODataTextDistribution.Utils.IOData, Distribution.Simple.Utils
IOEncodingDistribution.Simple.Program.Run
IOEncodingTextDistribution.Simple.Program.Run
IOEncodingUTF8Distribution.Simple.Program.Run
IOErrorDistribution.Compat.Prelude.Internal
ioErrorDistribution.Compat.Prelude.Internal
IOSDistribution.System
IPADistribution.SPDX.LicenseId, Distribution.SPDX
ipiFieldGrammarDistribution.Types.InstalledPackageInfo.FieldGrammar
IPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
IRIXDistribution.System
isAbsoluteOnAnyPlatformDistribution.Utils.Generic, Distribution.Simple.Utils
isAlphaDistribution.Compat.Prelude.Internal
isAlphaNumDistribution.Compat.Prelude.Internal
isAnyVersionDistribution.Version, Distribution.Simple
isAsciiDistribution.Utils.Generic
isAsciiAlphaDistribution.Utils.Generic
isAsciiAlphaNumDistribution.Utils.Generic
ISC 
1 (Data Constructor)Distribution.SPDX.LicenseId, Distribution.SPDX
2 (Data Constructor)Distribution.License, Distribution.Make, Distribution.Simple
isDefaultIncludeRenamingDistribution.Types.IncludeRenaming
isDefaultRenamingDistribution.Types.ModuleRenaming
isDenormalizedDistribution.Compat.Prelude.Internal
isDigitDistribution.Compat.Prelude.Internal
isDynamic 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
isIEEEDistribution.Compat.Prelude.Internal
isInfiniteDistribution.Compat.Prelude.Internal
isInfixOfDistribution.Utils.Generic, Distribution.Simple.Utils
isInSearchPathDistribution.Simple.Utils
isInternalDistribution.Simple.BuildToolDepends
isJustDistribution.Compat.Prelude.Internal
isNaNDistribution.Compat.Prelude.Internal
isNegativeZeroDistribution.Compat.Prelude.Internal
IsNodeDistribution.Compat.Graph
isNothingDistribution.Compat.Prelude.Internal
isNoVersionDistribution.Version, Distribution.Simple
isPrefixOfDistribution.Compat.Prelude.Internal
isRelativeOnAnyPlatformDistribution.Utils.Generic, Distribution.Simple.Utils
isSpaceDistribution.Compat.Prelude.Internal
isSpecificVersionDistribution.Version, Distribution.Simple
IsStringDistribution.Compat.Prelude.Internal
isSuffixOfDistribution.Compat.Prelude.Internal
isUpperDistribution.Compat.Prelude.Internal
isVerboseCallSiteDistribution.Verbosity
isVerboseCallStackDistribution.Verbosity
isVerboseMarkOutputDistribution.Verbosity
isVerboseNoWrapDistribution.Verbosity
isVerboseQuietDistribution.Verbosity
isVerboseTimestampDistribution.Verbosity
isWildcardRangeDistribution.Types.VersionRange
iterateDistribution.Compat.Prelude.Internal
JasPer_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
JavaScriptDistribution.System
JavaScriptFFILanguage.Haskell.Extension, Distribution.Simple
JHCDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
jhcProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
JSONDistribution.SPDX.LicenseId, Distribution.SPDX
jsSources 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
JustDistribution.Compat.Prelude.Internal
KeyDistribution.Compat.Graph
keysDistribution.Compat.Graph
keysSetDistribution.Compat.Graph
KindSignaturesLanguage.Haskell.Extension, Distribution.Simple
knownArchesDistribution.System
knownBenchmarkTypesDistribution.Types.BenchmarkType, Distribution.PackageDescription
knownBuildTypesDistribution.Types.BuildType, Distribution.PackageDescription
knownCompilerFlavorsDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
KnownExtensionLanguage.Haskell.Extension, Distribution.Simple
knownExtensionsLanguage.Haskell.Extension, Distribution.Simple
knownFieldDistribution.FieldGrammar.Class, Distribution.FieldGrammar
knownForeignLibTypesDistribution.Types.ForeignLibType
knownLanguagesLanguage.Haskell.Extension, Distribution.Simple
knownLicensesDistribution.License, Distribution.Simple
knownOSsDistribution.System
knownProfDetailLevelsDistribution.Simple.Compiler, Distribution.Simple
knownProgramsDistribution.Simple.Program.Db, Distribution.Simple.Program
knownRepoTypesDistribution.Types.SourceRepo, Distribution.PackageDescription
knownSuffixHandlersDistribution.Simple.PreProcess
knownTestTypesDistribution.Types.TestType, Distribution.PackageDescription
LDistribution.Parsec.Lexer
LAL_1_2Distribution.SPDX.LicenseId, Distribution.SPDX
LAL_1_3Distribution.SPDX.LicenseId, Distribution.SPDX
LambdaCaseLanguage.Haskell.Extension, Distribution.Simple
LanguageLanguage.Haskell.Extension, Distribution.Simple
languageToFlagsDistribution.Simple.Compiler, Distribution.Simple
lastDistribution.Compat.Prelude.Internal
Last' 
1 (Type/Class)Distribution.Compat.Semigroup
2 (Data Constructor)Distribution.Compat.Semigroup
LaterVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
laterVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
LaterVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
Latex2eDistribution.SPDX.LicenseId, Distribution.SPDX
lcmDistribution.Compat.Prelude.Internal
lc_ann_idDistribution.Backpack.LinkedComponent
lc_cidDistribution.Backpack.LinkedComponent
lc_componentDistribution.Backpack.LinkedComponent
lc_exe_depsDistribution.Backpack.LinkedComponent
lc_includesDistribution.Backpack.LinkedComponent
lc_instsDistribution.Backpack.LinkedComponent
lc_pkgidDistribution.Backpack.LinkedComponent
lc_publicDistribution.Backpack.LinkedComponent
lc_shapeDistribution.Backpack.LinkedComponent
lc_sig_includesDistribution.Backpack.LinkedComponent
lc_uidDistribution.Backpack.LinkedComponent
ldOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
ldProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
LeftDistribution.Compat.Prelude.Internal
LegacyExeDependency 
1 (Type/Class)Distribution.Types.LegacyExeDependency
2 (Data Constructor)Distribution.Types.LegacyExeDependency
lengthDistribution.Compat.Prelude.Internal
LensDistribution.Compat.Lens
Lens'Distribution.Compat.Lens
LensLikeDistribution.Compat.Lens
LensLike'Distribution.Compat.Lens
LeptonicaDistribution.SPDX.LicenseId, Distribution.SPDX
lessVerboseDistribution.Verbosity
letterDistribution.Compat.CharParsing
Lex 
1 (Type/Class)Distribution.Parsec.LexerMonad
2 (Data Constructor)Distribution.Parsec.LexerMonad
lexDistribution.Compat.Prelude.Internal
lexemeParsecDistribution.Parsec.Class
LexicalErrorDistribution.Parsec.Lexer
LexResult 
1 (Type/Class)Distribution.Parsec.LexerMonad
2 (Data Constructor)Distribution.Parsec.LexerMonad
LexState 
1 (Type/Class)Distribution.Parsec.LexerMonad
2 (Data Constructor)Distribution.Parsec.LexerMonad
lexTokenDistribution.Parsec.Lexer
LexWarning 
1 (Type/Class)Distribution.Parsec.LexerMonad
2 (Data Constructor)Distribution.Parsec.LexerMonad
LexWarningBOMDistribution.Parsec.LexerMonad
LexWarningNBSPDistribution.Parsec.LexerMonad
LexWarningTabDistribution.Parsec.LexerMonad
LexWarningTypeDistribution.Parsec.LexerMonad
LFlagsDistribution.Simple.Command
LGPLDistribution.License, Distribution.Make, Distribution.Simple
LGPLLRDistribution.SPDX.LicenseId, Distribution.SPDX
LGPL_2_0_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
LGPL_2_0_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
LGPL_2_1_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
LGPL_2_1_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
LGPL_3_0_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
LGPL_3_0_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
LHCDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
libAbiHash 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
libBuildInfo 
1 (Function)Distribution.Types.Library, Distribution.PackageDescription
2 (Function)Distribution.Types.Library.Lens, Distribution.Types.Lens
LibComponentLocalBuildInfoDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
libCoverageDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
libdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
LibdirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
LiberalTypeSynonymsLanguage.Haskell.Extension, Distribution.Simple
libexecdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
libexecsubdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
libExposed 
1 (Function)Distribution.Types.Library, Distribution.PackageDescription
2 (Function)Distribution.Types.Library.Lens, Distribution.Types.Lens
libModulesDistribution.Types.Library, Distribution.PackageDescription
libModulesAutogenDistribution.Types.Library, Distribution.PackageDescription
libName 
1 (Function)Distribution.Types.Library, Distribution.PackageDescription
2 (Function)Distribution.Types.Library.Lens, Distribution.Types.Lens
LibNameVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
LibpngDistribution.SPDX.LicenseId, Distribution.SPDX
Library 
1 (Type/Class)Distribution.Types.Library, Distribution.Types.Library.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.Library, Distribution.PackageDescription
library 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
libraryComponentNameDistribution.Types.ComponentName
libraryDirs 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
libraryDynDirs 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
libraryDynDirSupportedDistribution.Simple.Compiler, Distribution.Simple
libraryFieldGrammarDistribution.PackageDescription.FieldGrammar
libsubdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
LibsubdirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
LibtiffDistribution.SPDX.LicenseId, Distribution.SPDX
Libtool_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
LibVersionInfoDistribution.Types.ForeignLib
libVersionInfoCRADistribution.Types.ForeignLib
libVersionMajorDistribution.Types.ForeignLib
libVersionNumberDistribution.Types.ForeignLib
libVersionNumberShowDistribution.Types.ForeignLib
License 
1 (Type/Class)Distribution.SPDX.License, Distribution.SPDX
2 (Data Constructor)Distribution.SPDX.License, Distribution.SPDX
3 (Type/Class)Distribution.License, Distribution.Make, Distribution.Simple
license 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
3 (Function)Distribution.Types.InstalledPackageInfo.Lens
license'Distribution.Types.PackageDescription
licenseDocumentRefDistribution.SPDX.LicenseReference, Distribution.SPDX
LicenseExceptionIdDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
licenseExceptionIdDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
licenseExceptionIdListDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
licenseExceptionNameDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
LicenseExpressionDistribution.SPDX.LicenseExpression, Distribution.SPDX
licenseFiles 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
licenseFromSPDXDistribution.License, Distribution.Simple
LicenseIdDistribution.SPDX.LicenseId, Distribution.SPDX
licenseIdDistribution.SPDX.LicenseId, Distribution.SPDX
licenseIdListDistribution.SPDX.LicenseId, Distribution.SPDX
licenseIdMigrationMessageDistribution.SPDX.LicenseId
licenseIsOsiApprovedDistribution.SPDX.LicenseId, Distribution.SPDX
LicenseListVersionDistribution.SPDX.LicenseListVersion, Distribution.SPDX
LicenseListVersion_3_0Distribution.SPDX.LicenseListVersion, Distribution.SPDX
LicenseListVersion_3_2Distribution.SPDX.LicenseListVersion, Distribution.SPDX
licenseNameDistribution.SPDX.LicenseId, Distribution.SPDX
licenseRaw 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
LicenseRefDistribution.SPDX.LicenseReference, Distribution.SPDX
licenseRefDistribution.SPDX.LicenseReference, Distribution.SPDX
licenseToSPDXDistribution.License, Distribution.Simple
liftMDistribution.Compat.Prelude.Internal
liftM2Distribution.Compat.Prelude.Internal
liftOptionDistribution.Simple.Command
LiLiQ_P_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
LiLiQ_Rplus_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
LiLiQ_R_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
linesDistribution.Compat.Prelude.Internal
LinkedComponent 
1 (Type/Class)Distribution.Backpack.LinkedComponent
2 (Data Constructor)Distribution.Backpack.LinkedComponent
LinkedComponentMapDistribution.Backpack.LinkedComponent
LinuxDistribution.System
Linux_OpenIBDistribution.SPDX.LicenseId, Distribution.SPDX
Linux_syscall_noteDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
ListDistribution.Parsec.Newtypes
listDistribution.Simple.Program.HcPkg
listDirectoryDistribution.Compat.Directory
listInvocationDistribution.Simple.Program.HcPkg
listPackageSourcesDistribution.Simple.SrcDist
listToMaybeDistribution.Compat.Prelude.Internal
listUnionDistribution.Utils.Generic, Distribution.Simple.Utils
listUnionRightDistribution.Utils.Generic, Distribution.Simple.Utils
LitDistribution.Types.Condition, Distribution.PackageDescription
LiteralFileNameGlobStarDistribution.Simple.Glob
LLVM_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
LocalBuildInfo 
1 (Type/Class)Distribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
2 (Data Constructor)Distribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
localBuildInfoFileDistribution.Simple.Configure
localCompatPackageKeyDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
localComponentIdDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
localPackageDistribution.Types.LocalBuildInfo
localPackageLogDistribution.Simple.Test.Log
localPkgDescrDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
localUnitIdDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
locationPathDistribution.Simple.Program.Types, Distribution.Simple.Program
logDistribution.Compat.Prelude.Internal
logBaseDistribution.Compat.Prelude.Internal
logFileDistribution.Simple.Test.Log
LogProgressDistribution.Utils.LogProgress
lookDistribution.Compat.ReadP
lookup 
1 (Function)Distribution.Compat.Prelude.Internal
2 (Function)Distribution.Compat.Graph
lookupComponentDistribution.Types.PackageDescription, Distribution.Simple.LocalBuildInfo
lookupComponentIdDistribution.Simple.PackageIndex
lookupDependencyDistribution.Simple.PackageIndex
lookupFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
lookupInstalledPackageIdDistribution.Simple.PackageIndex
lookupInternalDependencyDistribution.Simple.PackageIndex
lookupKnownProgramDistribution.Simple.Program.Db, Distribution.Simple.Program
lookupPackageIdDistribution.Simple.PackageIndex
lookupPackageNameDistribution.Simple.PackageIndex
lookupProgramDistribution.Simple.Program.Db, Distribution.Simple.Program
lookupProgramVersionDistribution.Simple.Program.Db, Distribution.Simple.Program
lookupSourcePackageIdDistribution.Simple.PackageIndex
lookupUnitIdDistribution.Simple.PackageIndex
lowerDistribution.Compat.CharParsing
LowerBound 
1 (Type/Class)Distribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
2 (Data Constructor)Distribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
lowercaseDistribution.Utils.Generic, Distribution.Simple.Utils
LPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
LPL_1_02Distribution.SPDX.LicenseId, Distribution.SPDX
LPPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
LPPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
LPPL_1_2Distribution.SPDX.LicenseId, Distribution.SPDX
LPPL_1_3aDistribution.SPDX.LicenseId, Distribution.SPDX
LPPL_1_3cDistribution.SPDX.LicenseId, Distribution.SPDX
LTDistribution.Compat.Prelude.Internal
ltestDistribution.Parsec.Lexer
LTokenDistribution.Parsec.Lexer
LZMA_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
M68kDistribution.System
MagicHashLanguage.Haskell.Extension, Distribution.Simple
mainDistribution.ModuleName
maintainer 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
MajorBoundVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
majorBoundVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
MajorBoundVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
majorUpperBoundDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
MakeDistribution.Types.BuildType, Distribution.PackageDescription
makeAbsoluteDistribution.Compat.Directory
MakeIndexDistribution.SPDX.LicenseId, Distribution.SPDX
mandirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
many 
1 (Function)Distribution.Compat.Prelude.Internal, Distribution.Compat.Parsing, Distribution.Compat.CharParsing
2 (Function)Distribution.Compat.ReadP
many1Distribution.Compat.ReadP
manyTill 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
MapDistribution.Compat.Prelude.Internal
mapDistribution.Compat.Prelude.Internal
mapAccumMDistribution.Utils.MapAccum
mapCondTreeDistribution.Types.CondTree, Distribution.PackageDescription.Configuration
mapMaybeDistribution.Compat.Prelude.Internal
mappendDistribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
mapTreeCondsDistribution.Types.CondTree, Distribution.PackageDescription.Configuration
mapTreeConstrsDistribution.Types.CondTree, Distribution.PackageDescription.Configuration
mapTreeDataDistribution.Types.CondTree, Distribution.PackageDescription.Configuration
markupDistribution.Simple.Program.Hpc
markupPackageDistribution.Simple.Hpc
markupTestDistribution.Simple.Hpc
matchDirFileGlobDistribution.Simple.Glob
maxDistribution.Compat.Prelude.Internal
maxBoundDistribution.Compat.Prelude.Internal
MaximalDebugInfoDistribution.Simple.Compiler, Distribution.Simple
maximumDistribution.Compat.Prelude.Internal
MaximumOptimisationDistribution.Simple.Compiler, Distribution.Simple
MaybeDistribution.Compat.Prelude.Internal
maybeDistribution.Compat.Prelude.Internal
maybeComponentInstantiatedWithDistribution.Types.ComponentLocalBuildInfo
maybeExitDistribution.Simple.Utils
maybeGetPersistBuildConfigDistribution.Simple.Configure
maybeToFlagDistribution.Simple.Flag, Distribution.Simple.Setup
maybeToListDistribution.Compat.Prelude.Internal
mconcatDistribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
memberDistribution.Compat.Graph
memptyDistribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
MercurialDistribution.Types.SourceRepo, Distribution.PackageDescription
mergeDistribution.Simple.PackageIndex
Mif_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
minDistribution.Compat.Prelude.Internal
minBoundDistribution.Compat.Prelude.Internal
MinimalDebugInfoDistribution.Simple.Compiler, Distribution.Simple
minimumDistribution.Compat.Prelude.Internal
MipsDistribution.System
MirOSDistribution.SPDX.LicenseId, Distribution.SPDX
MIT 
1 (Data Constructor)Distribution.SPDX.LicenseId, Distribution.SPDX
2 (Data Constructor)Distribution.License, Distribution.Make, Distribution.Simple
MITNFADistribution.SPDX.LicenseId, Distribution.SPDX
MIT_0Distribution.SPDX.LicenseId, Distribution.SPDX
MIT_advertisingDistribution.SPDX.LicenseId, Distribution.SPDX
MIT_CMUDistribution.SPDX.LicenseId, Distribution.SPDX
MIT_ennaDistribution.SPDX.LicenseId, Distribution.SPDX
MIT_fehDistribution.SPDX.LicenseId, Distribution.SPDX
mixDirDistribution.Simple.Hpc
Mixin 
1 (Type/Class)Distribution.Types.Mixin
2 (Data Constructor)Distribution.Types.Mixin
mixinIncludeRenamingDistribution.Types.Mixin
mixinPackageNameDistribution.Types.Mixin
mixins 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
mixLinkPreModuleShapeDistribution.Backpack.PreModuleShape
mkAbiHashDistribution.Types.AbiHash, Distribution.Package, Distribution.Make, Distribution.Simple
mkCommandUIDistribution.Simple.Command
mkComponentIdDistribution.Types.ComponentId, Distribution.Package, Distribution.Make, Distribution.Simple
mkComponentsGraphDistribution.Backpack.ComponentsGraph
mkDefUnitIdDistribution.Backpack
MkFlagDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
mkFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
mkFlagNameDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
mkGenericSharedLibNameDistribution.Simple.BuildPaths
mkGenericStaticLibNameDistribution.Simple.BuildPaths
mkLegacyUnitIdDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
mkLexStateDistribution.Parsec.Lexer
mkLibNameDistribution.Simple.BuildPaths
mkLibVersionInfoDistribution.Types.ForeignLib
mkLicenseExceptionIdDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
mkLicenseIdDistribution.SPDX.LicenseId, Distribution.SPDX
mkLicenseRefDistribution.SPDX.LicenseReference, Distribution.SPDX
mkLicenseRef'Distribution.SPDX.LicenseReference, Distribution.SPDX
mkMungedPackageNameDistribution.Types.MungedPackageName
mkNameDistribution.Parsec.Field
MkNamelessFieldDistribution.FieldGrammar.Parsec
mkOpenUnitIdDistribution.Backpack
MkOptDescrDistribution.Simple.Command
mkPackageNameDistribution.Types.PackageName, Distribution.Package, Distribution.Make, Distribution.Simple
mkPkgconfigNameDistribution.Types.PkgconfigName, Distribution.Package, Distribution.Make, Distribution.Simple
mkProfLibNameDistribution.Simple.BuildPaths
MkSectionDistribution.FieldGrammar.Parsec, Distribution.FieldGrammar
mkSharedLibNameDistribution.Simple.BuildPaths
mkSimplePreProcessorDistribution.Simple.PreProcess
mkStaticLibNameDistribution.Simple.BuildPaths
mkUnitIdDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
mkUnqualComponentNameDistribution.Types.UnqualComponentName
mkVersionDistribution.Types.Version, Distribution.Version, Distribution.Simple
mkVersion'Distribution.Types.Version, Distribution.Version, Distribution.Simple
mkVersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
modDistribution.Compat.Prelude.Internal
modifyProgramSearchPathDistribution.Simple.Program.Db
modifyVerbosityDistribution.Verbosity
modShapeProvidesDistribution.Backpack.ModuleShape
modShapeRequiresDistribution.Backpack.ModuleShape
ModSubstDistribution.Backpack.ModSubst
modSubstDistribution.Backpack.ModSubst
ModTime 
1 (Type/Class)Distribution.Compat.Time
2 (Data Constructor)Distribution.Compat.Time
Module 
1 (Type/Class)Distribution.Types.Module, Distribution.Package, Distribution.Make, Distribution.Simple
2 (Data Constructor)Distribution.Types.Module, Distribution.Package, Distribution.Make, Distribution.Simple
ModuleName 
1 (Type/Class)Distribution.ModuleName
2 (Data Constructor)Distribution.ModuleName
moduleNameIndexDistribution.Simple.PackageIndex
modulePath 
1 (Function)Distribution.Types.Executable, Distribution.PackageDescription
2 (Function)Distribution.Types.Executable.Lens, Distribution.Types.Lens
ModuleReexport 
1 (Type/Class)Distribution.Types.ModuleReexport, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.ModuleReexport, Distribution.PackageDescription
moduleReexportNameDistribution.Types.ModuleReexport, Distribution.PackageDescription
moduleReexportOriginalNameDistribution.Types.ModuleReexport, Distribution.PackageDescription
moduleReexportOriginalPackageDistribution.Types.ModuleReexport, Distribution.PackageDescription
ModuleRenaming 
1 (Type/Class)Distribution.Types.ModuleRenaming, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.ModuleRenaming, Distribution.PackageDescription
ModuleShape 
1 (Type/Class)Distribution.Backpack.ModuleShape
2 (Data Constructor)Distribution.Backpack.ModuleShape
MonadDistribution.Compat.Prelude.Internal
MonadComprehensionsLanguage.Haskell.Extension, Distribution.Simple
MonadFailDesugaringLanguage.Haskell.Extension, Distribution.Simple
MonadPlusDistribution.Compat.Prelude.Internal
MonoidDistribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
monoidalFieldDistribution.FieldGrammar.Class, Distribution.FieldGrammar
monoidalFieldAlaDistribution.FieldGrammar.Class, Distribution.FieldGrammar
MonoLocalBindsLanguage.Haskell.Extension, Distribution.Simple
MonomorphismRestrictionLanguage.Haskell.Extension, Distribution.Simple
MonoPatBindsLanguage.Haskell.Extension, Distribution.Simple
MonotoneDistribution.Types.SourceRepo, Distribution.PackageDescription
moreRecentFileDistribution.Simple.Utils
moreVerboseDistribution.Verbosity
MotosotoDistribution.SPDX.LicenseId, Distribution.SPDX
Mpich2Distribution.SPDX.LicenseId, Distribution.SPDX
MPLDistribution.License, Distribution.Make, Distribution.Simple
mplusDistribution.Compat.Prelude.Internal
MPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
MPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
MPL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
MPL_2_0_no_copyleft_exceptionDistribution.SPDX.LicenseId, Distribution.SPDX
MQuoted 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
MS_PLDistribution.SPDX.LicenseId, Distribution.SPDX
MS_RLDistribution.SPDX.LicenseId, Distribution.SPDX
MTLLDistribution.SPDX.LicenseId, Distribution.SPDX
MulticsDistribution.SPDX.LicenseId, Distribution.SPDX
multiOptionDistribution.Simple.Command
MultiParamTypeClassesLanguage.Haskell.Extension, Distribution.Simple
multiStageProgramInvocationDistribution.Simple.Program.Run, Distribution.Simple.Program.Ar
MultiWayIfLanguage.Haskell.Extension, Distribution.Simple
munch 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.CharParsing
munch1 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.CharParsing
mungedIdDistribution.Package, Distribution.Make, Distribution.Simple
mungedNameDistribution.Types.MungedPackageId
mungedName'Distribution.Package, Distribution.Make, Distribution.Simple
MungedPackageId 
1 (Type/Class)Distribution.Types.MungedPackageId
2 (Data Constructor)Distribution.Types.MungedPackageId
mungedPackageIdDistribution.Types.InstalledPackageInfo
MungedPackageNameDistribution.Types.MungedPackageName
mungedPackageNameDistribution.Types.InstalledPackageInfo
mungedVersionDistribution.Types.MungedPackageId
mungedVersion'Distribution.Package, Distribution.Make, Distribution.Simple
MupDistribution.SPDX.LicenseId, Distribution.SPDX
mzeroDistribution.Compat.Prelude.Internal
NDistribution.Compat.Graph
Name 
1 (Type/Class)Distribution.Parsec.Field, Distribution.Parsec.Parser
2 (Data Constructor)Distribution.Parsec.Field, Distribution.Parsec.Parser
3 (Type/Class)Distribution.Simple.Command
nameDistribution.TestSuite
nameAnnDistribution.Parsec.Field
NamedFieldPunsLanguage.Haskell.Extension, Distribution.Simple
NamedWildCardsLanguage.Haskell.Extension, Distribution.Simple
NamelessFieldDistribution.FieldGrammar.Parsec
namelessFieldAnnDistribution.FieldGrammar.Parsec
NASA_1_3Distribution.SPDX.LicenseId, Distribution.SPDX
nativeMultiInstanceDistribution.Simple.Program.HcPkg
NaumenDistribution.SPDX.LicenseId, Distribution.SPDX
NBPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
NCSADistribution.SPDX.LicenseId, Distribution.SPDX
neededTargetsInBuildOrderDistribution.Types.LocalBuildInfo
neededTargetsInBuildOrder'Distribution.Types.LocalBuildInfo
negateDistribution.Compat.Prelude.Internal
NegativeLiteralsLanguage.Haskell.Extension, Distribution.Simple
neighborsDistribution.Compat.Graph
NetBSDDistribution.System
NetCDFDistribution.SPDX.LicenseId, Distribution.SPDX
Net_SNMPDistribution.SPDX.LicenseId, Distribution.SPDX
NeverDistribution.Simple.Setup
newlineDistribution.Compat.CharParsing
newPackageDepsBehaviourDistribution.Backpack.ConfiguredComponent
NewQualifiedOperatorsLanguage.Haskell.Extension, Distribution.Simple
newSimpleUnitIdDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
NewsletrDistribution.SPDX.LicenseId, Distribution.SPDX
NewtypeDistribution.Compat.Newtype
NFDataDistribution.Compat.Prelude.Internal
NGPLDistribution.SPDX.LicenseId, Distribution.SPDX
NHCDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
NLOD_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
NLPLDistribution.SPDX.LicenseId, Distribution.SPDX
NoAbiTagDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
noArgDistribution.Simple.Command
NoCallStackIODistribution.Compat.Prelude.Internal
NoCommaFSep 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
NoCommonStanzasDistribution.CabalSpecVersion
NoCopyDestDistribution.Simple.InstallDirs, Distribution.Simple.Setup, Distribution.Simple.LocalBuildInfo
NodeDistribution.Compat.Graph
NoDebugInfoDistribution.Simple.Compiler, Distribution.Simple
nodeKeyDistribution.Compat.Graph
nodeNeighborsDistribution.Compat.Graph
nodeValueDistribution.Compat.Graph
NoElifDistribution.CabalSpecVersion
NoExtensionOnStarDistribution.Simple.Glob
noExtraFlagsDistribution.Simple.Command
NoFlagDistribution.Simple.Flag, Distribution.Simple.Setup
NoGlobstarDistribution.CabalSpecVersion
NokiaDistribution.SPDX.LicenseId, Distribution.SPDX
Nokia_Qt_exception_1_1Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
NondecreasingIndentationLanguage.Haskell.Extension, Distribution.Simple
NONEDistribution.SPDX.License, Distribution.SPDX
NoneDistribution.Simple.PackageIndex
noneOfDistribution.Compat.CharParsing
NoOptimisationDistribution.Simple.Compiler, Distribution.Simple
NoParseDistribution.InstalledPackageInfo
noPkgDbStackDistribution.Simple.Program.HcPkg
normalDistribution.Verbosity
NormalCommandDistribution.Simple.Command
NormalDebugInfoDistribution.Simple.Compiler, Distribution.Simple
normaliseGhcArgsDistribution.Simple.Program.GHC
normaliseLineEndingsDistribution.Utils.Generic, Distribution.Simple.Utils
normaliseVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
NormalOptimisationDistribution.Simple.Compiler, Distribution.Simple
NOSLDistribution.SPDX.LicenseId, Distribution.SPDX
notDistribution.Compat.Prelude.Internal
notCharDistribution.Compat.CharParsing
notElemDistribution.Compat.Prelude.Internal
notFollowedByDistribution.Compat.Parsing, Distribution.Compat.CharParsing
NothingDistribution.Compat.Prelude.Internal
noticeDistribution.Simple.Utils
noticeDocDistribution.Simple.Utils
noticeNoWrapDistribution.Simple.Utils
notThisPackageVersionDistribution.Types.Dependency, Distribution.Package, Distribution.Make, Distribution.Simple
notThisVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
NoUpperBoundDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
noVerboseFlagDistribution.Simple.Program.HcPkg
noVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
NowebDistribution.SPDX.LicenseId, Distribution.SPDX
NPlusKPatternsLanguage.Haskell.Extension, Distribution.Simple
NPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
NPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
NPOSL_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
NRLDistribution.SPDX.LicenseId, Distribution.SPDX
NTPDistribution.SPDX.LicenseId, Distribution.SPDX
nubDistribution.Compat.Prelude.Internal
nubByDistribution.Compat.Prelude.Internal
NubListDistribution.Utils.NubList
NubListRDistribution.Utils.NubList
null 
1 (Function)Distribution.Compat.Prelude.Internal
2 (Function)Distribution.Compat.Graph
3 (Function)Distribution.Utils.IOData
NullaryTypeClassesLanguage.Haskell.Extension, Distribution.Simple
NullBSDDistribution.SPDX.LicenseId, Distribution.SPDX
nullFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
nullVersionDistribution.Types.Version, Distribution.Version, Distribution.Simple
NumDistribution.Compat.Prelude.Internal
NumDecimalsLanguage.Haskell.Extension, Distribution.Simple
NumericUnderscoresLanguage.Haskell.Extension, Distribution.Simple
numericVersionDistribution.Simple.HaskellSuite
ObjectiveCDistribution.Simple.CCompiler
ObjectiveCPlusPlusDistribution.Simple.CCompiler
objExtensionDistribution.Simple.BuildPaths
OCCT_exception_1_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
OCCT_PLDistribution.SPDX.LicenseId, Distribution.SPDX
OCLC_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
octDigitDistribution.Compat.CharParsing
ODbL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
ODC_By_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
oddDistribution.Compat.Prelude.Internal
OFL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
OFL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
OGTSLDistribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_1_2Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_1_3Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_1_4Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_0_1Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_1Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_2Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_2_1Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_2_2Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_3Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_4Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_5Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_6Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_7Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_8Distribution.SPDX.LicenseId, Distribution.SPDX
oldExtensions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
OMLDistribution.SPDX.LicenseId, Distribution.SPDX
OneComponentRequestedSpecDistribution.Types.ComponentRequestedSpec
oneOfDistribution.Compat.CharParsing
OpenBraceDistribution.Parsec.Lexer
OpenBSDDistribution.System
OpenJDK_assembly_exception_1_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
OpenModule 
1 (Type/Class)Distribution.Backpack
2 (Data Constructor)Distribution.Backpack
openModuleFreeHolesDistribution.Backpack
OpenModuleSubstDistribution.Backpack
openModuleSubstFreeHolesDistribution.Backpack
OpenModuleVarDistribution.Backpack
OpenSSLDistribution.SPDX.LicenseId, Distribution.SPDX
OpenUnitIdDistribution.Backpack
openUnitIdFreeHolesDistribution.Backpack
Openvpn_openssl_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
OPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
OptArgDistribution.Simple.Command
optArgDistribution.Simple.Command
optArg'Distribution.Simple.Command
OptDescrDistribution.Simple.Command
OptFlagsDistribution.Simple.Command
OptimisationLevelDistribution.Simple.Compiler, Distribution.Simple
option 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
3 (Function)Distribution.Simple.Command
optional 
1 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
2 (Function)Distribution.Compat.ReadP
optionalFieldDistribution.FieldGrammar.Class, Distribution.FieldGrammar
optionalFieldAlaDistribution.FieldGrammar.Class, Distribution.FieldGrammar
optionalFieldDefDistribution.FieldGrammar.Class, Distribution.FieldGrammar
optionalFieldDefAlaDistribution.FieldGrammar.Class, Distribution.FieldGrammar
OptionBoolDistribution.TestSuite
optionDefaultDistribution.TestSuite
OptionDescr 
1 (Type/Class)Distribution.TestSuite
2 (Data Constructor)Distribution.TestSuite
optionDescrDistribution.Simple.Command
optionDescriptionDistribution.TestSuite
optionDistPrefDistribution.Simple.Setup
OptionEnumDistribution.TestSuite
OptionField 
1 (Type/Class)Distribution.Simple.Command
2 (Data Constructor)Distribution.Simple.Command
OptionFileDistribution.TestSuite
optionFileExtensionsDistribution.TestSuite
optionFileIsDirDistribution.TestSuite
optionFileMustExistDistribution.TestSuite
optionName 
1 (Function)Distribution.TestSuite
2 (Function)Distribution.Simple.Command
OptionNumberDistribution.TestSuite
optionNumberBoundsDistribution.TestSuite
optionNumberIsIntDistribution.TestSuite
optionNumJobsDistribution.Simple.Setup
OptionRngSeedDistribution.TestSuite
OptionsDistribution.TestSuite
options 
1 (Function)Distribution.TestSuite
2 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
3 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
OptionSetDistribution.TestSuite
OptionStringDistribution.TestSuite
optionStringMultilineDistribution.TestSuite
OptionTypeDistribution.TestSuite
optionTypeDistribution.TestSuite
optionVerbosityDistribution.Simple.Setup
optKeepTempFilesDistribution.Simple.Utils
orDistribution.Compat.Prelude.Internal
OrdDistribution.Compat.Prelude.Internal
ordDistribution.Compat.Prelude.Internal
OrderingDistribution.Compat.Prelude.Internal
ordNubDistribution.Utils.Generic, Distribution.Simple.Utils
ordNubByDistribution.Utils.Generic, Distribution.Simple.Utils
ordNubRightDistribution.Utils.Generic, Distribution.Simple.Utils
OrEarlierVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
orEarlierVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
OrEarlierVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
OrLaterVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
orLaterVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
OrLaterVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
OS 
1 (Type/Class)Distribution.System
2 (Data Constructor)Distribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
OSET_PL_2_1Distribution.SPDX.LicenseId, Distribution.SPDX
OSL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
OSL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
OSL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
OSL_2_1Distribution.SPDX.LicenseId, Distribution.SPDX
OSL_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
OSVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
OSXDistribution.System
OtherArchDistribution.System
OtherCompilerDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
otherExtensions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
otherLanguages 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
OtherLicenseDistribution.License, Distribution.Make, Distribution.Simple
otherModules 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
OtherOSDistribution.System
OtherRepoTypeDistribution.Types.SourceRepo, Distribution.PackageDescription
otherwiseDistribution.Compat.Prelude.Internal
overDistribution.Compat.Lens
OverlappingInstancesLanguage.Haskell.Extension, Distribution.Simple
OverloadedLabelsLanguage.Haskell.Extension, Distribution.Simple
OverloadedListsLanguage.Haskell.Extension, Distribution.Simple
OverloadedStringsLanguage.Haskell.Extension, Distribution.Simple
overNubListDistribution.Utils.NubList
overNubListRDistribution.Utils.NubList
packDistribution.Compat.Newtype
pack'Distribution.Compat.Newtype
PackageDistribution.Package, Distribution.Make, Distribution.Simple
package 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Simple.Test.Log
PackageBuildImpossibleDistribution.PackageDescription.Check
PackageBuildWarningDistribution.PackageDescription.Check
PackageCheckDistribution.PackageDescription.Check
PackageDBDistribution.Simple.Compiler, Distribution.Simple
packageDbArgsDbDistribution.Simple.Program.GHC
packageDbOptDistribution.Simple.HaskellSuite
PackageDBStackDistribution.Simple.Compiler, Distribution.Simple
PackageDescription 
1 (Type/Class)Distribution.Types.PackageDescription, Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.PackageDescription, Distribution.PackageDescription
packageDescription 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
packageDescriptionFieldGrammarDistribution.PackageDescription.FieldGrammar
PackageDistInexcusableDistribution.PackageDescription.Check
PackageDistSuspiciousDistribution.PackageDescription.Check
PackageDistSuspiciousWarnDistribution.PackageDescription.Check
PackageIdDistribution.Types.PackageId, Distribution.Package, Distribution.Make, Distribution.Simple
packageIdDistribution.Package, Distribution.Make, Distribution.Simple
PackageIdentifier 
1 (Type/Class)Distribution.Types.PackageId, Distribution.Types.PackageId.Lens, Distribution.Package, Distribution.Types.Lens, Distribution.Make, Distribution.Simple
2 (Data Constructor)Distribution.Types.PackageId, Distribution.Package, Distribution.Make, Distribution.Simple
PackageImportsLanguage.Haskell.Extension, Distribution.Simple
PackageIndexDistribution.Simple.PackageIndex
PackageInstalledDistribution.Package, Distribution.Make, Distribution.Simple
packageKeySupportedDistribution.Simple.Compiler, Distribution.Simple
PackageLog 
1 (Type/Class)Distribution.Simple.Test.Log
2 (Data Constructor)Distribution.Simple.Test.Log
PackageNameDistribution.Types.PackageName, Distribution.Package, Distribution.Make, Distribution.Simple
packageNameDistribution.Package, Distribution.Make, Distribution.Simple
packageNameToUnqualComponentNameDistribution.Types.UnqualComponentName
packageTemplateEnvDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
packageVersionDistribution.Package, Distribution.Make, Distribution.Simple
ParallelArraysLanguage.Haskell.Extension, Distribution.Simple
ParallelListCompLanguage.Haskell.Extension, Distribution.Simple
parentSrcLocPrefixDistribution.Compat.Stack
parmakeSupportedDistribution.Simple.Compiler, Distribution.Simple
parseDistribution.Text
ParseArgsDistribution.Simple.Command
ParsecDistribution.Parsec.Class
parsecDistribution.Parsec.Class
parsecCommaListDistribution.Parsec.Class
ParsecFieldGrammarDistribution.FieldGrammar.Parsec, Distribution.FieldGrammar
ParsecFieldGrammar'Distribution.FieldGrammar
parsecFilePathDistribution.Parsec.Class
parsecFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
parsecHaskellStringDistribution.Parsec.Class
parsecLeadingCommaListDistribution.Parsec.Class
parsecMaybeQuotedDistribution.Parsec.Class
parseCompilerFlavorCompatDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
parseConditionDistribution.PackageDescription.Configuration
parseConditionConfVarDistribution.Parsec.ConfVar
parsecOpenModuleSubstDistribution.Backpack
parsecOpenModuleSubstEntryDistribution.Backpack
parsecOptCommaListDistribution.Parsec.Class
ParsecParserDistribution.Parsec.Class
parsecQuotedDistribution.Parsec.Class
parsecStandardDistribution.Parsec.Class
parsecTokenDistribution.Parsec.Class
parsecToken'Distribution.Parsec.Class
parsecToReadEDistribution.ReadE
parsecUnqualComponentNameDistribution.Parsec.Class
parsecWarningDistribution.Parsec.Class
ParseErrorExc 
1 (Type/Class)Distribution.Simple.GHC
2 (Data Constructor)Distribution.Simple.GHC
ParseFailedDistribution.InstalledPackageInfo
parseFailureDistribution.Parsec.ParseResult
parseFatalFailureDistribution.Parsec.ParseResult
parseFatalFailure'Distribution.Parsec.ParseResult
parseFieldGrammarDistribution.FieldGrammar.Parsec, Distribution.FieldGrammar
parseFileGlobDistribution.Simple.Glob
parseFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
parseGenericPackageDescriptionDistribution.PackageDescription.Parsec
parseGenericPackageDescriptionMaybeDistribution.PackageDescription.Parsec
parseGhcEnvironmentFileDistribution.Simple.GHC
parseHookedBuildInfoDistribution.PackageDescription.Parsec
parseInstalledPackageInfoDistribution.InstalledPackageInfo
ParseOkDistribution.InstalledPackageInfo
parseOpenModuleSubstDistribution.Backpack
parseOpenModuleSubstEntryDistribution.Backpack
ParserDistribution.Compat.ReadP
parseReadEDistribution.ReadE
ParseResult 
1 (Type/Class)Distribution.InstalledPackageInfo
2 (Type/Class)Distribution.Parsec.ParseResult, Distribution.PackageDescription.Parsec
parseStringDistribution.Parsec.ParseResult
parseWarningDistribution.Parsec.ParseResult
parseWarningsDistribution.Parsec.ParseResult
ParsingDistribution.Compat.Parsing, Distribution.Compat.CharParsing
PartialTypeSignaturesLanguage.Haskell.Extension, Distribution.Simple
partitionComponentsDistribution.Types.Component
partitionFieldsDistribution.FieldGrammar
PassDistribution.TestSuite
patchQuirksDistribution.PackageDescription.Quirks
PathTemplateDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
PathTemplateEnvDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
PathTemplateVariableDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
PatternGuardsLanguage.Haskell.Extension, Distribution.Simple
PatternSignaturesLanguage.Haskell.Extension, Distribution.Simple
PatternSynonymsLanguage.Haskell.Extension, Distribution.Simple
PDDL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
PermissiveDistribution.System
PError 
1 (Type/Class)Distribution.Parsec.Common
2 (Data Constructor)Distribution.Parsec.Common
3 (Type/Class)Distribution.InstalledPackageInfo
pfailDistribution.Compat.ReadP
PHP_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
PHP_3_01Distribution.SPDX.LicenseId, Distribution.SPDX
piDistribution.Compat.Prelude.Internal
pkgBuildableComponentsDistribution.Types.PackageDescription, Distribution.Simple.LocalBuildInfo
pkgComponentsDistribution.Types.PackageDescription, Distribution.Simple.LocalBuildInfo
PkgconfigDependency 
1 (Type/Class)Distribution.Types.PkgconfigDependency
2 (Data Constructor)Distribution.Types.PkgconfigDependency
pkgconfigDepends 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
PkgconfigNameDistribution.Types.PkgconfigName, Distribution.Package, Distribution.Make, Distribution.Simple
pkgConfigProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
pkgDescrFileDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
PkgIdVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
pkgName 
1 (Function)Distribution.Types.PackageId, Distribution.Package, Distribution.Make, Distribution.Simple
2 (Function)Distribution.Types.PackageId.Lens, Distribution.Types.Lens
PkgNameVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
pkgPathEnvVarDistribution.Simple.Build.PathsModule
pkgRoot 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
3 (Function)Distribution.Simple.GHC
pkgUrl 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
pkgVersion 
1 (Function)Distribution.Types.PackageId, Distribution.Package, Distribution.Make, Distribution.Simple
2 (Function)Distribution.Types.PackageId.Lens, Distribution.Types.Lens
PkgVerVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
plainDistribution.Simple.PreProcess.Unlit
Platform 
1 (Type/Class)Distribution.System
2 (Data Constructor)Distribution.System
platformDistribution.Simple.Test.Log
platformDefinesDistribution.Simple.PreProcess, Distribution.Simple.Configure
platformFromTripleDistribution.System
platformIndependentDistribution.Simple.PreProcess
platformTemplateEnvDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
PlexusDistribution.SPDX.LicenseId, Distribution.SPDX
PolyKindsLanguage.Haskell.Extension, Distribution.Simple
PolymorphicComponentsLanguage.Haskell.Extension, Distribution.Simple
Position 
1 (Type/Class)Distribution.Parsec.Common
2 (Data Constructor)Distribution.Parsec.Common
posixSecondsToModTimeDistribution.Compat.Time
postBenchDistribution.Simple.UserHooks, Distribution.Simple
postBuildDistribution.Simple.UserHooks, Distribution.Simple
postCleanDistribution.Simple.UserHooks, Distribution.Simple
postConfDistribution.Simple.UserHooks, Distribution.Simple
postCopyDistribution.Simple.UserHooks, Distribution.Simple
postDoctestDistribution.Simple.UserHooks, Distribution.Simple
PostfixOperatorsLanguage.Haskell.Extension, Distribution.Simple
PostgreSQLDistribution.SPDX.LicenseId, Distribution.SPDX
postHaddockDistribution.Simple.UserHooks, Distribution.Simple
postHscolourDistribution.Simple.UserHooks, Distribution.Simple
postInstDistribution.Simple.UserHooks, Distribution.Simple
postRegDistribution.Simple.UserHooks, Distribution.Simple
postReplDistribution.Simple.UserHooks, Distribution.Simple
postSDistDistribution.Simple.UserHooks, Distribution.Simple
postTestDistribution.Simple.UserHooks, Distribution.Simple
postUnregDistribution.Simple.UserHooks, Distribution.Simple
PPDistribution.Parsec.Class
ppAlexDistribution.Simple.PreProcess
PPCDistribution.System
ppC2hsDistribution.Simple.PreProcess
PPC64Distribution.System
ppCppDistribution.Simple.PreProcess
ppCpp'Distribution.Simple.PreProcess
ppGreenCardDistribution.Simple.PreProcess
ppHappyDistribution.Simple.PreProcess
ppHsc2hsDistribution.Simple.PreProcess
ppSuffixesDistribution.Simple.PreProcess
PPSuffixHandlerDistribution.Simple.PreProcess
ppUnlitDistribution.Simple.PreProcess
preBenchDistribution.Simple.UserHooks, Distribution.Simple
preBuildDistribution.Simple.UserHooks, Distribution.Simple
preCleanDistribution.Simple.UserHooks, Distribution.Simple
preConfDistribution.Simple.UserHooks, Distribution.Simple
preCopyDistribution.Simple.UserHooks, Distribution.Simple
predDistribution.Compat.Prelude.Internal
preDoctestDistribution.Simple.UserHooks, Distribution.Simple
prefixDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
prefixedFieldsDistribution.FieldGrammar.Class, Distribution.FieldGrammar
prefixRelativeComponentInstallDirsDistribution.Simple.LocalBuildInfo
prefixRelativeInstallDirs 
1 (Function)Distribution.Simple.InstallDirs
2 (Function)Distribution.Simple.LocalBuildInfo
PrefixVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
preHaddockDistribution.Simple.UserHooks, Distribution.Simple
preHscolourDistribution.Simple.UserHooks, Distribution.Simple
preInstDistribution.Simple.UserHooks, Distribution.Simple
preModShapeProvidesDistribution.Backpack.PreModuleShape
preModShapeRequiresDistribution.Backpack.PreModuleShape
PreModuleShape 
1 (Type/Class)Distribution.Backpack.PreModuleShape
2 (Data Constructor)Distribution.Backpack.PreModuleShape
prepareSnapshotTreeDistribution.Simple.SrcDist
prepareTreeDistribution.Simple.SrcDist
preprocessComponentDistribution.Simple.PreProcess
preprocessExtrasDistribution.Simple.PreProcess
PreProcessor 
1 (Type/Class)Distribution.Simple.PreProcess
2 (Data Constructor)Distribution.Simple.PreProcess
preRegDistribution.Simple.UserHooks, Distribution.Simple
preReplDistribution.Simple.UserHooks, Distribution.Simple
preSDistDistribution.Simple.UserHooks, Distribution.Simple
preTestDistribution.Simple.UserHooks, Distribution.Simple
Pretext 
1 (Type/Class)Distribution.Compat.Lens
2 (Data Constructor)Distribution.Compat.Lens
PrettyDistribution.Pretty
prettyDistribution.Pretty
prettyCallStackDistribution.Compat.Stack
PrettyFieldGrammarDistribution.FieldGrammar.Pretty, Distribution.FieldGrammar
prettyFieldGrammarDistribution.FieldGrammar.Pretty, Distribution.FieldGrammar
PrettyFieldGrammar'Distribution.FieldGrammar
prettyShowDistribution.Pretty
preUnregDistribution.Simple.UserHooks, Distribution.Simple
printDistribution.Compat.Prelude.Internal
printPackageProblemsDistribution.Simple.SrcDist
printRawCommandAndArgsDistribution.Simple.Utils
printRawCommandAndArgsAndEnvDistribution.Simple.Utils
productDistribution.Compat.Prelude.Internal
ProfDistribution.Simple.Hpc
ProfDetailAllFunctionsDistribution.Simple.Compiler, Distribution.Simple
ProfDetailDefaultDistribution.Simple.Compiler, Distribution.Simple
ProfDetailExportedFunctionsDistribution.Simple.Compiler, Distribution.Simple
ProfDetailLevelDistribution.Simple.Compiler, Distribution.Simple
ProfDetailNoneDistribution.Simple.Compiler, Distribution.Simple
ProfDetailOtherDistribution.Simple.Compiler, Distribution.Simple
ProfDetailToplevelFunctionsDistribution.Simple.Compiler, Distribution.Simple
profilingSupportedDistribution.Simple.Compiler, Distribution.Simple
profOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
ProgArgDistribution.Simple.Program.Types, Distribution.Simple.Program
progInvokeArgsDistribution.Simple.Program.Run, Distribution.Simple.Program
progInvokeCwdDistribution.Simple.Program.Run, Distribution.Simple.Program
progInvokeEnvDistribution.Simple.Program.Run, Distribution.Simple.Program
progInvokeInputDistribution.Simple.Program.Run, Distribution.Simple.Program
progInvokeInputEncodingDistribution.Simple.Program.Run, Distribution.Simple.Program
progInvokeOutputEncodingDistribution.Simple.Program.Run, Distribution.Simple.Program
progInvokePathDistribution.Simple.Program.Run, Distribution.Simple.Program
progInvokePathEnvDistribution.Simple.Program.Run, Distribution.Simple.Program
progPrefixDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
Program 
1 (Type/Class)Distribution.Simple.Program.Types, Distribution.Simple.Program
2 (Data Constructor)Distribution.Simple.Program.Types, Distribution.Simple.Program
ProgramConfigurationDistribution.Simple.Program
programConfigurationOptionsDistribution.Simple.Setup
programConfigurationPaths'Distribution.Simple.Setup
ProgramDbDistribution.Simple.Program.Db, Distribution.Simple.Program
programDbOptionsDistribution.Simple.Setup
programDbPaths'Distribution.Simple.Setup
programDefaultArgsDistribution.Simple.Program.Types, Distribution.Simple.Program
programFindLocationDistribution.Simple.Program.Types, Distribution.Simple.Program
programFindVersionDistribution.Simple.Program.Types, Distribution.Simple.Program
programFlagsDescriptionDistribution.Simple.Setup
programIdDistribution.Simple.Program.Types, Distribution.Simple.Program
ProgramInvocation 
1 (Type/Class)Distribution.Simple.Program.Run, Distribution.Simple.Program
2 (Data Constructor)Distribution.Simple.Program.Run, Distribution.Simple.Program
programInvocationDistribution.Simple.Program.Run, Distribution.Simple.Program
ProgramLocationDistribution.Simple.Program.Types, Distribution.Simple.Program
programLocationDistribution.Simple.Program.Types, Distribution.Simple.Program
programMonitorFilesDistribution.Simple.Program.Types, Distribution.Simple.Program
programNameDistribution.Simple.Program.Types, Distribution.Simple.Program
programNormaliseArgsDistribution.Simple.Program.Types, Distribution.Simple.Program
programOverrideArgsDistribution.Simple.Program.Types, Distribution.Simple.Program
programOverrideEnvDistribution.Simple.Program.Types, Distribution.Simple.Program
programPathDistribution.Simple.Program.Types, Distribution.Simple.Program
programPostConfDistribution.Simple.Program.Types, Distribution.Simple.Program
programPropertiesDistribution.Simple.Program.Types, Distribution.Simple.Program
ProgramSearchPathDistribution.Simple.Program.Find, Distribution.Simple.Program.Types, Distribution.Simple.Program
programSearchPathAsPATHVarDistribution.Simple.Program.Find
ProgramSearchPathDefaultDistribution.Simple.Program.Find, Distribution.Simple.Program.Types, Distribution.Simple.Program
ProgramSearchPathDirDistribution.Simple.Program.Find, Distribution.Simple.Program.Types, Distribution.Simple.Program
ProgramSearchPathEntryDistribution.Simple.Program.Find, Distribution.Simple.Program.Types, Distribution.Simple.Program
programVersionDistribution.Simple.Program.Types, Distribution.Simple.Program
Progress 
1 (Type/Class)Distribution.TestSuite
2 (Data Constructor)Distribution.TestSuite
3 (Type/Class)Distribution.Utils.Progress
progSuffixDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
projectVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
properFractionDistribution.Compat.Prelude.Internal
PsfragDistribution.SPDX.LicenseId, Distribution.SPDX
PsutilsDistribution.SPDX.LicenseId, Distribution.SPDX
PS_or_PDF_font_exception_20170817Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
PublicDomainDistribution.License, Distribution.Make, Distribution.Simple
pureDistribution.Compat.Prelude.Internal
PutDistribution.Compat.Binary
putDistribution.Compat.Binary, Distribution.Compat.Prelude.Internal
putCharDistribution.Compat.Prelude.Internal
putListDistribution.Compat.Binary, Distribution.Compat.Prelude.Internal
putStrDistribution.Compat.Prelude.Internal
putStrLnDistribution.Compat.Prelude.Internal
putWord8Distribution.Compat.Binary
PWarning 
1 (Type/Class)Distribution.Parsec.Common
2 (Data Constructor)Distribution.Parsec.Common
3 (Type/Class)Distribution.InstalledPackageInfo
PWarnTypeDistribution.Parsec.Common, Distribution.Parsec.Class
PWTBoolCaseDistribution.Parsec.Common, Distribution.Parsec.Class
PWTBuildTypeDefaultDistribution.Parsec.Common, Distribution.Parsec.Class
PWTDeprecatedFieldDistribution.Parsec.Common, Distribution.Parsec.Class
PWTDoubleDashDistribution.Parsec.Common, Distribution.Parsec.Class
PWTExtraBenchmarkModuleDistribution.Parsec.Common, Distribution.Parsec.Class
PWTExtraMainIsDistribution.Parsec.Common, Distribution.Parsec.Class
PWTExtraTestModuleDistribution.Parsec.Common, Distribution.Parsec.Class
PWTInvalidSubsectionDistribution.Parsec.Common, Distribution.Parsec.Class
PWTLexBOMDistribution.Parsec.Common, Distribution.Parsec.Class
PWTLexNBSPDistribution.Parsec.Common, Distribution.Parsec.Class
PWTLexTabDistribution.Parsec.Common, Distribution.Parsec.Class
PWTMultipleSingularFieldDistribution.Parsec.Common, Distribution.Parsec.Class
PWTNewSyntaxDistribution.Parsec.Common, Distribution.Parsec.Class
PWTOldSyntaxDistribution.Parsec.Common, Distribution.Parsec.Class
PWTOtherDistribution.Parsec.Common, Distribution.Parsec.Class
PWTQuirkyCabalFileDistribution.Parsec.Common, Distribution.Parsec.Class
PWTTrailingFieldsDistribution.Parsec.Common, Distribution.Parsec.Class
PWTUnknownFieldDistribution.Parsec.Common, Distribution.Parsec.Class
PWTUnknownSectionDistribution.Parsec.Common, Distribution.Parsec.Class
PWTUTFDistribution.Parsec.Common, Distribution.Parsec.Class
PWTVersionLeadingZerosDistribution.Parsec.Common, Distribution.Parsec.Class
PWTVersionTagDistribution.Parsec.Common, Distribution.Parsec.Class
Python_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
QhullDistribution.SPDX.LicenseId, Distribution.SPDX
QL1Distribution.Simple.BuildTarget
QL2Distribution.Simple.BuildTarget
QL3Distribution.Simple.BuildTarget
QPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
Qt_GPL_exception_1_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
Qt_LGPL_exception_1_1Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
qualifiedExeNameDistribution.Types.ExeDependency
QualLevelDistribution.Simple.BuildTarget
QuantifiedConstraintsLanguage.Haskell.Extension, Distribution.Simple
QuasiQuotesLanguage.Haskell.Extension, Distribution.Simple
quotDistribution.Compat.Prelude.Internal
quotRemDistribution.Compat.Prelude.Internal
Qwt_exception_1_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
Rank2TypesLanguage.Haskell.Extension, Distribution.Simple
RankNTypesLanguage.Haskell.Extension, Distribution.Simple
RationalDistribution.Compat.Prelude.Internal
rawSystemExitDistribution.Simple.Utils
rawSystemExitCodeDistribution.Simple.Utils
rawSystemExitWithEnvDistribution.Simple.Utils
rawSystemIOWithEnvDistribution.Simple.Utils
rawSystemProgramDistribution.Simple.Program
rawSystemProgramConfDistribution.Simple.Program
rawSystemProgramStdoutDistribution.Simple.Program
rawSystemProgramStdoutConfDistribution.Simple.Program
rawSystemStdInOutDistribution.Simple.Utils
rawSystemStdoutDistribution.Simple.Utils
RdiscDistribution.SPDX.LicenseId, Distribution.SPDX
ReadDistribution.Compat.Prelude.Internal
readDistribution.Compat.Prelude.Internal
readAndParseFileDistribution.Parsec.ParseResult
readBuildTargetsDistribution.Simple.BuildTarget
readDescDistribution.Simple.UserHooks, Distribution.Simple
ReadE 
1 (Type/Class)Distribution.ReadE
2 (Data Constructor)Distribution.ReadE
readEOrFailDistribution.ReadE
readFieldsDistribution.Parsec.Parser
readFields'Distribution.Parsec.Parser
readFileDistribution.Compat.Prelude.Internal
readGenericPackageDescriptionDistribution.PackageDescription.Parsec
readGhcEnvironmentFileDistribution.Simple.GHC
readHookedBuildInfoDistribution.PackageDescription.Parsec
readIODistribution.Compat.Prelude.Internal
readListDistribution.Compat.Prelude.Internal
readLnDistribution.Compat.Prelude.Internal
ReadPDistribution.Compat.ReadP
readPackageDbListDistribution.Simple.Setup
readParenDistribution.Compat.Prelude.Internal
readPToMaybeDistribution.Simple.Setup
readP_to_EDistribution.ReadE
readP_to_SDistribution.Compat.ReadP
ReadSDistribution.Compat.ReadP, Distribution.Compat.Prelude.Internal
readsDistribution.Compat.Prelude.Internal
readsPrecDistribution.Compat.Prelude.Internal
readS_to_PDistribution.Compat.ReadP
readTargetInfosDistribution.Simple.BuildTarget
readUserBuildTargetsDistribution.Simple.BuildTarget
readUTF8FileDistribution.Utils.Generic, Distribution.Simple.Utils
RealDistribution.Compat.Prelude.Internal
RealFloatDistribution.Compat.Prelude.Internal
RealFracDistribution.Compat.Prelude.Internal
realToFracDistribution.Compat.Prelude.Internal
RebindableSyntaxLanguage.Haskell.Extension, Distribution.Simple
recacheDistribution.Simple.Program.HcPkg
recacheInvocationDistribution.Simple.Program.HcPkg
recacheMultiInstanceDistribution.Simple.Program.HcPkg
recipDistribution.Compat.Prelude.Internal
reconfigureProgramsDistribution.Simple.Program.Db, Distribution.Simple.Program
RecordPunsLanguage.Haskell.Extension, Distribution.Simple
RecordWildCardsLanguage.Haskell.Extension, Distribution.Simple
recoverWithDistribution.Parsec.ParseResult
RecursiveDoLanguage.Haskell.Extension, Distribution.Simple
reexportedModules 
1 (Function)Distribution.Types.Library, Distribution.PackageDescription
2 (Function)Distribution.Types.Library.Lens, Distribution.Types.Lens
reexportedModulesSupportedDistribution.Simple.Compiler, Distribution.Simple
regArgsDistribution.Simple.Setup
regCabalFilePathDistribution.Simple.Setup
regDistPrefDistribution.Simple.Setup
regGenPkgConfDistribution.Simple.Setup
regGenScriptDistribution.Simple.Setup
regHookDistribution.Simple.UserHooks, Distribution.Simple
regInPlaceDistribution.Simple.Setup
register 
1 (Function)Distribution.Simple.Program.HcPkg
2 (Function)Distribution.Simple.Register
registerAllowOverwriteDistribution.Simple.Program.HcPkg, Distribution.Simple.Register
registerCommandDistribution.Simple.Setup
RegisterFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
registerInvocationDistribution.Simple.Program.HcPkg
registerMultiInstanceDistribution.Simple.Program.HcPkg, Distribution.Simple.Register
RegisterOptions 
1 (Type/Class)Distribution.Simple.Program.HcPkg, Distribution.Simple.Register
2 (Data Constructor)Distribution.Simple.Program.HcPkg, Distribution.Simple.Register
registerPackage 
1 (Function)Distribution.Simple.UHC
2 (Function)Distribution.Simple.HaskellSuite
3 (Function)Distribution.Simple.GHCJS
4 (Function)Distribution.Simple.GHC
5 (Function)Distribution.Simple.Register
registerSuppressFilesCheckDistribution.Simple.Program.HcPkg, Distribution.Simple.Register
registrationPackageDBDistribution.Simple.Compiler, Distribution.Simple
regPackageDBDistribution.Simple.Setup
regPrintIdDistribution.Simple.Setup
RegularPatternsLanguage.Haskell.Extension, Distribution.Simple
regVerbosityDistribution.Simple.Setup
RelaxedPolyRecLanguage.Haskell.Extension, Distribution.Simple
relaxHeadIntervalDistribution.Types.VersionInterval
relaxLastIntervalDistribution.Types.VersionInterval
relocatableDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
remDistribution.Compat.Prelude.Internal
removeLowerBoundDistribution.Version, Distribution.Simple
removeUpperBoundDistribution.Version, Distribution.Simple
renamePreModuleShapeDistribution.Backpack.PreModuleShape
renamingPackageFlagsSupportedDistribution.Simple.Compiler, Distribution.Simple
renderGhcEnvironmentFileDistribution.Simple.GHC
renderGhcOptionsDistribution.Simple.Program.GHC
repeatDistribution.Compat.Prelude.Internal
replDistribution.Simple.Build
replCommandDistribution.Simple.Setup
replDistPrefDistribution.Simple.Setup
replExe 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
ReplFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
replFLibDistribution.Simple.GHC
replHookDistribution.Simple.UserHooks, Distribution.Simple
replicateDistribution.Compat.Prelude.Internal
replLib 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
replOptionsDistribution.Simple.Setup
replProgramArgsDistribution.Simple.Setup
replProgramPathsDistribution.Simple.Setup
replReloadDistribution.Simple.Setup
replReplOptionsDistribution.Simple.Setup
replVerbosityDistribution.Simple.Setup
repoBranch 
1 (Function)Distribution.Types.SourceRepo, Distribution.PackageDescription
2 (Function)Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens
RepoHeadDistribution.Types.SourceRepo, Distribution.PackageDescription
RepoKindDistribution.Types.SourceRepo, Distribution.PackageDescription
repoKind 
1 (Function)Distribution.Types.SourceRepo, Distribution.PackageDescription
2 (Function)Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens
RepoKindUnknownDistribution.Types.SourceRepo, Distribution.PackageDescription
repoLocation 
1 (Function)Distribution.Types.SourceRepo, Distribution.PackageDescription
2 (Function)Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens
repoModule 
1 (Function)Distribution.Types.SourceRepo, Distribution.PackageDescription
2 (Function)Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens
reportBuildTargetProblemsDistribution.Simple.BuildTarget
reportsNoExtDistribution.Simple.GHC
reportUserBuildTargetProblemsDistribution.Simple.BuildTarget
repoSubdir 
1 (Function)Distribution.Types.SourceRepo, Distribution.PackageDescription
2 (Function)Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens
repoTag 
1 (Function)Distribution.Types.SourceRepo, Distribution.PackageDescription
2 (Function)Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens
RepoThisDistribution.Types.SourceRepo, Distribution.PackageDescription
RepoTypeDistribution.Types.SourceRepo, Distribution.PackageDescription
repoType 
1 (Function)Distribution.Types.SourceRepo, Distribution.PackageDescription
2 (Function)Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens
ReqArgDistribution.Simple.Command
reqArgDistribution.Simple.Command
reqArg'Distribution.Simple.Command
requiredSignaturesDistribution.InstalledPackageInfo
requireProgramDistribution.Simple.Program.Db, Distribution.Simple.Program
requireProgramVersionDistribution.Simple.Program.Db, Distribution.Simple.Program
requiresDirDbsDistribution.Simple.Program.HcPkg
resolveBuildTargetsDistribution.Simple.BuildTarget
restoreProgramConfigurationDistribution.Simple.Program
restoreProgramDbDistribution.Simple.Program.Db, Distribution.Simple.Program
RestrictedTypeSynonymsLanguage.Haskell.Extension, Distribution.Simple
ResultDistribution.TestSuite
retPosDistribution.Parsec.Common
returnDistribution.Compat.Prelude.Internal
revClosureDistribution.Compat.Graph
reverseDistribution.Compat.Prelude.Internal
reverseDependencyClosureDistribution.Simple.PackageIndex
reverseTopologicalOrderDistribution.Simple.PackageIndex
revNeighborsDistribution.Compat.Graph
revTopSortDistribution.Compat.Graph
rewriteFileDistribution.Simple.Utils
rewriteFileExDistribution.Simple.Utils
RHeCos_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
RightDistribution.Compat.Prelude.Internal
rnfDistribution.Compat.Prelude.Internal
RoleAnnotationsLanguage.Haskell.Extension, Distribution.Simple
roundDistribution.Compat.Prelude.Internal
RPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
RPL_1_5Distribution.SPDX.LicenseId, Distribution.SPDX
RPSL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
Rs6000Distribution.System
RSA_MDDistribution.SPDX.LicenseId, Distribution.SPDX
RSCPLDistribution.SPDX.LicenseId, Distribution.SPDX
RubyDistribution.SPDX.LicenseId, Distribution.SPDX
runDistribution.TestSuite
runCmdDistribution.Simple.GHCJS
runDbProgramDistribution.Simple.Program
runDirFileGlobDistribution.Simple.Glob
runDListDistribution.Compat.DList
runFieldParserDistribution.FieldGrammar.Parsec, Distribution.FieldGrammar
runFieldParser'Distribution.FieldGrammar.Parsec, Distribution.FieldGrammar
runGHCDistribution.Simple.Program.GHC
runghcProgramDistribution.Simple.Program.Builtin
runLogProgressDistribution.Utils.LogProgress
runParsecParserDistribution.Parsec.Class
runParseResultDistribution.Parsec.ParseResult, Distribution.PackageDescription.Parsec
runPreProcessorDistribution.Simple.PreProcess
runPretextDistribution.Compat.Lens
runProgramDistribution.Simple.Program
runProgramInvocationDistribution.Simple.Program.Run, Distribution.Simple.Program
runReadEDistribution.ReadE
runSimplePreProcessorDistribution.Simple.PreProcess
runTest 
1 (Function)Distribution.Simple.Test.LibV09
2 (Function)Distribution.Simple.Test.ExeV10
runTestsDistribution.Simple.UserHooks, Distribution.Simple
S390Distribution.System
SafeLanguage.Haskell.Extension, Distribution.Simple
SafeImportsLanguage.Haskell.Extension, Distribution.Simple
safeTailDistribution.Utils.Generic, Distribution.Simple.Utils
satisfy 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.CharParsing
satisfyRangeDistribution.Compat.CharParsing
SaxpathDistribution.SPDX.LicenseId, Distribution.SPDX
SAX_PDDistribution.SPDX.LicenseId, Distribution.SPDX
scaleFloatDistribution.Compat.Prelude.Internal
scanlDistribution.Compat.Prelude.Internal
scanl1Distribution.Compat.Prelude.Internal
scanrDistribution.Compat.Prelude.Internal
scanr1Distribution.Compat.Prelude.Internal
scanSpecVersionDistribution.PackageDescription.Parsec
SCCDistribution.Compat.Graph
SCEADistribution.SPDX.LicenseId, Distribution.SPDX
ScopedTypeVariablesLanguage.Haskell.Extension, Distribution.Simple
sdistDistribution.Simple.SrcDist
sdistCommandDistribution.Simple.Setup
sDistDirectoryDistribution.Simple.Setup
sDistDistPrefDistribution.Simple.Setup
SDistFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
sDistHookDistribution.Simple.UserHooks, Distribution.Simple
sDistListSourcesDistribution.Simple.Setup
sDistSnapshotDistribution.Simple.Setup
sDistVerbosityDistribution.Simple.Setup
searchByNameDistribution.Simple.PackageIndex
searchByNameSubstringDistribution.Simple.PackageIndex
SearchResultDistribution.Simple.PackageIndex
SecArgNameDistribution.Parsec.Field, Distribution.Parsec.Parser
SecArgOtherDistribution.Parsec.Field, Distribution.Parsec.Parser
SecArgStrDistribution.Parsec.Field, Distribution.Parsec.Parser
Section 
1 (Data Constructor)Distribution.Parsec.Field, Distribution.Parsec.Parser
2 (Type/Class)Distribution.FieldGrammar.Parsec, Distribution.FieldGrammar
SectionArgDistribution.Parsec.Field, Distribution.Parsec.Parser
sectionArgAnnDistribution.Parsec.Field
SemigroupDistribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
SendmailDistribution.SPDX.LicenseId, Distribution.SPDX
SeparatorDistribution.Pretty
sepBy 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
sepBy1 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
sepEndByDistribution.Compat.Parsing, Distribution.Compat.CharParsing
sepEndBy1Distribution.Compat.Parsing, Distribution.Compat.CharParsing
seqDistribution.Compat.Prelude.Internal
sequenceADistribution.Compat.Prelude.Internal
sequence_Distribution.Compat.Prelude.Internal
setDistribution.Compat.Lens
setCabalSpecVersionDistribution.Parsec.ParseResult
setFileExecutableDistribution.Simple.Utils
setFileOrdinaryDistribution.Simple.Utils
setInputDistribution.Parsec.LexerMonad
setOptionDistribution.TestSuite
setPosDistribution.Parsec.LexerMonad
setProgramSearchPathDistribution.Simple.Program.Db, Distribution.Simple.Program
setStartCodeDistribution.Parsec.LexerMonad
setupBInfoFieldGrammarDistribution.PackageDescription.FieldGrammar
SetupBuildInfo 
1 (Type/Class)Distribution.Types.SetupBuildInfo, Distribution.Types.SetupBuildInfo.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.SetupBuildInfo, Distribution.PackageDescription
setupBuildInfo 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
setupDepends 
1 (Function)Distribution.Types.SetupBuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.SetupBuildInfo.Lens, Distribution.Types.Lens
setupMessageDistribution.Simple.Utils
setupMessage'Distribution.Backpack.DescribeUnitId
SFlagsDistribution.Simple.Command
SGI_B_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
SGI_B_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
SGI_B_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
SHDistribution.System
shapeInstalledPackageDistribution.Backpack.ModuleShape
sharedOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
shortRelativePathDistribution.Simple.Utils
ShortTextDistribution.Utils.ShortText
ShowDistribution.Compat.Prelude.Internal
showDistribution.Compat.Prelude.Internal
ShowArgsDistribution.Simple.Command
showBuildTargetDistribution.Simple.BuildTarget
showCharDistribution.Compat.Prelude.Internal
showCompilerIdDistribution.Simple.Compiler, Distribution.Simple
showCompilerIdWithAbiDistribution.Simple.Compiler, Distribution.Simple
showComponentNameDistribution.Types.ComponentName, Distribution.Simple.LocalBuildInfo
showFilePathDistribution.Pretty
showFlagValueDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
showForCabalDistribution.Verbosity
showForGHCDistribution.Verbosity
showFreeTextDistribution.Pretty
showFullInstalledPackageInfoDistribution.InstalledPackageInfo
showGenericPackageDescriptionDistribution.PackageDescription.PrettyPrint
showHookedBuildInfoDistribution.PackageDescription.PrettyPrint
showInstalledPackageInfoDistribution.InstalledPackageInfo
showInstalledPackageInfoFieldDistribution.InstalledPackageInfo
showListDistribution.Compat.Prelude.Internal
ShowOrParseArgsDistribution.Simple.Command
showPackageDbListDistribution.Simple.Setup
showPackageDescriptionDistribution.PackageDescription.PrettyPrint
showParenDistribution.Compat.Prelude.Internal
showPErrorDistribution.Parsec.Common
showPosDistribution.Parsec.Common
showProfDetailLevelDistribution.Simple.Compiler, Distribution.Simple
showPWarningDistribution.Parsec.Common
ShowSDistribution.Compat.Prelude.Internal
showsDistribution.Compat.Prelude.Internal
showSimpleInstalledPackageInfoFieldDistribution.InstalledPackageInfo
showsPrecDistribution.Compat.Prelude.Internal
showStringDistribution.Compat.Prelude.Internal
showTokenDistribution.Pretty
showUserBuildTargetDistribution.Simple.BuildTarget
showVersionDistribution.Types.Version, Distribution.Version, Distribution.Simple
signatures 
1 (Function)Distribution.Types.Library, Distribution.PackageDescription
2 (Function)Distribution.Types.Library.Lens, Distribution.Types.Lens
significandDistribution.Compat.Prelude.Internal
signumDistribution.Compat.Prelude.Internal
silentDistribution.Verbosity
SimpleDistribution.Types.BuildType, Distribution.PackageDescription
simpleDistribution.ModuleName
simpleConfiguredProgramDistribution.Simple.Program.Types
simpleGhcEnvironmentFileDistribution.Simple.GHC
SimpleLicenseExpressionDistribution.SPDX.LicenseExpression, Distribution.SPDX
simpleLicenseExpressionDistribution.SPDX.LicenseExpression, Distribution.SPDX
simpleParseDistribution.Text
simpleParsecDistribution.Parsec.Class
simpleProgramDistribution.Simple.Program.Types, Distribution.Simple.Program
simpleProgramInvocationDistribution.Simple.Program.Run, Distribution.Simple.Program
simpleTestStubDistribution.Simple.Test.LibV09
simpleUserHooksDistribution.Simple
simplifyConditionDistribution.Types.Condition
simplifyCondTreeDistribution.Types.CondTree
simplifyDependencyDistribution.Types.Dependency, Distribution.Package, Distribution.Make, Distribution.Simple
simplifyVersionRangeDistribution.Version, Distribution.Simple
SimPL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
sinDistribution.Compat.Prelude.Internal
singletonDistribution.Compat.DList
sinhDistribution.Compat.Prelude.Internal
SISSLDistribution.SPDX.LicenseId, Distribution.SPDX
SISSL_1_2Distribution.SPDX.LicenseId, Distribution.SPDX
sizeDistribution.Compat.Graph
skipMany 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
skipMany1Distribution.Compat.ReadP
skipOptionalDistribution.Compat.Parsing, Distribution.Compat.CharParsing
skipSomeDistribution.Compat.Parsing, Distribution.Compat.CharParsing
skipSpacesDistribution.Compat.ReadP
skipSpaces1 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.CharParsing
SleepycatDistribution.SPDX.LicenseId, Distribution.SPDX
smartCopySourcesDistribution.Simple.Utils
SMLNJDistribution.SPDX.LicenseId, Distribution.SPDX
SMPPLDistribution.SPDX.LicenseId, Distribution.SPDX
snapshotPackageDistribution.Simple.SrcDist
snapshotVersionDistribution.Simple.SrcDist
sndDistribution.Compat.Prelude.Internal
SNIADistribution.SPDX.LicenseId, Distribution.SPDX
snocDistribution.Compat.DList
SolarisDistribution.System
someDistribution.Compat.Prelude.Internal, Distribution.Compat.Parsing, Distribution.Compat.CharParsing
sortDistribution.Compat.Prelude.Internal
sortByDistribution.Compat.Prelude.Internal
sourceComponentNameDistribution.InstalledPackageInfo
sourceLibName 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
sourcePackageId 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
SourceRepo 
1 (Type/Class)Distribution.Types.SourceRepo, Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.SourceRepo, Distribution.PackageDescription
sourceRepoFieldGrammarDistribution.PackageDescription.FieldGrammar
sourceRepos 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
spaceDistribution.Compat.CharParsing
spacesDistribution.Compat.CharParsing
spanDistribution.Compat.Prelude.Internal
spanMaybeDistribution.Utils.Generic
SparcDistribution.System
specHasCommonStanzasDistribution.CabalSpecVersion
specHasElifDistribution.CabalSpecVersion
SpecificPackageDBDistribution.Simple.Compiler, Distribution.Simple
SpecLicense 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
SpecVersion 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
specVersionDistribution.Types.PackageDescription, Distribution.PackageDescription
specVersion'Distribution.Types.PackageDescription
specVersionRaw 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
Spencer_86Distribution.SPDX.LicenseId, Distribution.SPDX
Spencer_94Distribution.SPDX.LicenseId, Distribution.SPDX
Spencer_99Distribution.SPDX.LicenseId, Distribution.SPDX
splitArgsDistribution.Simple.Setup
splitAtDistribution.Compat.Prelude.Internal
splitObjsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
splitSectionsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
SPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
sqrtDistribution.Compat.Prelude.Internal
srcPrefDistribution.Simple.BuildPaths
stability 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
StandaloneDerivingLanguage.Haskell.Extension, Distribution.Simple
StarInDirectoryDistribution.Simple.Glob
StarInExtensionDistribution.Simple.Glob
StarInFileNameDistribution.Simple.Glob
StarIsTypeLanguage.Haskell.Extension, Distribution.Simple
startInterpreter 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
3 (Function)Distribution.Simple.Build
staticLibExtensionDistribution.Simple.BuildPaths
staticOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
StaticPointersLanguage.Haskell.Extension, Distribution.Simple
stdParseDistribution.Text
stepProgressDistribution.Utils.Progress
StreamingDistribution.Simple.Setup
Strict 
1 (Data Constructor)Distribution.System
2 (Data Constructor)Language.Haskell.Extension, Distribution.Simple
StrictDataLanguage.Haskell.Extension, Distribution.Simple
StringDistribution.Compat.Prelude.Internal
string 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.CharParsing
stripExeDistribution.Simple.Program.Strip
stripExesDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
stripExtractVersionDistribution.Simple.Program.Internal
stripLibDistribution.Simple.Program.Strip
stripLibsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
stripParensVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
stripProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
stronglyConnCompDistribution.Compat.Graph
stubFilePathDistribution.Simple.Test.LibV09
stubMainDistribution.Simple.Test.LibV09
stubNameDistribution.Simple.Test.LibV09
stubWriteLogDistribution.Simple.Test.LibV09
subLibraries 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
substituteInstallDirTemplatesDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
substPathTemplate 
1 (Function)Distribution.Simple.InstallDirs
2 (Function)Distribution.Simple.LocalBuildInfo
subtractDistribution.Compat.Prelude.Internal
succDistribution.Compat.Prelude.Internal
succeedReadEDistribution.ReadE
SugarCRM_1_1_3Distribution.SPDX.LicenseId, Distribution.SPDX
suiteErrorDistribution.Simple.Test.Log
suiteFailedDistribution.Simple.Test.Log
suitePassedDistribution.Simple.Test.Log
sumDistribution.Compat.Prelude.Internal
summarizePackageDistribution.Simple.Test.Log
summarizeSuiteFinishDistribution.Simple.Test.Log
summarizeSuiteStartDistribution.Simple.Test.Log
summarizeTestDistribution.Simple.Test.Log
supportsDebugLevelsDistribution.Simple.GHC
supportsDirDbsDistribution.Simple.Program.HcPkg
supportsHaskell2010Distribution.Simple.GHC
supportsPkgEnvFilesDistribution.Simple.GHC
suppressFilesCheckDistribution.Simple.Program.HcPkg
suppressOverrideArgsDistribution.Simple.Program.Types, Distribution.Simple.Program
SVNDistribution.Types.SourceRepo, Distribution.PackageDescription
SWLDistribution.SPDX.LicenseId, Distribution.SPDX
synopsis 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
sysconfdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
tabDistribution.Compat.CharParsing
TabsErrorDistribution.InstalledPackageInfo
tagsDistribution.TestSuite
tailDistribution.Compat.Prelude.Internal
takeDistribution.Compat.Prelude.Internal
takeFieldsDistribution.FieldGrammar
takeWhileDistribution.Compat.Prelude.Internal
takeWhileEndLEDistribution.Utils.Generic, Distribution.Simple.Utils
tanDistribution.Compat.Prelude.Internal
tanhDistribution.Compat.Prelude.Internal
targetBuildDepends 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
targetCLBIDistribution.Types.TargetInfo
targetComponentDistribution.Types.TargetInfo
TargetInfo 
1 (Type/Class)Distribution.Types.TargetInfo
2 (Data Constructor)Distribution.Types.TargetInfo
tarProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
TCLDistribution.SPDX.LicenseId, Distribution.SPDX
TCP_wrappersDistribution.SPDX.LicenseId, Distribution.SPDX
TempFileOptions 
1 (Type/Class)Distribution.Simple.Utils
2 (Data Constructor)Distribution.Simple.Utils
TemplateHaskellLanguage.Haskell.Extension, Distribution.Simple
TemplateHaskellQuotesLanguage.Haskell.Extension, Distribution.Simple
Test 
1 (Type/Class)Distribution.TestSuite
2 (Data Constructor)Distribution.TestSuite
testDistribution.Simple.Test
testBuildInfo 
1 (Function)Distribution.Types.TestSuite, Distribution.PackageDescription
2 (Function)Distribution.Types.TestSuite.Lens, Distribution.Types.Lens
testCommandDistribution.Simple.Setup
TestComponentLocalBuildInfoDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
testCoverageDistribution.Types.LocalBuildInfo
testDistPrefDistribution.Simple.Setup
TestedWith 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
testedWith 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
TestFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
testGroupDistribution.TestSuite
testHookDistribution.Simple.UserHooks, Distribution.Simple
testHumanLogDistribution.Simple.Setup
TestInstance 
1 (Type/Class)Distribution.TestSuite
2 (Data Constructor)Distribution.TestSuite
testInterface 
1 (Function)Distribution.Types.TestSuite, Distribution.PackageDescription
2 (Function)Distribution.Types.TestSuite.Lens, Distribution.Types.Lens
testKeepTixDistribution.Simple.Setup
TestLogDistribution.Simple.Test.Log
TestLogsDistribution.Simple.Test.Log
testLogsDistribution.Simple.Test.Log
testMachineLogDistribution.Simple.Setup
testModulesDistribution.Types.TestSuite, Distribution.PackageDescription
testModulesAutogenDistribution.Types.TestSuite, Distribution.PackageDescription
testName 
1 (Function)Distribution.Types.TestSuite, Distribution.PackageDescription
2 (Function)Distribution.Types.TestSuite.Lens, Distribution.Types.Lens
3 (Function)Distribution.Simple.Test.Log
testOptionsDistribution.Simple.Setup
testOptionsReturnedDistribution.Simple.Test.Log
testResultDistribution.Simple.Test.Log
TestShowDetailsDistribution.Simple.Setup
testShowDetailsDistribution.Simple.Setup
testsRequestedDistribution.Types.ComponentRequestedSpec
testStanzaBuildInfoDistribution.PackageDescription.FieldGrammar
testStanzaMainIsDistribution.PackageDescription.FieldGrammar
testStanzaTestModuleDistribution.PackageDescription.FieldGrammar
testStanzaTestTypeDistribution.PackageDescription.FieldGrammar
TestSuite 
1 (Type/Class)Distribution.Types.TestSuite, Distribution.Types.TestSuite.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.TestSuite, Distribution.PackageDescription
TestSuiteExeV10Distribution.Types.TestSuiteInterface, Distribution.PackageDescription
testSuiteFieldGrammarDistribution.PackageDescription.FieldGrammar
TestSuiteInterfaceDistribution.Types.TestSuiteInterface, Distribution.PackageDescription
TestSuiteLibV09Distribution.Types.TestSuiteInterface, Distribution.PackageDescription
TestSuiteLog 
1 (Type/Class)Distribution.Simple.Test.Log
2 (Data Constructor)Distribution.Simple.Test.Log
testSuiteLogPathDistribution.Simple.Test.Log
testSuiteNameDistribution.Simple.Test.Log
TestSuiteNameVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
TestSuiteResultVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
testSuites 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Simple.Test.Log
TestSuiteStanza 
1 (Type/Class)Distribution.PackageDescription.FieldGrammar
2 (Data Constructor)Distribution.PackageDescription.FieldGrammar
TestSuiteUnsupportedDistribution.Types.TestSuiteInterface, Distribution.PackageDescription
TestTypeDistribution.Types.TestType, Distribution.PackageDescription
testTypeDistribution.Types.TestSuite, Distribution.PackageDescription
TestTypeExeDistribution.Types.TestType, Distribution.PackageDescription
TestTypeLibDistribution.Types.TestType, Distribution.PackageDescription
TestTypeUnknownDistribution.Types.TestType, Distribution.PackageDescription
testVerbosityDistribution.Simple.Setup
TextDistribution.Text
textDistribution.Compat.CharParsing
thisPackageVersionDistribution.Types.Dependency, Distribution.Package, Distribution.Make, Distribution.Simple
ThisVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
thisVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
ThisVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
tixDirDistribution.Simple.Hpc
tixFilePathDistribution.Simple.Hpc
TMateDistribution.SPDX.LicenseId, Distribution.SPDX
toConfiguredComponentDistribution.Backpack.ConfiguredComponent
toConfiguredComponentsDistribution.Backpack.ConfiguredComponent
toDepMapDistribution.Types.DependencyMap
toDListOfDistribution.Compat.Lens
toEnumDistribution.Compat.Prelude.Internal
toFilePathDistribution.ModuleName
toFlagDistribution.Simple.Flag, Distribution.Simple.Setup
toGraphDistribution.Compat.Graph
toIntegerDistribution.Compat.Prelude.Internal
Token 
1 (Type/Class)Distribution.Parsec.Lexer
2 (Type/Class)Distribution.Parsec.Newtypes
3 (Data Constructor)Distribution.Parsec.Newtypes
Token' 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
TokFieldLineDistribution.Parsec.Lexer
TokOtherDistribution.Parsec.Lexer
TokStrDistribution.Parsec.Lexer
TokSymDistribution.Parsec.Lexer
toLinkedComponentDistribution.Backpack.LinkedComponent
toLinkedComponentsDistribution.Backpack.LinkedComponent
toList 
1 (Function)Distribution.Compat.Graph
2 (Function)Distribution.Compat.DList
toListOfDistribution.Compat.Lens
toLowerDistribution.Compat.Prelude.Internal
toMapDistribution.Compat.Graph
toNubListDistribution.Utils.NubList
toNubListRDistribution.Utils.NubList
toPathTemplateDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
topHandlerDistribution.Simple.Utils
topHandlerWithDistribution.Simple.Utils
topologicalOrderDistribution.Simple.PackageIndex
toPreModuleShapeDistribution.Backpack.PreModuleShape
topSortDistribution.Compat.Graph
toPWarningsDistribution.Parsec.LexerMonad
toRationalDistribution.Compat.Prelude.Internal
TORQUE_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
toSetOfDistribution.Compat.Lens
toShortTextDistribution.Utils.ShortText
TOSLDistribution.SPDX.LicenseId, Distribution.SPDX
toUpperDistribution.Compat.Prelude.Internal
toUTF8BSDistribution.Utils.Generic, Distribution.Simple.Utils
toUTF8LBSDistribution.Utils.Generic, Distribution.Simple.Utils
toVersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
TraditionalRecordSyntaxLanguage.Haskell.Extension, Distribution.Simple
transformAllBuildDependsDistribution.PackageDescription.Configuration
transformAllBuildInfosDistribution.PackageDescription.Configuration
TransformListCompLanguage.Haskell.Extension, Distribution.Simple
TraversableDistribution.Compat.Prelude.Internal
TraversalDistribution.Compat.Lens
Traversal'Distribution.Compat.Lens
traverseDistribution.Compat.Prelude.Internal
traverseBuildInfosDistribution.Types.BuildInfo.Lens, Distribution.Types.Lens
traverseCondBranchCDistribution.Types.CondTree
traverseCondBranchVDistribution.Types.CondTree
traverseCondTreeCDistribution.Types.CondTree
traverseCondTreeVDistribution.Types.CondTree
traverse_Distribution.Compat.Prelude.Internal
TrueDistribution.Compat.Prelude.Internal
trueArgDistribution.Simple.Setup
truncateDistribution.Compat.Prelude.Internal
trusted 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
TrustworthyLanguage.Haskell.Extension, Distribution.Simple
tryDistribution.Compat.Parsing, Distribution.Compat.CharParsing
tryFindPackageDescDistribution.Simple.Utils
tryGetConfigStateFileDistribution.Simple.Configure
tryGetPersistBuildConfigDistribution.Simple.Configure
tryIODistribution.Compat.Exception
TupleSectionsLanguage.Haskell.Extension, Distribution.Simple
TU_Berlin_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
TU_Berlin_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
TypeableDistribution.Compat.Prelude.Internal
TypeApplicationsLanguage.Haskell.Extension, Distribution.Simple
TypeFamiliesLanguage.Haskell.Extension, Distribution.Simple
TypeFamilyDependenciesLanguage.Haskell.Extension, Distribution.Simple
TypeInTypeLanguage.Haskell.Extension, Distribution.Simple
TypeOperatorsLanguage.Haskell.Extension, Distribution.Simple
TypeSynonymInstancesLanguage.Haskell.Extension, Distribution.Simple
UHCDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
uhcProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
unAbiHashDistribution.Types.AbiHash, Distribution.Package, Distribution.Make, Distribution.Simple
UnambiguousDistribution.Simple.PackageIndex
UnboxedSumsLanguage.Haskell.Extension, Distribution.Simple
UnboxedTuplesLanguage.Haskell.Extension, Distribution.Simple
unComponentIdDistribution.Types.ComponentId, Distribution.Package, Distribution.Make, Distribution.Simple
unconfigureProgramDistribution.Simple.Program.Db
uncurryDistribution.Compat.Prelude.Internal
UndecidableInstancesLanguage.Haskell.Extension, Distribution.Simple
UndecidableSuperClassesLanguage.Haskell.Extension, Distribution.Simple
undefinedDistribution.Compat.Prelude.Internal
unDefUnitIdDistribution.Types.UnitId, Distribution.Backpack, Distribution.Package, Distribution.Make, Distribution.Simple
unexpectedDistribution.Compat.Parsing, Distribution.Compat.CharParsing
unFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
unFlagNameDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
unfoldrDistribution.Compat.Prelude.Internal
unfoldrMDistribution.Utils.Generic
UnicodeSyntaxLanguage.Haskell.Extension, Distribution.Simple
Unicode_DFS_2015Distribution.SPDX.LicenseId, Distribution.SPDX
Unicode_DFS_2016Distribution.SPDX.LicenseId, Distribution.SPDX
Unicode_TOUDistribution.SPDX.LicenseId, Distribution.SPDX
unifiedIPIDRequiredDistribution.Simple.Compiler, Distribution.Simple
unintersperseDistribution.Utils.Generic, Distribution.Simple.Utils
unionDistribution.Simple.Program.Hpc
unionLeftDistribution.Compat.Graph
unionRightDistribution.Compat.Graph
unionVersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
UnionVersionRangesDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
unionVersionRangesDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
UnionVersionRangesFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
uniqueFieldDistribution.FieldGrammar.Class, Distribution.FieldGrammar
uniqueFieldAlaDistribution.FieldGrammar.Class, Distribution.FieldGrammar
UnitIdDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
unitIdSupportedDistribution.Simple.Compiler, Distribution.Simple
unitIdTargetDistribution.Types.LocalBuildInfo
unitIdTarget'Distribution.Types.LocalBuildInfo
unknownCompilerInfoDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
UnknownExtensionLanguage.Haskell.Extension, Distribution.Simple
UnknownLanguageLanguage.Haskell.Extension, Distribution.Simple
UnknownLicenseDistribution.License, Distribution.Make, Distribution.Simple
unlessDistribution.Compat.Prelude.Internal
unLexDistribution.Parsec.LexerMonad
UnlicenseDistribution.SPDX.LicenseId, Distribution.SPDX
UnliftedFFITypesLanguage.Haskell.Extension, Distribution.Simple
unlinesDistribution.Compat.Prelude.Internal
unlitDistribution.Simple.PreProcess.Unlit
unMungedPackageNameDistribution.Types.MungedPackageName
unpackDistribution.Compat.Newtype
unpack'Distribution.Compat.Newtype
unPackageNameDistribution.Types.PackageName, Distribution.Package, Distribution.Make, Distribution.Simple
unPkgconfigNameDistribution.Types.PkgconfigName, Distribution.Package, Distribution.Make, Distribution.Simple
unPPDistribution.Parsec.Class
UnqualComponentNameDistribution.Types.UnqualComponentName
unqualComponentNameToPackageNameDistribution.Types.UnqualComponentName
unregHookDistribution.Simple.UserHooks, Distribution.Simple
unregister 
1 (Function)Distribution.Simple.Program.HcPkg
2 (Function)Distribution.Simple.Register
unregisterCommandDistribution.Simple.Setup
unregisterInvocationDistribution.Simple.Program.HcPkg
UnsafeLanguage.Haskell.Extension, Distribution.Simple
unsafeMkDefUnitIdDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
UnspecifiedLicenseDistribution.License, Distribution.Make, Distribution.Simple
unsupportedExtensionsDistribution.Simple.Compiler, Distribution.Simple
unsupportedLanguagesDistribution.Simple.Compiler, Distribution.Simple
untilDistribution.Compat.Prelude.Internal
unUnitIdDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
unUnqualComponentNameDistribution.Types.UnqualComponentName
unvalidateBenchmarkDistribution.PackageDescription.FieldGrammar
unvalidateTestSuiteDistribution.PackageDescription.FieldGrammar
unwordsDistribution.Compat.Prelude.Internal
unzipDistribution.Compat.Prelude.Internal
unzip3Distribution.Compat.Prelude.Internal
updatePackageDescriptionDistribution.Types.PackageDescription, Distribution.PackageDescription
updateProgramDistribution.Simple.Program.Db, Distribution.Simple.Program
UPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
upperDistribution.Compat.CharParsing
UpperBound 
1 (Type/Class)Distribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
2 (Data Constructor)Distribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
usageAlternativesDistribution.Simple.Command
usageDefaultDistribution.Simple.Command
useDistribution.Compat.Lens
usedExtensionsDistribution.Types.BuildInfo, Distribution.PackageDescription
userBugDistribution.PackageDescription.Utils
UserBuildTargetDistribution.Simple.BuildTarget
UserBuildTargetProblemDistribution.Simple.BuildTarget
UserBuildTargetUnrecognisedDistribution.Simple.BuildTarget
userErrorDistribution.Compat.Prelude.Internal
UserHooks 
1 (Type/Class)Distribution.Simple.UserHooks, Distribution.Simple
2 (Data Constructor)Distribution.Simple.UserHooks, Distribution.Simple
userMaybeSpecifyPathDistribution.Simple.Program.Db, Distribution.Simple.Program
UserPackageDBDistribution.Simple.Compiler, Distribution.Simple
UserSpecifiedDistribution.Simple.Program.Types, Distribution.Simple.Program
userSpecifiedArgsDistribution.Simple.Program.Db, Distribution.Simple.Program
userSpecifyArgsDistribution.Simple.Program.Db, Distribution.Simple.Program
userSpecifyArgssDistribution.Simple.Program.Db, Distribution.Simple.Program
userSpecifyPathDistribution.Simple.Program.Db, Distribution.Simple.Program
userSpecifyPathsDistribution.Simple.Program.Db, Distribution.Simple.Program
usesTemplateHaskellOrQQDistribution.Types.BuildInfo, Distribution.PackageDescription
U_boot_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
validateBenchmarkDistribution.PackageDescription.FieldGrammar
validateTestSuiteDistribution.PackageDescription.FieldGrammar
validateUTF8Distribution.Utils.Generic
validModuleComponentDistribution.ModuleName
validVersionDistribution.Types.Version
VanillaDistribution.Simple.Hpc
VarDistribution.Types.Condition, Distribution.PackageDescription
VaxDistribution.System
VCat 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
verboseDistribution.Verbosity
verboseCallSiteDistribution.Verbosity
verboseCallStackDistribution.Verbosity
verboseHasFlagsDistribution.Verbosity
verboseMarkOutputDistribution.Verbosity
verboseNoFlagsDistribution.Verbosity
verboseNoTimestampDistribution.Verbosity
verboseNoWrapDistribution.Verbosity
verboseTimestampDistribution.Verbosity
verboseUnmarkOutputDistribution.Verbosity
VerbosityDistribution.Verbosity
VersionDistribution.Types.Version, Distribution.Version, Distribution.Make, Distribution.Simple
version0Distribution.Types.Version, Distribution.Version, Distribution.Simple
VersionDoesNotSupportGlobDistribution.Simple.Glob
VersionDoesNotSupportGlobStarDistribution.Simple.Glob
VersionIntervalDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
VersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
versionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
versionNumbersDistribution.Types.Version, Distribution.Version, Distribution.Simple
VersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
VersionRangeFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
VersionRangeParensDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
VersionRangeParensFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
viewDistribution.Compat.Lens
viewAsFieldDescrDistribution.Simple.Command
ViewPatternsLanguage.Haskell.Extension, Distribution.Simple
VimDistribution.SPDX.LicenseId, Distribution.SPDX
virtualModules 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
voidDistribution.Compat.Prelude.Internal
VOSTROMDistribution.SPDX.LicenseId, Distribution.SPDX
VSL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
W3CDistribution.SPDX.LicenseId, Distribution.SPDX
W3C_19980720Distribution.SPDX.LicenseId, Distribution.SPDX
W3C_20150513Distribution.SPDX.LicenseId, Distribution.SPDX
warnDistribution.Simple.Utils
warningsDistribution.Parsec.LexerMonad
warnProgressDistribution.Utils.LogProgress
Watcom_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
WayDistribution.Simple.Hpc
whenDistribution.Compat.Prelude.Internal
wildcardUpperBoundDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
WildcardVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
WildcardVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
WindowsDistribution.System
withAllComponentsInBuildOrderDistribution.Simple.LocalBuildInfo
withAllTargetsInBuildOrderDistribution.Types.LocalBuildInfo
withAllTargetsInBuildOrder'Distribution.Types.LocalBuildInfo
withBenchLBIDistribution.Simple.LocalBuildInfo
withBenchmarkDistribution.Types.PackageDescription, Distribution.PackageDescription
WithCallStackDistribution.Compat.Stack
withComponentsInBuildOrderDistribution.Simple.LocalBuildInfo
withComponentsLBIDistribution.Simple.LocalBuildInfo
withDebugInfoDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withDynExeDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withExeDistribution.Types.PackageDescription, Distribution.PackageDescription
withExeLBIDistribution.Simple.LocalBuildInfo
withFileContentsDistribution.Utils.Generic, Distribution.Simple.Utils
withForeignLibDistribution.Types.PackageDescription
withFrozenCallStackDistribution.Compat.Stack
withGHCiLibDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withinIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
withinRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
withinVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
withLexicalCallStackDistribution.Compat.Stack
withLibDistribution.Types.PackageDescription, Distribution.PackageDescription
withLibLBIDistribution.Simple.LocalBuildInfo
withNeededTargetsInBuildOrderDistribution.Types.LocalBuildInfo
withNeededTargetsInBuildOrder'Distribution.Types.LocalBuildInfo
withOptimizationDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withOutputMarkerDistribution.Simple.Utils
withPackageDBDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withProfExeDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withProfExeDetailDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withProfLibDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withProfLibDetailDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withProgramsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withResponseFileDistribution.Simple.Program.ResponseFile
withSharedLibDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withStaticLibDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withTempDirectoryDistribution.Simple.Utils
withTempDirectoryExDistribution.Simple.Utils
withTempFileDistribution.Simple.Utils
withTempFileExDistribution.Simple.Utils
withTestDistribution.Types.PackageDescription, Distribution.PackageDescription
withTestLBIDistribution.Simple.LocalBuildInfo
withUTF8FileContentsDistribution.Utils.Generic, Distribution.Simple.Utils
withVanillaLibDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
WordDistribution.Compat.Binary, Distribution.Compat.Prelude.Internal
Word16Distribution.Compat.Binary, Distribution.Compat.Prelude.Internal
Word32Distribution.Compat.Binary, Distribution.Compat.Prelude.Internal
Word64Distribution.Compat.Binary, Distribution.Compat.Prelude.Internal
Word8Distribution.Compat.Binary, Distribution.Compat.Prelude.Internal
wordsDistribution.Compat.Prelude.Internal
wrapLineDistribution.Utils.Generic, Distribution.Simple.Utils
wrapTextDistribution.Utils.Generic, Distribution.Simple.Utils
writeAutogenFilesDistribution.Simple.Build
writeFileDistribution.Compat.Prelude.Internal
writeFileAtomicDistribution.Utils.Generic, Distribution.Simple.Utils
writeGenericPackageDescriptionDistribution.PackageDescription.PrettyPrint
writeGhcEnvironmentFileDistribution.Simple.GHC
writeHookedBuildInfoDistribution.PackageDescription.PrettyPrint
writePackageDescriptionDistribution.PackageDescription.PrettyPrint
writePersistBuildConfigDistribution.Simple.Configure
writeSimpleTestStubDistribution.Simple.Test.LibV09
writeUTF8FileDistribution.Utils.Generic, Distribution.Simple.Utils
WsuipaDistribution.SPDX.LicenseId, Distribution.SPDX
WTFPLDistribution.SPDX.LicenseId, Distribution.SPDX
WxWindows_exception_3_1Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
X11Distribution.SPDX.LicenseId, Distribution.SPDX
X86_64Distribution.System
xargsDistribution.Simple.Utils
XeroxDistribution.SPDX.LicenseId, Distribution.SPDX
XFree86_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
XinetdDistribution.SPDX.LicenseId, Distribution.SPDX
XmlSyntaxLanguage.Haskell.Extension, Distribution.Simple
XnetDistribution.SPDX.LicenseId, Distribution.SPDX
XppDistribution.SPDX.LicenseId, Distribution.SPDX
XSkatDistribution.SPDX.LicenseId, Distribution.SPDX
YHCDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
YPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
YPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
ZedDistribution.SPDX.LicenseId, Distribution.SPDX
Zend_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
zeroPosDistribution.Parsec.Common
Zimbra_1_3Distribution.SPDX.LicenseId, Distribution.SPDX
Zimbra_1_4Distribution.SPDX.LicenseId, Distribution.SPDX
zipDistribution.Compat.Prelude.Internal
zip3Distribution.Compat.Prelude.Internal
zipWithDistribution.Compat.Prelude.Internal
zipWith3Distribution.Compat.Prelude.Internal
ZlibDistribution.SPDX.LicenseId, Distribution.SPDX
Zlib_acknowledgementDistribution.SPDX.LicenseId, Distribution.SPDX
ZPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
ZPL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
ZPL_2_1Distribution.SPDX.LicenseId, Distribution.SPDX
^Distribution.Compat.Prelude.Internal
^#Distribution.Compat.Lens
^.Distribution.Compat.Lens
^^Distribution.Compat.Prelude.Internal
^^^Distribution.FieldGrammar
_1Distribution.Compat.Lens
_2Distribution.Compat.Lens
_ArchDistribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
_benchmarkStanzaBenchmarkModuleDistribution.PackageDescription.FieldGrammar
_benchmarkStanzaBenchmarkTypeDistribution.PackageDescription.FieldGrammar
_benchmarkStanzaBuildInfoDistribution.PackageDescription.FieldGrammar
_benchmarkStanzaMainIsDistribution.PackageDescription.FieldGrammar
_FlagDistribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
_ImplDistribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
_OSDistribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
_testStanzaBuildInfoDistribution.PackageDescription.FieldGrammar
_testStanzaMainIsDistribution.PackageDescription.FieldGrammar
_testStanzaTestModuleDistribution.PackageDescription.FieldGrammar
_testStanzaTestTypeDistribution.PackageDescription.FieldGrammar
||Distribution.Compat.Prelude.Internal
diff --git a/doc/API/Cabal/doc-index-B.html b/doc/API/Cabal/doc-index-B.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-B.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - B)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - B

backpackSupportedDistribution.Simple.Compiler, Distribution.Simple
BahyphDistribution.SPDX.LicenseId, Distribution.SPDX
BangPatternsLanguage.Haskell.Extension, Distribution.Simple
BarrDistribution.SPDX.LicenseId, Distribution.SPDX
BazaarDistribution.Types.SourceRepo, Distribution.PackageDescription
BeerwareDistribution.SPDX.LicenseId, Distribution.SPDX
benchDistribution.Simple.Bench
BenchComponentLocalBuildInfoDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
benchHookDistribution.Simple.UserHooks, Distribution.Simple
Benchmark 
1 (Type/Class)Distribution.Types.Benchmark, Distribution.Types.Benchmark.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.Benchmark, Distribution.PackageDescription
benchmarkBuildInfo 
1 (Function)Distribution.Types.Benchmark, Distribution.PackageDescription
2 (Function)Distribution.Types.Benchmark.Lens, Distribution.Types.Lens
benchmarkCommandDistribution.Simple.Setup
benchmarkDistPrefDistribution.Simple.Setup
BenchmarkExeV10Distribution.Types.BenchmarkInterface, Distribution.PackageDescription
benchmarkFieldGrammarDistribution.PackageDescription.FieldGrammar
BenchmarkFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
BenchmarkInterfaceDistribution.Types.BenchmarkInterface, Distribution.PackageDescription
benchmarkInterface 
1 (Function)Distribution.Types.Benchmark, Distribution.PackageDescription
2 (Function)Distribution.Types.Benchmark.Lens, Distribution.Types.Lens
benchmarkModulesDistribution.Types.Benchmark, Distribution.PackageDescription
benchmarkModulesAutogenDistribution.Types.Benchmark, Distribution.PackageDescription
benchmarkName 
1 (Function)Distribution.Types.Benchmark, Distribution.PackageDescription
2 (Function)Distribution.Types.Benchmark.Lens, Distribution.Types.Lens
BenchmarkNameVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
benchmarkOptionsDistribution.Simple.Setup
benchmarks 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
benchmarksRequestedDistribution.Types.ComponentRequestedSpec
BenchmarkStanza 
1 (Type/Class)Distribution.PackageDescription.FieldGrammar
2 (Data Constructor)Distribution.PackageDescription.FieldGrammar
benchmarkStanzaBenchmarkModuleDistribution.PackageDescription.FieldGrammar
benchmarkStanzaBenchmarkTypeDistribution.PackageDescription.FieldGrammar
benchmarkStanzaBuildInfoDistribution.PackageDescription.FieldGrammar
benchmarkStanzaMainIsDistribution.PackageDescription.FieldGrammar
BenchmarkTypeDistribution.Types.BenchmarkType, Distribution.PackageDescription
benchmarkTypeDistribution.Types.Benchmark, Distribution.PackageDescription
BenchmarkTypeExeDistribution.Types.BenchmarkType, Distribution.PackageDescription
BenchmarkTypeUnknownDistribution.Types.BenchmarkType, Distribution.PackageDescription
BenchmarkUnsupportedDistribution.Types.BenchmarkInterface, Distribution.PackageDescription
benchmarkVerbosityDistribution.Simple.Setup
between 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
betweenVersionsInclusiveDistribution.Version, Distribution.Simple
BinaryDistribution.Compat.Binary, Distribution.Compat.Prelude.Internal
BinaryLiteralsLanguage.Haskell.Extension, Distribution.Simple
bindirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
BindirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
Bison_exception_2_2Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
BitTorrent_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
BitTorrent_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
BlockArgumentsLanguage.Haskell.Extension, Distribution.Simple
blurFieldGrammarDistribution.FieldGrammar.Class, Distribution.FieldGrammar
bol_sectionDistribution.Parsec.Lexer
BoolDistribution.Compat.Prelude.Internal
booleanFieldDefDistribution.FieldGrammar.Class, Distribution.FieldGrammar
BooleanFlagDistribution.Simple.Flag, Distribution.Simple.Setup
BoolOptDistribution.Simple.Command
boolOpt 
1 (Function)Distribution.Simple.Command
2 (Function)Distribution.Simple.Setup
boolOpt' 
1 (Function)Distribution.Simple.Command
2 (Function)Distribution.Simple.Setup
Bootloader_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
BorceuxDistribution.SPDX.LicenseId, Distribution.SPDX
BoundDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
BoundedDistribution.Compat.Prelude.Internal
breakDistribution.Compat.Prelude.Internal
breakMaybeDistribution.Utils.Generic
brokenDistribution.Compat.Graph
brokenPackagesDistribution.Simple.PackageIndex
BSD2Distribution.License, Distribution.Make, Distribution.Simple
BSD3Distribution.License, Distribution.Make, Distribution.Simple
BSD4Distribution.License, Distribution.Make, Distribution.Simple
BSD_1_ClauseDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_2_ClauseDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_2_Clause_FreeBSDDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_2_Clause_NetBSDDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_2_Clause_PatentDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_3_ClauseDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_3_Clause_AttributionDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_3_Clause_ClearDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_3_Clause_LBNLDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_3_Clause_No_Nuclear_LicenseDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_3_Clause_No_Nuclear_License_2014Distribution.SPDX.LicenseId, Distribution.SPDX
BSD_3_Clause_No_Nuclear_WarrantyDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_4_ClauseDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_4_Clause_UCDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_ProtectionDistribution.SPDX.LicenseId, Distribution.SPDX
BSD_Source_CodeDistribution.SPDX.LicenseId, Distribution.SPDX
BSL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
bugReports 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
buildDistribution.Simple.Build
buildable 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
buildArchDistribution.System
buildArgsDistribution.Simple.Setup
buildCabalFilePathDistribution.Simple.Setup
buildCommandDistribution.Simple.Setup
buildCompilerFlavorDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
buildCompilerIdDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
buildDirDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
buildDistPrefDistribution.Simple.Setup
buildExe 
1 (Function)Distribution.Simple.UHC
2 (Function)Distribution.Simple.GHCJS
3 (Function)Distribution.Simple.GHC
BuildFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
buildFLibDistribution.Simple.GHC
buildHookDistribution.Simple.UserHooks, Distribution.Simple
BuildInfo 
1 (Type/Class)Distribution.Types.BuildInfo, Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.BuildInfo, Distribution.PackageDescription
buildInfo 
1 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
2 (Function)Distribution.Types.Executable, Distribution.PackageDescription
buildInfoFieldGrammarDistribution.PackageDescription.FieldGrammar
buildLib 
1 (Function)Distribution.Simple.UHC
2 (Function)Distribution.Simple.HaskellSuite
3 (Function)Distribution.Simple.GHCJS
4 (Function)Distribution.Simple.GHC
buildNumJobsDistribution.Simple.Setup
buildOptionsDistribution.Simple.Setup
buildOSDistribution.System
buildPlatformDistribution.System
buildProgramArgsDistribution.Simple.Setup
buildProgramPathsDistribution.Simple.Setup
BuildTargetDistribution.Simple.BuildTarget
BuildTargetAmbiguousDistribution.Simple.BuildTarget
BuildTargetComponentDistribution.Simple.BuildTarget
buildTargetComponentNameDistribution.Simple.BuildTarget
BuildTargetExpectedDistribution.Simple.BuildTarget
BuildTargetFileDistribution.Simple.BuildTarget
BuildTargetModuleDistribution.Simple.BuildTarget
BuildTargetNoSuchDistribution.Simple.BuildTarget
BuildTargetProblemDistribution.Simple.BuildTarget
buildToolDepends 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
buildTools 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
BuildTypeDistribution.Types.BuildType, Distribution.PackageDescription
buildTypeDistribution.Types.PackageDescription, Distribution.PackageDescription
buildTypeRaw 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
buildVerboseDistribution.Simple.Setup
buildVerbosityDistribution.Simple.Setup
builtinProgramsDistribution.Simple.Program.Builtin, Distribution.Simple.Program
byteSwap16Distribution.Compat.Binary
byteSwap32Distribution.Compat.Binary
byteSwap64Distribution.Compat.Binary
Bzip2_1_0_5Distribution.SPDX.LicenseId, Distribution.SPDX
Bzip2_1_0_6Distribution.SPDX.LicenseId, Distribution.SPDX
diff --git a/doc/API/Cabal/doc-index-C.html b/doc/API/Cabal/doc-index-C.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-C.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - C)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - C

CDistribution.Simple.CCompiler
c2hsProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
cabalBugDistribution.PackageDescription.Utils
CabalFeatureDistribution.CabalSpecVersion
cabalFilePathDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
CabalParsingDistribution.Parsec.Class
cabalSpecFeaturesDistribution.CabalSpecVersion
cabalSpecLatestDistribution.CabalSpecVersion
CabalSpecOldDistribution.CabalSpecVersion
cabalSpecSupportsDistribution.CabalSpecVersion
CabalSpecV1_22Distribution.CabalSpecVersion
CabalSpecV1_24Distribution.CabalSpecVersion
CabalSpecV2_0Distribution.CabalSpecVersion
CabalSpecV2_2Distribution.CabalSpecVersion
CabalSpecV2_4Distribution.CabalSpecVersion
CabalSpecVersionDistribution.CabalSpecVersion
cabalSpecVersionToSPDXListVersionDistribution.SPDX.LicenseListVersion, Distribution.SPDX
cabalVersionDistribution.Simple.Utils
CalderaDistribution.SPDX.LicenseId, Distribution.SPDX
calibrateMtimeChangeDelayDistribution.Compat.Time
CallStackDistribution.Compat.Stack
callStackDistribution.Compat.Stack
CAndDistribution.Types.Condition, Distribution.PackageDescription
cAndDistribution.Types.Condition, Distribution.PackageDescription
CApiFFILanguage.Haskell.Extension, Distribution.Simple
cataVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
catchExitDistribution.Compat.Exception
catchIODistribution.Compat.Exception
category 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
catMaybesDistribution.Compat.Prelude.Internal
CATOSL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
CBenchDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
CBenchNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
CC0_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
ccLdOptionsBuildInfoDistribution.Simple.Configure
ccOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
cc_ann_idDistribution.Backpack.ConfiguredComponent
CC_BY_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_2_5Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_4_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_2_5Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_4_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_ND_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_ND_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_ND_2_5Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_ND_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_ND_4_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_SA_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_SA_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_SA_2_5Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_SA_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_NC_SA_4_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_ND_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_ND_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_ND_2_5Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_ND_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_ND_4_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_SA_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_SA_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_SA_2_5Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_SA_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
CC_BY_SA_4_0Distribution.SPDX.LicenseId, Distribution.SPDX
cc_cidDistribution.Backpack.ConfiguredComponent
cc_componentDistribution.Backpack.ConfiguredComponent
cc_exe_depsDistribution.Backpack.ConfiguredComponent
cc_includesDistribution.Backpack.ConfiguredComponent
cc_nameDistribution.Backpack.ConfiguredComponent
cc_pkgidDistribution.Backpack.ConfiguredComponent
cc_publicDistribution.Backpack.ConfiguredComponent
CDDL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CDDL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
CDialectDistribution.Simple.CCompiler
cDialectFilenameExtensionDistribution.Simple.CCompiler
CDLA_Permissive_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CDLA_Sharing_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CECILL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CECILL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
CECILL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
CECILL_2_1Distribution.SPDX.LicenseId, Distribution.SPDX
CECILL_BDistribution.SPDX.LicenseId, Distribution.SPDX
CECILL_CDistribution.SPDX.LicenseId, Distribution.SPDX
ceilingDistribution.Compat.Prelude.Internal
CExeDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
CExeNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
CFLibDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
CFLibNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
chainl 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
chainl1 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
chainr 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
chainr1 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
CharDistribution.Compat.Prelude.Internal
char 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.CharParsing
CharParsingDistribution.Compat.CharParsing
chattyTryDistribution.Simple.Utils
checkConfiguredPackageDistribution.PackageDescription.Check
checkForeignDepsDistribution.Simple.Configure
checkPackageDistribution.PackageDescription.Check
checkPackageContentDistribution.PackageDescription.Check
CheckPackageContentOps 
1 (Type/Class)Distribution.PackageDescription.Check
2 (Data Constructor)Distribution.PackageDescription.Check
checkPackageFileNamesDistribution.PackageDescription.Check
checkPackageFilesDistribution.PackageDescription.Check
checkPersistBuildConfigOutdatedDistribution.Simple.Configure
choice 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
ChoiceOptDistribution.Simple.Command
choiceOptDistribution.Simple.Command
choiceOptFromEnumDistribution.Simple.Command
chrDistribution.Compat.Prelude.Internal
ci_ann_idDistribution.Types.ComponentInclude
ci_cnameDistribution.Types.ComponentInclude
ci_idDistribution.Types.ComponentInclude
ci_implicitDistribution.Types.ComponentInclude
ci_pkgidDistribution.Types.ComponentInclude
ci_renamingDistribution.Types.ComponentInclude
ClArtisticDistribution.SPDX.LicenseId, Distribution.SPDX
ClassificationStrictnessDistribution.System
classifyArchDistribution.System
classifyCompilerFlavorDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
classifyExtensionLanguage.Haskell.Extension, Distribution.Simple
classifyLanguageLanguage.Haskell.Extension, Distribution.Simple
classifyOSDistribution.System
classifyRepoKindDistribution.Types.SourceRepo
classifyRepoTypeDistribution.Types.SourceRepo
Classpath_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
cleanCabalFilePathDistribution.Simple.Setup
cleanCommandDistribution.Simple.Setup
cleanDistPrefDistribution.Simple.Setup
CleanFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
cleanHookDistribution.Simple.UserHooks, Distribution.Simple
cleanSaveConfDistribution.Simple.Setup
cleanVerbosityDistribution.Simple.Setup
CLibDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
CLibNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
CLISP_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
cloneLensDistribution.Compat.Lens
CloseBraceDistribution.Parsec.Lexer
closureDistribution.Compat.Graph
cmmOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
cmmSources 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
CNotDistribution.Types.Condition, Distribution.PackageDescription
cNotDistribution.Types.Condition, Distribution.PackageDescription
CNRI_JythonDistribution.SPDX.LicenseId, Distribution.SPDX
CNRI_PythonDistribution.SPDX.LicenseId, Distribution.SPDX
CNRI_Python_GPL_CompatibleDistribution.SPDX.LicenseId, Distribution.SPDX
ColonDistribution.Parsec.Lexer
combineInstallDirsDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
combineObjectFilesDistribution.Simple.Program.Ld
combinePathTemplateDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
CommaFSep 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
CommandDistribution.Simple.Command
commandAddActionDistribution.Simple.Command
commandDefaultFlagsDistribution.Simple.Command
commandDescriptionDistribution.Simple.Command
CommandErrorsDistribution.Simple.Command
commandFromSpecDistribution.Simple.Command
CommandHelpDistribution.Simple.Command
CommandListDistribution.Simple.Command
commandNameDistribution.Simple.Command
commandNotesDistribution.Simple.Command
commandOptionsDistribution.Simple.Command
CommandParseDistribution.Simple.Command
commandParseArgsDistribution.Simple.Command
CommandReadyToGoDistribution.Simple.Command
commandShowOptionsDistribution.Simple.Command
CommandSpec 
1 (Type/Class)Distribution.Simple.Command
2 (Data Constructor)Distribution.Simple.Command
commandsRunDistribution.Simple.Command
commandSynopsisDistribution.Simple.Command
CommandTypeDistribution.Simple.Command
CommandUI 
1 (Type/Class)Distribution.Simple.Command
2 (Data Constructor)Distribution.Simple.Command
commandUsageDistribution.Simple.Command
CommaVCat 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
CommonStanzasDistribution.CabalSpecVersion
compareDistribution.Compat.Prelude.Internal
comparingDistribution.Utils.Generic, Distribution.Simple.Utils
CompatDistribution.System
compatPackageKey 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
Compiler 
1 (Type/Class)Distribution.Simple.Compiler, Distribution.Simple
2 (Data Constructor)Distribution.Simple.Compiler, Distribution.Simple
compiler 
1 (Function)Distribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
2 (Function)Distribution.Simple.Test.Log
compilerAbiTagDistribution.Simple.Compiler, Distribution.Simple
compilerCompatDistribution.Simple.Compiler, Distribution.Simple
compilerCompatFlavorDistribution.Simple.Compiler, Distribution.Simple
compilerCompatVersionDistribution.Simple.Compiler, Distribution.Simple
compilerExtensionsDistribution.Simple.Compiler, Distribution.Simple
CompilerFlavorDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerFlavorDistribution.Simple.Compiler, Distribution.Simple
CompilerId 
1 (Type/Class)Distribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
2 (Data Constructor)Distribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerIdDistribution.Simple.Compiler, Distribution.Simple
CompilerInfo 
1 (Type/Class)Distribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
2 (Data Constructor)Distribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerInfoDistribution.Simple.Compiler, Distribution.Simple
compilerInfoAbiTagDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerInfoCompatDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerInfoExtensionsDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerInfoIdDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerInfoLanguagesDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
compilerLanguagesDistribution.Simple.Compiler, Distribution.Simple
compilerPropertiesDistribution.Simple.Compiler, Distribution.Simple
compilerTemplateEnvDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
CompilerVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
compilerVersionDistribution.Simple.Compiler, Distribution.Simple
ComponentDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
componentBuildableDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
componentBuildDirDistribution.Simple.LocalBuildInfo
componentBuildInfo 
1 (Function)Distribution.Types.Component, Distribution.Simple.LocalBuildInfo
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
componentCcGhcOptionsDistribution.Simple.GHC
componentCompatPackageKeyDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentCompatPackageNameDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentComponentIdDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentCycleMsgDistribution.Backpack.ComponentsGraph
ComponentDisabledReasonDistribution.Types.ComponentRequestedSpec
componentDisabledReasonDistribution.Types.ComponentRequestedSpec
componentEnabledDistribution.Types.ComponentRequestedSpec
componentEnabledSpecDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentExeDepsDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentExposedModulesDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentGhcOptions 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
componentGraphDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
ComponentIdDistribution.Types.ComponentId, Distribution.Package, Distribution.Make, Distribution.Simple
ComponentInclude 
1 (Type/Class)Distribution.Types.ComponentInclude
2 (Data Constructor)Distribution.Types.ComponentInclude
componentIncludesDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentInitialBuildStepsDistribution.Simple.Build
componentInstantiatedWithDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentInternalDepsDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentIsIndefiniteDistribution.Types.ComponentLocalBuildInfo
componentIsIndefinite_Distribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentIsPublicDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
ComponentLocalBuildInfoDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentLocalNameDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentModulesDistribution.Types.PackageDescription.Lens, Distribution.Types.Lens
ComponentNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
componentNameDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
componentNameCLBIsDistribution.Types.LocalBuildInfo
componentNameMapDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
componentNameRequestedDistribution.Types.ComponentRequestedSpec
componentNameStanzaDistribution.Types.ComponentName
componentNameStringDistribution.Types.ComponentName, Distribution.Simple.LocalBuildInfo
componentNameTargetsDistribution.Types.LocalBuildInfo
componentNameTargets'Distribution.Types.LocalBuildInfo
componentPackageDepsDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
ComponentRequestedSpec 
1 (Type/Class)Distribution.Types.ComponentRequestedSpec
2 (Data Constructor)Distribution.Types.ComponentRequestedSpec
componentsDistribution.ModuleName
componentsConfigsDistribution.Types.LocalBuildInfo
ComponentsGraphDistribution.Backpack.ComponentsGraph
componentsGraphToListDistribution.Backpack.ComponentsGraph
componentsInBuildOrderDistribution.Simple.LocalBuildInfo
ComponentsWithDepsDistribution.Backpack.ComponentsGraph
componentUnitIdDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
computeCompatPackageIdDistribution.Types.MungedPackageId
computeCompatPackageKeyDistribution.Simple.Configure
computeCompatPackageNameDistribution.Types.MungedPackageName, Distribution.Simple.Configure
computeComponentIdDistribution.Simple.Configure
computeEffectiveProfilingDistribution.Simple.Configure
concatDistribution.Compat.Prelude.Internal
concatMapDistribution.Compat.Prelude.Internal
concurrentlyDistribution.TestSuite
condBenchmarks 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
CondBranch 
1 (Type/Class)Distribution.Types.CondTree
2 (Data Constructor)Distribution.Types.CondTree
condBranchConditionDistribution.Types.CondTree
condBranchIfFalseDistribution.Types.CondTree
condBranchIfTrueDistribution.Types.CondTree
condExecutables 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
condForeignLibs 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
condIfThenDistribution.Types.CondTree
condIfThenElseDistribution.Types.CondTree
ConditionDistribution.Types.Condition, Distribution.PackageDescription
condLibrary 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
CondNodeDistribution.Types.CondTree, Distribution.PackageDescription
Condor_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
condSubLibraries 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
condTestSuites 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
CondTreeDistribution.Types.CondTree, Distribution.PackageDescription
condTreeComponentsDistribution.Types.CondTree, Distribution.PackageDescription
condTreeConstraintsDistribution.Types.CondTree, Distribution.PackageDescription
condTreeDataDistribution.Types.CondTree, Distribution.PackageDescription
confHookDistribution.Simple.UserHooks, Distribution.Simple
configAbsolutePathsDistribution.Simple.Setup
configArgsDistribution.Simple.Setup
configBenchmarksDistribution.Simple.Setup
configCabalFilePathDistribution.Simple.Setup
configCIDDistribution.Simple.Setup
configCompilerDistribution.Simple.Configure
configCompilerAuxDistribution.Simple.Configure
configCompilerAuxExDistribution.Simple.Configure
configCompilerExDistribution.Simple.Configure
configConfigurationsFlagsDistribution.Simple.Setup
configConfigureArgsDistribution.Simple.Setup
configConstraintsDistribution.Simple.Setup
configCoverageDistribution.Simple.Setup
configDebugInfoDistribution.Simple.Setup
configDependenciesDistribution.Simple.Setup
configDeterministicDistribution.Simple.Setup
configDistPrefDistribution.Simple.Setup
configDynExeDistribution.Simple.Setup
configExactConfigurationDistribution.Simple.Setup
configExtraFrameworkDirsDistribution.Simple.Setup
configExtraIncludeDirsDistribution.Simple.Setup
configExtraLibDirsDistribution.Simple.Setup
configFlagErrorDistribution.Simple.Setup
ConfigFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
configFlagsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
configGHCiLibDistribution.Simple.Setup
configHcFlavorDistribution.Simple.Setup
configHcPathDistribution.Simple.Setup
configHcPkgDistribution.Simple.Setup
configInstallDirsDistribution.Simple.Setup
configInstantiateWithDistribution.Simple.Setup
configIPIDDistribution.Simple.Setup
configLibCoverageDistribution.Simple.Setup
configOptimizationDistribution.Simple.Setup
configPackageDBsDistribution.Simple.Setup
configProfDistribution.Simple.Setup
configProfDetailDistribution.Simple.Setup
configProfExeDistribution.Simple.Setup
configProfLibDistribution.Simple.Setup
configProfLibDetailDistribution.Simple.Setup
configProgPrefixDistribution.Simple.Setup
configProgramArgsDistribution.Simple.Setup
configProgramPathExtraDistribution.Simple.Setup
configProgramPathsDistribution.Simple.Setup
configProgramsDistribution.Simple.Setup
configPrograms_Distribution.Simple.Setup
configProgSuffixDistribution.Simple.Setup
configRelocatableDistribution.Simple.Setup
configScratchDirDistribution.Simple.Setup
configSharedLibDistribution.Simple.Setup
configSplitObjsDistribution.Simple.Setup
configSplitSectionsDistribution.Simple.Setup
ConfigStateFileBadHeaderDistribution.Simple.Configure
ConfigStateFileBadVersionDistribution.Simple.Configure
ConfigStateFileErrorDistribution.Simple.Configure
ConfigStateFileMissingDistribution.Simple.Configure
ConfigStateFileNoHeaderDistribution.Simple.Configure
ConfigStateFileNoParseDistribution.Simple.Configure
configStaticLibDistribution.Simple.Setup
configStripExesDistribution.Simple.Setup
configStripLibsDistribution.Simple.Setup
configTestsDistribution.Simple.Setup
ConfigureDistribution.Types.BuildType, Distribution.PackageDescription
configure 
1 (Function)Distribution.Simple.UHC
2 (Function)Distribution.Simple.HaskellSuite
3 (Function)Distribution.Simple.GHCJS
4 (Function)Distribution.Simple.GHC
5 (Function)Distribution.Simple.Configure
configureAllKnownProgramsDistribution.Simple.Program.Db, Distribution.Simple.Program
configureArgsDistribution.Simple.Setup
configureCCompilerDistribution.Simple.Setup
configureCommandDistribution.Simple.Setup
configureComponentLocalBuildInfosDistribution.Backpack.Configure
ConfiguredComponent 
1 (Type/Class)Distribution.Backpack.ConfiguredComponent
2 (Data Constructor)Distribution.Backpack.ConfiguredComponent
ConfiguredComponentMapDistribution.Backpack.ConfiguredComponent
ConfiguredProgram 
1 (Type/Class)Distribution.Simple.Program.Types, Distribution.Simple.Program
2 (Data Constructor)Distribution.Simple.Program.Types, Distribution.Simple.Program
configuredProgramsDistribution.Simple.Program.Db
configureLinkerDistribution.Simple.Setup
configureOptionsDistribution.Simple.Setup
configureProgramDistribution.Simple.Program.Db, Distribution.Simple.Program
configUseResponseFilesDistribution.Simple.Setup
configUserInstallDistribution.Simple.Setup
configVanillaLibDistribution.Simple.Setup
configVerbosityDistribution.Simple.Setup
ConfVarDistribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
constDistribution.Compat.Prelude.Internal
constrainByDistribution.Types.DependencyMap
ConstrainedClassMethodsLanguage.Haskell.Extension, Distribution.Simple
ConstraintKindsLanguage.Haskell.Extension, Distribution.Simple
copyArgsDistribution.Simple.Setup
copyCabalFilePathDistribution.Simple.Setup
copyCommandDistribution.Simple.Setup
CopyDestDistribution.Simple.InstallDirs, Distribution.Simple.Setup, Distribution.Simple.LocalBuildInfo
copyDestDistribution.Simple.Setup
copyDirectoryRecursiveDistribution.Simple.Utils
copyDirectoryRecursiveVerboseDistribution.Simple.Utils
copyDistPrefDistribution.Simple.Setup
copyFilesDistribution.Simple.Utils
copyFileToDistribution.Simple.Utils
copyFileVerboseDistribution.Simple.Utils
CopyFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
copyHookDistribution.Simple.UserHooks, Distribution.Simple
copyright 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
CopyToDistribution.Simple.InstallDirs, Distribution.Simple.Setup, Distribution.Simple.LocalBuildInfo
CopyToDbDistribution.Simple.InstallDirs, Distribution.Simple.Setup, Distribution.Simple.LocalBuildInfo
copyVerbosityDistribution.Simple.Setup
COrDistribution.Types.Condition, Distribution.PackageDescription
cOrDistribution.Types.Condition, Distribution.PackageDescription
cosDistribution.Compat.Prelude.Internal
coshDistribution.Compat.Prelude.Internal
count 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
countTestResultsDistribution.Simple.Test.Log
coverageSupportedDistribution.Simple.Compiler, Distribution.Simple
CPAL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CPlusPlusDistribution.Simple.CCompiler
CPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CPOL_1_02Distribution.SPDX.LicenseId, Distribution.SPDX
CPPLanguage.Haskell.Extension, Distribution.Simple
cppHeaderNameDistribution.Simple.BuildPaths
cpphsProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
cppOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
cppProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
createArchiveDistribution.Simple.SrcDist
createArLibArchiveDistribution.Simple.Program.Ar
createDirectoryIfMissingVerboseDistribution.Simple.Utils
createInternalPackageDBDistribution.Simple.Build
createPackageDBDistribution.Simple.Register
createPipeDistribution.Compat.CreatePipe
createProcessWithEnvDistribution.Simple.Utils
createTempDirectoryDistribution.Simple.Utils
CrosswordDistribution.SPDX.LicenseId, Distribution.SPDX
CrystalStackerDistribution.SPDX.LicenseId, Distribution.SPDX
cSourceExtensionsDistribution.Simple.CCompiler
cSources 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
CSubLibNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
CTestDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
CTestNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
CUA_OPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
CubeDistribution.SPDX.LicenseId, Distribution.SPDX
curCodeDistribution.Parsec.LexerMonad
curInputDistribution.Parsec.LexerMonad
CurlDistribution.SPDX.LicenseId, Distribution.SPDX
curPosDistribution.Parsec.LexerMonad
currentDirDistribution.Simple.Utils
curryDistribution.Compat.Prelude.Internal
CustomDistribution.Types.BuildType, Distribution.PackageDescription
customFieldsBI 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
customFieldsPD 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
CVSDistribution.Types.SourceRepo, Distribution.PackageDescription
cxxOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
cxxSources 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
cycleDistribution.Compat.Prelude.Internal
cyclesDistribution.Compat.Graph
CyclicSCCDistribution.Compat.Graph
diff --git a/doc/API/Cabal/doc-index-D.html b/doc/API/Cabal/doc-index-D.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-D.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - D)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - D

DarcsDistribution.Types.SourceRepo, Distribution.PackageDescription
DataDistribution.Compat.Prelude.Internal
dataDir 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
datadirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
DatadirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
dataFiles 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
DataKindsLanguage.Haskell.Extension, Distribution.Simple
datasubdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
DatasubdirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
DatatypeContextsLanguage.Haskell.Extension, Distribution.Simple
dateToSnapshotNumberDistribution.Simple.SrcDist
deafeningDistribution.Verbosity
debugDistribution.Simple.Utils
DebugInfoLevelDistribution.Simple.Compiler, Distribution.Simple
debugNoWrapDistribution.Simple.Utils
decodeDistribution.Compat.Binary
decodeCompatPackageNameDistribution.Types.MungedPackageName
decodeFileDistribution.Compat.Binary
decodeFileOrFailDistribution.Compat.Binary
decodeFileOrFail'Distribution.Compat.Binary
decodeFloatDistribution.Compat.Prelude.Internal
decodeOrFailDistribution.Compat.Binary
decodeOrFailIODistribution.Compat.Binary
decodeStringUtf8Distribution.Utils.ShortText
defaultBenchmarkFlagsDistribution.Simple.Setup
defaultBuildFlagsDistribution.Simple.Setup
defaultCleanFlagsDistribution.Simple.Setup
defaultCompilerFlavorDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
defaultComponentRequestedSpecDistribution.Types.ComponentRequestedSpec
defaultConfigFlagsDistribution.Simple.Setup
defaultCopyFlagsDistribution.Simple.Setup
defaultDistPrefDistribution.Simple.Setup, Distribution.Simple.BuildPaths
defaultDoctestFlagsDistribution.Simple.Setup
defaultExtensions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
defaultGlobalFlagsDistribution.Simple.Setup
defaultHaddockFlagsDistribution.Simple.Setup
defaultHookedPackageDescDistribution.Simple.Utils, Distribution.Simple
defaultHscolourFlagsDistribution.Simple.Setup
defaultIncludeRenamingDistribution.Types.IncludeRenaming
defaultInstallDirsDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
defaultInstallDirs'Distribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
defaultInstallFlagsDistribution.Simple.Setup
defaultLanguage 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
defaultLibNameDistribution.Types.ComponentName, Distribution.PackageDescription, Distribution.Simple.LocalBuildInfo
defaultMain 
1 (Function)Distribution.Make
2 (Function)Distribution.Simple
defaultMainArgs 
1 (Function)Distribution.Make
2 (Function)Distribution.Simple
defaultMainNoRead 
1 (Function)Distribution.Make
2 (Function)Distribution.Simple
defaultMainWithHooksDistribution.Simple
defaultMainWithHooksArgsDistribution.Simple
defaultMainWithHooksNoReadDistribution.Simple
defaultMainWithHooksNoReadArgsDistribution.Simple
defaultPackageDescDistribution.Simple.Utils
defaultProgramConfigurationDistribution.Simple.Program
defaultProgramDbDistribution.Simple.Program.Db, Distribution.Simple.Program
defaultProgramSearchPathDistribution.Simple.Program.Find, Distribution.Simple.Program
defaultRegisterFlagsDistribution.Simple.Setup
defaultRegisterOptionsDistribution.Simple.Program.HcPkg, Distribution.Simple.Register
DefaultRenamingDistribution.Types.ModuleRenaming, Distribution.PackageDescription
defaultRenamingDistribution.Types.ModuleRenaming, Distribution.PackageDescription
defaultReplFlagsDistribution.Simple.Setup
defaultSDistFlagsDistribution.Simple.Setup
defaultSetupDepends 
1 (Function)Distribution.Types.SetupBuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.SetupBuildInfo.Lens, Distribution.Types.Lens
DefaultSignaturesLanguage.Haskell.Extension, Distribution.Simple
defaultStyleDistribution.Pretty, Distribution.Text
defaultTempFileOptionsDistribution.Simple.Utils
defaultTestFlagsDistribution.Simple.Setup
defaultUserHooksDistribution.Simple
DefiniteUnitIdDistribution.Backpack
DefUnitIdDistribution.Types.UnitId, Distribution.Backpack, Distribution.Package, Distribution.Make, Distribution.Simple
deleteInstalledPackageIdDistribution.Simple.PackageIndex
deleteKeyDistribution.Compat.Graph
deleteLookupDistribution.Compat.Graph
deletePackageDBDistribution.Simple.Register
deletePackageNameDistribution.Simple.PackageIndex
deleteSourcePackageIdDistribution.Simple.PackageIndex
deleteUnitIdDistribution.Simple.PackageIndex
depAbiHashDistribution.Types.AbiDependency, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
Dependency 
1 (Type/Class)Distribution.Types.Dependency, Distribution.Package, Distribution.Make, Distribution.Simple
2 (Data Constructor)Distribution.Types.Dependency, Distribution.Package, Distribution.Make, Distribution.Simple
dependencyClosureDistribution.Simple.PackageIndex
dependencyCyclesDistribution.Simple.PackageIndex
dependencyGraphDistribution.Simple.PackageIndex
dependencyInconsistenciesDistribution.Simple.PackageIndex
DependencyMapDistribution.Types.DependencyMap
depends 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
depLibraryPathsDistribution.Simple.LocalBuildInfo
depPkgNameDistribution.Types.Dependency, Distribution.Package, Distribution.Make, Distribution.Simple
deprecatedExtensionsLanguage.Haskell.Extension, Distribution.Simple
deprecatedField'Distribution.FieldGrammar.Class, Distribution.FieldGrammar
deprecatedSinceDistribution.FieldGrammar.Class, Distribution.FieldGrammar
depUnitIdDistribution.Types.AbiDependency, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
depVerRangeDistribution.Types.Dependency, Distribution.Package, Distribution.Make, Distribution.Simple
DeriveAnyClassLanguage.Haskell.Extension, Distribution.Simple
DeriveDataTypeableLanguage.Haskell.Extension, Distribution.Simple
DeriveFoldableLanguage.Haskell.Extension, Distribution.Simple
DeriveFunctorLanguage.Haskell.Extension, Distribution.Simple
DeriveGenericLanguage.Haskell.Extension, Distribution.Simple
DeriveLiftLanguage.Haskell.Extension, Distribution.Simple
DeriveTraversableLanguage.Haskell.Extension, Distribution.Simple
DerivingStrategiesLanguage.Haskell.Extension, Distribution.Simple
descCabalVersionDistribution.Types.PackageDescription, Distribution.PackageDescription
describeDistribution.Simple.Program.HcPkg
describeInvocationDistribution.Simple.Program.HcPkg
DescriptionDistribution.Simple.Command
description 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
desugarBuildToolDistribution.Simple.BuildToolDepends
dieDistribution.Simple.Utils
die'Distribution.Simple.Utils
dieNoVerbosityDistribution.Simple.Utils
dieNoWrapDistribution.Simple.Utils
dieProgressDistribution.Utils.LogProgress
dieWithLocationDistribution.Simple.Utils
dieWithLocation'Distribution.Simple.Utils
differenceVersionRangesDistribution.Version, Distribution.Simple
diffFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
DiffmarkDistribution.SPDX.LicenseId, Distribution.SPDX
DigiRule_FOSS_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
digitDistribution.Compat.CharParsing
DirectDistribution.Simple.Setup
DisabledAllBenchmarksDistribution.Types.ComponentRequestedSpec
DisabledAllButOneDistribution.Types.ComponentRequestedSpec
DisabledAllTestsDistribution.Types.ComponentRequestedSpec
DisabledComponentDistribution.Types.ComponentRequestedSpec
DisableExtensionLanguage.Haskell.Extension, Distribution.Simple
DisambiguateRecordFieldsLanguage.Haskell.Extension, Distribution.Simple
dispDistribution.Text
dispComponentsWithDepsDistribution.Backpack.ComponentsGraph
dispConfiguredComponentDistribution.Backpack.ConfiguredComponent
dispFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
displayDistribution.Text
displayExceptionDistribution.Compat.Exception
dispLinkedComponentDistribution.Backpack.LinkedComponent
dispOpenModuleSubstDistribution.Backpack
dispOpenModuleSubstEntryDistribution.Backpack
divDistribution.Compat.Prelude.Internal
divModDistribution.Compat.Prelude.Internal
DListDistribution.Compat.DList
dllExtensionDistribution.Simple.BuildPaths
DoAndIfThenElseLanguage.Haskell.Extension, Distribution.Simple
DOCDistribution.SPDX.LicenseId, Distribution.SPDX
docdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
DocdirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
doctestDistribution.Simple.Doctest
doctestCommandDistribution.Simple.Setup
doctestDistPrefDistribution.Simple.Setup
DoctestFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
doctestHookDistribution.Simple.UserHooks, Distribution.Simple
doctestProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
doctestProgramArgsDistribution.Simple.Setup
doctestProgramPathsDistribution.Simple.Setup
doctestVerbosityDistribution.Simple.Setup
doesDirectoryExistDistribution.PackageDescription.Check
doesExecutableExistDistribution.Simple.Utils
doesFileExistDistribution.PackageDescription.Check
doesPackageDBExistDistribution.Simple.Register
DoRecLanguage.Haskell.Extension, Distribution.Simple
DotseqnDistribution.SPDX.LicenseId, Distribution.SPDX
DoubleDistribution.Compat.Prelude.Internal
DragonFlyDistribution.System
dropDistribution.Compat.Prelude.Internal
dropExeExtensionDistribution.Simple.Utils
dropWhileDistribution.Compat.Prelude.Internal
dropWhileEndLEDistribution.Utils.Generic, Distribution.Simple.Utils
DS389_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
DSDPDistribution.SPDX.LicenseId, Distribution.SPDX
dumpDistribution.Simple.Program.HcPkg
dumpInvocationDistribution.Simple.Program.HcPkg
DuplicateRecordFieldsLanguage.Haskell.Extension, Distribution.Simple
DvipdfmDistribution.SPDX.LicenseId, Distribution.SPDX
DynDistribution.Simple.Hpc
dynlibdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
DynlibdirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
D_FSL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
diff --git a/doc/API/Cabal/doc-index-E.html b/doc/API/Cabal/doc-index-E.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-E.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - E)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - E

EAndDistribution.SPDX.LicenseExpression, Distribution.SPDX
EarlierVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
earlierVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
EarlierVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
ECL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
ECL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
ECos_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
EFL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
EFL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
EGenixDistribution.SPDX.LicenseId, Distribution.SPDX
EitherDistribution.Compat.Prelude.Internal
eitherDistribution.Compat.Prelude.Internal
eitherParsecDistribution.Parsec.Class
elemDistribution.Compat.Prelude.Internal
ELicenseDistribution.SPDX.LicenseExpression, Distribution.SPDX
ELicenseIdDistribution.SPDX.LicenseExpression, Distribution.SPDX
ELicenseIdPlusDistribution.SPDX.LicenseExpression, Distribution.SPDX
ELicenseRefDistribution.SPDX.LicenseExpression, Distribution.SPDX
ElifDistribution.CabalSpecVersion
embedVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
empty 
1 (Function)Distribution.Compat.Prelude.Internal
2 (Function)Distribution.Compat.Graph
emptyBenchmarkDistribution.Types.Benchmark, Distribution.PackageDescription
emptyBenchmarkFlagsDistribution.Simple.Setup
emptyBuildFlagsDistribution.Simple.Setup
emptyBuildInfoDistribution.Types.BuildInfo, Distribution.PackageDescription
EmptyCaseLanguage.Haskell.Extension, Distribution.Simple
emptyCleanFlagsDistribution.Simple.Setup
emptyConfigFlagsDistribution.Simple.Setup
emptyCopyFlagsDistribution.Simple.Setup
EmptyDataDeclsLanguage.Haskell.Extension, Distribution.Simple
emptyDoctestFlagsDistribution.Simple.Setup
emptyExecutableDistribution.Types.Executable, Distribution.PackageDescription
emptyFlagDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
emptyForeignLibDistribution.Types.ForeignLib
emptyGenericPackageDescriptionDistribution.Types.GenericPackageDescription
EmptyGlobDistribution.Simple.Glob
emptyGlobalFlagsDistribution.Simple.Setup
emptyHaddockFlagsDistribution.Simple.Setup
emptyHookedBuildInfoDistribution.Types.HookedBuildInfo, Distribution.PackageDescription
emptyHscolourFlagsDistribution.Simple.Setup
emptyInstalledPackageInfoDistribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
emptyInstallFlagsDistribution.Simple.Setup
emptyLibraryDistribution.Types.Library, Distribution.PackageDescription
emptyModuleShapeDistribution.Backpack.ModuleShape
emptyPackageDescriptionDistribution.Types.PackageDescription, Distribution.PackageDescription
emptyProgramConfigurationDistribution.Simple.Program
emptyProgramDbDistribution.Simple.Program.Db, Distribution.Simple.Program
emptyProgramInvocationDistribution.Simple.Program.Run, Distribution.Simple.Program
emptyRegisterFlagsDistribution.Simple.Setup
emptySDistFlagsDistribution.Simple.Setup
emptySourceRepoDistribution.Types.SourceRepo, Distribution.PackageDescription
emptyTestFlagsDistribution.Simple.Setup
emptyTestSuiteDistribution.Types.TestSuite, Distribution.PackageDescription
emptyUserHooksDistribution.Simple.UserHooks, Distribution.Simple
enabledBenchLBIsDistribution.Simple.LocalBuildInfo
enabledBuildDependsDistribution.Types.PackageDescription, Distribution.PackageDescription
enabledBuildInfosDistribution.Types.PackageDescription
enabledComponentsDistribution.Types.PackageDescription
enabledTestLBIsDistribution.Simple.LocalBuildInfo
EnableExtensionLanguage.Haskell.Extension, Distribution.Simple
encodeDistribution.Compat.Binary
encodeFileDistribution.Compat.Binary
encodeFloatDistribution.Compat.Prelude.Internal
encodeStringUtf8Distribution.Utils.ShortText
endBy 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
endBy1 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
EntessaDistribution.SPDX.LicenseId, Distribution.SPDX
EnumDistribution.Compat.Prelude.Internal
enumFromDistribution.Compat.Prelude.Internal
enumFromThenDistribution.Compat.Prelude.Internal
enumFromThenToDistribution.Compat.Prelude.Internal
enumFromToDistribution.Compat.Prelude.Internal
EOFDistribution.Parsec.Lexer
eof 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
EOrDistribution.SPDX.LicenseExpression, Distribution.SPDX
EPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
EPL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
EQDistribution.Compat.Prelude.Internal
EqDistribution.Compat.Prelude.Internal
equatingDistribution.Utils.Generic, Distribution.Simple.Utils
ErlPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
ErrorDistribution.TestSuite
errorDistribution.Compat.Prelude.Internal
errorWithoutStackTraceDistribution.Compat.Prelude.Internal
EtaDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
EUDatagridDistribution.SPDX.LicenseId, Distribution.SPDX
EUPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
EUPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
EUPL_1_2Distribution.SPDX.LicenseId, Distribution.SPDX
EurosymDistribution.SPDX.LicenseId, Distribution.SPDX
evenDistribution.Compat.Prelude.Internal
ExclusiveBoundDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
exeBuildDirDistribution.Simple.BuildPaths
exeBuildInfoDistribution.Types.Executable.Lens, Distribution.Types.Lens
execLexerDistribution.Parsec.LexerMonad
ExeComponentLocalBuildInfoDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
exeCoverageDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
Executable 
1 (Type/Class)Distribution.Types.Executable, Distribution.Types.Executable.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.Executable, Distribution.PackageDescription
executableFieldGrammarDistribution.PackageDescription.FieldGrammar
ExecutableNameVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
ExecutablePrivateDistribution.Types.ExecutableScope
ExecutablePublicDistribution.Types.ExecutableScope
executables 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
ExecutableScopeDistribution.Types.ExecutableScope
ExeDependency 
1 (Type/Class)Distribution.Types.ExeDependency
2 (Data Constructor)Distribution.Types.ExeDependency
exeExtensionDistribution.Simple.BuildPaths
exeExtensionsDistribution.Simple.Utils
exeModulesDistribution.Types.Executable, Distribution.PackageDescription
exeModulesAutogenDistribution.Types.Executable, Distribution.PackageDescription
exeName 
1 (Function)Distribution.Types.Executable, Distribution.PackageDescription
2 (Function)Distribution.Types.Executable.Lens, Distribution.Types.Lens
exeScope 
1 (Function)Distribution.Types.Executable, Distribution.PackageDescription
2 (Function)Distribution.Types.Executable.Lens, Distribution.Types.Lens
ExistentialQuantificationLanguage.Haskell.Extension, Distribution.Simple
existsAndIsMoreRecentThanDistribution.Simple.Utils
expDistribution.Compat.Prelude.Internal
expandOpenUnitIdDistribution.Backpack.FullUnitId
expandUnitIdDistribution.Backpack.FullUnitId
explainGlobSyntaxErrorDistribution.Simple.Glob
explanationDistribution.PackageDescription.Check
explicitEitherParsecDistribution.Parsec.Class
ExplicitForAllLanguage.Haskell.Extension, Distribution.Simple
explicitLibModulesDistribution.Types.Library, Distribution.PackageDescription
ExplicitNamespacesLanguage.Haskell.Extension, Distribution.Simple
exponentDistribution.Compat.Prelude.Internal
exposeDistribution.Simple.Program.HcPkg
exposed 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
ExposedModule 
1 (Type/Class)Distribution.Types.ExposedModule, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Data Constructor)Distribution.Types.ExposedModule, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
exposedModules 
1 (Function)Distribution.Types.Library, Distribution.PackageDescription
2 (Function)Distribution.Types.Library.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
exposedNameDistribution.Types.ExposedModule, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
exposedReexportDistribution.Types.ExposedModule, Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
exposeInvocationDistribution.Simple.Program.HcPkg
extendConfiguredComponentMapDistribution.Backpack.ConfiguredComponent
ExtendedDefaultRulesLanguage.Haskell.Extension, Distribution.Simple
extendLinkedComponentMapDistribution.Backpack.LinkedComponent
ExtensibleRecordsLanguage.Haskell.Extension, Distribution.Simple
ExtensionLanguage.Haskell.Extension, Distribution.Simple
extensionsToFlagsDistribution.Simple.Compiler, Distribution.Simple
externalPackageDepsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
extraBundledLibs 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
extraConfigArgsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
extractConditionDistribution.Types.CondTree, Distribution.PackageDescription.Configuration
extractConditionsDistribution.PackageDescription.Configuration
extraDocFiles 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
extraFrameworkDirs 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
extraGHCiLibraries 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
extraGHCiLibs 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
extraLibDirs 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
extraLibFlavours 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
extraLibraries 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
extraLibs 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
ExtraOptionsDistribution.TestSuite
extraSrcFiles 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
extraTmpFiles 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
diff --git a/doc/API/Cabal/doc-index-F.html b/doc/API/Cabal/doc-index-F.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-F.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - F)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - F

FailDistribution.TestSuite
failDistribution.Compat.Prelude.Internal
failProgressDistribution.Utils.Progress
failReadEDistribution.ReadE
FailuresDistribution.Simple.Setup
FairDistribution.SPDX.LicenseId, Distribution.SPDX
FalseDistribution.Compat.Prelude.Internal
falseArgDistribution.Simple.Setup
Fawkes_Runtime_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
Field 
1 (Type/Class)Distribution.Parsec.Field, Distribution.Parsec.Parser
2 (Data Constructor)Distribution.Parsec.Field, Distribution.Parsec.Parser
fieldAnnDistribution.Parsec.Field
fieldDescrParseDistribution.FieldGrammar.FieldDescrs
fieldDescrPrettyDistribution.FieldGrammar.FieldDescrs
FieldDescrsDistribution.FieldGrammar.FieldDescrs
fieldDescrsToListDistribution.FieldGrammar.FieldDescrs
FieldGrammarDistribution.FieldGrammar.Class, Distribution.FieldGrammar
fieldGrammarKnownFieldListDistribution.FieldGrammar.Parsec, Distribution.FieldGrammar
FieldLine 
1 (Type/Class)Distribution.Parsec.Field, Distribution.Parsec.Parser
2 (Data Constructor)Distribution.Parsec.Field, Distribution.Parsec.Parser
fieldLinesToStreamDistribution.Parsec.FieldLineStream
FieldLineStreamDistribution.Parsec.FieldLineStream
fieldLineStreamFromBSDistribution.Parsec.FieldLineStream
fieldLineStreamFromStringDistribution.Parsec.FieldLineStream
FieldNameDistribution.Parsec.Field
fieldNameDistribution.Parsec.Field
FieldsDistribution.FieldGrammar.Parsec, Distribution.FieldGrammar
fieldUniverseDistribution.Parsec.Field
fileGlobMatchesDistribution.Simple.Glob
filenameCDialectDistribution.Simple.CCompiler
FilePathDistribution.Compat.Prelude.Internal
FilePathNT 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
filterDistribution.Compat.Prelude.Internal
filterMDistribution.Compat.Prelude.Internal
finalizePackageDescriptionDistribution.PackageDescription.Configuration
finalizePDDistribution.PackageDescription.Configuration
findDistribution.Compat.Prelude.Internal
findAllFilesWithExtensionDistribution.Simple.Utils
findDistPrefDistribution.Simple.Configure
findDistPrefOrDefaultDistribution.Simple.Configure
findDuplicateFlagAssignmentsDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
findFileDistribution.Simple.Utils
findFileWithExtensionDistribution.Simple.Utils
findFileWithExtension'Distribution.Simple.Utils
findFirstFileDistribution.Simple.Utils
findHookedPackageDescDistribution.Simple.Utils
findModuleFileDistribution.Simple.Utils
findModuleFilesDistribution.Simple.Utils
findPackageDescDistribution.Simple.Utils
findProgramLocationDistribution.Simple.Utils, Distribution.Simple.Program
findProgramOnPathDistribution.Simple.Program
findProgramOnSearchPathDistribution.Simple.Program.Find, Distribution.Simple.Program
findProgramVersionDistribution.Simple.Utils, Distribution.Simple.Program
FinishedDistribution.TestSuite
firstDistribution.Compat.Prelude.Internal
Flag 
1 (Type/Class)Distribution.Simple.Flag, Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Flag, Distribution.Simple.Setup
3 (Data Constructor)Distribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
4 (Type/Class)Distribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
5 (Type/Class)Distribution.Simple.Compiler
FlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
flagAssignmentDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
flagDebugInfoDistribution.Simple.GHC
flagDefault 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
flagDescription 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
flagFieldGrammarDistribution.PackageDescription.FieldGrammar
flagGhciScriptDistribution.Simple.GHC
flagManual 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
FlagNameDistribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
flagName 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
flagPackageConf 
1 (Function)Distribution.Simple.GHC
2 (Function)Distribution.Simple.Program.HcPkg
flagProfAutoDistribution.Simple.GHC
flagToDebugInfoLevelDistribution.Simple.Compiler, Distribution.Simple
flagToListDistribution.Simple.Flag, Distribution.Simple.Setup
flagToMaybeDistribution.Simple.Flag, Distribution.Simple.Setup
flagToOptimisationLevelDistribution.Simple.Compiler, Distribution.Simple
flagToProfDetailLevelDistribution.Simple.Compiler, Distribution.Simple
flagToVerbosityDistribution.Verbosity
flagWarnMissingHomeModulesDistribution.Simple.GHC
flatStyleDistribution.Pretty, Distribution.Text
flattenPackageDescriptionDistribution.PackageDescription.Configuration
FlexibleContextsLanguage.Haskell.Extension, Distribution.Simple
FlexibleInstancesLanguage.Haskell.Extension, Distribution.Simple
flibBuildDirDistribution.Simple.BuildPaths
FLibComponentLocalBuildInfoDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
flibdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
flipDistribution.Compat.Prelude.Internal
FloatDistribution.Compat.Prelude.Internal
floatDigitsDistribution.Compat.Prelude.Internal
FloatingDistribution.Compat.Prelude.Internal
floatRadixDistribution.Compat.Prelude.Internal
floatRangeDistribution.Compat.Prelude.Internal
floorDistribution.Compat.Prelude.Internal
FLSConsDistribution.Parsec.FieldLineStream
FLSLastDistribution.Parsec.FieldLineStream
FLTK_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
fmapDistribution.Compat.Prelude.Internal
FoldableDistribution.Compat.Prelude.Internal
foldComponentDistribution.Types.Component, Distribution.Simple.LocalBuildInfo
foldlDistribution.Compat.Prelude.Internal
foldl'Distribution.Compat.Prelude.Internal
foldl1Distribution.Compat.Prelude.Internal
foldMDistribution.Compat.Prelude.Internal
foldMapDistribution.Compat.Prelude.Internal
foldProgressDistribution.Utils.Progress
foldrDistribution.Compat.Prelude.Internal
foldr1Distribution.Compat.Prelude.Internal
foldVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
foldVersionRange'Distribution.Version, Distribution.Simple
Font_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
forDistribution.Compat.Prelude.Internal
ForDevelopmentDistribution.Simple.Setup
ForeignFunctionInterfaceLanguage.Haskell.Extension, Distribution.Simple
ForeignLib 
1 (Type/Class)Distribution.Types.ForeignLib, Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
2 (Data Constructor)Distribution.Types.ForeignLib
foreignLibBuildInfo 
1 (Function)Distribution.Types.ForeignLib
2 (Function)Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
foreignLibFieldGrammarDistribution.PackageDescription.FieldGrammar
foreignLibIsSharedDistribution.Types.ForeignLib
foreignLibModDefFile 
1 (Function)Distribution.Types.ForeignLib
2 (Function)Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
foreignLibModulesDistribution.Types.ForeignLib
foreignLibName 
1 (Function)Distribution.Types.ForeignLib
2 (Function)Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
ForeignLibNativeSharedDistribution.Types.ForeignLibType
ForeignLibNativeStaticDistribution.Types.ForeignLibType
ForeignLibOptionDistribution.Types.ForeignLibOption
foreignLibOptions 
1 (Function)Distribution.Types.ForeignLib
2 (Function)Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
foreignLibs 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
ForeignLibStandaloneDistribution.Types.ForeignLibOption
ForeignLibTypeDistribution.Types.ForeignLibType
foreignLibType 
1 (Function)Distribution.Types.ForeignLib
2 (Function)Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
foreignLibTypeIsSharedDistribution.Types.ForeignLibType
ForeignLibTypeUnknownDistribution.Types.ForeignLibType
foreignLibVersionDistribution.Types.ForeignLib
foreignLibVersionInfo 
1 (Function)Distribution.Types.ForeignLib
2 (Function)Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
foreignLibVersionLinux 
1 (Function)Distribution.Types.ForeignLib
2 (Function)Distribution.Types.ForeignLib.Lens, Distribution.Types.Lens
ForHackageDistribution.Simple.Setup
for_Distribution.Compat.Prelude.Internal
FoundOnSystemDistribution.Simple.Program.Types, Distribution.Simple.Program
FractionalDistribution.Compat.Prelude.Internal
frameworkDirs 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
frameworks 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
Frameworx_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
FreeBSDDistribution.System
FreeImageDistribution.SPDX.LicenseId, Distribution.SPDX
Freertos_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
FreeText 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
freeVarsDistribution.PackageDescription.Configuration
fromComponentsDistribution.ModuleName
fromDepMapDistribution.Types.DependencyMap
fromDistinctListDistribution.Compat.Graph
fromEnumDistribution.Compat.Prelude.Internal
fromFlagDistribution.Simple.Flag, Distribution.Simple.Setup
fromFlagOrDefaultDistribution.Simple.Flag, Distribution.Simple.Setup
fromIntegerDistribution.Compat.Prelude.Internal
fromIntegralDistribution.Compat.Prelude.Internal
fromList 
1 (Function)Distribution.Compat.DList
2 (Function)Distribution.Simple.PackageIndex
fromMaybeDistribution.Compat.Prelude.Internal
fromNubListDistribution.Utils.NubList
fromNubListRDistribution.Utils.NubList
fromPathTemplateDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
fromRationalDistribution.Compat.Prelude.Internal
fromShortTextDistribution.Utils.ShortText
FromStringDistribution.InstalledPackageInfo
fromStringDistribution.Compat.Prelude.Internal, Distribution.ModuleName
fromUTF8BSDistribution.Utils.Generic, Distribution.Simple.Utils
fromUTF8LBSDistribution.Utils.Generic, Distribution.Simple.Utils
fromVersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
FSep 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
FSFAPDistribution.SPDX.LicenseId, Distribution.SPDX
FSFULDistribution.SPDX.LicenseId, Distribution.SPDX
FSFULLRDistribution.SPDX.LicenseId, Distribution.SPDX
fstDistribution.Compat.Prelude.Internal
FTLDistribution.SPDX.LicenseId, Distribution.SPDX
FullDbDistribution.Backpack.FullUnitId
FullUnitId 
1 (Type/Class)Distribution.Backpack.FullUnitId
2 (Data Constructor)Distribution.Backpack.FullUnitId
FunctionalDependenciesLanguage.Haskell.Extension, Distribution.Simple
FunctorDistribution.Compat.Prelude.Internal
diff --git a/doc/API/Cabal/doc-index-G.html b/doc/API/Cabal/doc-index-G.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-G.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - G)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - G

GADTsLanguage.Haskell.Extension, Distribution.Simple
GADTSyntaxLanguage.Haskell.Extension, Distribution.Simple
gatherDistribution.Compat.ReadP
GBinaryGetDistribution.Compat.Binary
GBinaryPutDistribution.Compat.Binary
gccProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
GCC_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
GCC_exception_3_1Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
gcdDistribution.Compat.Prelude.Internal
generalInstalledPackageInfoDistribution.Simple.Register
GeneralizedNewtypeDerivingLanguage.Haskell.Extension, Distribution.Simple
generate 
1 (Function)Distribution.Simple.Build.PathsModule
2 (Function)Distribution.Simple.Build.Macros
generatePackageVersionMacrosDistribution.Simple.Build.Macros
generateRegistrationInfoDistribution.Simple.Register
GenericDistribution.Compat.Prelude.Internal
GenericPackageDescription 
1 (Type/Class)Distribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
genericRnfDistribution.Compat.Prelude.Internal
GenericsLanguage.Haskell.Extension, Distribution.Simple
genPackageFlags 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
GetDistribution.Compat.Binary
get 
1 (Function)Distribution.Compat.Binary, Distribution.Compat.Prelude.Internal
2 (Function)Distribution.Compat.ReadP
getAllDistribution.Compat.Semigroup
getAllInternalToolDependenciesDistribution.Simple.BuildToolDepends
getAllToolDependenciesDistribution.Simple.BuildToolDepends
getAnyDistribution.Compat.Semigroup
getCabalSpecVersionDistribution.Parsec.ParseResult
getCharDistribution.Compat.Prelude.Internal
getCompilerVersionDistribution.Simple.HaskellSuite
getComponentDistribution.Types.PackageDescription, Distribution.Simple.LocalBuildInfo
getComponentLocalBuildInfoDistribution.Simple.LocalBuildInfo
getConfigStateFileDistribution.Simple.Configure
getContentsDistribution.Compat.Prelude.Internal
getCurTimeDistribution.Compat.Time
getDbProgramOutputDistribution.Simple.Program
getDirectoryContentsDistribution.PackageDescription.Check
getDirectoryContentsRecursiveDistribution.Simple.Utils
getEffectiveEnvironmentDistribution.Simple.Program.Run
getExeSourceFilesDistribution.Simple.BuildPaths
getExtensionsDistribution.Simple.HaskellSuite
getFileAgeDistribution.Compat.Time
getFileContentsDistribution.PackageDescription.Check
getFilePathNTDistribution.Parsec.Newtypes
getFLibSourceFilesDistribution.Simple.BuildPaths
getFreeTextDistribution.Parsec.Newtypes
getGhcInfoDistribution.Simple.GHC
getGlobalPackageDB 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
getHSLibraryNameDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
getImplInfoDistribution.Simple.GHC
getInputDistribution.Parsec.LexerMonad
getInstalledPackages 
1 (Function)Distribution.Simple.UHC
2 (Function)Distribution.Simple.HaskellSuite
3 (Function)Distribution.Simple.GHCJS
4 (Function)Distribution.Simple.GHC
5 (Function)Distribution.Simple.Configure
getInstalledPackagesMonitorFiles 
1 (Function)Distribution.Simple.GHC
2 (Function)Distribution.Simple.Configure
getInternalPackagesDistribution.Simple.Configure
getLanguagesDistribution.Simple.HaskellSuite
getLast'Distribution.Compat.Semigroup
getLibDir 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
getLibSourceFilesDistribution.Simple.BuildPaths
getLineDistribution.Compat.Prelude.Internal
getModTimeDistribution.Compat.Time
getMQuotedDistribution.Parsec.Newtypes
getNameDistribution.Parsec.Field
getNormalCommandDescriptionsDistribution.Simple.Command
getPackageDBContents 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
3 (Function)Distribution.Simple.Configure
getPersistBuildConfigDistribution.Simple.Configure
getPosDistribution.Parsec.LexerMonad
getProgramInvocationOutputDistribution.Simple.Program.Run, Distribution.Simple.Program
getProgramInvocationOutputAndErrorsDistribution.Simple.Program.Run
getProgramOutputDistribution.Simple.Program
getProgramSearchPathDistribution.Simple.Program.Db, Distribution.Simple.Program
getSourceFilesDistribution.Simple.BuildPaths
getSpecLicenseDistribution.Parsec.Newtypes
getSpecVersionDistribution.Parsec.Newtypes
getStartCodeDistribution.Parsec.LexerMonad
getSystemSearchPathDistribution.Simple.Program.Find
getTestedWithDistribution.Parsec.Newtypes
GettingDistribution.Compat.Lens
gettingDistribution.Compat.Lens
getTokenDistribution.Parsec.Newtypes
getToken'Distribution.Parsec.Newtypes
getWord8Distribution.Compat.Binary
GFDL_1_1_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
GFDL_1_1_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
GFDL_1_2_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
GFDL_1_2_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
GFDL_1_3_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
GFDL_1_3_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
ggetDistribution.Compat.Binary
GHCDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
GhcDynamicOnlyDistribution.Simple.Program.GHC
GhcDynLinkModeDistribution.Simple.Program.GHC
GhcEnvFileClearPackageDbStackDistribution.Simple.GHC
GhcEnvFileCommentDistribution.Simple.GHC
GhcEnvFilePackageDbDistribution.Simple.GHC
GhcEnvFilePackageIdDistribution.Simple.GHC
GhcEnvironmentFileEntryDistribution.Simple.GHC
GHCForeignImportPrimLanguage.Haskell.Extension, Distribution.Simple
GhcImplInfo 
1 (Type/Class)Distribution.Simple.GHC
2 (Data Constructor)Distribution.Simple.GHC
ghcInvocationDistribution.Simple.Program.GHC
GHCJSDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
GhcjsDistribution.System
ghcjsPkgProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
ghcjsProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
GhcMaximumOptimisationDistribution.Simple.Program.GHC
GhcModeDistribution.Simple.Program.GHC
GhcModeAbiHashDistribution.Simple.Program.GHC
GhcModeCompileDistribution.Simple.Program.GHC
GhcModeInteractiveDistribution.Simple.Program.GHC
GhcModeLinkDistribution.Simple.Program.GHC
GhcModeMakeDistribution.Simple.Program.GHC
GhcNoOptimisationDistribution.Simple.Program.GHC
GhcNormalOptimisationDistribution.Simple.Program.GHC
ghcOptCabalDistribution.Simple.Program.GHC
ghcOptCcOptionsDistribution.Simple.Program.GHC
ghcOptCppIncludePathDistribution.Simple.Program.GHC
ghcOptCppIncludesDistribution.Simple.Program.GHC
ghcOptCppOptionsDistribution.Simple.Program.GHC
ghcOptCxxOptionsDistribution.Simple.Program.GHC
ghcOptDebugInfoDistribution.Simple.Program.GHC
ghcOptDylibNameDistribution.Simple.Program.GHC
ghcOptDynHiSuffixDistribution.Simple.Program.GHC
ghcOptDynLinkModeDistribution.Simple.Program.GHC
ghcOptDynObjSuffixDistribution.Simple.Program.GHC
ghcOptExtensionMapDistribution.Simple.Program.GHC
ghcOptExtensionsDistribution.Simple.Program.GHC
ghcOptExtraDistribution.Simple.Program.GHC
ghcOptExtraDefaultDistribution.Simple.Program.GHC
ghcOptExtraPathDistribution.Simple.Program.GHC
ghcOptFfiIncludesDistribution.Simple.Program.GHC
ghcOptFPicDistribution.Simple.Program.GHC
ghcOptGHCiScriptsDistribution.Simple.Program.GHC
ghcOptHideAllPackagesDistribution.Simple.Program.GHC
ghcOptHiDirDistribution.Simple.Program.GHC
ghcOptHiSuffixDistribution.Simple.Program.GHC
ghcOptHPCDirDistribution.Simple.Program.GHC
GhcOptimisationDistribution.Simple.Program.GHC
ghcOptInputFilesDistribution.Simple.Program.GHC
ghcOptInputModulesDistribution.Simple.Program.GHC
ghcOptInstantiatedWithDistribution.Simple.Program.GHC
GhcOptions 
1 (Type/Class)Distribution.Simple.Program.GHC
2 (Data Constructor)Distribution.Simple.Program.GHC
ghcOptLanguageDistribution.Simple.Program.GHC
ghcOptLinkFrameworkDirsDistribution.Simple.Program.GHC
ghcOptLinkFrameworksDistribution.Simple.Program.GHC
ghcOptLinkLibPathDistribution.Simple.Program.GHC
ghcOptLinkLibsDistribution.Simple.Program.GHC
ghcOptLinkModDefFilesDistribution.Simple.Program.GHC
ghcOptLinkNoHsMainDistribution.Simple.Program.GHC
ghcOptLinkOptionsDistribution.Simple.Program.GHC
ghcOptModeDistribution.Simple.Program.GHC
ghcOptNoAutoLinkPackagesDistribution.Simple.Program.GHC
ghcOptNoCodeDistribution.Simple.Program.GHC
ghcOptNoLinkDistribution.Simple.Program.GHC
ghcOptNumJobsDistribution.Simple.Program.GHC
ghcOptObjDirDistribution.Simple.Program.GHC
ghcOptObjSuffixDistribution.Simple.Program.GHC
ghcOptOptimisationDistribution.Simple.Program.GHC
ghcOptOutputDirDistribution.Simple.Program.GHC
ghcOptOutputDynFileDistribution.Simple.Program.GHC
ghcOptOutputFileDistribution.Simple.Program.GHC
ghcOptPackageDBsDistribution.Simple.Program.GHC
ghcOptPackagesDistribution.Simple.Program.GHC
ghcOptProfilingAutoDistribution.Simple.Program.GHC
ghcOptProfilingModeDistribution.Simple.Program.GHC
ghcOptRPathsDistribution.Simple.Program.GHC
ghcOptSharedDistribution.Simple.Program.GHC
ghcOptSourcePathDistribution.Simple.Program.GHC
ghcOptSourcePathClearDistribution.Simple.Program.GHC
ghcOptSplitObjsDistribution.Simple.Program.GHC
ghcOptSplitSectionsDistribution.Simple.Program.GHC
ghcOptStaticLibDistribution.Simple.Program.GHC
ghcOptStubDirDistribution.Simple.Program.GHC
ghcOptThisComponentIdDistribution.Simple.Program.GHC
ghcOptThisUnitIdDistribution.Simple.Program.GHC
ghcOptVerbosityDistribution.Simple.Program.GHC
ghcOptWarnMissingHomeModulesDistribution.Simple.Program.GHC
ghcPkgProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
ghcPlatformAndVersionStringDistribution.Simple.GHC
GhcProfAutoDistribution.Simple.Program.GHC
GhcProfAutoAllDistribution.Simple.Program.GHC
GhcProfAutoExportedDistribution.Simple.Program.GHC
GhcProfAutoToplevelDistribution.Simple.Program.GHC
ghcProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
GhcSpecialOptimisationDistribution.Simple.Program.GHC
GhcStaticAndDynamicDistribution.Simple.Program.GHC
GhcStaticOnlyDistribution.Simple.Program.GHC
GiftwareDistribution.SPDX.LicenseId, Distribution.SPDX
GitDistribution.Types.SourceRepo, Distribution.PackageDescription
GL2PSDistribution.SPDX.LicenseId, Distribution.SPDX
GlideDistribution.SPDX.LicenseId, Distribution.SPDX
GlobDistribution.Simple.Glob
globalCommandDistribution.Simple.Setup
GlobalFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
globalNumericVersionDistribution.Simple.Setup
GlobalPackageDBDistribution.Simple.Compiler, Distribution.Simple
globalVersionDistribution.Simple.Setup
GlobMatchDistribution.Simple.Glob
GlobMissingDirectoryDistribution.Simple.Glob
GlobResultDistribution.Simple.Glob
GlobstarDistribution.CabalSpecVersion
GlobSyntaxErrorDistribution.Simple.Glob
GlobWarnMultiDotDistribution.Simple.Glob
GlulxeDistribution.SPDX.LicenseId, Distribution.SPDX
gmappendDistribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
gmemptyDistribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
GnuArchDistribution.Types.SourceRepo, Distribution.PackageDescription
GnuplotDistribution.SPDX.LicenseId, Distribution.SPDX
Gnu_javamail_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
GPLDistribution.License, Distribution.Make, Distribution.Simple
GPL_1_0_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
GPL_1_0_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
GPL_2_0_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
GPL_2_0_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
GPL_3_0_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
GPL_3_0_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
gputDistribution.Compat.Binary
GraphDistribution.Compat.Graph
greencardProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
GroupDistribution.TestSuite
GroupLogsDistribution.Simple.Test.Log
groupNameDistribution.TestSuite
groupTestsDistribution.TestSuite
GSOAP_1_3bDistribution.SPDX.LicenseId, Distribution.SPDX
GTDistribution.Compat.Prelude.Internal
guessWayDistribution.Simple.Hpc
diff --git a/doc/API/Cabal/doc-index-H.html b/doc/API/Cabal/doc-index-H.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-H.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - H)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - H

haddockDistribution.Simple.Haddock
haddockArgsDistribution.Simple.Setup
haddockBenchmarksDistribution.Simple.Setup
haddockCabalFilePathDistribution.Simple.Setup
haddockCommandDistribution.Simple.Setup
haddockContentsDistribution.Simple.Setup
haddockCssDistribution.Simple.Setup
haddockdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
haddockDirNameDistribution.Simple.BuildPaths
haddockDistPrefDistribution.Simple.Setup
haddockExecutablesDistribution.Simple.Setup
HaddockFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
haddockForeignLibsDistribution.Simple.Setup
haddockForHackageDistribution.Simple.Setup
haddockHoogleDistribution.Simple.Setup
haddockHookDistribution.Simple.UserHooks, Distribution.Simple
haddockHscolourCssDistribution.Simple.Setup
haddockHtmlDistribution.Simple.Setup
haddockHtmlLocationDistribution.Simple.Setup
haddockHTMLs 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
haddockInterfaces 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
haddockInternalDistribution.Simple.Setup
haddockKeepTempFilesDistribution.Simple.Setup
haddockLinkedSourceDistribution.Simple.Setup
haddockNameDistribution.Simple.BuildPaths
haddockOptionsDistribution.Simple.Setup
haddockPackagePathsDistribution.Simple.Haddock
haddockPrefDistribution.Simple.BuildPaths
haddockProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
haddockProgramArgsDistribution.Simple.Setup
haddockProgramPathsDistribution.Simple.Setup
haddockQuickJumpDistribution.Simple.Setup
HaddockTargetDistribution.Simple.Setup
haddockTestSuitesDistribution.Simple.Setup
haddockVerbosityDistribution.Simple.Setup
HaLVMDistribution.System
handleDoesNotExistDistribution.Simple.Utils
happyProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
hasBenchmarksDistribution.Types.PackageDescription, Distribution.PackageDescription
HasBuildInfoDistribution.Types.BuildInfo.Lens, Distribution.Types.Lens
HasBuildInfosDistribution.Types.BuildInfo.Lens, Distribution.Types.Lens
HasCommonStanzas 
1 (Type/Class)Distribution.CabalSpecVersion
2 (Data Constructor)Distribution.CabalSpecVersion
HasElif 
1 (Type/Class)Distribution.CabalSpecVersion
2 (Data Constructor)Distribution.CabalSpecVersion
hasExesDistribution.Types.PackageDescription, Distribution.PackageDescription
hasForeignLibsDistribution.Types.PackageDescription
HasGlobstar 
1 (Type/Class)Distribution.CabalSpecVersion
2 (Data Constructor)Distribution.CabalSpecVersion
hashModuleSubstDistribution.Backpack
Haskell2010Language.Haskell.Extension, Distribution.Simple
Haskell98Language.Haskell.Extension, Distribution.Simple
HaskellReportDistribution.SPDX.LicenseId, Distribution.SPDX
HaskellSuiteDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
haskellSuitePkgProgramDistribution.Simple.Program.Builtin
haskellSuiteProgramDistribution.Simple.Program.Builtin
hasLibsDistribution.Types.PackageDescription, Distribution.PackageDescription
hasLowerBoundDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
HasMungedPackageIdDistribution.Package, Distribution.Make, Distribution.Simple
hasPublicLibDistribution.Types.PackageDescription, Distribution.PackageDescription
hasTestsDistribution.Types.PackageDescription, Distribution.PackageDescription
HasUnitIdDistribution.Package, Distribution.Make, Distribution.Simple
hasUpperBoundDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
HBCDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
hcOptionsDistribution.Types.BuildInfo, Distribution.PackageDescription
HcPkgInfo 
1 (Type/Class)Distribution.Simple.Program.HcPkg
2 (Data Constructor)Distribution.Simple.Program.HcPkg
hcPkgInfo 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
hcPkgProgramDistribution.Simple.Program.HcPkg
hcProfOptionsDistribution.Types.BuildInfo, Distribution.PackageDescription
hcSharedOptionsDistribution.Types.BuildInfo, Distribution.PackageDescription
hcStaticOptionsDistribution.Types.BuildInfo, Distribution.PackageDescription
headDistribution.Compat.Prelude.Internal
HeliumDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
helpCommandUIDistribution.Simple.Command
HereDocumentsLanguage.Haskell.Extension, Distribution.Simple
hexDigitDistribution.Compat.CharParsing
HexFloatLiteralsLanguage.Haskell.Extension, Distribution.Simple
hGetContentsDistribution.Utils.IOData
HiddenCommandDistribution.Simple.Command
hiddenCommandDistribution.Simple.Command
hiddenFieldDistribution.FieldGrammar.Class, Distribution.FieldGrammar
hiddenModules 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
hideDistribution.Simple.Program.HcPkg
hideInvocationDistribution.Simple.Program.HcPkg
HidingRenamingDistribution.Types.ModuleRenaming, Distribution.PackageDescription
hmakeProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
homepage 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
HookedBuildInfoDistribution.Types.HookedBuildInfo, Distribution.PackageDescription
hookedPreProcessorsDistribution.Simple.UserHooks, Distribution.Simple
hookedProgramsDistribution.Simple.UserHooks, Distribution.Simple
hostPlatformDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
hpcProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
HPNDDistribution.SPDX.LicenseId, Distribution.SPDX
HppaDistribution.System
hPutContentsDistribution.Utils.IOData
HPUXDistribution.System
hsc2hsProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
hscolourDistribution.Simple.Haddock
hscolourBenchmarksDistribution.Simple.Setup
hscolourCabalFilePathDistribution.Simple.Setup
hscolourCommandDistribution.Simple.Setup
hscolourCSSDistribution.Simple.Setup
hscolourDistPrefDistribution.Simple.Setup
hscolourExecutablesDistribution.Simple.Setup
HscolourFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
hscolourForeignLibsDistribution.Simple.Setup
hscolourHookDistribution.Simple.UserHooks, Distribution.Simple
hscolourPrefDistribution.Simple.BuildPaths
hscolourProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
hscolourTestSuitesDistribution.Simple.Setup
hscolourVerbosityDistribution.Simple.Setup
hsLibraries 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
hsSourceDirs 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
hstoolVersionDistribution.Simple.HaskellSuite
htmlDirDistribution.Simple.Hpc
htmldirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
HtmldirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
HugsDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
HurdDistribution.System
hyloVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
diff --git a/doc/API/Cabal/doc-index-I.html b/doc/API/Cabal/doc-index-I.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-I.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - I)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - I

I2p_gpl_java_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
I386Distribution.System
IA64Distribution.System
IBM_pibsDistribution.SPDX.LicenseId, Distribution.SPDX
ICUDistribution.SPDX.LicenseId, Distribution.SPDX
idDistribution.Compat.Prelude.Internal
ignoreBOMDistribution.Utils.Generic, Distribution.Simple.Utils
ignoreConditionsDistribution.Types.CondTree
IJGDistribution.SPDX.LicenseId, Distribution.SPDX
ImageMagickDistribution.SPDX.LicenseId, Distribution.SPDX
IMatixDistribution.SPDX.LicenseId, Distribution.SPDX
Imlib2Distribution.SPDX.LicenseId, Distribution.SPDX
ImplDistribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
ImplicitParamsLanguage.Haskell.Extension, Distribution.Simple
ImplicitPreludeLanguage.Haskell.Extension, Distribution.Simple
importDirs 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
ImpredicativeTypesLanguage.Haskell.Extension, Distribution.Simple
includedirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
includeDirs 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
includeProvidesRnDistribution.Types.IncludeRenaming
IncludeRenaming 
1 (Type/Class)Distribution.Types.IncludeRenaming
2 (Data Constructor)Distribution.Types.IncludeRenaming
includeRequiresRnDistribution.Types.IncludeRenaming
includes 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
InclusiveBoundDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
IncoherentInstancesLanguage.Haskell.Extension, Distribution.Simple
incPosDistribution.Parsec.Common
IndefFullUnitIdDistribution.Backpack
indefinite 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
IndentDistribution.Parsec.Lexer
indentWithDistribution.Pretty
infoDistribution.Simple.Utils
infoNoWrapDistribution.Simple.Utils
infoProgressDistribution.Utils.LogProgress
Info_ZIPDistribution.SPDX.LicenseId, Distribution.SPDX
init 
1 (Function)Distribution.Compat.Prelude.Internal
2 (Function)Distribution.Simple.Program.HcPkg
initialBuildStepsDistribution.Simple.Build
initialPathTemplateEnvDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
initInvocationDistribution.Simple.Program.HcPkg
initPackageDB 
1 (Function)Distribution.Simple.HaskellSuite
2 (Function)Distribution.Simple.Register
inplaceInstalledPackageInfoDistribution.Simple.Register
inplacePackageDbPathDistribution.Simple.UHC
InputStreamDistribution.Parsec.LexerMonad
insert 
1 (Function)Distribution.Compat.Graph
2 (Function)Distribution.Simple.PackageIndex
insertFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
installDistribution.Simple.Install
installCabalFilePathDistribution.Simple.Setup
installCommandDistribution.Simple.Setup
installDestDistribution.Simple.Setup
installDirectoryContentsDistribution.Simple.Utils
InstallDirs 
1 (Type/Class)Distribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
2 (Data Constructor)Distribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
installDirsOptionsDistribution.Simple.Setup
installDirsTemplateEnvDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
InstallDirTemplatesDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
installDirTemplatesDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
installDistPrefDistribution.Simple.Setup
installedComponentIdDistribution.InstalledPackageInfo
installedComponentId_ 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
installedDependsDistribution.Package, Distribution.Make, Distribution.Simple
installedOpenUnitIdDistribution.InstalledPackageInfo
InstalledPackageIdDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
installedPackageId 
1 (Function)Distribution.Package, Distribution.Make, Distribution.Simple
2 (Function)Distribution.InstalledPackageInfo
InstalledPackageIndexDistribution.Simple.PackageIndex
InstalledPackageInfo 
1 (Type/Class)Distribution.Types.InstalledPackageInfo, Distribution.Types.InstalledPackageInfo.Lens, Distribution.InstalledPackageInfo
2 (Data Constructor)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
installedPkgsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
installedUnitId 
1 (Function)Distribution.Package, Distribution.Make, Distribution.Simple
2 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
3 (Function)Distribution.Types.InstalledPackageInfo.Lens
installExe 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
installExecutableFileDistribution.Simple.Utils
installExecutableFilesDistribution.Simple.Utils
InstallFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
installFLibDistribution.Simple.GHC
installIncludes 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
installInPlaceDistribution.Simple.Setup
installLib 
1 (Function)Distribution.Simple.UHC
2 (Function)Distribution.Simple.HaskellSuite
3 (Function)Distribution.Simple.GHCJS
4 (Function)Distribution.Simple.GHC
installMaybeExecutableFileDistribution.Simple.Utils
installMaybeExecutableFilesDistribution.Simple.Utils
installOrdinaryFileDistribution.Simple.Utils
installOrdinaryFilesDistribution.Simple.Utils
installPackageDBDistribution.Simple.Setup
installUseWrapperDistribution.Simple.Setup
installVerbosityDistribution.Simple.Setup
InstanceSigsLanguage.Haskell.Extension, Distribution.Simple
instantiatedWith 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
instHookDistribution.Simple.UserHooks, Distribution.Simple
IntDistribution.Compat.Prelude.Internal
Int16Distribution.Compat.Prelude.Internal
Int32Distribution.Compat.Prelude.Internal
Int64Distribution.Compat.Prelude.Internal
Int8Distribution.Compat.Prelude.Internal
IntegerDistribution.Compat.Prelude.Internal
IntegralDistribution.Compat.Prelude.Internal
integralDistribution.Compat.CharParsing
IntelDistribution.SPDX.LicenseId, Distribution.SPDX
Intel_ACPIDistribution.SPDX.LicenseId, Distribution.SPDX
interactDistribution.Compat.Prelude.Internal
Interbase_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
intercalateDistribution.Compat.Prelude.Internal, Distribution.Utils.Generic, Distribution.Simple.Utils
internalPackageDBPathDistribution.Simple.Register
interpModuleRenamingDistribution.Types.ModuleRenaming
interpretPackageDbFlagsDistribution.Simple.Configure
InterruptibleFFILanguage.Haskell.Extension, Distribution.Simple
intersectVersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
IntersectVersionRangesDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
intersectVersionRangesDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
IntersectVersionRangesFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
intersperseDistribution.Compat.Prelude.Internal
intToVerbosityDistribution.Verbosity
invertVersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
invertVersionRangeDistribution.Version, Distribution.Simple
invocationAsBatchFileDistribution.Simple.Program.Script
invocationAsShellScriptDistribution.Simple.Program.Script
invocationAsSystemScriptDistribution.Simple.Program.Script
invokeDistribution.Simple.Program.HcPkg
invokeHcPkgDistribution.Simple.Register
in_field_bracesDistribution.Parsec.Lexer
in_field_layoutDistribution.Parsec.Lexer
in_sectionDistribution.Parsec.Lexer
IODistribution.Compat.Prelude.Internal
IODataDistribution.Utils.IOData, Distribution.Simple.Utils
IODataBinaryDistribution.Utils.IOData, Distribution.Simple.Utils
IODataModeDistribution.Utils.IOData, Distribution.Simple.Utils
IODataModeBinaryDistribution.Utils.IOData, Distribution.Simple.Utils
IODataModeTextDistribution.Utils.IOData, Distribution.Simple.Utils
IODataTextDistribution.Utils.IOData, Distribution.Simple.Utils
IOEncodingDistribution.Simple.Program.Run
IOEncodingTextDistribution.Simple.Program.Run
IOEncodingUTF8Distribution.Simple.Program.Run
IOErrorDistribution.Compat.Prelude.Internal
ioErrorDistribution.Compat.Prelude.Internal
IOSDistribution.System
IPADistribution.SPDX.LicenseId, Distribution.SPDX
ipiFieldGrammarDistribution.Types.InstalledPackageInfo.FieldGrammar
IPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
IRIXDistribution.System
isAbsoluteOnAnyPlatformDistribution.Utils.Generic, Distribution.Simple.Utils
isAlphaDistribution.Compat.Prelude.Internal
isAlphaNumDistribution.Compat.Prelude.Internal
isAnyVersionDistribution.Version, Distribution.Simple
isAsciiDistribution.Utils.Generic
isAsciiAlphaDistribution.Utils.Generic
isAsciiAlphaNumDistribution.Utils.Generic
ISC 
1 (Data Constructor)Distribution.SPDX.LicenseId, Distribution.SPDX
2 (Data Constructor)Distribution.License, Distribution.Make, Distribution.Simple
isDefaultIncludeRenamingDistribution.Types.IncludeRenaming
isDefaultRenamingDistribution.Types.ModuleRenaming
isDenormalizedDistribution.Compat.Prelude.Internal
isDigitDistribution.Compat.Prelude.Internal
isDynamic 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
isIEEEDistribution.Compat.Prelude.Internal
isInfiniteDistribution.Compat.Prelude.Internal
isInfixOfDistribution.Utils.Generic, Distribution.Simple.Utils
isInSearchPathDistribution.Simple.Utils
isInternalDistribution.Simple.BuildToolDepends
isJustDistribution.Compat.Prelude.Internal
isNaNDistribution.Compat.Prelude.Internal
isNegativeZeroDistribution.Compat.Prelude.Internal
IsNodeDistribution.Compat.Graph
isNothingDistribution.Compat.Prelude.Internal
isNoVersionDistribution.Version, Distribution.Simple
isPrefixOfDistribution.Compat.Prelude.Internal
isRelativeOnAnyPlatformDistribution.Utils.Generic, Distribution.Simple.Utils
isSpaceDistribution.Compat.Prelude.Internal
isSpecificVersionDistribution.Version, Distribution.Simple
IsStringDistribution.Compat.Prelude.Internal
isSuffixOfDistribution.Compat.Prelude.Internal
isUpperDistribution.Compat.Prelude.Internal
isVerboseCallSiteDistribution.Verbosity
isVerboseCallStackDistribution.Verbosity
isVerboseMarkOutputDistribution.Verbosity
isVerboseNoWrapDistribution.Verbosity
isVerboseQuietDistribution.Verbosity
isVerboseTimestampDistribution.Verbosity
isWildcardRangeDistribution.Types.VersionRange
iterateDistribution.Compat.Prelude.Internal
diff --git a/doc/API/Cabal/doc-index-J.html b/doc/API/Cabal/doc-index-J.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-J.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - J)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - J

JasPer_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
JavaScriptDistribution.System
JavaScriptFFILanguage.Haskell.Extension, Distribution.Simple
JHCDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
jhcProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
JSONDistribution.SPDX.LicenseId, Distribution.SPDX
jsSources 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
JustDistribution.Compat.Prelude.Internal
diff --git a/doc/API/Cabal/doc-index-K.html b/doc/API/Cabal/doc-index-K.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-K.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - K)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - K

KeyDistribution.Compat.Graph
keysDistribution.Compat.Graph
keysSetDistribution.Compat.Graph
KindSignaturesLanguage.Haskell.Extension, Distribution.Simple
knownArchesDistribution.System
knownBenchmarkTypesDistribution.Types.BenchmarkType, Distribution.PackageDescription
knownBuildTypesDistribution.Types.BuildType, Distribution.PackageDescription
knownCompilerFlavorsDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
KnownExtensionLanguage.Haskell.Extension, Distribution.Simple
knownExtensionsLanguage.Haskell.Extension, Distribution.Simple
knownFieldDistribution.FieldGrammar.Class, Distribution.FieldGrammar
knownForeignLibTypesDistribution.Types.ForeignLibType
knownLanguagesLanguage.Haskell.Extension, Distribution.Simple
knownLicensesDistribution.License, Distribution.Simple
knownOSsDistribution.System
knownProfDetailLevelsDistribution.Simple.Compiler, Distribution.Simple
knownProgramsDistribution.Simple.Program.Db, Distribution.Simple.Program
knownRepoTypesDistribution.Types.SourceRepo, Distribution.PackageDescription
knownSuffixHandlersDistribution.Simple.PreProcess
knownTestTypesDistribution.Types.TestType, Distribution.PackageDescription
diff --git a/doc/API/Cabal/doc-index-L.html b/doc/API/Cabal/doc-index-L.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-L.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - L)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - L

LDistribution.Parsec.Lexer
LAL_1_2Distribution.SPDX.LicenseId, Distribution.SPDX
LAL_1_3Distribution.SPDX.LicenseId, Distribution.SPDX
LambdaCaseLanguage.Haskell.Extension, Distribution.Simple
LanguageLanguage.Haskell.Extension, Distribution.Simple
languageToFlagsDistribution.Simple.Compiler, Distribution.Simple
lastDistribution.Compat.Prelude.Internal
Last' 
1 (Type/Class)Distribution.Compat.Semigroup
2 (Data Constructor)Distribution.Compat.Semigroup
LaterVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
laterVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
LaterVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
Latex2eDistribution.SPDX.LicenseId, Distribution.SPDX
lcmDistribution.Compat.Prelude.Internal
lc_ann_idDistribution.Backpack.LinkedComponent
lc_cidDistribution.Backpack.LinkedComponent
lc_componentDistribution.Backpack.LinkedComponent
lc_exe_depsDistribution.Backpack.LinkedComponent
lc_includesDistribution.Backpack.LinkedComponent
lc_instsDistribution.Backpack.LinkedComponent
lc_pkgidDistribution.Backpack.LinkedComponent
lc_publicDistribution.Backpack.LinkedComponent
lc_shapeDistribution.Backpack.LinkedComponent
lc_sig_includesDistribution.Backpack.LinkedComponent
lc_uidDistribution.Backpack.LinkedComponent
ldOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
ldProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
LeftDistribution.Compat.Prelude.Internal
LegacyExeDependency 
1 (Type/Class)Distribution.Types.LegacyExeDependency
2 (Data Constructor)Distribution.Types.LegacyExeDependency
lengthDistribution.Compat.Prelude.Internal
LensDistribution.Compat.Lens
Lens'Distribution.Compat.Lens
LensLikeDistribution.Compat.Lens
LensLike'Distribution.Compat.Lens
LeptonicaDistribution.SPDX.LicenseId, Distribution.SPDX
lessVerboseDistribution.Verbosity
letterDistribution.Compat.CharParsing
Lex 
1 (Type/Class)Distribution.Parsec.LexerMonad
2 (Data Constructor)Distribution.Parsec.LexerMonad
lexDistribution.Compat.Prelude.Internal
lexemeParsecDistribution.Parsec.Class
LexicalErrorDistribution.Parsec.Lexer
LexResult 
1 (Type/Class)Distribution.Parsec.LexerMonad
2 (Data Constructor)Distribution.Parsec.LexerMonad
LexState 
1 (Type/Class)Distribution.Parsec.LexerMonad
2 (Data Constructor)Distribution.Parsec.LexerMonad
lexTokenDistribution.Parsec.Lexer
LexWarning 
1 (Type/Class)Distribution.Parsec.LexerMonad
2 (Data Constructor)Distribution.Parsec.LexerMonad
LexWarningBOMDistribution.Parsec.LexerMonad
LexWarningNBSPDistribution.Parsec.LexerMonad
LexWarningTabDistribution.Parsec.LexerMonad
LexWarningTypeDistribution.Parsec.LexerMonad
LFlagsDistribution.Simple.Command
LGPLDistribution.License, Distribution.Make, Distribution.Simple
LGPLLRDistribution.SPDX.LicenseId, Distribution.SPDX
LGPL_2_0_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
LGPL_2_0_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
LGPL_2_1_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
LGPL_2_1_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
LGPL_3_0_onlyDistribution.SPDX.LicenseId, Distribution.SPDX
LGPL_3_0_or_laterDistribution.SPDX.LicenseId, Distribution.SPDX
LHCDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
libAbiHash 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
libBuildInfo 
1 (Function)Distribution.Types.Library, Distribution.PackageDescription
2 (Function)Distribution.Types.Library.Lens, Distribution.Types.Lens
LibComponentLocalBuildInfoDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
libCoverageDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
libdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
LibdirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
LiberalTypeSynonymsLanguage.Haskell.Extension, Distribution.Simple
libexecdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
libexecsubdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
libExposed 
1 (Function)Distribution.Types.Library, Distribution.PackageDescription
2 (Function)Distribution.Types.Library.Lens, Distribution.Types.Lens
libModulesDistribution.Types.Library, Distribution.PackageDescription
libModulesAutogenDistribution.Types.Library, Distribution.PackageDescription
libName 
1 (Function)Distribution.Types.Library, Distribution.PackageDescription
2 (Function)Distribution.Types.Library.Lens, Distribution.Types.Lens
LibNameVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
LibpngDistribution.SPDX.LicenseId, Distribution.SPDX
Library 
1 (Type/Class)Distribution.Types.Library, Distribution.Types.Library.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.Library, Distribution.PackageDescription
library 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
libraryComponentNameDistribution.Types.ComponentName
libraryDirs 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
libraryDynDirs 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
libraryDynDirSupportedDistribution.Simple.Compiler, Distribution.Simple
libraryFieldGrammarDistribution.PackageDescription.FieldGrammar
libsubdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
LibsubdirVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
LibtiffDistribution.SPDX.LicenseId, Distribution.SPDX
Libtool_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
LibVersionInfoDistribution.Types.ForeignLib
libVersionInfoCRADistribution.Types.ForeignLib
libVersionMajorDistribution.Types.ForeignLib
libVersionNumberDistribution.Types.ForeignLib
libVersionNumberShowDistribution.Types.ForeignLib
License 
1 (Type/Class)Distribution.SPDX.License, Distribution.SPDX
2 (Data Constructor)Distribution.SPDX.License, Distribution.SPDX
3 (Type/Class)Distribution.License, Distribution.Make, Distribution.Simple
license 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
3 (Function)Distribution.Types.InstalledPackageInfo.Lens
license'Distribution.Types.PackageDescription
licenseDocumentRefDistribution.SPDX.LicenseReference, Distribution.SPDX
LicenseExceptionIdDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
licenseExceptionIdDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
licenseExceptionIdListDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
licenseExceptionNameDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
LicenseExpressionDistribution.SPDX.LicenseExpression, Distribution.SPDX
licenseFiles 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
licenseFromSPDXDistribution.License, Distribution.Simple
LicenseIdDistribution.SPDX.LicenseId, Distribution.SPDX
licenseIdDistribution.SPDX.LicenseId, Distribution.SPDX
licenseIdListDistribution.SPDX.LicenseId, Distribution.SPDX
licenseIdMigrationMessageDistribution.SPDX.LicenseId
licenseIsOsiApprovedDistribution.SPDX.LicenseId, Distribution.SPDX
LicenseListVersionDistribution.SPDX.LicenseListVersion, Distribution.SPDX
LicenseListVersion_3_0Distribution.SPDX.LicenseListVersion, Distribution.SPDX
LicenseListVersion_3_2Distribution.SPDX.LicenseListVersion, Distribution.SPDX
licenseNameDistribution.SPDX.LicenseId, Distribution.SPDX
licenseRaw 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
LicenseRefDistribution.SPDX.LicenseReference, Distribution.SPDX
licenseRefDistribution.SPDX.LicenseReference, Distribution.SPDX
licenseToSPDXDistribution.License, Distribution.Simple
liftMDistribution.Compat.Prelude.Internal
liftM2Distribution.Compat.Prelude.Internal
liftOptionDistribution.Simple.Command
LiLiQ_P_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
LiLiQ_Rplus_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
LiLiQ_R_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
linesDistribution.Compat.Prelude.Internal
LinkedComponent 
1 (Type/Class)Distribution.Backpack.LinkedComponent
2 (Data Constructor)Distribution.Backpack.LinkedComponent
LinkedComponentMapDistribution.Backpack.LinkedComponent
LinuxDistribution.System
Linux_OpenIBDistribution.SPDX.LicenseId, Distribution.SPDX
Linux_syscall_noteDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
ListDistribution.Parsec.Newtypes
listDistribution.Simple.Program.HcPkg
listDirectoryDistribution.Compat.Directory
listInvocationDistribution.Simple.Program.HcPkg
listPackageSourcesDistribution.Simple.SrcDist
listToMaybeDistribution.Compat.Prelude.Internal
listUnionDistribution.Utils.Generic, Distribution.Simple.Utils
listUnionRightDistribution.Utils.Generic, Distribution.Simple.Utils
LitDistribution.Types.Condition, Distribution.PackageDescription
LiteralFileNameGlobStarDistribution.Simple.Glob
LLVM_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
LocalBuildInfo 
1 (Type/Class)Distribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
2 (Data Constructor)Distribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
localBuildInfoFileDistribution.Simple.Configure
localCompatPackageKeyDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
localComponentIdDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
localPackageDistribution.Types.LocalBuildInfo
localPackageLogDistribution.Simple.Test.Log
localPkgDescrDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
localUnitIdDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
locationPathDistribution.Simple.Program.Types, Distribution.Simple.Program
logDistribution.Compat.Prelude.Internal
logBaseDistribution.Compat.Prelude.Internal
logFileDistribution.Simple.Test.Log
LogProgressDistribution.Utils.LogProgress
lookDistribution.Compat.ReadP
lookup 
1 (Function)Distribution.Compat.Prelude.Internal
2 (Function)Distribution.Compat.Graph
lookupComponentDistribution.Types.PackageDescription, Distribution.Simple.LocalBuildInfo
lookupComponentIdDistribution.Simple.PackageIndex
lookupDependencyDistribution.Simple.PackageIndex
lookupFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
lookupInstalledPackageIdDistribution.Simple.PackageIndex
lookupInternalDependencyDistribution.Simple.PackageIndex
lookupKnownProgramDistribution.Simple.Program.Db, Distribution.Simple.Program
lookupPackageIdDistribution.Simple.PackageIndex
lookupPackageNameDistribution.Simple.PackageIndex
lookupProgramDistribution.Simple.Program.Db, Distribution.Simple.Program
lookupProgramVersionDistribution.Simple.Program.Db, Distribution.Simple.Program
lookupSourcePackageIdDistribution.Simple.PackageIndex
lookupUnitIdDistribution.Simple.PackageIndex
lowerDistribution.Compat.CharParsing
LowerBound 
1 (Type/Class)Distribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
2 (Data Constructor)Distribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
lowercaseDistribution.Utils.Generic, Distribution.Simple.Utils
LPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
LPL_1_02Distribution.SPDX.LicenseId, Distribution.SPDX
LPPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
LPPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
LPPL_1_2Distribution.SPDX.LicenseId, Distribution.SPDX
LPPL_1_3aDistribution.SPDX.LicenseId, Distribution.SPDX
LPPL_1_3cDistribution.SPDX.LicenseId, Distribution.SPDX
LTDistribution.Compat.Prelude.Internal
ltestDistribution.Parsec.Lexer
LTokenDistribution.Parsec.Lexer
LZMA_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
diff --git a/doc/API/Cabal/doc-index-M.html b/doc/API/Cabal/doc-index-M.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-M.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - M)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - M

M68kDistribution.System
MagicHashLanguage.Haskell.Extension, Distribution.Simple
mainDistribution.ModuleName
maintainer 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
MajorBoundVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
majorBoundVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
MajorBoundVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
majorUpperBoundDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
MakeDistribution.Types.BuildType, Distribution.PackageDescription
makeAbsoluteDistribution.Compat.Directory
MakeIndexDistribution.SPDX.LicenseId, Distribution.SPDX
mandirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
many 
1 (Function)Distribution.Compat.Prelude.Internal, Distribution.Compat.Parsing, Distribution.Compat.CharParsing
2 (Function)Distribution.Compat.ReadP
many1Distribution.Compat.ReadP
manyTill 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
MapDistribution.Compat.Prelude.Internal
mapDistribution.Compat.Prelude.Internal
mapAccumMDistribution.Utils.MapAccum
mapCondTreeDistribution.Types.CondTree, Distribution.PackageDescription.Configuration
mapMaybeDistribution.Compat.Prelude.Internal
mappendDistribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
mapTreeCondsDistribution.Types.CondTree, Distribution.PackageDescription.Configuration
mapTreeConstrsDistribution.Types.CondTree, Distribution.PackageDescription.Configuration
mapTreeDataDistribution.Types.CondTree, Distribution.PackageDescription.Configuration
markupDistribution.Simple.Program.Hpc
markupPackageDistribution.Simple.Hpc
markupTestDistribution.Simple.Hpc
matchDirFileGlobDistribution.Simple.Glob
maxDistribution.Compat.Prelude.Internal
maxBoundDistribution.Compat.Prelude.Internal
MaximalDebugInfoDistribution.Simple.Compiler, Distribution.Simple
maximumDistribution.Compat.Prelude.Internal
MaximumOptimisationDistribution.Simple.Compiler, Distribution.Simple
MaybeDistribution.Compat.Prelude.Internal
maybeDistribution.Compat.Prelude.Internal
maybeComponentInstantiatedWithDistribution.Types.ComponentLocalBuildInfo
maybeExitDistribution.Simple.Utils
maybeGetPersistBuildConfigDistribution.Simple.Configure
maybeToFlagDistribution.Simple.Flag, Distribution.Simple.Setup
maybeToListDistribution.Compat.Prelude.Internal
mconcatDistribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
memberDistribution.Compat.Graph
memptyDistribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
MercurialDistribution.Types.SourceRepo, Distribution.PackageDescription
mergeDistribution.Simple.PackageIndex
Mif_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
minDistribution.Compat.Prelude.Internal
minBoundDistribution.Compat.Prelude.Internal
MinimalDebugInfoDistribution.Simple.Compiler, Distribution.Simple
minimumDistribution.Compat.Prelude.Internal
MipsDistribution.System
MirOSDistribution.SPDX.LicenseId, Distribution.SPDX
MIT 
1 (Data Constructor)Distribution.SPDX.LicenseId, Distribution.SPDX
2 (Data Constructor)Distribution.License, Distribution.Make, Distribution.Simple
MITNFADistribution.SPDX.LicenseId, Distribution.SPDX
MIT_0Distribution.SPDX.LicenseId, Distribution.SPDX
MIT_advertisingDistribution.SPDX.LicenseId, Distribution.SPDX
MIT_CMUDistribution.SPDX.LicenseId, Distribution.SPDX
MIT_ennaDistribution.SPDX.LicenseId, Distribution.SPDX
MIT_fehDistribution.SPDX.LicenseId, Distribution.SPDX
mixDirDistribution.Simple.Hpc
Mixin 
1 (Type/Class)Distribution.Types.Mixin
2 (Data Constructor)Distribution.Types.Mixin
mixinIncludeRenamingDistribution.Types.Mixin
mixinPackageNameDistribution.Types.Mixin
mixins 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
mixLinkPreModuleShapeDistribution.Backpack.PreModuleShape
mkAbiHashDistribution.Types.AbiHash, Distribution.Package, Distribution.Make, Distribution.Simple
mkCommandUIDistribution.Simple.Command
mkComponentIdDistribution.Types.ComponentId, Distribution.Package, Distribution.Make, Distribution.Simple
mkComponentsGraphDistribution.Backpack.ComponentsGraph
mkDefUnitIdDistribution.Backpack
MkFlagDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
mkFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
mkFlagNameDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
mkGenericSharedLibNameDistribution.Simple.BuildPaths
mkGenericStaticLibNameDistribution.Simple.BuildPaths
mkLegacyUnitIdDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
mkLexStateDistribution.Parsec.Lexer
mkLibNameDistribution.Simple.BuildPaths
mkLibVersionInfoDistribution.Types.ForeignLib
mkLicenseExceptionIdDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
mkLicenseIdDistribution.SPDX.LicenseId, Distribution.SPDX
mkLicenseRefDistribution.SPDX.LicenseReference, Distribution.SPDX
mkLicenseRef'Distribution.SPDX.LicenseReference, Distribution.SPDX
mkMungedPackageNameDistribution.Types.MungedPackageName
mkNameDistribution.Parsec.Field
MkNamelessFieldDistribution.FieldGrammar.Parsec
mkOpenUnitIdDistribution.Backpack
MkOptDescrDistribution.Simple.Command
mkPackageNameDistribution.Types.PackageName, Distribution.Package, Distribution.Make, Distribution.Simple
mkPkgconfigNameDistribution.Types.PkgconfigName, Distribution.Package, Distribution.Make, Distribution.Simple
mkProfLibNameDistribution.Simple.BuildPaths
MkSectionDistribution.FieldGrammar.Parsec, Distribution.FieldGrammar
mkSharedLibNameDistribution.Simple.BuildPaths
mkSimplePreProcessorDistribution.Simple.PreProcess
mkStaticLibNameDistribution.Simple.BuildPaths
mkUnitIdDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
mkUnqualComponentNameDistribution.Types.UnqualComponentName
mkVersionDistribution.Types.Version, Distribution.Version, Distribution.Simple
mkVersion'Distribution.Types.Version, Distribution.Version, Distribution.Simple
mkVersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
modDistribution.Compat.Prelude.Internal
modifyProgramSearchPathDistribution.Simple.Program.Db
modifyVerbosityDistribution.Verbosity
modShapeProvidesDistribution.Backpack.ModuleShape
modShapeRequiresDistribution.Backpack.ModuleShape
ModSubstDistribution.Backpack.ModSubst
modSubstDistribution.Backpack.ModSubst
ModTime 
1 (Type/Class)Distribution.Compat.Time
2 (Data Constructor)Distribution.Compat.Time
Module 
1 (Type/Class)Distribution.Types.Module, Distribution.Package, Distribution.Make, Distribution.Simple
2 (Data Constructor)Distribution.Types.Module, Distribution.Package, Distribution.Make, Distribution.Simple
ModuleName 
1 (Type/Class)Distribution.ModuleName
2 (Data Constructor)Distribution.ModuleName
moduleNameIndexDistribution.Simple.PackageIndex
modulePath 
1 (Function)Distribution.Types.Executable, Distribution.PackageDescription
2 (Function)Distribution.Types.Executable.Lens, Distribution.Types.Lens
ModuleReexport 
1 (Type/Class)Distribution.Types.ModuleReexport, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.ModuleReexport, Distribution.PackageDescription
moduleReexportNameDistribution.Types.ModuleReexport, Distribution.PackageDescription
moduleReexportOriginalNameDistribution.Types.ModuleReexport, Distribution.PackageDescription
moduleReexportOriginalPackageDistribution.Types.ModuleReexport, Distribution.PackageDescription
ModuleRenaming 
1 (Type/Class)Distribution.Types.ModuleRenaming, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.ModuleRenaming, Distribution.PackageDescription
ModuleShape 
1 (Type/Class)Distribution.Backpack.ModuleShape
2 (Data Constructor)Distribution.Backpack.ModuleShape
MonadDistribution.Compat.Prelude.Internal
MonadComprehensionsLanguage.Haskell.Extension, Distribution.Simple
MonadFailDesugaringLanguage.Haskell.Extension, Distribution.Simple
MonadPlusDistribution.Compat.Prelude.Internal
MonoidDistribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
monoidalFieldDistribution.FieldGrammar.Class, Distribution.FieldGrammar
monoidalFieldAlaDistribution.FieldGrammar.Class, Distribution.FieldGrammar
MonoLocalBindsLanguage.Haskell.Extension, Distribution.Simple
MonomorphismRestrictionLanguage.Haskell.Extension, Distribution.Simple
MonoPatBindsLanguage.Haskell.Extension, Distribution.Simple
MonotoneDistribution.Types.SourceRepo, Distribution.PackageDescription
moreRecentFileDistribution.Simple.Utils
moreVerboseDistribution.Verbosity
MotosotoDistribution.SPDX.LicenseId, Distribution.SPDX
Mpich2Distribution.SPDX.LicenseId, Distribution.SPDX
MPLDistribution.License, Distribution.Make, Distribution.Simple
mplusDistribution.Compat.Prelude.Internal
MPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
MPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
MPL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
MPL_2_0_no_copyleft_exceptionDistribution.SPDX.LicenseId, Distribution.SPDX
MQuoted 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
MS_PLDistribution.SPDX.LicenseId, Distribution.SPDX
MS_RLDistribution.SPDX.LicenseId, Distribution.SPDX
MTLLDistribution.SPDX.LicenseId, Distribution.SPDX
MulticsDistribution.SPDX.LicenseId, Distribution.SPDX
multiOptionDistribution.Simple.Command
MultiParamTypeClassesLanguage.Haskell.Extension, Distribution.Simple
multiStageProgramInvocationDistribution.Simple.Program.Run, Distribution.Simple.Program.Ar
MultiWayIfLanguage.Haskell.Extension, Distribution.Simple
munch 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.CharParsing
munch1 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.CharParsing
mungedIdDistribution.Package, Distribution.Make, Distribution.Simple
mungedNameDistribution.Types.MungedPackageId
mungedName'Distribution.Package, Distribution.Make, Distribution.Simple
MungedPackageId 
1 (Type/Class)Distribution.Types.MungedPackageId
2 (Data Constructor)Distribution.Types.MungedPackageId
mungedPackageIdDistribution.Types.InstalledPackageInfo
MungedPackageNameDistribution.Types.MungedPackageName
mungedPackageNameDistribution.Types.InstalledPackageInfo
mungedVersionDistribution.Types.MungedPackageId
mungedVersion'Distribution.Package, Distribution.Make, Distribution.Simple
MupDistribution.SPDX.LicenseId, Distribution.SPDX
mzeroDistribution.Compat.Prelude.Internal
diff --git a/doc/API/Cabal/doc-index-N.html b/doc/API/Cabal/doc-index-N.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-N.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - N)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - N

NDistribution.Compat.Graph
Name 
1 (Type/Class)Distribution.Parsec.Field, Distribution.Parsec.Parser
2 (Data Constructor)Distribution.Parsec.Field, Distribution.Parsec.Parser
3 (Type/Class)Distribution.Simple.Command
nameDistribution.TestSuite
nameAnnDistribution.Parsec.Field
NamedFieldPunsLanguage.Haskell.Extension, Distribution.Simple
NamedWildCardsLanguage.Haskell.Extension, Distribution.Simple
NamelessFieldDistribution.FieldGrammar.Parsec
namelessFieldAnnDistribution.FieldGrammar.Parsec
NASA_1_3Distribution.SPDX.LicenseId, Distribution.SPDX
nativeMultiInstanceDistribution.Simple.Program.HcPkg
NaumenDistribution.SPDX.LicenseId, Distribution.SPDX
NBPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
NCSADistribution.SPDX.LicenseId, Distribution.SPDX
neededTargetsInBuildOrderDistribution.Types.LocalBuildInfo
neededTargetsInBuildOrder'Distribution.Types.LocalBuildInfo
negateDistribution.Compat.Prelude.Internal
NegativeLiteralsLanguage.Haskell.Extension, Distribution.Simple
neighborsDistribution.Compat.Graph
NetBSDDistribution.System
NetCDFDistribution.SPDX.LicenseId, Distribution.SPDX
Net_SNMPDistribution.SPDX.LicenseId, Distribution.SPDX
NeverDistribution.Simple.Setup
newlineDistribution.Compat.CharParsing
newPackageDepsBehaviourDistribution.Backpack.ConfiguredComponent
NewQualifiedOperatorsLanguage.Haskell.Extension, Distribution.Simple
newSimpleUnitIdDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
NewsletrDistribution.SPDX.LicenseId, Distribution.SPDX
NewtypeDistribution.Compat.Newtype
NFDataDistribution.Compat.Prelude.Internal
NGPLDistribution.SPDX.LicenseId, Distribution.SPDX
NHCDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
NLOD_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
NLPLDistribution.SPDX.LicenseId, Distribution.SPDX
NoAbiTagDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
noArgDistribution.Simple.Command
NoCallStackIODistribution.Compat.Prelude.Internal
NoCommaFSep 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
NoCommonStanzasDistribution.CabalSpecVersion
NoCopyDestDistribution.Simple.InstallDirs, Distribution.Simple.Setup, Distribution.Simple.LocalBuildInfo
NodeDistribution.Compat.Graph
NoDebugInfoDistribution.Simple.Compiler, Distribution.Simple
nodeKeyDistribution.Compat.Graph
nodeNeighborsDistribution.Compat.Graph
nodeValueDistribution.Compat.Graph
NoElifDistribution.CabalSpecVersion
NoExtensionOnStarDistribution.Simple.Glob
noExtraFlagsDistribution.Simple.Command
NoFlagDistribution.Simple.Flag, Distribution.Simple.Setup
NoGlobstarDistribution.CabalSpecVersion
NokiaDistribution.SPDX.LicenseId, Distribution.SPDX
Nokia_Qt_exception_1_1Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
NondecreasingIndentationLanguage.Haskell.Extension, Distribution.Simple
NONEDistribution.SPDX.License, Distribution.SPDX
NoneDistribution.Simple.PackageIndex
noneOfDistribution.Compat.CharParsing
NoOptimisationDistribution.Simple.Compiler, Distribution.Simple
NoParseDistribution.InstalledPackageInfo
noPkgDbStackDistribution.Simple.Program.HcPkg
normalDistribution.Verbosity
NormalCommandDistribution.Simple.Command
NormalDebugInfoDistribution.Simple.Compiler, Distribution.Simple
normaliseGhcArgsDistribution.Simple.Program.GHC
normaliseLineEndingsDistribution.Utils.Generic, Distribution.Simple.Utils
normaliseVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
NormalOptimisationDistribution.Simple.Compiler, Distribution.Simple
NOSLDistribution.SPDX.LicenseId, Distribution.SPDX
notDistribution.Compat.Prelude.Internal
notCharDistribution.Compat.CharParsing
notElemDistribution.Compat.Prelude.Internal
notFollowedByDistribution.Compat.Parsing, Distribution.Compat.CharParsing
NothingDistribution.Compat.Prelude.Internal
noticeDistribution.Simple.Utils
noticeDocDistribution.Simple.Utils
noticeNoWrapDistribution.Simple.Utils
notThisPackageVersionDistribution.Types.Dependency, Distribution.Package, Distribution.Make, Distribution.Simple
notThisVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
NoUpperBoundDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
noVerboseFlagDistribution.Simple.Program.HcPkg
noVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
NowebDistribution.SPDX.LicenseId, Distribution.SPDX
NPlusKPatternsLanguage.Haskell.Extension, Distribution.Simple
NPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
NPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
NPOSL_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
NRLDistribution.SPDX.LicenseId, Distribution.SPDX
NTPDistribution.SPDX.LicenseId, Distribution.SPDX
nubDistribution.Compat.Prelude.Internal
nubByDistribution.Compat.Prelude.Internal
NubListDistribution.Utils.NubList
NubListRDistribution.Utils.NubList
null 
1 (Function)Distribution.Compat.Prelude.Internal
2 (Function)Distribution.Compat.Graph
3 (Function)Distribution.Utils.IOData
NullaryTypeClassesLanguage.Haskell.Extension, Distribution.Simple
NullBSDDistribution.SPDX.LicenseId, Distribution.SPDX
nullFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
nullVersionDistribution.Types.Version, Distribution.Version, Distribution.Simple
NumDistribution.Compat.Prelude.Internal
NumDecimalsLanguage.Haskell.Extension, Distribution.Simple
NumericUnderscoresLanguage.Haskell.Extension, Distribution.Simple
numericVersionDistribution.Simple.HaskellSuite
diff --git a/doc/API/Cabal/doc-index-O.html b/doc/API/Cabal/doc-index-O.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-O.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - O)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - O

ObjectiveCDistribution.Simple.CCompiler
ObjectiveCPlusPlusDistribution.Simple.CCompiler
objExtensionDistribution.Simple.BuildPaths
OCCT_exception_1_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
OCCT_PLDistribution.SPDX.LicenseId, Distribution.SPDX
OCLC_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
octDigitDistribution.Compat.CharParsing
ODbL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
ODC_By_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
oddDistribution.Compat.Prelude.Internal
OFL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
OFL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
OGTSLDistribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_1_2Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_1_3Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_1_4Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_0_1Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_1Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_2Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_2_1Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_2_2Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_3Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_4Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_5Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_6Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_7Distribution.SPDX.LicenseId, Distribution.SPDX
OLDAP_2_8Distribution.SPDX.LicenseId, Distribution.SPDX
oldExtensions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
OMLDistribution.SPDX.LicenseId, Distribution.SPDX
OneComponentRequestedSpecDistribution.Types.ComponentRequestedSpec
oneOfDistribution.Compat.CharParsing
OpenBraceDistribution.Parsec.Lexer
OpenBSDDistribution.System
OpenJDK_assembly_exception_1_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
OpenModule 
1 (Type/Class)Distribution.Backpack
2 (Data Constructor)Distribution.Backpack
openModuleFreeHolesDistribution.Backpack
OpenModuleSubstDistribution.Backpack
openModuleSubstFreeHolesDistribution.Backpack
OpenModuleVarDistribution.Backpack
OpenSSLDistribution.SPDX.LicenseId, Distribution.SPDX
OpenUnitIdDistribution.Backpack
openUnitIdFreeHolesDistribution.Backpack
Openvpn_openssl_exceptionDistribution.SPDX.LicenseExceptionId, Distribution.SPDX
OPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
OptArgDistribution.Simple.Command
optArgDistribution.Simple.Command
optArg'Distribution.Simple.Command
OptDescrDistribution.Simple.Command
OptFlagsDistribution.Simple.Command
OptimisationLevelDistribution.Simple.Compiler, Distribution.Simple
option 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
3 (Function)Distribution.Simple.Command
optional 
1 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
2 (Function)Distribution.Compat.ReadP
optionalFieldDistribution.FieldGrammar.Class, Distribution.FieldGrammar
optionalFieldAlaDistribution.FieldGrammar.Class, Distribution.FieldGrammar
optionalFieldDefDistribution.FieldGrammar.Class, Distribution.FieldGrammar
optionalFieldDefAlaDistribution.FieldGrammar.Class, Distribution.FieldGrammar
OptionBoolDistribution.TestSuite
optionDefaultDistribution.TestSuite
OptionDescr 
1 (Type/Class)Distribution.TestSuite
2 (Data Constructor)Distribution.TestSuite
optionDescrDistribution.Simple.Command
optionDescriptionDistribution.TestSuite
optionDistPrefDistribution.Simple.Setup
OptionEnumDistribution.TestSuite
OptionField 
1 (Type/Class)Distribution.Simple.Command
2 (Data Constructor)Distribution.Simple.Command
OptionFileDistribution.TestSuite
optionFileExtensionsDistribution.TestSuite
optionFileIsDirDistribution.TestSuite
optionFileMustExistDistribution.TestSuite
optionName 
1 (Function)Distribution.TestSuite
2 (Function)Distribution.Simple.Command
OptionNumberDistribution.TestSuite
optionNumberBoundsDistribution.TestSuite
optionNumberIsIntDistribution.TestSuite
optionNumJobsDistribution.Simple.Setup
OptionRngSeedDistribution.TestSuite
OptionsDistribution.TestSuite
options 
1 (Function)Distribution.TestSuite
2 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
3 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
OptionSetDistribution.TestSuite
OptionStringDistribution.TestSuite
optionStringMultilineDistribution.TestSuite
OptionTypeDistribution.TestSuite
optionTypeDistribution.TestSuite
optionVerbosityDistribution.Simple.Setup
optKeepTempFilesDistribution.Simple.Utils
orDistribution.Compat.Prelude.Internal
OrdDistribution.Compat.Prelude.Internal
ordDistribution.Compat.Prelude.Internal
OrderingDistribution.Compat.Prelude.Internal
ordNubDistribution.Utils.Generic, Distribution.Simple.Utils
ordNubByDistribution.Utils.Generic, Distribution.Simple.Utils
ordNubRightDistribution.Utils.Generic, Distribution.Simple.Utils
OrEarlierVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
orEarlierVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
OrEarlierVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
OrLaterVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
orLaterVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
OrLaterVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
OS 
1 (Type/Class)Distribution.System
2 (Data Constructor)Distribution.Types.GenericPackageDescription, Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
OSET_PL_2_1Distribution.SPDX.LicenseId, Distribution.SPDX
OSL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
OSL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
OSL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
OSL_2_1Distribution.SPDX.LicenseId, Distribution.SPDX
OSL_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
OSVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
OSXDistribution.System
OtherArchDistribution.System
OtherCompilerDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
otherExtensions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
otherLanguages 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
OtherLicenseDistribution.License, Distribution.Make, Distribution.Simple
otherModules 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
OtherOSDistribution.System
OtherRepoTypeDistribution.Types.SourceRepo, Distribution.PackageDescription
otherwiseDistribution.Compat.Prelude.Internal
overDistribution.Compat.Lens
OverlappingInstancesLanguage.Haskell.Extension, Distribution.Simple
OverloadedLabelsLanguage.Haskell.Extension, Distribution.Simple
OverloadedListsLanguage.Haskell.Extension, Distribution.Simple
OverloadedStringsLanguage.Haskell.Extension, Distribution.Simple
overNubListDistribution.Utils.NubList
overNubListRDistribution.Utils.NubList
diff --git a/doc/API/Cabal/doc-index-P.html b/doc/API/Cabal/doc-index-P.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-P.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - P)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - P

packDistribution.Compat.Newtype
pack'Distribution.Compat.Newtype
PackageDistribution.Package, Distribution.Make, Distribution.Simple
package 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Simple.Test.Log
PackageBuildImpossibleDistribution.PackageDescription.Check
PackageBuildWarningDistribution.PackageDescription.Check
PackageCheckDistribution.PackageDescription.Check
PackageDBDistribution.Simple.Compiler, Distribution.Simple
packageDbArgsDbDistribution.Simple.Program.GHC
packageDbOptDistribution.Simple.HaskellSuite
PackageDBStackDistribution.Simple.Compiler, Distribution.Simple
PackageDescription 
1 (Type/Class)Distribution.Types.PackageDescription, Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.PackageDescription, Distribution.PackageDescription
packageDescription 
1 (Function)Distribution.Types.GenericPackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.GenericPackageDescription.Lens, Distribution.Types.Lens
packageDescriptionFieldGrammarDistribution.PackageDescription.FieldGrammar
PackageDistInexcusableDistribution.PackageDescription.Check
PackageDistSuspiciousDistribution.PackageDescription.Check
PackageDistSuspiciousWarnDistribution.PackageDescription.Check
PackageIdDistribution.Types.PackageId, Distribution.Package, Distribution.Make, Distribution.Simple
packageIdDistribution.Package, Distribution.Make, Distribution.Simple
PackageIdentifier 
1 (Type/Class)Distribution.Types.PackageId, Distribution.Types.PackageId.Lens, Distribution.Package, Distribution.Types.Lens, Distribution.Make, Distribution.Simple
2 (Data Constructor)Distribution.Types.PackageId, Distribution.Package, Distribution.Make, Distribution.Simple
PackageImportsLanguage.Haskell.Extension, Distribution.Simple
PackageIndexDistribution.Simple.PackageIndex
PackageInstalledDistribution.Package, Distribution.Make, Distribution.Simple
packageKeySupportedDistribution.Simple.Compiler, Distribution.Simple
PackageLog 
1 (Type/Class)Distribution.Simple.Test.Log
2 (Data Constructor)Distribution.Simple.Test.Log
PackageNameDistribution.Types.PackageName, Distribution.Package, Distribution.Make, Distribution.Simple
packageNameDistribution.Package, Distribution.Make, Distribution.Simple
packageNameToUnqualComponentNameDistribution.Types.UnqualComponentName
packageTemplateEnvDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
packageVersionDistribution.Package, Distribution.Make, Distribution.Simple
ParallelArraysLanguage.Haskell.Extension, Distribution.Simple
ParallelListCompLanguage.Haskell.Extension, Distribution.Simple
parentSrcLocPrefixDistribution.Compat.Stack
parmakeSupportedDistribution.Simple.Compiler, Distribution.Simple
parseDistribution.Text
ParseArgsDistribution.Simple.Command
ParsecDistribution.Parsec.Class
parsecDistribution.Parsec.Class
parsecCommaListDistribution.Parsec.Class
ParsecFieldGrammarDistribution.FieldGrammar.Parsec, Distribution.FieldGrammar
ParsecFieldGrammar'Distribution.FieldGrammar
parsecFilePathDistribution.Parsec.Class
parsecFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
parsecHaskellStringDistribution.Parsec.Class
parsecLeadingCommaListDistribution.Parsec.Class
parsecMaybeQuotedDistribution.Parsec.Class
parseCompilerFlavorCompatDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
parseConditionDistribution.PackageDescription.Configuration
parseConditionConfVarDistribution.Parsec.ConfVar
parsecOpenModuleSubstDistribution.Backpack
parsecOpenModuleSubstEntryDistribution.Backpack
parsecOptCommaListDistribution.Parsec.Class
ParsecParserDistribution.Parsec.Class
parsecQuotedDistribution.Parsec.Class
parsecStandardDistribution.Parsec.Class
parsecTokenDistribution.Parsec.Class
parsecToken'Distribution.Parsec.Class
parsecToReadEDistribution.ReadE
parsecUnqualComponentNameDistribution.Parsec.Class
parsecWarningDistribution.Parsec.Class
ParseErrorExc 
1 (Type/Class)Distribution.Simple.GHC
2 (Data Constructor)Distribution.Simple.GHC
ParseFailedDistribution.InstalledPackageInfo
parseFailureDistribution.Parsec.ParseResult
parseFatalFailureDistribution.Parsec.ParseResult
parseFatalFailure'Distribution.Parsec.ParseResult
parseFieldGrammarDistribution.FieldGrammar.Parsec, Distribution.FieldGrammar
parseFileGlobDistribution.Simple.Glob
parseFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
parseGenericPackageDescriptionDistribution.PackageDescription.Parsec
parseGenericPackageDescriptionMaybeDistribution.PackageDescription.Parsec
parseGhcEnvironmentFileDistribution.Simple.GHC
parseHookedBuildInfoDistribution.PackageDescription.Parsec
parseInstalledPackageInfoDistribution.InstalledPackageInfo
ParseOkDistribution.InstalledPackageInfo
parseOpenModuleSubstDistribution.Backpack
parseOpenModuleSubstEntryDistribution.Backpack
ParserDistribution.Compat.ReadP
parseReadEDistribution.ReadE
ParseResult 
1 (Type/Class)Distribution.InstalledPackageInfo
2 (Type/Class)Distribution.Parsec.ParseResult, Distribution.PackageDescription.Parsec
parseStringDistribution.Parsec.ParseResult
parseWarningDistribution.Parsec.ParseResult
parseWarningsDistribution.Parsec.ParseResult
ParsingDistribution.Compat.Parsing, Distribution.Compat.CharParsing
PartialTypeSignaturesLanguage.Haskell.Extension, Distribution.Simple
partitionComponentsDistribution.Types.Component
partitionFieldsDistribution.FieldGrammar
PassDistribution.TestSuite
patchQuirksDistribution.PackageDescription.Quirks
PathTemplateDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
PathTemplateEnvDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
PathTemplateVariableDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
PatternGuardsLanguage.Haskell.Extension, Distribution.Simple
PatternSignaturesLanguage.Haskell.Extension, Distribution.Simple
PatternSynonymsLanguage.Haskell.Extension, Distribution.Simple
PDDL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
PermissiveDistribution.System
PError 
1 (Type/Class)Distribution.Parsec.Common
2 (Data Constructor)Distribution.Parsec.Common
3 (Type/Class)Distribution.InstalledPackageInfo
pfailDistribution.Compat.ReadP
PHP_3_0Distribution.SPDX.LicenseId, Distribution.SPDX
PHP_3_01Distribution.SPDX.LicenseId, Distribution.SPDX
piDistribution.Compat.Prelude.Internal
pkgBuildableComponentsDistribution.Types.PackageDescription, Distribution.Simple.LocalBuildInfo
pkgComponentsDistribution.Types.PackageDescription, Distribution.Simple.LocalBuildInfo
PkgconfigDependency 
1 (Type/Class)Distribution.Types.PkgconfigDependency
2 (Data Constructor)Distribution.Types.PkgconfigDependency
pkgconfigDepends 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
PkgconfigNameDistribution.Types.PkgconfigName, Distribution.Package, Distribution.Make, Distribution.Simple
pkgConfigProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
pkgDescrFileDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
PkgIdVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
pkgName 
1 (Function)Distribution.Types.PackageId, Distribution.Package, Distribution.Make, Distribution.Simple
2 (Function)Distribution.Types.PackageId.Lens, Distribution.Types.Lens
PkgNameVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
pkgPathEnvVarDistribution.Simple.Build.PathsModule
pkgRoot 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
3 (Function)Distribution.Simple.GHC
pkgUrl 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
pkgVersion 
1 (Function)Distribution.Types.PackageId, Distribution.Package, Distribution.Make, Distribution.Simple
2 (Function)Distribution.Types.PackageId.Lens, Distribution.Types.Lens
PkgVerVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
plainDistribution.Simple.PreProcess.Unlit
Platform 
1 (Type/Class)Distribution.System
2 (Data Constructor)Distribution.System
platformDistribution.Simple.Test.Log
platformDefinesDistribution.Simple.PreProcess, Distribution.Simple.Configure
platformFromTripleDistribution.System
platformIndependentDistribution.Simple.PreProcess
platformTemplateEnvDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
PlexusDistribution.SPDX.LicenseId, Distribution.SPDX
PolyKindsLanguage.Haskell.Extension, Distribution.Simple
PolymorphicComponentsLanguage.Haskell.Extension, Distribution.Simple
Position 
1 (Type/Class)Distribution.Parsec.Common
2 (Data Constructor)Distribution.Parsec.Common
posixSecondsToModTimeDistribution.Compat.Time
postBenchDistribution.Simple.UserHooks, Distribution.Simple
postBuildDistribution.Simple.UserHooks, Distribution.Simple
postCleanDistribution.Simple.UserHooks, Distribution.Simple
postConfDistribution.Simple.UserHooks, Distribution.Simple
postCopyDistribution.Simple.UserHooks, Distribution.Simple
postDoctestDistribution.Simple.UserHooks, Distribution.Simple
PostfixOperatorsLanguage.Haskell.Extension, Distribution.Simple
PostgreSQLDistribution.SPDX.LicenseId, Distribution.SPDX
postHaddockDistribution.Simple.UserHooks, Distribution.Simple
postHscolourDistribution.Simple.UserHooks, Distribution.Simple
postInstDistribution.Simple.UserHooks, Distribution.Simple
postRegDistribution.Simple.UserHooks, Distribution.Simple
postReplDistribution.Simple.UserHooks, Distribution.Simple
postSDistDistribution.Simple.UserHooks, Distribution.Simple
postTestDistribution.Simple.UserHooks, Distribution.Simple
postUnregDistribution.Simple.UserHooks, Distribution.Simple
PPDistribution.Parsec.Class
ppAlexDistribution.Simple.PreProcess
PPCDistribution.System
ppC2hsDistribution.Simple.PreProcess
PPC64Distribution.System
ppCppDistribution.Simple.PreProcess
ppCpp'Distribution.Simple.PreProcess
ppGreenCardDistribution.Simple.PreProcess
ppHappyDistribution.Simple.PreProcess
ppHsc2hsDistribution.Simple.PreProcess
ppSuffixesDistribution.Simple.PreProcess
PPSuffixHandlerDistribution.Simple.PreProcess
ppUnlitDistribution.Simple.PreProcess
preBenchDistribution.Simple.UserHooks, Distribution.Simple
preBuildDistribution.Simple.UserHooks, Distribution.Simple
preCleanDistribution.Simple.UserHooks, Distribution.Simple
preConfDistribution.Simple.UserHooks, Distribution.Simple
preCopyDistribution.Simple.UserHooks, Distribution.Simple
predDistribution.Compat.Prelude.Internal
preDoctestDistribution.Simple.UserHooks, Distribution.Simple
prefixDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
prefixedFieldsDistribution.FieldGrammar.Class, Distribution.FieldGrammar
prefixRelativeComponentInstallDirsDistribution.Simple.LocalBuildInfo
prefixRelativeInstallDirs 
1 (Function)Distribution.Simple.InstallDirs
2 (Function)Distribution.Simple.LocalBuildInfo
PrefixVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
preHaddockDistribution.Simple.UserHooks, Distribution.Simple
preHscolourDistribution.Simple.UserHooks, Distribution.Simple
preInstDistribution.Simple.UserHooks, Distribution.Simple
preModShapeProvidesDistribution.Backpack.PreModuleShape
preModShapeRequiresDistribution.Backpack.PreModuleShape
PreModuleShape 
1 (Type/Class)Distribution.Backpack.PreModuleShape
2 (Data Constructor)Distribution.Backpack.PreModuleShape
prepareSnapshotTreeDistribution.Simple.SrcDist
prepareTreeDistribution.Simple.SrcDist
preprocessComponentDistribution.Simple.PreProcess
preprocessExtrasDistribution.Simple.PreProcess
PreProcessor 
1 (Type/Class)Distribution.Simple.PreProcess
2 (Data Constructor)Distribution.Simple.PreProcess
preRegDistribution.Simple.UserHooks, Distribution.Simple
preReplDistribution.Simple.UserHooks, Distribution.Simple
preSDistDistribution.Simple.UserHooks, Distribution.Simple
preTestDistribution.Simple.UserHooks, Distribution.Simple
Pretext 
1 (Type/Class)Distribution.Compat.Lens
2 (Data Constructor)Distribution.Compat.Lens
PrettyDistribution.Pretty
prettyDistribution.Pretty
prettyCallStackDistribution.Compat.Stack
PrettyFieldGrammarDistribution.FieldGrammar.Pretty, Distribution.FieldGrammar
prettyFieldGrammarDistribution.FieldGrammar.Pretty, Distribution.FieldGrammar
PrettyFieldGrammar'Distribution.FieldGrammar
prettyShowDistribution.Pretty
preUnregDistribution.Simple.UserHooks, Distribution.Simple
printDistribution.Compat.Prelude.Internal
printPackageProblemsDistribution.Simple.SrcDist
printRawCommandAndArgsDistribution.Simple.Utils
printRawCommandAndArgsAndEnvDistribution.Simple.Utils
productDistribution.Compat.Prelude.Internal
ProfDistribution.Simple.Hpc
ProfDetailAllFunctionsDistribution.Simple.Compiler, Distribution.Simple
ProfDetailDefaultDistribution.Simple.Compiler, Distribution.Simple
ProfDetailExportedFunctionsDistribution.Simple.Compiler, Distribution.Simple
ProfDetailLevelDistribution.Simple.Compiler, Distribution.Simple
ProfDetailNoneDistribution.Simple.Compiler, Distribution.Simple
ProfDetailOtherDistribution.Simple.Compiler, Distribution.Simple
ProfDetailToplevelFunctionsDistribution.Simple.Compiler, Distribution.Simple
profilingSupportedDistribution.Simple.Compiler, Distribution.Simple
profOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
ProgArgDistribution.Simple.Program.Types, Distribution.Simple.Program
progInvokeArgsDistribution.Simple.Program.Run, Distribution.Simple.Program
progInvokeCwdDistribution.Simple.Program.Run, Distribution.Simple.Program
progInvokeEnvDistribution.Simple.Program.Run, Distribution.Simple.Program
progInvokeInputDistribution.Simple.Program.Run, Distribution.Simple.Program
progInvokeInputEncodingDistribution.Simple.Program.Run, Distribution.Simple.Program
progInvokeOutputEncodingDistribution.Simple.Program.Run, Distribution.Simple.Program
progInvokePathDistribution.Simple.Program.Run, Distribution.Simple.Program
progInvokePathEnvDistribution.Simple.Program.Run, Distribution.Simple.Program
progPrefixDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
Program 
1 (Type/Class)Distribution.Simple.Program.Types, Distribution.Simple.Program
2 (Data Constructor)Distribution.Simple.Program.Types, Distribution.Simple.Program
ProgramConfigurationDistribution.Simple.Program
programConfigurationOptionsDistribution.Simple.Setup
programConfigurationPaths'Distribution.Simple.Setup
ProgramDbDistribution.Simple.Program.Db, Distribution.Simple.Program
programDbOptionsDistribution.Simple.Setup
programDbPaths'Distribution.Simple.Setup
programDefaultArgsDistribution.Simple.Program.Types, Distribution.Simple.Program
programFindLocationDistribution.Simple.Program.Types, Distribution.Simple.Program
programFindVersionDistribution.Simple.Program.Types, Distribution.Simple.Program
programFlagsDescriptionDistribution.Simple.Setup
programIdDistribution.Simple.Program.Types, Distribution.Simple.Program
ProgramInvocation 
1 (Type/Class)Distribution.Simple.Program.Run, Distribution.Simple.Program
2 (Data Constructor)Distribution.Simple.Program.Run, Distribution.Simple.Program
programInvocationDistribution.Simple.Program.Run, Distribution.Simple.Program
ProgramLocationDistribution.Simple.Program.Types, Distribution.Simple.Program
programLocationDistribution.Simple.Program.Types, Distribution.Simple.Program
programMonitorFilesDistribution.Simple.Program.Types, Distribution.Simple.Program
programNameDistribution.Simple.Program.Types, Distribution.Simple.Program
programNormaliseArgsDistribution.Simple.Program.Types, Distribution.Simple.Program
programOverrideArgsDistribution.Simple.Program.Types, Distribution.Simple.Program
programOverrideEnvDistribution.Simple.Program.Types, Distribution.Simple.Program
programPathDistribution.Simple.Program.Types, Distribution.Simple.Program
programPostConfDistribution.Simple.Program.Types, Distribution.Simple.Program
programPropertiesDistribution.Simple.Program.Types, Distribution.Simple.Program
ProgramSearchPathDistribution.Simple.Program.Find, Distribution.Simple.Program.Types, Distribution.Simple.Program
programSearchPathAsPATHVarDistribution.Simple.Program.Find
ProgramSearchPathDefaultDistribution.Simple.Program.Find, Distribution.Simple.Program.Types, Distribution.Simple.Program
ProgramSearchPathDirDistribution.Simple.Program.Find, Distribution.Simple.Program.Types, Distribution.Simple.Program
ProgramSearchPathEntryDistribution.Simple.Program.Find, Distribution.Simple.Program.Types, Distribution.Simple.Program
programVersionDistribution.Simple.Program.Types, Distribution.Simple.Program
Progress 
1 (Type/Class)Distribution.TestSuite
2 (Data Constructor)Distribution.TestSuite
3 (Type/Class)Distribution.Utils.Progress
progSuffixDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
projectVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
properFractionDistribution.Compat.Prelude.Internal
PsfragDistribution.SPDX.LicenseId, Distribution.SPDX
PsutilsDistribution.SPDX.LicenseId, Distribution.SPDX
PS_or_PDF_font_exception_20170817Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
PublicDomainDistribution.License, Distribution.Make, Distribution.Simple
pureDistribution.Compat.Prelude.Internal
PutDistribution.Compat.Binary
putDistribution.Compat.Binary, Distribution.Compat.Prelude.Internal
putCharDistribution.Compat.Prelude.Internal
putListDistribution.Compat.Binary, Distribution.Compat.Prelude.Internal
putStrDistribution.Compat.Prelude.Internal
putStrLnDistribution.Compat.Prelude.Internal
putWord8Distribution.Compat.Binary
PWarning 
1 (Type/Class)Distribution.Parsec.Common
2 (Data Constructor)Distribution.Parsec.Common
3 (Type/Class)Distribution.InstalledPackageInfo
PWarnTypeDistribution.Parsec.Common, Distribution.Parsec.Class
PWTBoolCaseDistribution.Parsec.Common, Distribution.Parsec.Class
PWTBuildTypeDefaultDistribution.Parsec.Common, Distribution.Parsec.Class
PWTDeprecatedFieldDistribution.Parsec.Common, Distribution.Parsec.Class
PWTDoubleDashDistribution.Parsec.Common, Distribution.Parsec.Class
PWTExtraBenchmarkModuleDistribution.Parsec.Common, Distribution.Parsec.Class
PWTExtraMainIsDistribution.Parsec.Common, Distribution.Parsec.Class
PWTExtraTestModuleDistribution.Parsec.Common, Distribution.Parsec.Class
PWTInvalidSubsectionDistribution.Parsec.Common, Distribution.Parsec.Class
PWTLexBOMDistribution.Parsec.Common, Distribution.Parsec.Class
PWTLexNBSPDistribution.Parsec.Common, Distribution.Parsec.Class
PWTLexTabDistribution.Parsec.Common, Distribution.Parsec.Class
PWTMultipleSingularFieldDistribution.Parsec.Common, Distribution.Parsec.Class
PWTNewSyntaxDistribution.Parsec.Common, Distribution.Parsec.Class
PWTOldSyntaxDistribution.Parsec.Common, Distribution.Parsec.Class
PWTOtherDistribution.Parsec.Common, Distribution.Parsec.Class
PWTQuirkyCabalFileDistribution.Parsec.Common, Distribution.Parsec.Class
PWTTrailingFieldsDistribution.Parsec.Common, Distribution.Parsec.Class
PWTUnknownFieldDistribution.Parsec.Common, Distribution.Parsec.Class
PWTUnknownSectionDistribution.Parsec.Common, Distribution.Parsec.Class
PWTUTFDistribution.Parsec.Common, Distribution.Parsec.Class
PWTVersionLeadingZerosDistribution.Parsec.Common, Distribution.Parsec.Class
PWTVersionTagDistribution.Parsec.Common, Distribution.Parsec.Class
Python_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
diff --git a/doc/API/Cabal/doc-index-Q.html b/doc/API/Cabal/doc-index-Q.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-Q.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - Q)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - Q

QhullDistribution.SPDX.LicenseId, Distribution.SPDX
QL1Distribution.Simple.BuildTarget
QL2Distribution.Simple.BuildTarget
QL3Distribution.Simple.BuildTarget
QPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
Qt_GPL_exception_1_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
Qt_LGPL_exception_1_1Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
qualifiedExeNameDistribution.Types.ExeDependency
QualLevelDistribution.Simple.BuildTarget
QuantifiedConstraintsLanguage.Haskell.Extension, Distribution.Simple
QuasiQuotesLanguage.Haskell.Extension, Distribution.Simple
quotDistribution.Compat.Prelude.Internal
quotRemDistribution.Compat.Prelude.Internal
Qwt_exception_1_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
diff --git a/doc/API/Cabal/doc-index-R.html b/doc/API/Cabal/doc-index-R.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-R.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - R)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - R

Rank2TypesLanguage.Haskell.Extension, Distribution.Simple
RankNTypesLanguage.Haskell.Extension, Distribution.Simple
RationalDistribution.Compat.Prelude.Internal
rawSystemExitDistribution.Simple.Utils
rawSystemExitCodeDistribution.Simple.Utils
rawSystemExitWithEnvDistribution.Simple.Utils
rawSystemIOWithEnvDistribution.Simple.Utils
rawSystemProgramDistribution.Simple.Program
rawSystemProgramConfDistribution.Simple.Program
rawSystemProgramStdoutDistribution.Simple.Program
rawSystemProgramStdoutConfDistribution.Simple.Program
rawSystemStdInOutDistribution.Simple.Utils
rawSystemStdoutDistribution.Simple.Utils
RdiscDistribution.SPDX.LicenseId, Distribution.SPDX
ReadDistribution.Compat.Prelude.Internal
readDistribution.Compat.Prelude.Internal
readAndParseFileDistribution.Parsec.ParseResult
readBuildTargetsDistribution.Simple.BuildTarget
readDescDistribution.Simple.UserHooks, Distribution.Simple
ReadE 
1 (Type/Class)Distribution.ReadE
2 (Data Constructor)Distribution.ReadE
readEOrFailDistribution.ReadE
readFieldsDistribution.Parsec.Parser
readFields'Distribution.Parsec.Parser
readFileDistribution.Compat.Prelude.Internal
readGenericPackageDescriptionDistribution.PackageDescription.Parsec
readGhcEnvironmentFileDistribution.Simple.GHC
readHookedBuildInfoDistribution.PackageDescription.Parsec
readIODistribution.Compat.Prelude.Internal
readListDistribution.Compat.Prelude.Internal
readLnDistribution.Compat.Prelude.Internal
ReadPDistribution.Compat.ReadP
readPackageDbListDistribution.Simple.Setup
readParenDistribution.Compat.Prelude.Internal
readPToMaybeDistribution.Simple.Setup
readP_to_EDistribution.ReadE
readP_to_SDistribution.Compat.ReadP
ReadSDistribution.Compat.ReadP, Distribution.Compat.Prelude.Internal
readsDistribution.Compat.Prelude.Internal
readsPrecDistribution.Compat.Prelude.Internal
readS_to_PDistribution.Compat.ReadP
readTargetInfosDistribution.Simple.BuildTarget
readUserBuildTargetsDistribution.Simple.BuildTarget
readUTF8FileDistribution.Utils.Generic, Distribution.Simple.Utils
RealDistribution.Compat.Prelude.Internal
RealFloatDistribution.Compat.Prelude.Internal
RealFracDistribution.Compat.Prelude.Internal
realToFracDistribution.Compat.Prelude.Internal
RebindableSyntaxLanguage.Haskell.Extension, Distribution.Simple
recacheDistribution.Simple.Program.HcPkg
recacheInvocationDistribution.Simple.Program.HcPkg
recacheMultiInstanceDistribution.Simple.Program.HcPkg
recipDistribution.Compat.Prelude.Internal
reconfigureProgramsDistribution.Simple.Program.Db, Distribution.Simple.Program
RecordPunsLanguage.Haskell.Extension, Distribution.Simple
RecordWildCardsLanguage.Haskell.Extension, Distribution.Simple
recoverWithDistribution.Parsec.ParseResult
RecursiveDoLanguage.Haskell.Extension, Distribution.Simple
reexportedModules 
1 (Function)Distribution.Types.Library, Distribution.PackageDescription
2 (Function)Distribution.Types.Library.Lens, Distribution.Types.Lens
reexportedModulesSupportedDistribution.Simple.Compiler, Distribution.Simple
regArgsDistribution.Simple.Setup
regCabalFilePathDistribution.Simple.Setup
regDistPrefDistribution.Simple.Setup
regGenPkgConfDistribution.Simple.Setup
regGenScriptDistribution.Simple.Setup
regHookDistribution.Simple.UserHooks, Distribution.Simple
regInPlaceDistribution.Simple.Setup
register 
1 (Function)Distribution.Simple.Program.HcPkg
2 (Function)Distribution.Simple.Register
registerAllowOverwriteDistribution.Simple.Program.HcPkg, Distribution.Simple.Register
registerCommandDistribution.Simple.Setup
RegisterFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
registerInvocationDistribution.Simple.Program.HcPkg
registerMultiInstanceDistribution.Simple.Program.HcPkg, Distribution.Simple.Register
RegisterOptions 
1 (Type/Class)Distribution.Simple.Program.HcPkg, Distribution.Simple.Register
2 (Data Constructor)Distribution.Simple.Program.HcPkg, Distribution.Simple.Register
registerPackage 
1 (Function)Distribution.Simple.UHC
2 (Function)Distribution.Simple.HaskellSuite
3 (Function)Distribution.Simple.GHCJS
4 (Function)Distribution.Simple.GHC
5 (Function)Distribution.Simple.Register
registerSuppressFilesCheckDistribution.Simple.Program.HcPkg, Distribution.Simple.Register
registrationPackageDBDistribution.Simple.Compiler, Distribution.Simple
regPackageDBDistribution.Simple.Setup
regPrintIdDistribution.Simple.Setup
RegularPatternsLanguage.Haskell.Extension, Distribution.Simple
regVerbosityDistribution.Simple.Setup
RelaxedPolyRecLanguage.Haskell.Extension, Distribution.Simple
relaxHeadIntervalDistribution.Types.VersionInterval
relaxLastIntervalDistribution.Types.VersionInterval
relocatableDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
remDistribution.Compat.Prelude.Internal
removeLowerBoundDistribution.Version, Distribution.Simple
removeUpperBoundDistribution.Version, Distribution.Simple
renamePreModuleShapeDistribution.Backpack.PreModuleShape
renamingPackageFlagsSupportedDistribution.Simple.Compiler, Distribution.Simple
renderGhcEnvironmentFileDistribution.Simple.GHC
renderGhcOptionsDistribution.Simple.Program.GHC
repeatDistribution.Compat.Prelude.Internal
replDistribution.Simple.Build
replCommandDistribution.Simple.Setup
replDistPrefDistribution.Simple.Setup
replExe 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
ReplFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
replFLibDistribution.Simple.GHC
replHookDistribution.Simple.UserHooks, Distribution.Simple
replicateDistribution.Compat.Prelude.Internal
replLib 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
replOptionsDistribution.Simple.Setup
replProgramArgsDistribution.Simple.Setup
replProgramPathsDistribution.Simple.Setup
replReloadDistribution.Simple.Setup
replReplOptionsDistribution.Simple.Setup
replVerbosityDistribution.Simple.Setup
repoBranch 
1 (Function)Distribution.Types.SourceRepo, Distribution.PackageDescription
2 (Function)Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens
RepoHeadDistribution.Types.SourceRepo, Distribution.PackageDescription
RepoKindDistribution.Types.SourceRepo, Distribution.PackageDescription
repoKind 
1 (Function)Distribution.Types.SourceRepo, Distribution.PackageDescription
2 (Function)Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens
RepoKindUnknownDistribution.Types.SourceRepo, Distribution.PackageDescription
repoLocation 
1 (Function)Distribution.Types.SourceRepo, Distribution.PackageDescription
2 (Function)Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens
repoModule 
1 (Function)Distribution.Types.SourceRepo, Distribution.PackageDescription
2 (Function)Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens
reportBuildTargetProblemsDistribution.Simple.BuildTarget
reportsNoExtDistribution.Simple.GHC
reportUserBuildTargetProblemsDistribution.Simple.BuildTarget
repoSubdir 
1 (Function)Distribution.Types.SourceRepo, Distribution.PackageDescription
2 (Function)Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens
repoTag 
1 (Function)Distribution.Types.SourceRepo, Distribution.PackageDescription
2 (Function)Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens
RepoThisDistribution.Types.SourceRepo, Distribution.PackageDescription
RepoTypeDistribution.Types.SourceRepo, Distribution.PackageDescription
repoType 
1 (Function)Distribution.Types.SourceRepo, Distribution.PackageDescription
2 (Function)Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens
ReqArgDistribution.Simple.Command
reqArgDistribution.Simple.Command
reqArg'Distribution.Simple.Command
requiredSignaturesDistribution.InstalledPackageInfo
requireProgramDistribution.Simple.Program.Db, Distribution.Simple.Program
requireProgramVersionDistribution.Simple.Program.Db, Distribution.Simple.Program
requiresDirDbsDistribution.Simple.Program.HcPkg
resolveBuildTargetsDistribution.Simple.BuildTarget
restoreProgramConfigurationDistribution.Simple.Program
restoreProgramDbDistribution.Simple.Program.Db, Distribution.Simple.Program
RestrictedTypeSynonymsLanguage.Haskell.Extension, Distribution.Simple
ResultDistribution.TestSuite
retPosDistribution.Parsec.Common
returnDistribution.Compat.Prelude.Internal
revClosureDistribution.Compat.Graph
reverseDistribution.Compat.Prelude.Internal
reverseDependencyClosureDistribution.Simple.PackageIndex
reverseTopologicalOrderDistribution.Simple.PackageIndex
revNeighborsDistribution.Compat.Graph
revTopSortDistribution.Compat.Graph
rewriteFileDistribution.Simple.Utils
rewriteFileExDistribution.Simple.Utils
RHeCos_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
RightDistribution.Compat.Prelude.Internal
rnfDistribution.Compat.Prelude.Internal
RoleAnnotationsLanguage.Haskell.Extension, Distribution.Simple
roundDistribution.Compat.Prelude.Internal
RPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
RPL_1_5Distribution.SPDX.LicenseId, Distribution.SPDX
RPSL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
Rs6000Distribution.System
RSA_MDDistribution.SPDX.LicenseId, Distribution.SPDX
RSCPLDistribution.SPDX.LicenseId, Distribution.SPDX
RubyDistribution.SPDX.LicenseId, Distribution.SPDX
runDistribution.TestSuite
runCmdDistribution.Simple.GHCJS
runDbProgramDistribution.Simple.Program
runDirFileGlobDistribution.Simple.Glob
runDListDistribution.Compat.DList
runFieldParserDistribution.FieldGrammar.Parsec, Distribution.FieldGrammar
runFieldParser'Distribution.FieldGrammar.Parsec, Distribution.FieldGrammar
runGHCDistribution.Simple.Program.GHC
runghcProgramDistribution.Simple.Program.Builtin
runLogProgressDistribution.Utils.LogProgress
runParsecParserDistribution.Parsec.Class
runParseResultDistribution.Parsec.ParseResult, Distribution.PackageDescription.Parsec
runPreProcessorDistribution.Simple.PreProcess
runPretextDistribution.Compat.Lens
runProgramDistribution.Simple.Program
runProgramInvocationDistribution.Simple.Program.Run, Distribution.Simple.Program
runReadEDistribution.ReadE
runSimplePreProcessorDistribution.Simple.PreProcess
runTest 
1 (Function)Distribution.Simple.Test.LibV09
2 (Function)Distribution.Simple.Test.ExeV10
runTestsDistribution.Simple.UserHooks, Distribution.Simple
diff --git a/doc/API/Cabal/doc-index-S.html b/doc/API/Cabal/doc-index-S.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-S.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - S)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - S

S390Distribution.System
SafeLanguage.Haskell.Extension, Distribution.Simple
SafeImportsLanguage.Haskell.Extension, Distribution.Simple
safeTailDistribution.Utils.Generic, Distribution.Simple.Utils
satisfy 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.CharParsing
satisfyRangeDistribution.Compat.CharParsing
SaxpathDistribution.SPDX.LicenseId, Distribution.SPDX
SAX_PDDistribution.SPDX.LicenseId, Distribution.SPDX
scaleFloatDistribution.Compat.Prelude.Internal
scanlDistribution.Compat.Prelude.Internal
scanl1Distribution.Compat.Prelude.Internal
scanrDistribution.Compat.Prelude.Internal
scanr1Distribution.Compat.Prelude.Internal
scanSpecVersionDistribution.PackageDescription.Parsec
SCCDistribution.Compat.Graph
SCEADistribution.SPDX.LicenseId, Distribution.SPDX
ScopedTypeVariablesLanguage.Haskell.Extension, Distribution.Simple
sdistDistribution.Simple.SrcDist
sdistCommandDistribution.Simple.Setup
sDistDirectoryDistribution.Simple.Setup
sDistDistPrefDistribution.Simple.Setup
SDistFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
sDistHookDistribution.Simple.UserHooks, Distribution.Simple
sDistListSourcesDistribution.Simple.Setup
sDistSnapshotDistribution.Simple.Setup
sDistVerbosityDistribution.Simple.Setup
searchByNameDistribution.Simple.PackageIndex
searchByNameSubstringDistribution.Simple.PackageIndex
SearchResultDistribution.Simple.PackageIndex
SecArgNameDistribution.Parsec.Field, Distribution.Parsec.Parser
SecArgOtherDistribution.Parsec.Field, Distribution.Parsec.Parser
SecArgStrDistribution.Parsec.Field, Distribution.Parsec.Parser
Section 
1 (Data Constructor)Distribution.Parsec.Field, Distribution.Parsec.Parser
2 (Type/Class)Distribution.FieldGrammar.Parsec, Distribution.FieldGrammar
SectionArgDistribution.Parsec.Field, Distribution.Parsec.Parser
sectionArgAnnDistribution.Parsec.Field
SemigroupDistribution.Compat.Semigroup, Distribution.Compat.Prelude.Internal
SendmailDistribution.SPDX.LicenseId, Distribution.SPDX
SeparatorDistribution.Pretty
sepBy 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
sepBy1 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
sepEndByDistribution.Compat.Parsing, Distribution.Compat.CharParsing
sepEndBy1Distribution.Compat.Parsing, Distribution.Compat.CharParsing
seqDistribution.Compat.Prelude.Internal
sequenceADistribution.Compat.Prelude.Internal
sequence_Distribution.Compat.Prelude.Internal
setDistribution.Compat.Lens
setCabalSpecVersionDistribution.Parsec.ParseResult
setFileExecutableDistribution.Simple.Utils
setFileOrdinaryDistribution.Simple.Utils
setInputDistribution.Parsec.LexerMonad
setOptionDistribution.TestSuite
setPosDistribution.Parsec.LexerMonad
setProgramSearchPathDistribution.Simple.Program.Db, Distribution.Simple.Program
setStartCodeDistribution.Parsec.LexerMonad
setupBInfoFieldGrammarDistribution.PackageDescription.FieldGrammar
SetupBuildInfo 
1 (Type/Class)Distribution.Types.SetupBuildInfo, Distribution.Types.SetupBuildInfo.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.SetupBuildInfo, Distribution.PackageDescription
setupBuildInfo 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
setupDepends 
1 (Function)Distribution.Types.SetupBuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.SetupBuildInfo.Lens, Distribution.Types.Lens
setupMessageDistribution.Simple.Utils
setupMessage'Distribution.Backpack.DescribeUnitId
SFlagsDistribution.Simple.Command
SGI_B_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
SGI_B_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
SGI_B_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
SHDistribution.System
shapeInstalledPackageDistribution.Backpack.ModuleShape
sharedOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
shortRelativePathDistribution.Simple.Utils
ShortTextDistribution.Utils.ShortText
ShowDistribution.Compat.Prelude.Internal
showDistribution.Compat.Prelude.Internal
ShowArgsDistribution.Simple.Command
showBuildTargetDistribution.Simple.BuildTarget
showCharDistribution.Compat.Prelude.Internal
showCompilerIdDistribution.Simple.Compiler, Distribution.Simple
showCompilerIdWithAbiDistribution.Simple.Compiler, Distribution.Simple
showComponentNameDistribution.Types.ComponentName, Distribution.Simple.LocalBuildInfo
showFilePathDistribution.Pretty
showFlagValueDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
showForCabalDistribution.Verbosity
showForGHCDistribution.Verbosity
showFreeTextDistribution.Pretty
showFullInstalledPackageInfoDistribution.InstalledPackageInfo
showGenericPackageDescriptionDistribution.PackageDescription.PrettyPrint
showHookedBuildInfoDistribution.PackageDescription.PrettyPrint
showInstalledPackageInfoDistribution.InstalledPackageInfo
showInstalledPackageInfoFieldDistribution.InstalledPackageInfo
showListDistribution.Compat.Prelude.Internal
ShowOrParseArgsDistribution.Simple.Command
showPackageDbListDistribution.Simple.Setup
showPackageDescriptionDistribution.PackageDescription.PrettyPrint
showParenDistribution.Compat.Prelude.Internal
showPErrorDistribution.Parsec.Common
showPosDistribution.Parsec.Common
showProfDetailLevelDistribution.Simple.Compiler, Distribution.Simple
showPWarningDistribution.Parsec.Common
ShowSDistribution.Compat.Prelude.Internal
showsDistribution.Compat.Prelude.Internal
showSimpleInstalledPackageInfoFieldDistribution.InstalledPackageInfo
showsPrecDistribution.Compat.Prelude.Internal
showStringDistribution.Compat.Prelude.Internal
showTokenDistribution.Pretty
showUserBuildTargetDistribution.Simple.BuildTarget
showVersionDistribution.Types.Version, Distribution.Version, Distribution.Simple
signatures 
1 (Function)Distribution.Types.Library, Distribution.PackageDescription
2 (Function)Distribution.Types.Library.Lens, Distribution.Types.Lens
significandDistribution.Compat.Prelude.Internal
signumDistribution.Compat.Prelude.Internal
silentDistribution.Verbosity
SimpleDistribution.Types.BuildType, Distribution.PackageDescription
simpleDistribution.ModuleName
simpleConfiguredProgramDistribution.Simple.Program.Types
simpleGhcEnvironmentFileDistribution.Simple.GHC
SimpleLicenseExpressionDistribution.SPDX.LicenseExpression, Distribution.SPDX
simpleLicenseExpressionDistribution.SPDX.LicenseExpression, Distribution.SPDX
simpleParseDistribution.Text
simpleParsecDistribution.Parsec.Class
simpleProgramDistribution.Simple.Program.Types, Distribution.Simple.Program
simpleProgramInvocationDistribution.Simple.Program.Run, Distribution.Simple.Program
simpleTestStubDistribution.Simple.Test.LibV09
simpleUserHooksDistribution.Simple
simplifyConditionDistribution.Types.Condition
simplifyCondTreeDistribution.Types.CondTree
simplifyDependencyDistribution.Types.Dependency, Distribution.Package, Distribution.Make, Distribution.Simple
simplifyVersionRangeDistribution.Version, Distribution.Simple
SimPL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
sinDistribution.Compat.Prelude.Internal
singletonDistribution.Compat.DList
sinhDistribution.Compat.Prelude.Internal
SISSLDistribution.SPDX.LicenseId, Distribution.SPDX
SISSL_1_2Distribution.SPDX.LicenseId, Distribution.SPDX
sizeDistribution.Compat.Graph
skipMany 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.Parsing, Distribution.Compat.CharParsing
skipMany1Distribution.Compat.ReadP
skipOptionalDistribution.Compat.Parsing, Distribution.Compat.CharParsing
skipSomeDistribution.Compat.Parsing, Distribution.Compat.CharParsing
skipSpacesDistribution.Compat.ReadP
skipSpaces1 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.CharParsing
SleepycatDistribution.SPDX.LicenseId, Distribution.SPDX
smartCopySourcesDistribution.Simple.Utils
SMLNJDistribution.SPDX.LicenseId, Distribution.SPDX
SMPPLDistribution.SPDX.LicenseId, Distribution.SPDX
snapshotPackageDistribution.Simple.SrcDist
snapshotVersionDistribution.Simple.SrcDist
sndDistribution.Compat.Prelude.Internal
SNIADistribution.SPDX.LicenseId, Distribution.SPDX
snocDistribution.Compat.DList
SolarisDistribution.System
someDistribution.Compat.Prelude.Internal, Distribution.Compat.Parsing, Distribution.Compat.CharParsing
sortDistribution.Compat.Prelude.Internal
sortByDistribution.Compat.Prelude.Internal
sourceComponentNameDistribution.InstalledPackageInfo
sourceLibName 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
sourcePackageId 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
SourceRepo 
1 (Type/Class)Distribution.Types.SourceRepo, Distribution.Types.SourceRepo.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.SourceRepo, Distribution.PackageDescription
sourceRepoFieldGrammarDistribution.PackageDescription.FieldGrammar
sourceRepos 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
spaceDistribution.Compat.CharParsing
spacesDistribution.Compat.CharParsing
spanDistribution.Compat.Prelude.Internal
spanMaybeDistribution.Utils.Generic
SparcDistribution.System
specHasCommonStanzasDistribution.CabalSpecVersion
specHasElifDistribution.CabalSpecVersion
SpecificPackageDBDistribution.Simple.Compiler, Distribution.Simple
SpecLicense 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
SpecVersion 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
specVersionDistribution.Types.PackageDescription, Distribution.PackageDescription
specVersion'Distribution.Types.PackageDescription
specVersionRaw 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
Spencer_86Distribution.SPDX.LicenseId, Distribution.SPDX
Spencer_94Distribution.SPDX.LicenseId, Distribution.SPDX
Spencer_99Distribution.SPDX.LicenseId, Distribution.SPDX
splitArgsDistribution.Simple.Setup
splitAtDistribution.Compat.Prelude.Internal
splitObjsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
splitSectionsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
SPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
sqrtDistribution.Compat.Prelude.Internal
srcPrefDistribution.Simple.BuildPaths
stability 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
StandaloneDerivingLanguage.Haskell.Extension, Distribution.Simple
StarInDirectoryDistribution.Simple.Glob
StarInExtensionDistribution.Simple.Glob
StarInFileNameDistribution.Simple.Glob
StarIsTypeLanguage.Haskell.Extension, Distribution.Simple
startInterpreter 
1 (Function)Distribution.Simple.GHCJS
2 (Function)Distribution.Simple.GHC
3 (Function)Distribution.Simple.Build
staticLibExtensionDistribution.Simple.BuildPaths
staticOptions 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
StaticPointersLanguage.Haskell.Extension, Distribution.Simple
stdParseDistribution.Text
stepProgressDistribution.Utils.Progress
StreamingDistribution.Simple.Setup
Strict 
1 (Data Constructor)Distribution.System
2 (Data Constructor)Language.Haskell.Extension, Distribution.Simple
StrictDataLanguage.Haskell.Extension, Distribution.Simple
StringDistribution.Compat.Prelude.Internal
string 
1 (Function)Distribution.Compat.ReadP
2 (Function)Distribution.Compat.CharParsing
stripExeDistribution.Simple.Program.Strip
stripExesDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
stripExtractVersionDistribution.Simple.Program.Internal
stripLibDistribution.Simple.Program.Strip
stripLibsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
stripParensVersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
stripProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
stronglyConnCompDistribution.Compat.Graph
stubFilePathDistribution.Simple.Test.LibV09
stubMainDistribution.Simple.Test.LibV09
stubNameDistribution.Simple.Test.LibV09
stubWriteLogDistribution.Simple.Test.LibV09
subLibraries 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
substituteInstallDirTemplatesDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
substPathTemplate 
1 (Function)Distribution.Simple.InstallDirs
2 (Function)Distribution.Simple.LocalBuildInfo
subtractDistribution.Compat.Prelude.Internal
succDistribution.Compat.Prelude.Internal
succeedReadEDistribution.ReadE
SugarCRM_1_1_3Distribution.SPDX.LicenseId, Distribution.SPDX
suiteErrorDistribution.Simple.Test.Log
suiteFailedDistribution.Simple.Test.Log
suitePassedDistribution.Simple.Test.Log
sumDistribution.Compat.Prelude.Internal
summarizePackageDistribution.Simple.Test.Log
summarizeSuiteFinishDistribution.Simple.Test.Log
summarizeSuiteStartDistribution.Simple.Test.Log
summarizeTestDistribution.Simple.Test.Log
supportsDebugLevelsDistribution.Simple.GHC
supportsDirDbsDistribution.Simple.Program.HcPkg
supportsHaskell2010Distribution.Simple.GHC
supportsPkgEnvFilesDistribution.Simple.GHC
suppressFilesCheckDistribution.Simple.Program.HcPkg
suppressOverrideArgsDistribution.Simple.Program.Types, Distribution.Simple.Program
SVNDistribution.Types.SourceRepo, Distribution.PackageDescription
SWLDistribution.SPDX.LicenseId, Distribution.SPDX
synopsis 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
4 (Function)Distribution.Types.InstalledPackageInfo.Lens
sysconfdirDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
diff --git a/doc/API/Cabal/doc-index-T.html b/doc/API/Cabal/doc-index-T.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-T.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - T)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - T

tabDistribution.Compat.CharParsing
TabsErrorDistribution.InstalledPackageInfo
tagsDistribution.TestSuite
tailDistribution.Compat.Prelude.Internal
takeDistribution.Compat.Prelude.Internal
takeFieldsDistribution.FieldGrammar
takeWhileDistribution.Compat.Prelude.Internal
takeWhileEndLEDistribution.Utils.Generic, Distribution.Simple.Utils
tanDistribution.Compat.Prelude.Internal
tanhDistribution.Compat.Prelude.Internal
targetBuildDepends 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
targetCLBIDistribution.Types.TargetInfo
targetComponentDistribution.Types.TargetInfo
TargetInfo 
1 (Type/Class)Distribution.Types.TargetInfo
2 (Data Constructor)Distribution.Types.TargetInfo
tarProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
TCLDistribution.SPDX.LicenseId, Distribution.SPDX
TCP_wrappersDistribution.SPDX.LicenseId, Distribution.SPDX
TempFileOptions 
1 (Type/Class)Distribution.Simple.Utils
2 (Data Constructor)Distribution.Simple.Utils
TemplateHaskellLanguage.Haskell.Extension, Distribution.Simple
TemplateHaskellQuotesLanguage.Haskell.Extension, Distribution.Simple
Test 
1 (Type/Class)Distribution.TestSuite
2 (Data Constructor)Distribution.TestSuite
testDistribution.Simple.Test
testBuildInfo 
1 (Function)Distribution.Types.TestSuite, Distribution.PackageDescription
2 (Function)Distribution.Types.TestSuite.Lens, Distribution.Types.Lens
testCommandDistribution.Simple.Setup
TestComponentLocalBuildInfoDistribution.Types.ComponentLocalBuildInfo, Distribution.Simple.LocalBuildInfo
testCoverageDistribution.Types.LocalBuildInfo
testDistPrefDistribution.Simple.Setup
TestedWith 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
testedWith 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
TestFlags 
1 (Type/Class)Distribution.Simple.Setup
2 (Data Constructor)Distribution.Simple.Setup
testGroupDistribution.TestSuite
testHookDistribution.Simple.UserHooks, Distribution.Simple
testHumanLogDistribution.Simple.Setup
TestInstance 
1 (Type/Class)Distribution.TestSuite
2 (Data Constructor)Distribution.TestSuite
testInterface 
1 (Function)Distribution.Types.TestSuite, Distribution.PackageDescription
2 (Function)Distribution.Types.TestSuite.Lens, Distribution.Types.Lens
testKeepTixDistribution.Simple.Setup
TestLogDistribution.Simple.Test.Log
TestLogsDistribution.Simple.Test.Log
testLogsDistribution.Simple.Test.Log
testMachineLogDistribution.Simple.Setup
testModulesDistribution.Types.TestSuite, Distribution.PackageDescription
testModulesAutogenDistribution.Types.TestSuite, Distribution.PackageDescription
testName 
1 (Function)Distribution.Types.TestSuite, Distribution.PackageDescription
2 (Function)Distribution.Types.TestSuite.Lens, Distribution.Types.Lens
3 (Function)Distribution.Simple.Test.Log
testOptionsDistribution.Simple.Setup
testOptionsReturnedDistribution.Simple.Test.Log
testResultDistribution.Simple.Test.Log
TestShowDetailsDistribution.Simple.Setup
testShowDetailsDistribution.Simple.Setup
testsRequestedDistribution.Types.ComponentRequestedSpec
testStanzaBuildInfoDistribution.PackageDescription.FieldGrammar
testStanzaMainIsDistribution.PackageDescription.FieldGrammar
testStanzaTestModuleDistribution.PackageDescription.FieldGrammar
testStanzaTestTypeDistribution.PackageDescription.FieldGrammar
TestSuite 
1 (Type/Class)Distribution.Types.TestSuite, Distribution.Types.TestSuite.Lens, Distribution.Types.Lens, Distribution.PackageDescription
2 (Data Constructor)Distribution.Types.TestSuite, Distribution.PackageDescription
TestSuiteExeV10Distribution.Types.TestSuiteInterface, Distribution.PackageDescription
testSuiteFieldGrammarDistribution.PackageDescription.FieldGrammar
TestSuiteInterfaceDistribution.Types.TestSuiteInterface, Distribution.PackageDescription
TestSuiteLibV09Distribution.Types.TestSuiteInterface, Distribution.PackageDescription
TestSuiteLog 
1 (Type/Class)Distribution.Simple.Test.Log
2 (Data Constructor)Distribution.Simple.Test.Log
testSuiteLogPathDistribution.Simple.Test.Log
testSuiteNameDistribution.Simple.Test.Log
TestSuiteNameVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
TestSuiteResultVarDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
testSuites 
1 (Function)Distribution.Types.PackageDescription, Distribution.PackageDescription
2 (Function)Distribution.Types.PackageDescription.Lens, Distribution.Types.Lens
3 (Function)Distribution.Simple.Test.Log
TestSuiteStanza 
1 (Type/Class)Distribution.PackageDescription.FieldGrammar
2 (Data Constructor)Distribution.PackageDescription.FieldGrammar
TestSuiteUnsupportedDistribution.Types.TestSuiteInterface, Distribution.PackageDescription
TestTypeDistribution.Types.TestType, Distribution.PackageDescription
testTypeDistribution.Types.TestSuite, Distribution.PackageDescription
TestTypeExeDistribution.Types.TestType, Distribution.PackageDescription
TestTypeLibDistribution.Types.TestType, Distribution.PackageDescription
TestTypeUnknownDistribution.Types.TestType, Distribution.PackageDescription
testVerbosityDistribution.Simple.Setup
TextDistribution.Text
textDistribution.Compat.CharParsing
thisPackageVersionDistribution.Types.Dependency, Distribution.Package, Distribution.Make, Distribution.Simple
ThisVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
thisVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
ThisVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
tixDirDistribution.Simple.Hpc
tixFilePathDistribution.Simple.Hpc
TMateDistribution.SPDX.LicenseId, Distribution.SPDX
toConfiguredComponentDistribution.Backpack.ConfiguredComponent
toConfiguredComponentsDistribution.Backpack.ConfiguredComponent
toDepMapDistribution.Types.DependencyMap
toDListOfDistribution.Compat.Lens
toEnumDistribution.Compat.Prelude.Internal
toFilePathDistribution.ModuleName
toFlagDistribution.Simple.Flag, Distribution.Simple.Setup
toGraphDistribution.Compat.Graph
toIntegerDistribution.Compat.Prelude.Internal
Token 
1 (Type/Class)Distribution.Parsec.Lexer
2 (Type/Class)Distribution.Parsec.Newtypes
3 (Data Constructor)Distribution.Parsec.Newtypes
Token' 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
TokFieldLineDistribution.Parsec.Lexer
TokOtherDistribution.Parsec.Lexer
TokStrDistribution.Parsec.Lexer
TokSymDistribution.Parsec.Lexer
toLinkedComponentDistribution.Backpack.LinkedComponent
toLinkedComponentsDistribution.Backpack.LinkedComponent
toList 
1 (Function)Distribution.Compat.Graph
2 (Function)Distribution.Compat.DList
toListOfDistribution.Compat.Lens
toLowerDistribution.Compat.Prelude.Internal
toMapDistribution.Compat.Graph
toNubListDistribution.Utils.NubList
toNubListRDistribution.Utils.NubList
toPathTemplateDistribution.Simple.InstallDirs, Distribution.Simple.LocalBuildInfo
topHandlerDistribution.Simple.Utils
topHandlerWithDistribution.Simple.Utils
topologicalOrderDistribution.Simple.PackageIndex
toPreModuleShapeDistribution.Backpack.PreModuleShape
topSortDistribution.Compat.Graph
toPWarningsDistribution.Parsec.LexerMonad
toRationalDistribution.Compat.Prelude.Internal
TORQUE_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
toSetOfDistribution.Compat.Lens
toShortTextDistribution.Utils.ShortText
TOSLDistribution.SPDX.LicenseId, Distribution.SPDX
toUpperDistribution.Compat.Prelude.Internal
toUTF8BSDistribution.Utils.Generic, Distribution.Simple.Utils
toUTF8LBSDistribution.Utils.Generic, Distribution.Simple.Utils
toVersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
TraditionalRecordSyntaxLanguage.Haskell.Extension, Distribution.Simple
transformAllBuildDependsDistribution.PackageDescription.Configuration
transformAllBuildInfosDistribution.PackageDescription.Configuration
TransformListCompLanguage.Haskell.Extension, Distribution.Simple
TraversableDistribution.Compat.Prelude.Internal
TraversalDistribution.Compat.Lens
Traversal'Distribution.Compat.Lens
traverseDistribution.Compat.Prelude.Internal
traverseBuildInfosDistribution.Types.BuildInfo.Lens, Distribution.Types.Lens
traverseCondBranchCDistribution.Types.CondTree
traverseCondBranchVDistribution.Types.CondTree
traverseCondTreeCDistribution.Types.CondTree
traverseCondTreeVDistribution.Types.CondTree
traverse_Distribution.Compat.Prelude.Internal
TrueDistribution.Compat.Prelude.Internal
trueArgDistribution.Simple.Setup
truncateDistribution.Compat.Prelude.Internal
trusted 
1 (Function)Distribution.Types.InstalledPackageInfo, Distribution.InstalledPackageInfo
2 (Function)Distribution.Types.InstalledPackageInfo.Lens
TrustworthyLanguage.Haskell.Extension, Distribution.Simple
tryDistribution.Compat.Parsing, Distribution.Compat.CharParsing
tryFindPackageDescDistribution.Simple.Utils
tryGetConfigStateFileDistribution.Simple.Configure
tryGetPersistBuildConfigDistribution.Simple.Configure
tryIODistribution.Compat.Exception
TupleSectionsLanguage.Haskell.Extension, Distribution.Simple
TU_Berlin_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
TU_Berlin_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
TypeableDistribution.Compat.Prelude.Internal
TypeApplicationsLanguage.Haskell.Extension, Distribution.Simple
TypeFamiliesLanguage.Haskell.Extension, Distribution.Simple
TypeFamilyDependenciesLanguage.Haskell.Extension, Distribution.Simple
TypeInTypeLanguage.Haskell.Extension, Distribution.Simple
TypeOperatorsLanguage.Haskell.Extension, Distribution.Simple
TypeSynonymInstancesLanguage.Haskell.Extension, Distribution.Simple
diff --git a/doc/API/Cabal/doc-index-U.html b/doc/API/Cabal/doc-index-U.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-U.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - U)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - U

UHCDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
uhcProgramDistribution.Simple.Program.Builtin, Distribution.Simple.Program
unAbiHashDistribution.Types.AbiHash, Distribution.Package, Distribution.Make, Distribution.Simple
UnambiguousDistribution.Simple.PackageIndex
UnboxedSumsLanguage.Haskell.Extension, Distribution.Simple
UnboxedTuplesLanguage.Haskell.Extension, Distribution.Simple
unComponentIdDistribution.Types.ComponentId, Distribution.Package, Distribution.Make, Distribution.Simple
unconfigureProgramDistribution.Simple.Program.Db
uncurryDistribution.Compat.Prelude.Internal
UndecidableInstancesLanguage.Haskell.Extension, Distribution.Simple
UndecidableSuperClassesLanguage.Haskell.Extension, Distribution.Simple
undefinedDistribution.Compat.Prelude.Internal
unDefUnitIdDistribution.Types.UnitId, Distribution.Backpack, Distribution.Package, Distribution.Make, Distribution.Simple
unexpectedDistribution.Compat.Parsing, Distribution.Compat.CharParsing
unFlagAssignmentDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
unFlagNameDistribution.Types.GenericPackageDescription, Distribution.PackageDescription
unfoldrDistribution.Compat.Prelude.Internal
unfoldrMDistribution.Utils.Generic
UnicodeSyntaxLanguage.Haskell.Extension, Distribution.Simple
Unicode_DFS_2015Distribution.SPDX.LicenseId, Distribution.SPDX
Unicode_DFS_2016Distribution.SPDX.LicenseId, Distribution.SPDX
Unicode_TOUDistribution.SPDX.LicenseId, Distribution.SPDX
unifiedIPIDRequiredDistribution.Simple.Compiler, Distribution.Simple
unintersperseDistribution.Utils.Generic, Distribution.Simple.Utils
unionDistribution.Simple.Program.Hpc
unionLeftDistribution.Compat.Graph
unionRightDistribution.Compat.Graph
unionVersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
UnionVersionRangesDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
unionVersionRangesDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
UnionVersionRangesFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
uniqueFieldDistribution.FieldGrammar.Class, Distribution.FieldGrammar
uniqueFieldAlaDistribution.FieldGrammar.Class, Distribution.FieldGrammar
UnitIdDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
unitIdSupportedDistribution.Simple.Compiler, Distribution.Simple
unitIdTargetDistribution.Types.LocalBuildInfo
unitIdTarget'Distribution.Types.LocalBuildInfo
unknownCompilerInfoDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
UnknownExtensionLanguage.Haskell.Extension, Distribution.Simple
UnknownLanguageLanguage.Haskell.Extension, Distribution.Simple
UnknownLicenseDistribution.License, Distribution.Make, Distribution.Simple
unlessDistribution.Compat.Prelude.Internal
unLexDistribution.Parsec.LexerMonad
UnlicenseDistribution.SPDX.LicenseId, Distribution.SPDX
UnliftedFFITypesLanguage.Haskell.Extension, Distribution.Simple
unlinesDistribution.Compat.Prelude.Internal
unlitDistribution.Simple.PreProcess.Unlit
unMungedPackageNameDistribution.Types.MungedPackageName
unpackDistribution.Compat.Newtype
unpack'Distribution.Compat.Newtype
unPackageNameDistribution.Types.PackageName, Distribution.Package, Distribution.Make, Distribution.Simple
unPkgconfigNameDistribution.Types.PkgconfigName, Distribution.Package, Distribution.Make, Distribution.Simple
unPPDistribution.Parsec.Class
UnqualComponentNameDistribution.Types.UnqualComponentName
unqualComponentNameToPackageNameDistribution.Types.UnqualComponentName
unregHookDistribution.Simple.UserHooks, Distribution.Simple
unregister 
1 (Function)Distribution.Simple.Program.HcPkg
2 (Function)Distribution.Simple.Register
unregisterCommandDistribution.Simple.Setup
unregisterInvocationDistribution.Simple.Program.HcPkg
UnsafeLanguage.Haskell.Extension, Distribution.Simple
unsafeMkDefUnitIdDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
UnspecifiedLicenseDistribution.License, Distribution.Make, Distribution.Simple
unsupportedExtensionsDistribution.Simple.Compiler, Distribution.Simple
unsupportedLanguagesDistribution.Simple.Compiler, Distribution.Simple
untilDistribution.Compat.Prelude.Internal
unUnitIdDistribution.Types.UnitId, Distribution.Package, Distribution.Make, Distribution.Simple
unUnqualComponentNameDistribution.Types.UnqualComponentName
unvalidateBenchmarkDistribution.PackageDescription.FieldGrammar
unvalidateTestSuiteDistribution.PackageDescription.FieldGrammar
unwordsDistribution.Compat.Prelude.Internal
unzipDistribution.Compat.Prelude.Internal
unzip3Distribution.Compat.Prelude.Internal
updatePackageDescriptionDistribution.Types.PackageDescription, Distribution.PackageDescription
updateProgramDistribution.Simple.Program.Db, Distribution.Simple.Program
UPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
upperDistribution.Compat.CharParsing
UpperBound 
1 (Type/Class)Distribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
2 (Data Constructor)Distribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
usageAlternativesDistribution.Simple.Command
usageDefaultDistribution.Simple.Command
useDistribution.Compat.Lens
usedExtensionsDistribution.Types.BuildInfo, Distribution.PackageDescription
userBugDistribution.PackageDescription.Utils
UserBuildTargetDistribution.Simple.BuildTarget
UserBuildTargetProblemDistribution.Simple.BuildTarget
UserBuildTargetUnrecognisedDistribution.Simple.BuildTarget
userErrorDistribution.Compat.Prelude.Internal
UserHooks 
1 (Type/Class)Distribution.Simple.UserHooks, Distribution.Simple
2 (Data Constructor)Distribution.Simple.UserHooks, Distribution.Simple
userMaybeSpecifyPathDistribution.Simple.Program.Db, Distribution.Simple.Program
UserPackageDBDistribution.Simple.Compiler, Distribution.Simple
UserSpecifiedDistribution.Simple.Program.Types, Distribution.Simple.Program
userSpecifiedArgsDistribution.Simple.Program.Db, Distribution.Simple.Program
userSpecifyArgsDistribution.Simple.Program.Db, Distribution.Simple.Program
userSpecifyArgssDistribution.Simple.Program.Db, Distribution.Simple.Program
userSpecifyPathDistribution.Simple.Program.Db, Distribution.Simple.Program
userSpecifyPathsDistribution.Simple.Program.Db, Distribution.Simple.Program
usesTemplateHaskellOrQQDistribution.Types.BuildInfo, Distribution.PackageDescription
U_boot_exception_2_0Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
diff --git a/doc/API/Cabal/doc-index-V.html b/doc/API/Cabal/doc-index-V.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-V.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - V)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - V

validateBenchmarkDistribution.PackageDescription.FieldGrammar
validateTestSuiteDistribution.PackageDescription.FieldGrammar
validateUTF8Distribution.Utils.Generic
validModuleComponentDistribution.ModuleName
validVersionDistribution.Types.Version
VanillaDistribution.Simple.Hpc
VarDistribution.Types.Condition, Distribution.PackageDescription
VaxDistribution.System
VCat 
1 (Type/Class)Distribution.Parsec.Newtypes
2 (Data Constructor)Distribution.Parsec.Newtypes
verboseDistribution.Verbosity
verboseCallSiteDistribution.Verbosity
verboseCallStackDistribution.Verbosity
verboseHasFlagsDistribution.Verbosity
verboseMarkOutputDistribution.Verbosity
verboseNoFlagsDistribution.Verbosity
verboseNoTimestampDistribution.Verbosity
verboseNoWrapDistribution.Verbosity
verboseTimestampDistribution.Verbosity
verboseUnmarkOutputDistribution.Verbosity
VerbosityDistribution.Verbosity
VersionDistribution.Types.Version, Distribution.Version, Distribution.Make, Distribution.Simple
version0Distribution.Types.Version, Distribution.Version, Distribution.Simple
VersionDoesNotSupportGlobDistribution.Simple.Glob
VersionDoesNotSupportGlobStarDistribution.Simple.Glob
VersionIntervalDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
VersionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
versionIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
versionNumbersDistribution.Types.Version, Distribution.Version, Distribution.Simple
VersionRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
VersionRangeFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
VersionRangeParensDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
VersionRangeParensFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
viewDistribution.Compat.Lens
viewAsFieldDescrDistribution.Simple.Command
ViewPatternsLanguage.Haskell.Extension, Distribution.Simple
VimDistribution.SPDX.LicenseId, Distribution.SPDX
virtualModules 
1 (Function)Distribution.Types.BuildInfo, Distribution.PackageDescription
2 (Function)Distribution.Types.BuildInfo.Lens, Distribution.Types.Lens
voidDistribution.Compat.Prelude.Internal
VOSTROMDistribution.SPDX.LicenseId, Distribution.SPDX
VSL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
diff --git a/doc/API/Cabal/doc-index-W.html b/doc/API/Cabal/doc-index-W.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-W.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - W)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - W

W3CDistribution.SPDX.LicenseId, Distribution.SPDX
W3C_19980720Distribution.SPDX.LicenseId, Distribution.SPDX
W3C_20150513Distribution.SPDX.LicenseId, Distribution.SPDX
warnDistribution.Simple.Utils
warningsDistribution.Parsec.LexerMonad
warnProgressDistribution.Utils.LogProgress
Watcom_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
WayDistribution.Simple.Hpc
whenDistribution.Compat.Prelude.Internal
wildcardUpperBoundDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
WildcardVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
WildcardVersionFDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
WindowsDistribution.System
withAllComponentsInBuildOrderDistribution.Simple.LocalBuildInfo
withAllTargetsInBuildOrderDistribution.Types.LocalBuildInfo
withAllTargetsInBuildOrder'Distribution.Types.LocalBuildInfo
withBenchLBIDistribution.Simple.LocalBuildInfo
withBenchmarkDistribution.Types.PackageDescription, Distribution.PackageDescription
WithCallStackDistribution.Compat.Stack
withComponentsInBuildOrderDistribution.Simple.LocalBuildInfo
withComponentsLBIDistribution.Simple.LocalBuildInfo
withDebugInfoDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withDynExeDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withExeDistribution.Types.PackageDescription, Distribution.PackageDescription
withExeLBIDistribution.Simple.LocalBuildInfo
withFileContentsDistribution.Utils.Generic, Distribution.Simple.Utils
withForeignLibDistribution.Types.PackageDescription
withFrozenCallStackDistribution.Compat.Stack
withGHCiLibDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withinIntervalsDistribution.Types.VersionInterval, Distribution.Version, Distribution.Simple
withinRangeDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
withinVersionDistribution.Types.VersionRange, Distribution.Version, Distribution.Simple
withLexicalCallStackDistribution.Compat.Stack
withLibDistribution.Types.PackageDescription, Distribution.PackageDescription
withLibLBIDistribution.Simple.LocalBuildInfo
withNeededTargetsInBuildOrderDistribution.Types.LocalBuildInfo
withNeededTargetsInBuildOrder'Distribution.Types.LocalBuildInfo
withOptimizationDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withOutputMarkerDistribution.Simple.Utils
withPackageDBDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withProfExeDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withProfExeDetailDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withProfLibDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withProfLibDetailDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withProgramsDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withResponseFileDistribution.Simple.Program.ResponseFile
withSharedLibDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withStaticLibDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
withTempDirectoryDistribution.Simple.Utils
withTempDirectoryExDistribution.Simple.Utils
withTempFileDistribution.Simple.Utils
withTempFileExDistribution.Simple.Utils
withTestDistribution.Types.PackageDescription, Distribution.PackageDescription
withTestLBIDistribution.Simple.LocalBuildInfo
withUTF8FileContentsDistribution.Utils.Generic, Distribution.Simple.Utils
withVanillaLibDistribution.Types.LocalBuildInfo, Distribution.Simple.LocalBuildInfo
WordDistribution.Compat.Binary, Distribution.Compat.Prelude.Internal
Word16Distribution.Compat.Binary, Distribution.Compat.Prelude.Internal
Word32Distribution.Compat.Binary, Distribution.Compat.Prelude.Internal
Word64Distribution.Compat.Binary, Distribution.Compat.Prelude.Internal
Word8Distribution.Compat.Binary, Distribution.Compat.Prelude.Internal
wordsDistribution.Compat.Prelude.Internal
wrapLineDistribution.Utils.Generic, Distribution.Simple.Utils
wrapTextDistribution.Utils.Generic, Distribution.Simple.Utils
writeAutogenFilesDistribution.Simple.Build
writeFileDistribution.Compat.Prelude.Internal
writeFileAtomicDistribution.Utils.Generic, Distribution.Simple.Utils
writeGenericPackageDescriptionDistribution.PackageDescription.PrettyPrint
writeGhcEnvironmentFileDistribution.Simple.GHC
writeHookedBuildInfoDistribution.PackageDescription.PrettyPrint
writePackageDescriptionDistribution.PackageDescription.PrettyPrint
writePersistBuildConfigDistribution.Simple.Configure
writeSimpleTestStubDistribution.Simple.Test.LibV09
writeUTF8FileDistribution.Utils.Generic, Distribution.Simple.Utils
WsuipaDistribution.SPDX.LicenseId, Distribution.SPDX
WTFPLDistribution.SPDX.LicenseId, Distribution.SPDX
WxWindows_exception_3_1Distribution.SPDX.LicenseExceptionId, Distribution.SPDX
diff --git a/doc/API/Cabal/doc-index-X.html b/doc/API/Cabal/doc-index-X.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-X.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - X)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - X

X11Distribution.SPDX.LicenseId, Distribution.SPDX
X86_64Distribution.System
xargsDistribution.Simple.Utils
XeroxDistribution.SPDX.LicenseId, Distribution.SPDX
XFree86_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
XinetdDistribution.SPDX.LicenseId, Distribution.SPDX
XmlSyntaxLanguage.Haskell.Extension, Distribution.Simple
XnetDistribution.SPDX.LicenseId, Distribution.SPDX
XppDistribution.SPDX.LicenseId, Distribution.SPDX
XSkatDistribution.SPDX.LicenseId, Distribution.SPDX
diff --git a/doc/API/Cabal/doc-index-Y.html b/doc/API/Cabal/doc-index-Y.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-Y.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - Y)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - Y

YHCDistribution.Compiler, Distribution.Simple.Compiler, Distribution.Simple
YPL_1_0Distribution.SPDX.LicenseId, Distribution.SPDX
YPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
diff --git a/doc/API/Cabal/doc-index-Z.html b/doc/API/Cabal/doc-index-Z.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index-Z.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index - Z)

Cabal-2.4.0.1: A framework for packaging Haskell software

Index - Z

ZedDistribution.SPDX.LicenseId, Distribution.SPDX
Zend_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
zeroPosDistribution.Parsec.Common
Zimbra_1_3Distribution.SPDX.LicenseId, Distribution.SPDX
Zimbra_1_4Distribution.SPDX.LicenseId, Distribution.SPDX
zipDistribution.Compat.Prelude.Internal
zip3Distribution.Compat.Prelude.Internal
zipWithDistribution.Compat.Prelude.Internal
zipWith3Distribution.Compat.Prelude.Internal
ZlibDistribution.SPDX.LicenseId, Distribution.SPDX
Zlib_acknowledgementDistribution.SPDX.LicenseId, Distribution.SPDX
ZPL_1_1Distribution.SPDX.LicenseId, Distribution.SPDX
ZPL_2_0Distribution.SPDX.LicenseId, Distribution.SPDX
ZPL_2_1Distribution.SPDX.LicenseId, Distribution.SPDX
diff --git a/doc/API/Cabal/doc-index.html b/doc/API/Cabal/doc-index.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/doc-index.html @@ -0,0 +1,1 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software (Index)

Cabal-2.4.0.1: A framework for packaging Haskell software

diff --git a/doc/API/Cabal/haddock-bundle.min.js b/doc/API/Cabal/haddock-bundle.min.js new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/haddock-bundle.min.js @@ -0,0 +1,2 @@ +!function e(t,n,o){function r(s,a){if(!n[s]){if(!t[s]){var l="function"==typeof require&&require;if(!a&&l)return l(s,!0);if(i)return i(s,!0);var c=new Error("Cannot find module '"+s+"'");throw c.code="MODULE_NOT_FOUND",c}var u=n[s]={exports:{}};t[s][0].call(u.exports,function(e){var n=t[s][1][e];return r(n||e)},u,u.exports,e,t,n,o)}return n[s].exports}for(var i="function"==typeof require&&require,s=0;s element with id '"+e+"'");return t}function r(e){for(var t=e.target,n=t.id,r=o(n),i=r.element.open,s=0,l=r.toggles;s0&&(d[n.id]={element:n,openByDefault:!!n.open,toggles:[]},n.addEventListener("toggle",r))}}function s(e){var t=o(e).element;t.open=!t.open}function a(){var e=Object.keys(p);document.cookie="toggled="+encodeURIComponent(e.join("+"))}function l(){var e=h.getCookie("toggled");if(e)for(var t=0,n=e.split("+");t=0&&e.followActiveLink()),"s"===t.key&&"input"!==t.target.tagName.toLowerCase()&&(t.preventDefault(),e.show())})},t.prototype.hide=function(){this.setState({isVisible:!1})},t.prototype.show=function(){this.state.isVisible||(this.focusPlease=!0,this.setState({isVisible:!0,activeLinkIndex:-1}))},t.prototype.toggleVisibility=function(){this.state.isVisible?this.hide():this.show()},t.prototype.navigateLinks=function(e){var t=Math.max(-1,Math.min(this.linkIndex-1,this.state.activeLinkIndex+e));this.navigatedByKeyboard=!0,this.setState({activeLinkIndex:t})},t.prototype.followActiveLink=function(){this.activeLinkAction&&this.activeLinkAction()},t.prototype.updateResults=function(){var e=this.input&&this.input.value||"",t={};this.state.fuse.search(e).forEach(function(e){var n=e.item.module;(t[n]||(t[n]=[])).push(e)});var n=[];for(var o in t)!function(e){var o=t[e],r=0;o.forEach(function(e){r+=1/e.score}),n.push({module:e,totalScore:1/r,items:o})}(o);n.sort(function(e,t){return e.totalScore-t.totalScore}),this.setState({searchString:e,isVisible:!0,moduleResults:n})},t.prototype.componentDidUpdate=function(){if(this.searchResults&&this.activeLink&&this.navigatedByKeyboard){var e=this.activeLink.getClientRects()[0],t=this.searchResults.getClientRects()[0].top;e.bottom>window.innerHeight?this.searchResults.scrollTop+=e.bottom-window.innerHeight+80:e.top=0}function s(e,t){var n=o(e.className||"");n.indexOf(" "+t+" ")<0&&(e.className=r(n+" "+t))}function a(e,t){var n=o(e.className||"");n=n.replace(" "+t+" "," "),e.className=r(n)}function l(e,t,n,o){return null==o&&(o=!i(e,t)),o?(a(e,n),s(e,t)):(a(e,t),s(e,n)),o}function c(e){var t=document.getElementById("page-menu");if(t&&t.firstChild){var n=t.firstChild.cloneNode(!1);n.innerHTML=e,t.appendChild(n)}}function u(){return Array.prototype.slice.call(document.getElementsByTagName("link")).filter(function(e){return-1!=e.rel.indexOf("style")&&e.title})}function h(){var e=u(),t="";e.forEach(function(e){t+="
  • "+e.title+"
    • "}),e.length>1&&c("")}function d(e){for(var t=u(),n=null,o=0;on)return i(e,this.pattern,o);var r=this.options,a=r.location,l=r.distance,c=r.threshold,u=r.findAllMatches,h=r.minMatchCharLength;return s(e,this.pattern,this.patternAlphabet,{location:a,distance:l,threshold:c,findAllMatches:u,minMatchCharLength:h})}}]),e}();e.exports=l},function(e,t,n){"use strict";var o=n(0),r=function e(t,n,r){if(n){var i=n.indexOf("."),s=n,a=null;-1!==i&&(s=n.slice(0,i),a=n.slice(i+1));var l=t[s];if(null!==l&&void 0!==l)if(a||"string"!=typeof l&&"number"!=typeof l)if(o(l))for(var c=0,u=l.length;c0&&void 0!==arguments[0]?arguments[0]:[],t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:1,n=[],o=-1,r=-1,i=0,s=e.length;i=t&&n.push([o,r]),o=-1)}return e[i-1]&&i-o>=t&&n.push([o,i-1]),n}},function(e,t,n){"use strict";e.exports=function(e){for(var t={},n=e.length,o=0;o2&&void 0!==arguments[2]?arguments[2]:/ +/g,r=new RegExp(t.replace(o,"\\$&").replace(n,"|")),i=e.match(r),s=!!i,a=[];if(s)for(var l=0,c=i.length;l=E;P-=1){var R=P-1,U=n[e.charAt(R)];if(U&&(b[R]=1),j[P]=(j[P+1]<<1|1)&U,0!==I&&(j[P]|=(L[P+1]|L[P])<<1|1|L[P+1]),j[P]&N&&(C=o(t,{errors:I,currentLocation:R,expectedLocation:g,distance:c}))<=y){if(y=C,(_=R)<=g)break;E=Math.max(1,2*g-_)}}if(o(t,{errors:I+1,currentLocation:g,expectedLocation:g,distance:c})>y)break;L=j}return{isMatch:_>=0,score:0===C?.001:C,matchedIndices:r(b,v)}}},function(e,t,n){"use strict";function o(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}var r=function(){function e(e,t){for(var n=0;n0&&void 0!==arguments[0]?arguments[0]:"",t=[];if(this.options.tokenize)for(var n=e.split(this.options.tokenSeparator),o=0,r=n.length;o0&&void 0!==arguments[0]?arguments[0]:[],t=arguments[1],n=this.list,o={},r=[];if("string"==typeof n[0]){for(var i=0,s=n.length;i1)throw new Error("Key weight has to be > 0 and <= 1");p=p.name}else a[p]={weight:1};this._analyze({key:p,value:this.options.getFn(u,p),record:u,index:l},{resultMap:o,results:r,tokenSearchers:e,fullSearcher:t})}return{weights:a,results:r}}},{key:"_analyze",value:function(e,t){var n=e.key,o=e.arrayIndex,r=void 0===o?-1:o,i=e.value,s=e.record,l=e.index,c=t.tokenSearchers,u=void 0===c?[]:c,h=t.fullSearcher,d=void 0===h?[]:h,p=t.resultMap,f=void 0===p?{}:p,v=t.results,g=void 0===v?[]:v;if(void 0!==i&&null!==i){var m=!1,y=-1,_=0;if("string"==typeof i){this._log("\nKey: "+(""===n?"-":n));var k=d.search(i);if(this._log('Full text: "'+i+'", score: '+k.score),this.options.tokenize){for(var b=i.split(this.options.tokenSeparator),x=[],w=0;w-1&&(E=(E+y)/2),this._log("Score average:",E);var T=!this.options.tokenize||!this.options.matchAllTokens||_>=u.length;if(this._log("\nCheck Matches: "+T),(m||k.isMatch)&&T){var j=f[l];j?j.output.push({key:n,arrayIndex:r,value:i,score:E,matchedIndices:k.matchedIndices}):(f[l]={item:s,output:[{key:n,arrayIndex:r,value:i,score:E,matchedIndices:k.matchedIndices}]},g.push(f[l]))}}else if(a(i))for(var P=0,R=i.length;P-1&&(s.arrayIndex=i.arrayIndex),t.matches.push(s)}}}),this.options.includeScore&&n.push(function(e,t){t.score=e.score});for(var o=0,r=e.length;o2;)A.push(arguments[s]);for(n&&null!=n.children&&(A.length||A.push(n.children),delete n.children);A.length;)if((r=A.pop())&&void 0!==r.pop)for(s=r.length;s--;)A.push(r[s]);else"boolean"==typeof r&&(r=null),(i="function"!=typeof t)&&(null==r?r="":"number"==typeof r?r=String(r):"string"!=typeof r&&(i=!1)),i&&o?a[a.length-1]+=r:a===O?a=[r]:a.push(r),o=i;var l=new e;return l.nodeName=t,l.children=a,l.attributes=null==n?void 0:n,l.key=null==n?void 0:n.key,void 0!==I.vnode&&I.vnode(l),l}function o(e,t){for(var n in t)e[n]=t[n];return e}function r(e){!e.__d&&(e.__d=!0)&&1==j.push(e)&&(I.debounceRendering||E)(i)}function i(){var e,t=j;for(j=[];e=t.pop();)e.__d&&L(e)}function s(e,t,n){return"string"==typeof t||"number"==typeof t?void 0!==e.splitText:"string"==typeof t.nodeName?!e._componentConstructor&&a(e,t.nodeName):n||e._componentConstructor===t.nodeName}function a(e,t){return e.__n===t||e.nodeName.toLowerCase()===t.toLowerCase()}function l(e){var t=o({},e.attributes);t.children=e.children;var n=e.nodeName.defaultProps;if(void 0!==n)for(var r in n)void 0===t[r]&&(t[r]=n[r]);return t}function c(e,t){var n=t?document.createElementNS("http://www.w3.org/2000/svg",e):document.createElement(e);return n.__n=e,n}function u(e){var t=e.parentNode;t&&t.removeChild(e)}function h(e,t,n,o,r){if("className"===t&&(t="class"),"key"===t);else if("ref"===t)n&&n(null),o&&o(e);else if("class"!==t||r)if("style"===t){if(o&&"string"!=typeof o&&"string"!=typeof n||(e.style.cssText=o||""),o&&"object"==typeof o){if("string"!=typeof n)for(var i in n)i in o||(e.style[i]="");for(var i in o)e.style[i]="number"==typeof o[i]&&!1===T.test(i)?o[i]+"px":o[i]}}else if("dangerouslySetInnerHTML"===t)o&&(e.innerHTML=o.__html||"");else if("o"==t[0]&&"n"==t[1]){var s=t!==(t=t.replace(/Capture$/,""));t=t.toLowerCase().substring(2),o?n||e.addEventListener(t,p,s):e.removeEventListener(t,p,s),(e.__l||(e.__l={}))[t]=o}else if("list"!==t&&"type"!==t&&!r&&t in e)d(e,t,null==o?"":o),null!=o&&!1!==o||e.removeAttribute(t);else{var a=r&&t!==(t=t.replace(/^xlink\:?/,""));null==o||!1===o?a?e.removeAttributeNS("http://www.w3.org/1999/xlink",t.toLowerCase()):e.removeAttribute(t):"function"!=typeof o&&(a?e.setAttributeNS("http://www.w3.org/1999/xlink",t.toLowerCase(),o):e.setAttribute(t,o))}else e.className=o||""}function d(e,t,n){try{e[t]=n}catch(e){}}function p(e){return this.__l[e.type](I.event&&I.event(e)||e)}function f(){for(var e;e=P.pop();)I.afterMount&&I.afterMount(e),e.componentDidMount&&e.componentDidMount()}function v(e,t,n,o,r,i){R++||(U=null!=r&&void 0!==r.ownerSVGElement,D=null!=e&&!("__preactattr_"in e));var s=g(e,t,n,o,i);return r&&s.parentNode!==r&&r.appendChild(s),--R||(D=!1,i||f()),s}function g(e,t,n,o,r){var i=e,s=U;if(null!=t&&"boolean"!=typeof t||(t=""),"string"==typeof t||"number"==typeof t)return e&&void 0!==e.splitText&&e.parentNode&&(!e._component||r)?e.nodeValue!=t&&(e.nodeValue=t):(i=document.createTextNode(t),e&&(e.parentNode&&e.parentNode.replaceChild(i,e),y(e,!0))),i.__preactattr_=!0,i;var l=t.nodeName;if("function"==typeof l)return C(e,t,n,o);if(U="svg"===l||"foreignObject"!==l&&U,l=String(l),(!e||!a(e,l))&&(i=c(l,U),e)){for(;e.firstChild;)i.appendChild(e.firstChild);e.parentNode&&e.parentNode.replaceChild(i,e),y(e,!0)}var u=i.firstChild,h=i.__preactattr_,d=t.children;if(null==h){h=i.__preactattr_={};for(var p=i.attributes,f=p.length;f--;)h[p[f].name]=p[f].value}return!D&&d&&1===d.length&&"string"==typeof d[0]&&null!=u&&void 0!==u.splitText&&null==u.nextSibling?u.nodeValue!=d[0]&&(u.nodeValue=d[0]):(d&&d.length||null!=u)&&m(i,d,n,o,D||null!=h.dangerouslySetInnerHTML),k(i,t.attributes,h),U=s,i}function m(e,t,n,o,r){var i,a,l,c,h,d=e.childNodes,p=[],f={},v=0,m=0,_=d.length,k=0,b=t?t.length:0;if(0!==_)for(L=0;L<_;L++){var x=d[L],w=x.__preactattr_;null!=(S=b&&w?x._component?x._component.__k:w.key:null)?(v++,f[S]=x):(w||(void 0!==x.splitText?!r||x.nodeValue.trim():r))&&(p[k++]=x)}if(0!==b)for(L=0;L2?[].slice.call(arguments,2):e.children)},Component:N,render:function(e,t,n){return v(n,e,{},!1,t,!1)},rerender:i,options:I};void 0!==t?t.exports=F:self.preact=F}()},{}]},{},[3]); +//# sourceMappingURL=haddock-bundle.min.js.map diff --git a/doc/API/Cabal/hslogo-16.png b/doc/API/Cabal/hslogo-16.png new file mode 100644 Binary files /dev/null and b/doc/API/Cabal/hslogo-16.png differ diff --git a/doc/API/Cabal/index.html b/doc/API/Cabal/index.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/index.html @@ -0,0 +1,4 @@ +Cabal-2.4.0.1: A framework for packaging Haskell software

    Cabal-2.4.0.1: A framework for packaging Haskell software

    Cabal-2.4.0.1: A framework for packaging Haskell software

    The Haskell Common Architecture for Building Applications and +Libraries: a framework defining a common interface for authors to more +easily build their Haskell applications in a portable way.

    The Haskell Cabal is part of a larger infrastructure for distributing, +organizing, and cataloging Haskell libraries and tools.

    Signatures

    Modules

    diff --git a/doc/API/Cabal/meta.json b/doc/API/Cabal/meta.json new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/meta.json @@ -0,0 +1,1 @@ +{"haddock_version":"2.20.0"} diff --git a/doc/API/Cabal/minus.gif b/doc/API/Cabal/minus.gif new file mode 100644 Binary files /dev/null and b/doc/API/Cabal/minus.gif differ diff --git a/doc/API/Cabal/ocean.css b/doc/API/Cabal/ocean.css new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/ocean.css @@ -0,0 +1,647 @@ +/* @group Fundamentals */ + +* { margin: 0; padding: 0 } + +/* Is this portable? */ +html { + background-color: white; + width: 100%; + height: 100%; +} + +body { + background: white; + color: black; + text-align: left; + min-height: 100%; + position: relative; +} + +p { + margin: 0.8em 0; +} + +ul, ol { + margin: 0.8em 0 0.8em 2em; +} + +dl { + margin: 0.8em 0; +} + +dt { + font-weight: bold; +} +dd { + margin-left: 2em; +} + +a { text-decoration: none; } +a[href]:link { color: rgb(196,69,29); } +a[href]:visited { color: rgb(171,105,84); } +a[href]:hover { text-decoration:underline; } + +a[href].def:link, a[href].def:visited { color: black; } +a[href].def:hover { color: rgb(78, 98, 114); } + +/* @end */ + +/* @group Show and hide with JS */ + +body.js-enabled .hide-when-js-enabled { + display: none; +} + +/* @end */ + +/* @group Fonts & Sizes */ + +/* Basic technique & IE workarounds from YUI 3 + For reasons, see: + http://yui.yahooapis.com/3.1.1/build/cssfonts/fonts.css + */ + +body { + font:13px/1.4 sans-serif; + *font-size:small; /* for IE */ + *font:x-small; /* for IE in quirks mode */ +} + +h1 { font-size: 146.5%; /* 19pt */ } +h2 { font-size: 131%; /* 17pt */ } +h3 { font-size: 116%; /* 15pt */ } +h4 { font-size: 100%; /* 13pt */ } +h5 { font-size: 100%; /* 13pt */ } + +select, input, button, textarea { + font:99% sans-serif; +} + +table { + font-size:inherit; + font:100%; +} + +pre, code, kbd, samp, tt, .src { + font-family:monospace; + *font-size:108%; + line-height: 124%; +} + +.links, .link { + font-size: 85%; /* 11pt */ +} + +#module-header .caption { + font-size: 182%; /* 24pt */ +} + +#module-header .caption sup { + font-size: 70%; + font-weight: normal; +} + +.info { + font-size: 85%; /* 11pt */ +} + +#table-of-contents, #synopsis { + /* font-size: 85%; /* 11pt */ +} + + +/* @end */ + +/* @group Common */ + +.caption, h1, h2, h3, h4, h5, h6, summary { + font-weight: bold; + color: rgb(78,98,114); + margin: 0.8em 0 0.4em; +} + +* + h1, * + h2, * + h3, * + h4, * + h5, * + h6 { + margin-top: 2em; +} + +h1 + h2, h2 + h3, h3 + h4, h4 + h5, h5 + h6 { + margin-top: inherit; +} + +ul.links { + list-style: none; + text-align: left; + float: right; + display: inline-table; + margin: 0 0 0 1em; +} + +ul.links li { + display: inline; + border-left: 1px solid #d5d5d5; + white-space: nowrap; + padding: 0; +} + +ul.links li a { + padding: 0.2em 0.5em; +} + +.hide { display: none; } +.show { display: inherit; } +.clear { clear: both; } + +.collapser { + background-image: url(minus.gif); + background-repeat: no-repeat; +} +.expander { + background-image: url(plus.gif); + background-repeat: no-repeat; +} +.collapser, .expander { + padding-left: 14px; + margin-left: -14px; + cursor: pointer; +} +p.caption.collapser, +p.caption.expander { + background-position: 0 0.4em; +} + +.instance.collapser, .instance.expander { + margin-left: 0px; + background-position: left center; + min-width: 9px; + min-height: 9px; +} + +summary { + cursor: pointer; + outline: none; + list-style-image: url(plus.gif); + list-style-position: outside; +} + +details[open] > summary { + list-style-image: url(minus.gif); +} + +pre { + padding: 0.25em; + margin: 0.8em 0; + background: rgb(229,237,244); + overflow: auto; + border-bottom: 0.25em solid white; + /* white border adds some space below the box to compensate + for visual extra space that paragraphs have between baseline + and the bounding box */ +} + +.src { + background: #f0f0f0; + padding: 0.2em 0.5em; +} + +.keyword { font-weight: normal; } +.def { font-weight: bold; } + +@media print { + #footer { display: none; } +} + +/* @end */ + +/* @group Page Structure */ + +#content { + margin: 0 auto; + padding: 0 2em 6em; +} + +#package-header { + background: rgb(41,56,69); + border-top: 5px solid rgb(78,98,114); + color: #ddd; + padding: 0.2em; + position: relative; + text-align: left; +} + +#package-header .caption { + background: url(hslogo-16.png) no-repeat 0em; + color: white; + margin: 0 2em; + font-weight: normal; + font-style: normal; + padding-left: 2em; +} + +#package-header a:link, #package-header a:visited { color: white; } +#package-header a:hover { background: rgb(78,98,114); } + +#module-header .caption { + color: rgb(78,98,114); + font-weight: bold; + border-bottom: 1px solid #ddd; +} + +table.info { + float: right; + padding: 0.5em 1em; + border: 1px solid #ddd; + color: rgb(78,98,114); + background-color: #fff; + max-width: 40%; + border-spacing: 0; + position: relative; + top: -0.5em; + margin: 0 0 0 2em; +} + +.info th { + padding: 0 1em 0 0; +} + +div#style-menu-holder { + position: relative; + z-index: 2; + display: inline; +} + +#style-menu { + position: absolute; + z-index: 1; + overflow: visible; + background: #374c5e; + margin: 0; + text-align: center; + right: 0; + padding: 0; + top: 1.25em; +} + +#style-menu li { + display: list-item; + border-style: none; + margin: 0; + padding: 0; + color: #000; + list-style-type: none; +} + +#style-menu li + li { + border-top: 1px solid #919191; +} + +#style-menu a { + width: 6em; + padding: 3px; + display: block; +} + +#footer { + background: #ddd; + border-top: 1px solid #aaa; + padding: 0.5em 0; + color: #666; + text-align: center; + position: absolute; + bottom: 0; + width: 100%; + height: 3em; +} + +/* @end */ + +/* @group Front Matter */ + +#table-of-contents { + float: right; + clear: right; + background: #faf9dc; + border: 1px solid #d8d7ad; + padding: 0.5em 1em; + max-width: 20em; + margin: 0.5em 0 1em 1em; +} + +#table-of-contents .caption { + text-align: center; + margin: 0; +} + +#table-of-contents ul { + list-style: none; + margin: 0; +} + +#table-of-contents ul ul { + margin-left: 2em; +} + +#description .caption { + display: none; +} + +#synopsis { + display: block; + position: fixed; + right: 0; + height: 80%; + top: 10%; + padding: 0; + max-width: 75%; + /* Ensure that synopsis covers everything (including MathJAX markup) */ + z-index: 1; +} + +#synopsis summary { + display: block; + float: left; + width: 29px; + color: rgba(255,255,255,0); + height: 110px; + margin: 0; + font-size: 1px; + padding: 0; + background: url(synopsis.png) no-repeat 0px -8px; +} + +#synopsis details[open] > summary { + background: url(synopsis.png) no-repeat -64px -8px; +} + +#synopsis ul { + height: 100%; + overflow: auto; + padding: 0.5em; + margin: 0; +} + +#synopsis ul ul { + overflow: hidden; +} + +#synopsis ul, +#synopsis ul li.src { + background-color: #faf9dc; + white-space: nowrap; + list-style: none; + margin-left: 0; +} + +/* @end */ + +/* @group Main Content */ + +#interface div.top { margin: 2em 0; } +#interface h1 + div.top, +#interface h2 + div.top, +#interface h3 + div.top, +#interface h4 + div.top, +#interface h5 + div.top { + margin-top: 1em; +} +#interface .src .selflink, +#interface .src .link { + float: right; + color: #919191; + background: #f0f0f0; + padding: 0 0.5em 0.2em; + margin: 0 -0.5em 0 0; + -moz-user-select: none; +} +#interface .src .selflink { + border-left: 1px solid #919191; + margin: 0 -0.5em 0 0.5em; +} + +#interface span.fixity { + color: #919191; + border-left: 1px solid #919191; + padding: 0.2em 0.5em 0.2em 0.5em; + margin: 0 -1em 0 1em; +} + +#interface span.rightedge { + border-left: 1px solid #919191; + padding: 0.2em 0 0.2em 0; + margin: 0 0 0 1em; +} + +#interface table { border-spacing: 2px; } +#interface td { + vertical-align: top; + padding-left: 0.5em; +} + +#interface td.doc p { + margin: 0; +} +#interface td.doc p + p { + margin-top: 0.8em; +} + +.doc table { + border-collapse: collapse; + border-spacing: 0px; +} + +.doc th, +.doc td { + padding: 5px; + border: 1px solid #ddd; +} + +.doc th { + background-color: #f0f0f0; +} + +.clearfix:after { + clear: both; + content: " "; + display: block; + height: 0; + visibility: hidden; +} + +.subs ul { + list-style: none; + display: table; + margin: 0; +} + +.subs ul li { + display: table-row; +} + +.subs ul li dfn { + display: table-cell; + font-style: normal; + font-weight: bold; + margin: 1px 0; + white-space: nowrap; +} + +.subs ul li > .doc { + display: table-cell; + padding-left: 0.5em; + margin-bottom: 0.5em; +} + +.subs ul li > .doc p { + margin: 0; +} + +/* Render short-style data instances */ +.inst ul { + height: 100%; + padding: 0.5em; + margin: 0; +} + +.inst, .inst li { + list-style: none; + margin-left: 1em; +} + +/* Workaround for bug in Firefox (issue #384) */ +.inst-left { + float: left; +} + +.top p.src { + border-top: 1px solid #ccc; +} + +.subs, .doc { + /* use this selector for one level of indent */ + padding-left: 2em; +} + +.warning { + color: red; +} + +.arguments { + margin-top: -0.4em; +} +.arguments .caption { + display: none; +} + +.fields { padding-left: 1em; } + +.fields .caption { display: none; } + +.fields p { margin: 0 0; } + +/* this seems bulky to me +.methods, .constructors { + background: #f8f8f8; + border: 1px solid #eee; +} +*/ + +/* @end */ + +/* @group Auxillary Pages */ + + +.extension-list { + list-style-type: none; + margin-left: 0; +} + +#mini { + margin: 0 auto; + padding: 0 1em 1em; +} + +#mini > * { + font-size: 93%; /* 12pt */ +} + +#mini #module-list .caption, +#mini #module-header .caption { + font-size: 125%; /* 15pt */ +} + +#mini #interface h1, +#mini #interface h2, +#mini #interface h3, +#mini #interface h4 { + font-size: 109%; /* 13pt */ + margin: 1em 0 0; +} + +#mini #interface .top, +#mini #interface .src { + margin: 0; +} + +#mini #module-list ul { + list-style: none; + margin: 0; +} + +#alphabet ul { + list-style: none; + padding: 0; + margin: 0.5em 0 0; + text-align: center; +} + +#alphabet li { + display: inline; + margin: 0 0.25em; +} + +#alphabet a { + font-weight: bold; +} + +#index .caption, +#module-list .caption { font-size: 131%; /* 17pt */ } + +#index table { + margin-left: 2em; +} + +#index .src { + font-weight: bold; +} +#index .alt { + font-size: 77%; /* 10pt */ + font-style: italic; + padding-left: 2em; +} + +#index td + td { + padding-left: 1em; +} + +#module-list ul { + list-style: none; + margin: 0 0 0 2em; +} + +#module-list li { + clear: right; +} + +#module-list span.collapser, +#module-list span.expander { + background-position: 0 0.3em; +} + +#module-list .package { + float: right; +} + +:target { + background-color: #ffff00; +} + +/* @end */ diff --git a/doc/API/Cabal/plus.gif b/doc/API/Cabal/plus.gif new file mode 100644 Binary files /dev/null and b/doc/API/Cabal/plus.gif differ diff --git a/doc/API/Cabal/quick-jump.css b/doc/API/Cabal/quick-jump.css new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/quick-jump.css @@ -0,0 +1,164 @@ +/* @group Search box layout */ + +#search { + position: fixed; + top: 3.2em; + bottom: 0; + left: calc(50% - 22em); + width: 44em; + z-index: 1000; + pointer-events: none; + overflow-y: auto; +} + +#search.hidden { + display: none; +} + +#search-form, #search-results { + box-shadow: 2px 2px 6px rgb(199, 204, 208); + pointer-events: all; +} + +#search-form input { + font-size: 1.25em; line-height: 2.3em; height: 2.4em; + display: block; + box-sizing: border-box; + width: 100%; + margin: 0; + padding: 0 0.75em; + border: 0.05em solid rgb(151, 179, 202); +} + +#search input:focus { + outline: none; +} + +#search p.error { + color: rgb(107, 24, 24); + font-weight: bold; +} + +#search-results { + box-sizing: border-box; + border: 0.05em solid #b2d5fb; + background: #e8f3ff; +} + +#search-form input + #search-results { + border-top: none; + top: 3em; + max-height: calc(100% - 3em); +} + +/* @end */ + +/* @group search results */ + +#search-results > ul { + margin: 0; + list-style: none; +} + +#search-results > ul > li, +#search-results > p, +#search-results > table { + padding: 0.5em 1em; + margin: 0; +} + +#search-results > ul > li { + border-bottom: 1px solid #b2d5fb; +} + +#search-results > ul > li > ul { + list-style: none; +} + +.search-module h4 { + margin: 0; +} + +.search-module > ul { + margin: 0.5em 0 0.5em 2em; +} + +.search-module > ul > li > a[href] { + display: block; + color: inherit; + padding: 0.25em 0.5em; +} + +.search-module > ul > li > a[href].active-link { + background: #faf9dc; +} + +.search-module a[href]:hover { + text-decoration: none; +} + +.search-result a a { + pointer-events: none; +} + +.search-result ul.subs { + display: inline-block; + margin: 0; padding: 0; +} + +.search-result ul.subs li { + display: none; +} + +.search-result ul.subs::after { + display: inline-block; + content: "..."; + color: rgb(78,98,114); + margin: 0 0.25em; +} + +.more-results { + color: rgb(99, 141, 173); + position: relative; +} + +.more-results::before { + content: "+"; + display: inline-block; + color: #b2d5fb; + font-weight: bold; + font-size: 1.25em; line-height: inherit; + position: absolute; + left: -1em; +} + +/* @end */ + +/* @group Keyboard shortcuts table */ + +.keyboard-shortcuts { + line-height: 1.6em; +} + +.keyboard-shortcuts th { + color: rgb(78,98,114); +} + +.keyboard-shortcuts td:first-child, +.keyboard-shortcuts th:first-child { + text-align: right; + padding-right: 0.6em; +} + +.key { + display: inline-block; + font-size: 0.9em; + min-width: 0.8em; line-height: 1.2em; + text-align: center; + background: #b2d5fb; + border: 1px solid #74a3d6; + padding: 0 0.2em; + margin: 0 0.1em; +} + +/* @end */ diff --git a/doc/API/Cabal/synopsis.png b/doc/API/Cabal/synopsis.png new file mode 100644 Binary files /dev/null and b/doc/API/Cabal/synopsis.png differ diff --git a/doc/conf.py b/doc/conf.py --- a/doc/conf.py +++ b/doc/conf.py @@ -13,7 +13,7 @@ sys.path.insert(0, os.path.abspath('.')) import cabaldomain -version = "2.4.0.0" +version = "2.4.0.1" extensions = ['sphinx.ext.extlinks', 'sphinx.ext.todo'] diff --git a/doc/users-guide/.buildinfo b/doc/users-guide/.buildinfo new file mode 100644 --- /dev/null +++ b/doc/users-guide/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: d0070ffe9a5b541bcdbedf442e6e7d9d +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/doc/users-guide/.doctrees/bugs-and-stability.doctree b/doc/users-guide/.doctrees/bugs-and-stability.doctree new file mode 100644 Binary files /dev/null and b/doc/users-guide/.doctrees/bugs-and-stability.doctree differ diff --git a/doc/users-guide/.doctrees/concepts-and-development.doctree b/doc/users-guide/.doctrees/concepts-and-development.doctree new file mode 100644 Binary files /dev/null and b/doc/users-guide/.doctrees/concepts-and-development.doctree differ diff --git a/doc/users-guide/.doctrees/config-and-install.doctree b/doc/users-guide/.doctrees/config-and-install.doctree new file mode 100644 Binary files /dev/null and b/doc/users-guide/.doctrees/config-and-install.doctree differ diff --git a/doc/users-guide/.doctrees/developing-packages.doctree b/doc/users-guide/.doctrees/developing-packages.doctree new file mode 100644 Binary files /dev/null and b/doc/users-guide/.doctrees/developing-packages.doctree differ diff --git a/doc/users-guide/.doctrees/environment.pickle b/doc/users-guide/.doctrees/environment.pickle new file mode 100644 Binary files /dev/null and b/doc/users-guide/.doctrees/environment.pickle differ diff --git a/doc/users-guide/.doctrees/file-format-changelog.doctree b/doc/users-guide/.doctrees/file-format-changelog.doctree new file mode 100644 Binary files /dev/null and b/doc/users-guide/.doctrees/file-format-changelog.doctree differ diff --git a/doc/users-guide/.doctrees/index.doctree b/doc/users-guide/.doctrees/index.doctree new file mode 100644 Binary files /dev/null and b/doc/users-guide/.doctrees/index.doctree differ diff --git a/doc/users-guide/.doctrees/installing-packages.doctree b/doc/users-guide/.doctrees/installing-packages.doctree new file mode 100644 Binary files /dev/null and b/doc/users-guide/.doctrees/installing-packages.doctree differ diff --git a/doc/users-guide/.doctrees/intro.doctree b/doc/users-guide/.doctrees/intro.doctree new file mode 100644 Binary files /dev/null and b/doc/users-guide/.doctrees/intro.doctree differ diff --git a/doc/users-guide/.doctrees/misc.doctree b/doc/users-guide/.doctrees/misc.doctree new file mode 100644 Binary files /dev/null and b/doc/users-guide/.doctrees/misc.doctree differ diff --git a/doc/users-guide/.doctrees/nix-integration.doctree b/doc/users-guide/.doctrees/nix-integration.doctree new file mode 100644 Binary files /dev/null and b/doc/users-guide/.doctrees/nix-integration.doctree differ diff --git a/doc/users-guide/.doctrees/nix-local-build-overview.doctree b/doc/users-guide/.doctrees/nix-local-build-overview.doctree new file mode 100644 Binary files /dev/null and b/doc/users-guide/.doctrees/nix-local-build-overview.doctree differ diff --git a/doc/users-guide/.doctrees/nix-local-build.doctree b/doc/users-guide/.doctrees/nix-local-build.doctree new file mode 100644 Binary files /dev/null and b/doc/users-guide/.doctrees/nix-local-build.doctree differ diff --git a/doc/users-guide/_sources/bugs-and-stability.rst.txt b/doc/users-guide/_sources/bugs-and-stability.rst.txt new file mode 100644 --- /dev/null +++ b/doc/users-guide/_sources/bugs-and-stability.rst.txt @@ -0,0 +1,6 @@ +Reporting Bugs and Stability of Cabal Interfaces +================================================ + +.. toctree:: + misc + diff --git a/doc/users-guide/_sources/concepts-and-development.rst.txt b/doc/users-guide/_sources/concepts-and-development.rst.txt new file mode 100644 --- /dev/null +++ b/doc/users-guide/_sources/concepts-and-development.rst.txt @@ -0,0 +1,7 @@ +Package Concepts and Development +================================ + +.. toctree:: + :maxdepth: 2 + + developing-packages diff --git a/doc/users-guide/_sources/config-and-install.rst.txt b/doc/users-guide/_sources/config-and-install.rst.txt new file mode 100644 --- /dev/null +++ b/doc/users-guide/_sources/config-and-install.rst.txt @@ -0,0 +1,5 @@ +Configuration and Installing Packages +===================================== + +.. toctree:: + installing-packages diff --git a/doc/users-guide/_sources/developing-packages.rst.txt b/doc/users-guide/_sources/developing-packages.rst.txt new file mode 100644 --- /dev/null +++ b/doc/users-guide/_sources/developing-packages.rst.txt @@ -0,0 +1,3480 @@ +Quickstart +========== + +Lets assume we have created a project directory and already have a +Haskell module or two. + +Every project needs a name, we'll call this example "proglet". + +.. highlight:: console + +:: + + $ cd proglet/ + $ ls + Proglet.hs + +It is assumed that (apart from external dependencies) all the files that +make up a package live under a common project root directory. This +simple example has all the project files in one directory, but most +packages will use one or more subdirectories. + +To turn this into a Cabal package we need two extra files in the +project's root directory: + +- ``proglet.cabal``: containing package metadata and build information. + +- ``Setup.hs``: usually containing a few standardized lines of code, + but can be customized if necessary. + +We can create both files manually or we can use ``cabal init`` to create +them for us. + +Using "cabal init" +------------------ + +The ``cabal init`` command is interactive. It asks us a number of +questions starting with the package name and version. + +:: + + $ cabal init + Package name [default "proglet"]? + Package version [default "0.1"]? + ... + +It also asks questions about various other bits of package metadata. For +a package that you never intend to distribute to others, these fields +can be left blank. + +One of the important questions is whether the package contains a library +or an executable. Libraries are collections of Haskell modules that can +be re-used by other Haskell libraries and programs, while executables +are standalone programs. + +:: + + What does the package build: + 1) Library + 2) Executable + Your choice? + +For the moment these are the only choices. For more complex packages +(e.g. a library and multiple executables or test suites) the ``.cabal`` +file can be edited afterwards. + +Finally, ``cabal init`` creates the initial ``proglet.cabal`` and +``Setup.hs`` files, and depending on your choice of license, a +``LICENSE`` file as well. + +:: + + Generating LICENSE... + Generating Setup.hs... + Generating proglet.cabal... + + You may want to edit the .cabal file and add a Description field. + +As this stage the ``proglet.cabal`` is not quite complete and before you +are able to build the package you will need to edit the file and add +some build information about the library or executable. + +Editing the .cabal file +----------------------- + +.. highlight:: cabal + +Load up the ``.cabal`` file in a text editor. The first part of the +``.cabal`` file has the package metadata and towards the end of the file +you will find the :pkg-section:`executable` or :pkg-section:`library` section. + +You will see that the fields that have yet to be filled in are commented +out. Cabal files use "``--``" Haskell-style comment syntax. (Note that +comments are only allowed on lines on their own. Trailing comments on +other lines are not allowed because they could be confused with program +options.) + +If you selected earlier to create a library package then your ``.cabal`` +file will have a section that looks like this: + +:: + + library + exposed-modules: Proglet + -- other-modules: + -- build-depends: + +Alternatively, if you selected an executable then there will be a +section like: + +:: + + executable proglet + -- main-is: + -- other-modules: + -- build-depends: + +The build information fields listed (but commented out) are just the few +most important and common fields. There are many others that are covered +later in this chapter. + +Most of the build information fields are the same between libraries and +executables. The difference is that libraries have a number of "exposed" +modules that make up the public interface of the library, while +executables have a file containing a ``Main`` module. + +The name of a library always matches the name of the package, so it is +not specified in the library section. Executables often follow the name +of the package too, but this is not required and the name is given +explicitly. + +Modules included in the package +------------------------------- + +For a library, ``cabal init`` looks in the project directory for files +that look like Haskell modules and adds all the modules to the +:pkg-field:`library:exposed-modules` field. For modules that do not form part +of your package's public interface, you can move those modules to the +:pkg-field:`other-modules` field. Either way, all modules in the library need +to be listed. + +For an executable, ``cabal init`` does not try to guess which file +contains your program's ``Main`` module. You will need to fill in the +:pkg-field:`executable:main-is` field with the file name of your program's +``Main`` module (including ``.hs`` or ``.lhs`` extension). Other modules +included in the executable should be listed in the :pkg-field:`other-modules` +field. + +Modules imported from other packages +------------------------------------ + +While your library or executable may include a number of modules, it +almost certainly also imports a number of external modules from the +standard libraries or other pre-packaged libraries. (These other +libraries are of course just Cabal packages that contain a library.) + +You have to list all of the library packages that your library or +executable imports modules from. Or to put it another way: you have to +list all the other packages that your package depends on. + +For example, suppose the example ``Proglet`` module imports the module +``Data.Map``. The ``Data.Map`` module comes from the ``containers`` +package, so we must list it: + +:: + + library + exposed-modules: Proglet + other-modules: + build-depends: containers, base == 4.* + +In addition, almost every package also depends on the ``base`` library +package because it exports the standard ``Prelude`` module plus other +basic modules like ``Data.List``. + +You will notice that we have listed ``base == 4.*``. This gives a +constraint on the version of the base package that our package will work +with. The most common kinds of constraints are: + +- ``pkgname >= n`` +- ``pkgname ^>= n`` (since Cabal 2.0) +- ``pkgname >= n && < m`` +- ``pkgname == n.*`` (since Cabal 1.6) + +The last is just shorthand, for example ``base == 4.*`` means exactly +the same thing as ``base >= 4 && < 5``. Please refer to the documentation +on the :pkg-field:`build-depends` field for more information. + +Building the package +-------------------- + +For simple packages that's it! We can now try configuring and building +the package: + +.. code-block:: console + + $ cabal configure + $ cabal build + +Assuming those two steps worked then you can also install the package: + +.. code-block:: console + + $ cabal install + +For libraries this makes them available for use in GHCi or to be used by +other packages. For executables it installs the program so that you can +run it (though you may first need to adjust your system's ``$PATH``). + +Next steps +---------- + +What we have covered so far should be enough for very simple packages +that you use on your own system. + +The next few sections cover more details needed for more complex +packages and details needed for distributing packages to other people. + +The previous chapter covers building and installing packages -- your own +packages or ones developed by other people. + +Package concepts +================ + +Before diving into the details of writing packages it helps to +understand a bit about packages in the Haskell world and the particular +approach that Cabal takes. + +The point of packages +--------------------- + +Packages are a mechanism for organising and distributing code. Packages +are particularly suited for "programming in the large", that is building +big systems by using and re-using code written by different people at +different times. + +People organise code into packages based on functionality and +dependencies. Social factors are also important: most packages have a +single author, or a relatively small team of authors. + +Packages are also used for distribution: the idea is that a package can +be created in one place and be moved to a different computer and be +usable in that different environment. There are a surprising number of +details that have to be got right for this to work, and a good package +system helps to simply this process and make it reliable. + +Packages come in two main flavours: libraries of reusable code, and +complete programs. Libraries present a code interface, an API, while +programs can be run directly. In the Haskell world, library packages +expose a set of Haskell modules as their public interface. Cabal +packages can contain a library or executables or both. + +Some programming languages have packages as a builtin language concept. +For example in Java, a package provides a local namespace for types and +other definitions. In the Haskell world, packages are not a part of the +language itself. Haskell programs consist of a number of modules, and +packages just provide a way to partition the modules into sets of +related functionality. Thus the choice of module names in Haskell is +still important, even when using packages. + +Package names and versions +-------------------------- + +All packages have a name, e.g. "HUnit". Package names are assumed to be +unique. Cabal package names may contain letters, numbers and hyphens, +but not spaces and may also not contain a hyphened section consisting of +only numbers. The namespace for Cabal packages is flat, not +hierarchical. + +Packages also have a version, e.g "1.1". This matches the typical way in +which packages are developed. Strictly speaking, each version of a +package is independent, but usually they are very similar. Cabal package +versions follow the conventional numeric style, consisting of a sequence +of digits such as "1.0.1" or "2.0". There are a range of common +conventions for "versioning" packages, that is giving some meaning to +the version number in terms of changes in the package, such as +e.g. `SemVer `__; however, for packages intended to be +distributed via Hackage Haskell's `Package Versioning Policy`_ applies +(see also the `PVP/SemVer FAQ section `__). + +The combination of package name and version is called the *package ID* +and is written with a hyphen to separate the name and version, e.g. +"HUnit-1.1". + +For Cabal packages, the combination of the package name and version +*uniquely* identifies each package. Or to put it another way: two +packages with the same name and version are considered to *be* the same. + +Strictly speaking, the package ID only identifies each Cabal *source* +package; the same Cabal source package can be configured and built in +different ways. There is a separate installed package ID that uniquely +identifies each installed package instance. Most of the time however, +users need not be aware of this detail. + +Kinds of package: Cabal vs GHC vs system +---------------------------------------- + +It can be slightly confusing at first because there are various +different notions of package floating around. Fortunately the details +are not very complicated. + +Cabal packages + Cabal packages are really source packages. That is they contain + Haskell (and sometimes C) source code. + + Cabal packages can be compiled to produce GHC packages. They can + also be translated into operating system packages. + +GHC packages + This is GHC's view on packages. GHC only cares about library + packages, not executables. Library packages have to be registered + with GHC for them to be available in GHCi or to be used when + compiling other programs or packages. + + The low-level tool ``ghc-pkg`` is used to register GHC packages and + to get information on what packages are currently registered. + + You never need to make GHC packages manually. When you build and + install a Cabal package containing a library then it gets registered + with GHC automatically. + + Haskell implementations other than GHC have essentially the same + concept of registered packages. For the most part, Cabal hides the + slight differences. + +Operating system packages + On operating systems like Linux and Mac OS X, the system has a + specific notion of a package and there are tools for installing and + managing packages. + + The Cabal package format is designed to allow Cabal packages to be + translated, mostly-automatically, into operating system packages. + They are usually translated 1:1, that is a single Cabal package + becomes a single system package. + + It is also possible to make Windows installers from Cabal packages, + though this is typically done for a program together with all of its + library dependencies, rather than packaging each library separately. + +Unit of distribution +-------------------- + +The Cabal package is the unit of distribution. What this means is that +each Cabal package can be distributed on its own in source or binary +form. Of course there may dependencies between packages, but there is +usually a degree of flexibility in which versions of packages can work +together so distributing them independently makes sense. + +It is perhaps easiest to see what being "the unit of distribution" +means by contrast to an alternative approach. Many projects are made up +of several interdependent packages and during development these might +all be kept under one common directory tree and be built and tested +together. When it comes to distribution however, rather than +distributing them all together in a single tarball, it is required that +they each be distributed independently in their own tarballs. + +Cabal's approach is to say that if you can specify a dependency on a +package then that package should be able to be distributed +independently. Or to put it the other way round, if you want to +distribute it as a single unit, then it should be a single package. + +Explicit dependencies and automatic package management +------------------------------------------------------ + +Cabal takes the approach that all packages dependencies are specified +explicitly and specified in a declarative way. The point is to enable +automatic package management. This means tools like ``cabal`` can +resolve dependencies and install a package plus all of its dependencies +automatically. Alternatively, it is possible to mechanically (or mostly +mechanically) translate Cabal packages into system packages and let the +system package manager install dependencies automatically. + +It is important to track dependencies accurately so that packages can +reliably be moved from one system to another system and still be able to +build it there. Cabal is therefore relatively strict about specifying +dependencies. For example Cabal's default build system will not even let +code build if it tries to import a module from a package that isn't +listed in the ``.cabal`` file, even if that package is actually +installed. This helps to ensure that there are no "untracked +dependencies" that could cause the code to fail to build on some other +system. + +The explicit dependency approach is in contrast to the traditional +"./configure" approach where instead of specifying dependencies +declaratively, the ``./configure`` script checks if the dependencies are +present on the system. Some manual work is required to transform a +``./configure`` based package into a Linux distribution package (or +similar). This conversion work is usually done by people other than the +package author(s). The practical effect of this is that only the most +popular packages will benefit from automatic package management. +Instead, Cabal forces the original author to specify the dependencies +but the advantage is that every package can benefit from automatic +package management. + +The "./configure" approach tends to encourage packages that adapt +themselves to the environment in which they are built, for example by +disabling optional features so that they can continue to work when a +particular dependency is not available. This approach makes sense in a +world where installing additional dependencies is a tiresome manual +process and so minimising dependencies is important. The automatic +package management view is that packages should just declare what they +need and the package manager will take responsibility for ensuring that +all the dependencies are installed. + +Sometimes of course optional features and optional dependencies do make +sense. Cabal packages can have optional features and varying +dependencies. These conditional dependencies are still specified in a +declarative way however and remain compatible with automatic package +management. The need to remain compatible with automatic package +management means that Cabal's conditional dependencies system is a bit +less flexible than with the "./configure" approach. + +.. note:: + `GNU autoconf places restrictions on paths, including the + path that the user builds a package from. + `_ + Package authors using ``build-type: configure`` should be aware of + these restrictions; because users may be unexpectedly constrained and + face mysterious errors, it is recommended that ``build-type: configure`` + is only used where strictly necessary. + +Portability +----------- + +One of the purposes of Cabal is to make it easier to build packages on +different platforms (operating systems and CPU architectures), with +different compiler versions and indeed even with different Haskell +implementations. (Yes, there are Haskell implementations other than +GHC!) + +Cabal provides abstractions of features present in different Haskell +implementations and wherever possible it is best to take advantage of +these to increase portability. Where necessary however it is possible to +use specific features of specific implementations. + +For example a package author can list in the package's ``.cabal`` what +language extensions the code uses. This allows Cabal to figure out if +the language extension is supported by the Haskell implementation that +the user picks. Additionally, certain language extensions such as +Template Haskell require special handling from the build system and by +listing the extension it provides the build system with enough +information to do the right thing. + +Another similar example is linking with foreign libraries. Rather than +specifying GHC flags directly, the package author can list the libraries +that are needed and the build system will take care of using the right +flags for the compiler. Additionally this makes it easier for tools to +discover what system C libraries a package needs, which is useful for +tracking dependencies on system libraries (e.g. when translating into +Linux distribution packages). + +In fact both of these examples fall into the category of explicitly +specifying dependencies. Not all dependencies are other Cabal packages. +Foreign libraries are clearly another kind of dependency. It's also +possible to think of language extensions as dependencies: the package +depends on a Haskell implementation that supports all those extensions. + +Where compiler-specific options are needed however, there is an "escape +hatch" available. The developer can specify implementation-specific +options and more generally there is a configuration mechanism to +customise many aspects of how a package is built depending on the +Haskell implementation, the operating system, computer architecture and +user-specified configuration flags. + +Developing packages +=================== + +The Cabal package is the unit of distribution. When installed, its +purpose is to make available: + +- One or more Haskell programs. + +- At most one library, exposing a number of Haskell modules. + +However having both a library and executables in a package does not work +very well; if the executables depend on the library, they must +explicitly list all the modules they directly or indirectly import from +that library. Fortunately, starting with Cabal 1.8.0.4, executables can +also declare the package that they are in as a dependency, and Cabal +will treat them as if they were in another package that depended on the +library. + +Internally, the package may consist of much more than a bunch of Haskell +modules: it may also have C source code and header files, source code +meant for preprocessing, documentation, test cases, auxiliary tools etc. + +A package is identified by a globally-unique *package name*, which +consists of one or more alphanumeric words separated by hyphens. To +avoid ambiguity, each of these words should contain at least one letter. +Chaos will result if two distinct packages with the same name are +installed on the same system. A particular version of the package is +distinguished by a *version number*, consisting of a sequence of one or +more integers separated by dots. These can be combined to form a single +text string called the *package ID*, using a hyphen to separate the name +from the version, e.g. "``HUnit-1.1``". + +.. Note:: + + Packages are not part of the Haskell language; they simply + populate the hierarchical space of module names. In GHC 6.6 and later a + program may contain multiple modules with the same name if they come + from separate packages; in all other current Haskell systems packages + may not overlap in the modules they provide, including hidden modules. + +Creating a package +------------------ + +Suppose you have a directory hierarchy containing the source files that +make up your package. You will need to add two more files to the root +directory of the package: + +:file:`{package-name}.cabal` + a Unicode UTF-8 text file containing a package description. For + details of the syntax of this file, see the section on + `package descriptions`_. + +:file:`Setup.hs` + a single-module Haskell program to perform various setup tasks (with + the interface described in the section on :ref:`installing-packages`). + This module should import only modules that will be present in all Haskell + implementations, including modules of the Cabal library. The content of + this file is determined by the :pkg-field:`build-type` setting in the + ``.cabal`` file. In most cases it will be trivial, calling on the Cabal + library to do most of the work. + +Once you have these, you can create a source bundle of this directory +for distribution. Building of the package is discussed in the section on +:ref:`installing-packages`. + +One of the purposes of Cabal is to make it easier to build a package +with different Haskell implementations. So it provides abstractions of +features present in different Haskell implementations and wherever +possible it is best to take advantage of these to increase portability. +Where necessary however it is possible to use specific features of +specific implementations. For example one of the pieces of information a +package author can put in the package's ``.cabal`` file is what language +extensions the code uses. This is far preferable to specifying flags for +a specific compiler as it allows Cabal to pick the right flags for the +Haskell implementation that the user picks. It also allows Cabal to +figure out if the language extension is even supported by the Haskell +implementation that the user picks. Where compiler-specific options are +needed however, there is an "escape hatch" available. The developer can +specify implementation-specific options and more generally there is a +configuration mechanism to customise many aspects of how a package is +built depending on the Haskell implementation, the Operating system, +computer architecture and user-specified configuration flags. + +:: + + name: Foo + version: 1.0 + + library + build-depends: base >= 4 && < 5 + exposed-modules: Foo + extensions: ForeignFunctionInterface + ghc-options: -Wall + if os(windows) + build-depends: Win32 >= 2.1 && < 2.6 + +Example: A package containing a simple library +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The HUnit package contains a file ``HUnit.cabal`` containing: + +:: + + name: HUnit + version: 1.1.1 + synopsis: A unit testing framework for Haskell + homepage: http://hunit.sourceforge.net/ + category: Testing + author: Dean Herington + license: BSD3 + license-file: LICENSE + cabal-version: >= 1.10 + build-type: Simple + + library + build-depends: base >= 2 && < 4 + exposed-modules: Test.HUnit.Base, Test.HUnit.Lang, + Test.HUnit.Terminal, Test.HUnit.Text, Test.HUnit + default-extensions: CPP + +and the following ``Setup.hs``: + +.. code-block:: haskell + + import Distribution.Simple + main = defaultMain + +Example: A package containing executable programs +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:: + + name: TestPackage + version: 0.0 + synopsis: Small package with two programs + author: Angela Author + license: BSD3 + build-type: Simple + cabal-version: >= 1.8 + + executable program1 + build-depends: HUnit >= 1.1.1 && < 1.2 + main-is: Main.hs + hs-source-dirs: prog1 + + executable program2 + main-is: Main.hs + build-depends: HUnit >= 1.1.1 && < 1.2 + hs-source-dirs: prog2 + other-modules: Utils + +with ``Setup.hs`` the same as above. + +Example: A package containing a library and executable programs +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:: + + name: TestPackage + version: 0.0 + synopsis: Package with library and two programs + license: BSD3 + author: Angela Author + build-type: Simple + cabal-version: >= 1.8 + + library + build-depends: HUnit >= 1.1.1 && < 1.2 + exposed-modules: A, B, C + + executable program1 + main-is: Main.hs + hs-source-dirs: prog1 + other-modules: A, B + + executable program2 + main-is: Main.hs + hs-source-dirs: prog2 + other-modules: A, C, Utils + +with ``Setup.hs`` the same as above. Note that any library modules +required (directly or indirectly) by an executable must be listed again. + +The trivial setup script used in these examples uses the *simple build +infrastructure* provided by the Cabal library (see +`Distribution.Simple <../release/cabal-latest/doc/API/Cabal/Distribution-Simple.html>`__). +The simplicity lies in its interface rather that its implementation. It +automatically handles preprocessing with standard preprocessors, and +builds packages for all the Haskell implementations. + +The simple build infrastructure can also handle packages where building +is governed by system-dependent parameters, if you specify a little more +(see the section on `system-dependent parameters`_). +A few packages require `more elaborate solutions `_. + +Package descriptions +-------------------- + +The package description file must have a name ending in "``.cabal``". It +must be a Unicode text file encoded using valid UTF-8. There must be +exactly one such file in the directory. The first part of the name is +usually the package name, and some of the tools that operate on Cabal +packages require this; specifically, Hackage rejects packages which +don't follow this rule. + +In the package description file, lines whose first non-whitespace +characters are "``--``" are treated as comments and ignored. + +This file should contain of a number global property descriptions and +several sections. + +- The `package properties`_ describe the package + as a whole, such as name, license, author, etc. + +- Optionally, a number of *configuration flags* can be declared. These + can be used to enable or disable certain features of a package. (see + the section on `configurations`_). + +- The (optional) library section specifies the `library`_ properties and + relevant `build information`_. + +- Following is an arbitrary number of executable sections which describe + an executable program and relevant `build information`_. + +Each section consists of a number of property descriptions in the form +of field/value pairs, with a syntax roughly like mail message headers. + +- Case is not significant in field names, but is significant in field + values. + +- To continue a field value, indent the next line relative to the field + name. + +- Field names may be indented, but all field values in the same section + must use the same indentation. + +- Tabs are *not* allowed as indentation characters due to a missing + standard interpretation of tab width. + +- To get a blank line in a field value, use an indented "``.``" + +The syntax of the value depends on the field. Field types include: + +*token*, *filename*, *directory* + Either a sequence of one or more non-space non-comma characters, or + a quoted string in Haskell 98 lexical syntax. The latter can be used + for escaping whitespace, for example: + ``ghc-options: -Wall "-with-rtsopts=-T -I1"``. Unless otherwise + stated, relative filenames and directories are interpreted from the + package root directory. +*freeform*, *URL*, *address* + An arbitrary, uninterpreted string. +*identifier* + A letter followed by zero or more alphanumerics or underscores. +*compiler* + A compiler flavor (one of: ``GHC``, ``UHC`` or ``LHC``) + followed by a version range. For example, ``GHC ==6.10.3``, or + ``LHC >=0.6 && <0.8``. + +Modules and preprocessors +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Haskell module names listed in the :pkg-field:`library:exposed-modules` and +:pkg-field:`library:other-modules` fields may correspond to Haskell source +files, i.e. with names ending in "``.hs``" or "``.lhs``", or to inputs for +various Haskell preprocessors. The simple build infrastructure understands the +extensions: + +- ``.gc`` (:hackage-pkg:`greencard`) +- ``.chs`` (:hackage-pkg:`c2hs`) +- ``.hsc`` (:hackage-pkg:`hsc2hs`) +- ``.y`` and ``.ly`` (happy_) +- ``.x`` (alex_) +- ``.cpphs`` (cpphs_) + +When building, Cabal will automatically run the appropriate preprocessor +and compile the Haskell module it produces. For the ``c2hs`` and +``hsc2hs`` preprocessors, Cabal will also automatically add, compile and +link any C sources generated by the preprocessor (produced by +``hsc2hs``'s ``#def`` feature or ``c2hs``'s auto-generated wrapper +functions). Dependencies on pre-processors are specified via the +:pkg-field:`build-tools` or :pkg-field:`build-tool-depends` fields. + +Some fields take lists of values, which are optionally separated by +commas, except for the :pkg-field:`build-depends` field, where the commas are +mandatory. + +Some fields are marked as required. All others are optional, and unless +otherwise specified have empty default values. + +Package properties +^^^^^^^^^^^^^^^^^^ + +These fields may occur in the first top-level properties section and +describe the package as a whole: + +.. pkg-field:: name: package-name (required) + + The unique name of the package, without the version number. + + As pointed out in the section on `package descriptions`_, some + tools require the package-name specified for this field to match + the package description's file-name :file:`{package-name}.cabal`. + + Package names are case-sensitive and must match the regular expression + (i.e. alphanumeric "words" separated by dashes; each alphanumeric + word must contain at least one letter): + ``[[:digit:]]*[[:alpha:]][[:alnum:]]*(-[[:digit:]]*[[:alpha:]][[:alnum:]]*)*``. + + Or, expressed in ABNF_: + + .. code-block:: abnf + + package-name = package-name-part *("-" package-name-part) + package-name-part = *DIGIT UALPHA *UALNUM + + UALNUM = UALPHA / DIGIT + UALPHA = ... ; set of alphabetic Unicode code-points + + .. note:: + + Hackage restricts package names to the ASCII subset. + +.. pkg-field:: version: numbers (required) + + The package version number, usually consisting of a sequence of + natural numbers separated by dots, i.e. as the regular + expression ``[0-9]+([.][0-9]+)*`` or expressed in ABNF_: + + .. code-block:: abnf + + package-version = 1*DIGIT *("." 1*DIGIT) + +.. pkg-field:: cabal-version: >= x.y + + The version of the Cabal specification that this package description + uses. The Cabal specification does slowly evolve, introducing new + features and occasionally changing the meaning of existing features. + By specifying which version of the spec you are using it enables + programs which process the package description to know what syntax + to expect and what each part means. + + For historical reasons this is always expressed using *>=* version + range syntax. No other kinds of version range make sense, in + particular upper bounds do not make sense. In future this field will + specify just a version number, rather than a version range. + + The version number you specify will affect both compatibility and + behaviour. Most tools (including the Cabal library and cabal + program) understand a range of versions of the Cabal specification. + Older tools will of course only work with older versions of the + Cabal specification. Most of the time, tools that are too old will + recognise this fact and produce a suitable error message. + + As for behaviour, new versions of the Cabal spec can change the + meaning of existing syntax. This means if you want to take advantage + of the new meaning or behaviour then you must specify the newer + Cabal version. Tools are expected to use the meaning and behaviour + appropriate to the version given in the package description. + + In particular, the syntax of package descriptions changed + significantly with Cabal version 1.2 and the :pkg-field:`cabal-version` + field is now required. Files written in the old syntax are still + recognized, so if you require compatibility with very old Cabal + versions then you may write your package description file using the + old syntax. Please consult the user's guide of an older Cabal + version for a description of that syntax. + +.. pkg-field:: build-type: identifier + + :default: ``Custom`` or ``Simple`` + + The type of build used by this package. Build types are the + constructors of the + `BuildType <../release/cabal-latest/doc/API/Cabal/Distribution-PackageDescription.html#t:BuildType>`__ + type. This field is optional and when missing, its default value + is inferred according to the following rules: + + - When :pkg-field:`cabal-version` is set to ``2.2`` or higher, + the default is ``Simple`` unless a :pkg-section:`custom-setup` + exists, in which case the inferred default is ``Custom``. + + - For lower :pkg-field:`cabal-version` values, the default is + ``Custom`` unconditionally. + + If the build type is anything other than ``Custom``, then the + ``Setup.hs`` file *must* be exactly the standardized content + discussed below. This is because in these cases, ``cabal`` will + ignore the ``Setup.hs`` file completely, whereas other methods of + package management, such as ``runhaskell Setup.hs [CMD]``, still + rely on the ``Setup.hs`` file. + + For build type ``Simple``, the contents of ``Setup.hs`` must be: + + .. code-block:: haskell + + import Distribution.Simple + main = defaultMain + + For build type ``Configure`` (see the section on `system-dependent + parameters`_ below), the contents of + ``Setup.hs`` must be: + + .. code-block:: haskell + + import Distribution.Simple + main = defaultMainWithHooks autoconfUserHooks + + For build type ``Make`` (see the section on `more complex packages`_ below), + the contents of ``Setup.hs`` must be: + + .. code-block:: haskell + + import Distribution.Make + main = defaultMain + + For build type ``Custom``, the file ``Setup.hs`` can be customized, + and will be used both by ``cabal`` and other tools. + + For most packages, the build type ``Simple`` is sufficient. + +.. pkg-field:: license: identifier + + :default: ``AllRightsReserved`` + + The type of license under which this package is distributed. License + names are the constants of the + `License <../release/cabal-latest/doc/API/Cabal/Distribution-License.html#t:License>`__ + type. + +.. pkg-field:: license-file: filename +.. pkg-field:: license-files: filename list + + The name of a file(s) containing the precise copyright license for + this package. The license file(s) will be installed with the + package. + + If you have multiple license files then use the :pkg-field:`license-files` + field instead of (or in addition to) the :pkg-field:`license-file` field. + +.. pkg-field:: copyright: freeform + + The content of a copyright notice, typically the name of the holder + of the copyright on the package and the year(s) from which copyright + is claimed. For example:: + + copyright: (c) 2006-2007 Joe Bloggs + +.. pkg-field:: author: freeform + + The original author of the package. + + Remember that ``.cabal`` files are Unicode, using the UTF-8 + encoding. + +.. pkg-field:: maintainer: address + + The current maintainer or maintainers of the package. This is an + e-mail address to which users should send bug reports, feature + requests and patches. + +.. pkg-field:: stability: freeform + + The stability level of the package, e.g. ``alpha``, + ``experimental``, ``provisional``, ``stable``. + +.. pkg-field:: homepage: URL + + The package homepage. + +.. pkg-field:: bug-reports: URL + + The URL where users should direct bug reports. This would normally + be either: + + - A ``mailto:`` URL, e.g. for a person or a mailing list. + + - An ``http:`` (or ``https:``) URL for an online bug tracking + system. + + For example Cabal itself uses a web-based bug tracking system + + :: + + bug-reports: https://github.com/haskell/cabal/issues + +.. pkg-field:: package-url: URL + + The location of a source bundle for the package. The distribution + should be a Cabal package. + +.. pkg-field:: synopsis: freeform + + A very short description of the package, for use in a table of + packages. This is your headline, so keep it short (one line) but as + informative as possible. Save space by not including the package + name or saying it's written in Haskell. + +.. pkg-field:: description: freeform + + Description of the package. This may be several paragraphs, and + should be aimed at a Haskell programmer who has never heard of your + package before. + + For library packages, this field is used as prologue text by + :ref:`setup-haddock` and thus may contain the same markup as Haddock_ + documentation comments. + +.. pkg-field:: category: freeform + + A classification category for future use by the package catalogue + Hackage_. These categories have not + yet been specified, but the upper levels of the module hierarchy + make a good start. + +.. pkg-field:: tested-with: compiler list + + A list of compilers and versions against which the package has been + tested (or at least built). + +.. pkg-field:: data-files: filename list + + A list of files to be installed for run-time use by the package. + This is useful for packages that use a large amount of static data, + such as tables of values or code templates. Cabal provides a way to + `find these files at run-time <#accessing-data-files-from-package-code>`_. + + A limited form of ``*`` wildcards in file names, for example + ``data-files: images/*.png`` matches all the ``.png`` files in the + ``images`` directory. ``data-files: audio/**/*.mp3`` matches all + the ``.mp3`` files in the ``audio`` directory, including + subdirectories. + + The specific limitations of this wildcard syntax are + + - ``*`` wildcards are only allowed in place of the file name, not + in the directory name or file extension. It must replace the + whole file name (e.g., ``*.html`` is allowed, but + ``chapter-*.html`` is not). If a wildcard is used, it must be + used with an extension, so ``data-files: data/*`` is not + allowed. + + - Prior to Cabal 2.4, when matching a wildcard plus extension, a + file's full extension must match exactly, so ``*.gz`` matches + ``foo.gz`` but not ``foo.tar.gz``. This restriction has been + lifted when ``cabal-version: 2.4`` or greater so that ``*.gz`` + does match ``foo.tar.gz`` + + - ``*`` wildcards will not match if the file name is empty (e.g., + ``*.html`` will not match ``foo/.html``). + + - ``**`` wildcards can only appear as the final path component + before the file name (e.g., ``data/**/images/*.jpg`` is not + allowed). If a ``**`` wildcard is used, then the file name must + include a ``*`` wildcard (e.g., ``data/**/README.rst`` is not + allowed). + + - A wildcard that does not match any files is an error. + + The reason for providing only a very limited form of wildcard is to + concisely express the common case of a large number of related files + of the same file type without making it too easy to accidentally + include unwanted files. + + On efficiency: if you use ``**`` patterns, the directory tree will + be walked starting with the parent directory of the ``**``. If + that's the root of the project, this might include ``.git/``, + ``dist-newstyle/``, or other large directories! To avoid this + behaviour, put the files that wildcards will match against in + their own folder. + + ``**`` wildcards are available starting in Cabal 2.4. + +.. pkg-field:: data-dir: directory + + The directory where Cabal looks for data files to install, relative + to the source directory. By default, Cabal will look in the source + directory itself. + +.. pkg-field:: extra-source-files: filename list + + A list of additional files to be included in source distributions + built with :ref:`setup-sdist`. As with :pkg-field:`data-files` it can use + a limited form of ``*`` wildcards in file names. + +.. pkg-field:: extra-doc-files: filename list + + A list of additional files to be included in source distributions, + and also copied to the html directory when Haddock documentation is + generated. As with :pkg-field:`data-files` it can use a limited form of + ``*`` wildcards in file names. + +.. pkg-field:: extra-tmp-files: filename list + + A list of additional files or directories to be removed by + :ref:`setup-clean`. These would typically be additional files created by + additional hooks, such as the scheme described in the section on + `system-dependent parameters`_ + +Library +^^^^^^^ + +.. pkg-section:: library name + :synopsis: Library build information. + + Build information for libraries. + + Currently, there can only be one publicly exposed library in a + package, and its name is the same as package name set by global + :pkg-field:`name` field. In this case, the ``name`` argument to + the :pkg-section:`library` section must be omitted. + + Starting with Cabal 2.0, private internal sub-library components + can be defined by using setting the ``name`` field to a name + different from the current package's name; see section on + :ref:`Internal Libraries ` for more information. + +The library section should contain the following fields: + +.. pkg-field:: exposed-modules: identifier list + + :required: if this package contains a library + + A list of modules added by this package. + +.. pkg-field:: virtual-modules: identifier list + :since: 2.2 + + A list of virtual modules provided by this package. Virtual modules + are modules without a source file. See for example the ``GHC.Prim`` + module from the ``ghc-prim`` package. Modules listed here will not be + built, but still end up in the list of ``exposed-modules`` in the + installed package info when the package is registered in the package + database. + +.. pkg-field:: exposed: boolean + + :default: ``True`` + + Some Haskell compilers (notably GHC) support the notion of packages + being "exposed" or "hidden" which means the modules they provide can + be easily imported without always having to specify which package + they come from. However this only works effectively if the modules + provided by all exposed packages do not overlap (otherwise a module + import would be ambiguous). + + Almost all new libraries use hierarchical module names that do not + clash, so it is very uncommon to have to use this field. However it + may be necessary to set ``exposed: False`` for some old libraries + that use a flat module namespace or where it is known that the + exposed modules would clash with other common modules. + +.. pkg-field:: reexported-modules: exportlist + :since: 1.22 + + Supported only in GHC 7.10 and later. A list of modules to + *reexport* from this package. The syntax of this field is + ``orig-pkg:Name as NewName`` to reexport module ``Name`` from + ``orig-pkg`` with the new name ``NewName``. We also support + abbreviated versions of the syntax: if you omit ``as NewName``, + we'll reexport without renaming; if you omit ``orig-pkg``, then we + will automatically figure out which package to reexport from, if + it's unambiguous. + + Reexported modules are useful for compatibility shims when a package + has been split into multiple packages, and they have the useful + property that if a package provides a module, and another package + reexports it under the same name, these are not considered a + conflict (as would be the case with a stub module.) They can also be + used to resolve name conflicts. + +.. pkg-field:: signatures: signature list + :since: 2.0 + + Supported only in GHC 8.2 and later. A list of `module signatures `__ required by this package. + + Module signatures are part of the + `Backpack `__ extension to + the Haskell module system. + + Packages that do not export any modules and only export required signatures + are called "signature-only packages", and their signatures are subjected to + `signature thinning + `__. + + + +The library section may also contain build information fields (see the +section on `build information`_). + +.. _sublibs: + +**Internal Libraries** + +Cabal 2.0 and later support "internal libraries", which are extra named +libraries (as opposed to the usual unnamed library section). For +example, suppose that your test suite needs access to some internal +modules in your library, which you do not otherwise want to export. You +could put these modules in an internal library, which the main library +and the test suite :pkg-field:`build-depends` upon. Then your Cabal file might +look something like this: + +:: + + cabal-version: 2.0 + name: foo + version: 0.1.0.0 + license: BSD3 + build-type: Simple + + library foo-internal + exposed-modules: Foo.Internal + -- NOTE: no explicit constraints on base needed + -- as they're inherited from the 'library' stanza + build-depends: base + + library + exposed-modules: Foo.Public + build-depends: foo-internal, base >= 4.3 && < 5 + + test-suite test-foo + type: exitcode-stdio-1.0 + main-is: test-foo.hs + -- NOTE: no constraints on 'foo-internal' as same-package + -- dependencies implicitly refer to the same package instance + build-depends: foo-internal, base + +Internal libraries are also useful for packages that define multiple +executables, but do not define a publically accessible library. Internal +libraries are only visible internally in the package (so they can only +be added to the :pkg-field:`build-depends` of same-package libraries, +executables, test suites, etc.) Internal libraries locally shadow any +packages which have the same name; consequently, don't name an internal +library with the same name as an external dependency if you need to be +able to refer to the external dependency in a +:pkg-field:`build-depends` declaration. + +Shadowing can be used to vendor an external dependency into a package +and thus emulate *private dependencies*. Below is an example based on +a real-world use case: + +:: + + cabal-version: 2.2 + name: haddock-library + version: 1.6.0 + + library + build-depends: + , base ^>= 4.11.1.0 + , bytestring ^>= 0.10.2.0 + , containers ^>= 0.4.2.1 || ^>= 0.5.0.0 + , transformers ^>= 0.5.0.0 + + hs-source-dirs: src + + -- internal sub-lib + build-depends: attoparsec + + exposed-modules: + Documentation.Haddock + + library attoparsec + build-depends: + , base ^>= 4.11.1.0 + , bytestring ^>= 0.10.2.0 + , deepseq ^>= 1.4.0.0 + + hs-source-dirs: vendor/attoparsec-0.13.1.0 + + -- NB: haddock-library needs only small part of lib:attoparsec + -- internally, so we only bundle that subset here + exposed-modules: + Data.Attoparsec.ByteString + Data.Attoparsec.Combinator + + other-modules: + Data.Attoparsec.Internal + + ghc-options: -funbox-strict-fields -Wall -fwarn-tabs -O2 + + +Opening an interpreter session +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +While developing a package, it is often useful to make its code +available inside an interpreter session. This can be done with the +``repl`` command: + +.. code-block:: console + + $ cabal repl + +The name comes from the acronym +`REPL `__, +which stands for "read-eval-print-loop". By default ``cabal repl`` loads +the first component in a package. If the package contains several named +components, the name can be given as an argument to ``repl``. The name +can be also optionally prefixed with the component's type for +disambiguation purposes. Example: + +.. code-block:: console + + $ cabal repl foo + $ cabal repl exe:foo + $ cabal repl test:bar + $ cabal repl bench:baz + +Freezing dependency versions +"""""""""""""""""""""""""""" + +If a package is built in several different environments, such as a +development environment, a staging environment and a production +environment, it may be necessary or desirable to ensure that the same +dependency versions are selected in each environment. This can be done +with the ``freeze`` command: + +.. code-block:: console + + $ cabal freeze + +The command writes the selected version for all dependencies to the +``cabal.config`` file. All environments which share this file will use +the dependency versions specified in it. + +Generating dependency version bounds +"""""""""""""""""""""""""""""""""""" + +Cabal also has the ability to suggest dependency version bounds that +conform to `Package Versioning Policy`_, which is +a recommended versioning system for publicly released Cabal packages. +This is done by running the ``gen-bounds`` command: + +.. code-block:: console + + $ cabal gen-bounds + +For example, given the following dependencies specified in +:pkg-field:`build-depends`: + +:: + + build-depends: + foo == 0.5.2 + bar == 1.1 + +``gen-bounds`` will suggest changing them to the following: + +:: + + build-depends: + foo >= 0.5.2 && < 0.6 + bar >= 1.1 && < 1.2 + +Listing outdated dependency version bounds +"""""""""""""""""""""""""""""""""""""""""" + +Manually updating dependency version bounds in a ``.cabal`` file or a +freeze file can be tedious, especially when there's a lot of +dependencies. The ``cabal outdated`` command is designed to help with +that. It will print a list of packages for which there is a new +version on Hackage that is outside the version bound specified in the +``build-depends`` field. The ``outdated`` command can also be +configured to act on the freeze file (both old- and new-style) and +ignore major (or all) version bumps on Hackage for a subset of +dependencies. + +The following flags are supported by the ``outdated`` command: + +``--freeze-file`` + Read dependency version bounds from the freeze file (``cabal.config``) + instead of the package description file (``$PACKAGENAME.cabal``). + ``--v1-freeze-file`` is an alias for this flag starting in Cabal 2.4. +``--new-freeze-file`` + Read dependency version bounds from the new-style freeze file + (by default, ``cabal.project.freeze``) instead of the package + description file. ``--v2-freeze-file`` is an alias for this flag + starting in Cabal 2.4. +``--project-file`` *PROJECTFILE* + :since: 2.4 + + Read dependendency version bounds from the new-style freeze file + related to the named project file (i.e., ``$PROJECTFILE.freeze``) + instead of the package desctription file. If multiple ``--project-file`` + flags are provided, only the final one is considered. This flag + must only be passed in when ``--new-freeze-file`` is present. +``--simple-output`` + Print only the names of outdated dependencies, one per line. +``--exit-code`` + Exit with a non-zero exit code when there are outdated dependencies. +``-q, --quiet`` + Don't print any output. Implies ``-v0`` and ``--exit-code``. +``--ignore`` *PACKAGENAMES* + Don't warn about outdated dependency version bounds for the packages in this + list. +``--minor`` *[PACKAGENAMES]* + Ignore major version bumps for these packages. E.g. if there's a version 2.0 + of a package ``pkg`` on Hackage and the freeze file specifies the constraint + ``pkg == 1.9``, ``cabal outdated --freeze --minor=pkg`` will only consider + the ``pkg`` outdated when there's a version of ``pkg`` on Hackage satisfying + ``pkg > 1.9 && < 2.0``. ``--minor`` can also be used without arguments, in + that case major version bumps are ignored for all packages. + +Examples: + +.. code-block:: console + + $ cd /some/package + $ cabal outdated + Outdated dependencies: + haskell-src-exts <1.17 (latest: 1.19.1) + language-javascript <0.6 (latest: 0.6.0.9) + unix ==2.7.2.0 (latest: 2.7.2.1) + + $ cabal outdated --simple-output + haskell-src-exts + language-javascript + unix + + $ cabal outdated --ignore=haskell-src-exts + Outdated dependencies: + language-javascript <0.6 (latest: 0.6.0.9) + unix ==2.7.2.0 (latest: 2.7.2.1) + + $ cabal outdated --ignore=haskell-src-exts,language-javascript,unix + All dependencies are up to date. + + $ cabal outdated --ignore=haskell-src-exts,language-javascript,unix -q + $ echo $? + 0 + + $ cd /some/other/package + $ cabal outdated --freeze-file + Outdated dependencies: + HTTP ==4000.3.3 (latest: 4000.3.4) + HUnit ==1.3.1.1 (latest: 1.5.0.0) + + $ cabal outdated --freeze-file --ignore=HTTP --minor=HUnit + Outdated dependencies: + HUnit ==1.3.1.1 (latest: 1.3.1.2) + + +Executables +^^^^^^^^^^^ + +.. pkg-section:: executable name + :synopsis: Executable build info section. + + Executable sections (if present) describe executable programs contained + in the package and must have an argument after the section label, which + defines the name of the executable. This is a freeform argument but may + not contain spaces. + +The executable may be described using the following fields, as well as +build information fields (see the section on `build information`_). + +.. pkg-field:: main-is: filename (required) + + The name of the ``.hs`` or ``.lhs`` file containing the ``Main`` + module. Note that it is the ``.hs`` filename that must be listed, + even if that file is generated using a preprocessor. The source file + must be relative to one of the directories listed in + :pkg-field:`hs-source-dirs`. Further, while the name of the file may + vary, the module itself must be named ``Main``. + +.. pkg-field:: scope: token + :since: 2.0 + + Whether the executable is ``public`` (default) or ``private``, i.e. meant to + be run by other programs rather than the user. Private executables are + installed into `$libexecdir/$libexecsubdir`. + +Running executables +""""""""""""""""""" + +You can have Cabal build and run your executables by using the ``run`` +command: + +.. code-block:: console + + $ cabal run EXECUTABLE [-- EXECUTABLE_FLAGS] + +This command will configure, build and run the executable +``EXECUTABLE``. The double dash separator is required to distinguish +executable flags from ``run``'s own flags. If there is only one +executable defined in the whole package, the executable's name can be +omitted. See the output of ``cabal help run`` for a list of options you +can pass to ``cabal run``. + +Test suites +^^^^^^^^^^^ + +.. pkg-section:: test-suite name + :synopsis: Test suite build information. + + Test suite sections (if present) describe package test suites and must + have an argument after the section label, which defines the name of the + test suite. This is a freeform argument, but may not contain spaces. It + should be unique among the names of the package's other test suites, the + package's executables, and the package itself. Using test suite sections + requires at least Cabal version 1.9.2. + +The test suite may be described using the following fields, as well as +build information fields (see the section on `build information`_). + +.. pkg-field:: type: interface (required) + + The interface type and version of the test suite. Cabal supports two + test suite interfaces, called ``exitcode-stdio-1.0`` and + ``detailed-0.9``. Each of these types may require or disallow other + fields as described below. + +Test suites using the ``exitcode-stdio-1.0`` interface are executables +that indicate test failure with a non-zero exit code when run; they may +provide human-readable log information through the standard output and +error channels. The ``exitcode-stdio-1.0`` type requires the ``main-is`` +field. + +.. pkg-field:: main-is: filename + :synopsis: Module containing tests main function. + + :required: ``exitcode-stdio-1.0`` + :disallowed: ``detailed-0.9`` + + The name of the ``.hs`` or ``.lhs`` file containing the ``Main`` + module. Note that it is the ``.hs`` filename that must be listed, + even if that file is generated using a preprocessor. The source file + must be relative to one of the directories listed in + :pkg-field:`hs-source-dirs`. This field is analogous to the ``main-is`` field + of an executable section. + +Test suites using the ``detailed-0.9`` interface are modules exporting +the symbol ``tests :: IO [Test]``. The ``Test`` type is exported by the +module ``Distribution.TestSuite`` provided by Cabal. For more details, +see the example below. + +The ``detailed-0.9`` interface allows Cabal and other test agents to +inspect a test suite's results case by case, producing detailed human- +and machine-readable log files. The ``detailed-0.9`` interface requires +the :pkg-field:`test-module` field. + +.. pkg-field:: test-module: identifier + + :required: ``detailed-0.9`` + :disallowed: ``exitcode-stdio-1.0`` + + The module exporting the ``tests`` symbol. + +Example: Package using ``exitcode-stdio-1.0`` interface +""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +The example package description and executable source file below +demonstrate the use of the ``exitcode-stdio-1.0`` interface. + +.. code-block:: cabal + :caption: foo.cabal + + Name: foo + Version: 1.0 + License: BSD3 + Cabal-Version: >= 1.9.2 + Build-Type: Simple + + Test-Suite test-foo + type: exitcode-stdio-1.0 + main-is: test-foo.hs + build-depends: base >= 4 && < 5 + +.. code-block:: haskell + :caption: test-foo.hs + + module Main where + + import System.Exit (exitFailure) + + main = do + putStrLn "This test always fails!" + exitFailure + +Example: Package using ``detailed-0.9`` interface +""""""""""""""""""""""""""""""""""""""""""""""""" + +The example package description and test module source file below +demonstrate the use of the ``detailed-0.9`` interface. The test module +also develops a simple implementation of the interface set by +``Distribution.TestSuite``, but in actual usage the implementation would +be provided by the library that provides the testing facility. + +.. code-block:: cabal + :caption: bar.cabal + + Name: bar + Version: 1.0 + License: BSD3 + Cabal-Version: >= 1.9.2 + Build-Type: Simple + + Test-Suite test-bar + type: detailed-0.9 + test-module: Bar + build-depends: base >= 4 && < 5, Cabal >= 1.9.2 && < 2 + + +.. code-block:: haskell + :caption: Bar.hs + + module Bar ( tests ) where + + import Distribution.TestSuite + + tests :: IO [Test] + tests = return [ Test succeeds, Test fails ] + where + succeeds = TestInstance + { run = return $ Finished Pass + , name = "succeeds" + , tags = [] + , options = [] + , setOption = \_ _ -> Right succeeds + } + fails = TestInstance + { run = return $ Finished $ Fail "Always fails!" + , name = "fails" + , tags = [] + , options = [] + , setOption = \_ _ -> Right fails + } + +Running test suites +""""""""""""""""""" + +You can have Cabal run your test suites using its built-in test runner: + +:: + + $ cabal configure --enable-tests + $ cabal build + $ cabal test + +See the output of ``cabal help test`` for a list of options you can pass +to ``cabal test``. + +Benchmarks +^^^^^^^^^^ + +.. pkg-section:: benchmark name + :since: 1.9.2 + :synopsis: Benchmark build information. + + Benchmark sections (if present) describe benchmarks contained in the + package and must have an argument after the section label, which defines + the name of the benchmark. This is a freeform argument, but may not + contain spaces. It should be unique among the names of the package's + other benchmarks, the package's test suites, the package's executables, + and the package itself. Using benchmark sections requires at least Cabal + version 1.9.2. + +The benchmark may be described using the following fields, as well as +build information fields (see the section on `build information`_). + +.. pkg-field:: type: interface (required) + + The interface type and version of the benchmark. At the moment Cabal + only support one benchmark interface, called ``exitcode-stdio-1.0``. + +Benchmarks using the ``exitcode-stdio-1.0`` interface are executables +that indicate failure to run the benchmark with a non-zero exit code +when run; they may provide human-readable information through the +standard output and error channels. + +.. pkg-field:: main-is: filename + + :required: ``exitcode-stdio-1.0`` + + The name of the ``.hs`` or ``.lhs`` file containing the ``Main`` + module. Note that it is the ``.hs`` filename that must be listed, + even if that file is generated using a preprocessor. The source file + must be relative to one of the directories listed in + :pkg-field:`hs-source-dirs`. This field is analogous to the ``main-is`` + field of an executable section. Further, while the name of the file may + vary, the module itself must be named ``Main``. + +Example: Package using ``exitcode-stdio-1.0`` interface +""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +The example package description and executable source file below +demonstrate the use of the ``exitcode-stdio-1.0`` interface. + +.. code-block:: cabal + :caption: foo.cabal + :name: foo-bench.cabal + + Name: foo + Version: 1.0 + License: BSD3 + Cabal-Version: >= 1.9.2 + Build-Type: Simple + + Benchmark bench-foo + type: exitcode-stdio-1.0 + main-is: bench-foo.hs + build-depends: base >= 4 && < 5, time >= 1.1 && < 1.7 + +.. code-block:: haskell + :caption: bench-foo.hs + + {-# LANGUAGE BangPatterns #-} + module Main where + + import Data.Time.Clock + + fib 0 = 1 + fib 1 = 1 + fib n = fib (n-1) + fib (n-2) + + main = do + start <- getCurrentTime + let !r = fib 20 + end <- getCurrentTime + putStrLn $ "fib 20 took " ++ show (diffUTCTime end start) + +Running benchmarks +"""""""""""""""""" + +You can have Cabal run your benchmark using its built-in benchmark +runner: + +:: + + $ cabal configure --enable-benchmarks + $ cabal build + $ cabal bench + +See the output of ``cabal help bench`` for a list of options you can +pass to ``cabal bench``. + +Foreign libraries +^^^^^^^^^^^^^^^^^ + +Foreign libraries are system libraries intended to be linked against +programs written in C or other "foreign" languages. They +come in two primary flavours: dynamic libraries (``.so`` files on Linux, +``.dylib`` files on OSX, ``.dll`` files on Windows, etc.) are linked against +executables when the executable is run (or even lazily during +execution), while static libraries (``.a`` files on Linux/OSX, ``.lib`` +files on Windows) get linked against the executable at compile time. + +Foreign libraries only work with GHC 7.8 and later. + +A typical stanza for a foreign library looks like + +:: + + foreign-library myforeignlib + type: native-shared + lib-version-info: 6:3:2 + + if os(Windows) + options: standalone + mod-def-file: MyForeignLib.def + + other-modules: MyForeignLib.SomeModule + MyForeignLib.SomeOtherModule + build-depends: base >=4.7 && <4.9 + hs-source-dirs: src + c-sources: csrc/MyForeignLibWrapper.c + default-language: Haskell2010 + + +.. pkg-section:: foreign-library name + :since: 2.0 + :synopsis: Foriegn library build information. + + Build information for `foreign libraries`_. + +.. pkg-field:: type: foreign library type + + Cabal recognizes ``native-static`` and ``native-shared`` here, although + we currently only support building `native-shared` libraries. + +.. pkg-field:: options: foreign library option list + + Options for building the foreign library, typically specific to the + specified type of foreign library. Currently we only support + ``standalone`` here. A standalone dynamic library is one that does not + have any dependencies on other (Haskell) shared libraries; without + the ``standalone`` option the generated library would have dependencies + on the Haskell runtime library (``libHSrts``), the base library + (``libHSbase``), etc. Currently, ``standalone`` *must* be used on Windows + and *must not* be used on any other platform. + +.. pkg-field:: mod-def-file: filename + + This option can only be used when creating dynamic Windows libraries + (that is, when using ``native-shared`` and the ``os`` is ``Windows``). If + used, it must be a path to a *module definition file*. The details of + module definition files are beyond the scope of this document; see the + `GHC `_ + manual for some details and some further pointers. + +.. pkg-field:: lib-version-info: current:revision:age + + This field is currently only used on Linux. + + This field specifies a Libtool-style version-info field that sets + an appropriate ABI version for the foreign library. Note that the + three numbers specified in this field do not directly specify the + actual ABI version: ``6:3:2`` results in library version ``4.2.3``. + + With this field set, the SONAME of the library is set, and symlinks + are installed. + + How you should bump this field on an ABI change depends on the + breakage you introduce: + + - Programs using the previous version may use the new version as + drop-in replacement, and programs using the new version can also + work with the previous one. In other words, no recompiling nor + relinking is needed. In this case, bump ``revision`` only, don't + touch current nor age. + - Programs using the previous version may use the new version as + drop-in replacement, but programs using the new version may use + APIs not present in the previous one. In other words, a program + linking against the new version may fail with "unresolved + symbols" if linking against the old version at runtime: set + revision to 0, bump current and age. + - Programs may need to be changed, recompiled, and relinked in + order to use the new version. Bump current, set revision and age + to 0. + + Also refer to the Libtool documentation on the version-info field. + +.. pkg-field:: lib-version-linux: version + + This field is only used on Linux. + + Specifies the library ABI version directly for foreign libraries + built on Linux: so specifying ``4.2.3`` causes a library + ``libfoo.so.4.2.3`` to be built with SONAME ``libfoo.so.4``, and + appropriate symlinks ``libfoo.so.4`` and ``libfoo.so`` to be + installed. + +Note that typically foreign libraries should export a way to initialize +and shutdown the Haskell runtime. In the example above, this is done by +the ``csrc/MyForeignLibWrapper.c`` file, which might look something like + +.. code-block:: c + + #include + #include "HsFFI.h" + + HsBool myForeignLibInit(void){ + int argc = 2; + char *argv[] = { "+RTS", "-A32m", NULL }; + char **pargv = argv; + + // Initialize Haskell runtime + hs_init(&argc, &pargv); + + // do any other initialization here and + // return false if there was a problem + return HS_BOOL_TRUE; + } + + void myForeignLibExit(void){ + hs_exit(); + } + +With modern ghc regular libraries are installed in directories that contain +package keys. This isn't usually a problem because the package gets registered +in ghc's package DB and so we can figure out what the location of the library +is. Foreign libraries however don't get registered, which means that we'd have +to have a way of finding out where a platform library got installed (other than by +searching the ``lib/`` directory). Instead, we install foreign libraries in +``~/.cabal/lib``, much like we install executables in ``~/.cabal/bin``. + +Build information +^^^^^^^^^^^^^^^^^ +.. pkg-section:: None + +The following fields may be optionally present in a library, executable, +test suite or benchmark section, and give information for the building +of the corresponding library or executable. See also the sections on +`system-dependent parameters`_ and `configurations`_ for a way to supply +system-dependent values for these fields. + +.. pkg-field:: build-depends: library list + + Declares the *library* dependencies required to build the current + package component; see :pkg-field:`build-tool-depends` for + declaring build-time *tool* dependencies. External library + dependencies should be annotated with a version constraint. + + **Library Names** + + External libraries are identified by the package's name they're + provided by (currently a package can only publically expose its + main library compeonent; in future, packages with multiple exposed + public library components will be supported and a syntax for + referring to public sub-libraries will be provided). + + In order to specify an intra-package dependency on an internal + library component you can use the unqualified name of the + component library component. Note that locally defined sub-library + names shadow external package names of the same name. See section on + :ref:`Internal Libraries ` for examples and more information. + + **Version Constraints** + + Version constraints use the operators ``==, >=, >, <, <=`` and a + version number. Multiple constraints can be combined using ``&&`` or + ``||``. If no version constraint is specified, any version is + assumed to be acceptable. For example: + + :: + + library + build-depends: + base >= 2, + foo >= 1.2.3 && < 1.3, + bar + + Dependencies like ``foo >= 1.2.3 && < 1.3`` turn out to be very + common because it is recommended practise for package versions to + correspond to API versions (see PVP_). + + Since Cabal 1.6, there is a special wildcard syntax to help with + such ranges + + :: + + build-depends: foo ==1.2.* + + It is only syntactic sugar. It is exactly equivalent to + ``foo >= 1.2 && < 1.3``. + + .. Warning:: + + A potential pitfall of the wildcard syntax is that the + constraint ``nats == 1.0.*`` doesn't match the release + ``nats-1`` because the version ``1`` is lexicographically less + than ``1.0``. This is not an issue with the caret-operator + ``^>=`` described below. + + Starting with Cabal 2.0, there's a new version operator to express + PVP_-style major upper bounds conveniently, and is inspired by similar + syntactic sugar found in other language ecosystems where it's often + called the "Caret" operator: + + :: + + build-depends: + foo ^>= 1.2.3.4, + bar ^>= 1 + + This allows to assert the positive knowledge that this package is + *known* to be semantically compatible with the releases + ``foo-1.2.3.4`` and ``bar-1`` respectively. The information + encoded via such ``^>=``-assertions is used by the cabal solver to + infer version constraints describing semantically compatible + version ranges according to the PVP_ contract (see below). + + Another way to say this is that ``foo < 1.3`` expresses *negative* + information, i.e. "``foo-1.3`` or ``foo-1.4.2`` will *not* be + compatible"; whereas ``foo ^>= 1.2.3.4`` asserts the *positive* + information that "``foo-1.2.3.4`` is *known* to be compatible" and (in + the absence of additional information) according to the PVP_ + contract we can (positively) infer right away that all versions + satisfying ``foo >= 1.2.3.4 && < 1.3`` will be compatible as well. + + .. Note:: + + More generally, the PVP_ contract implies that we can safely + relax the lower bound to ``>= 1.2``, because if we know that + ``foo-1.2.3.4`` is semantically compatible, then so is + ``foo-1.2`` (if it typechecks). But we'd need to perform + additional static analysis (i.e. perform typechecking) in order + to know if our package in the role of an API consumer will + successfully typecheck against the dependency ``foo-1.2``. But + since we cannot do this analysis during constraint solving and + to keep things simple, we pragmatically use ``foo >= 1.2.3.4`` + as the initially inferred approximation for the lower bound + resulting from the assertion ``foo ^>= 1.2.3.4``. If further + evidence becomes available that e.g. ``foo-1.2`` typechecks, + one can simply revise the dependency specification to include + the assertion ``foo ^>= 1.2``. + + The subtle but important difference in signaling allows tooling to + treat explicitly expressed ``<``-style constraints and inferred + (``^>=``-style) upper bounds differently. For instance, + :option:`--allow-newer`'s ``^``-modifier allows to relax only + ``^>=``-style bounds while leaving explicitly stated + ``<``-constraints unaffected. + + Ignoring the signaling intent, the default syntactic desugaring rules are + + - ``^>= x`` == ``>= x && < x.1`` + - ``^>= x.y`` == ``>= x.y && < x.(y+1)`` + - ``^>= x.y.z`` == ``>= x.y.z && < x.(y+1)`` + - ``^>= x.y.z.u`` == ``>= x.y.z.u && < x.(y+1)`` + - etc. + + .. Note:: + + One might expected the desugaring to truncate all version + components below (and including) the patch-level, i.e. + ``^>= x.y.z.u`` == ``>= x.y.z && < x.(y+1)``, + as the major and minor version components alone are supposed to + uniquely identify the API according to the PVP_. However, by + designing ``^>=`` to be closer to the ``>=`` operator, we avoid + the potentially confusing effect of ``^>=`` being more liberal + than ``>=`` in the presence of patch-level versions. + + Consequently, the example declaration above is equivalent to + + :: + + build-depends: + foo >= 1.2.3.4 && < 1.3, + bar >= 1 && < 1.1 + + .. Note:: + + Prior to Cabal 1.8, ``build-depends`` specified in each + section were global to all sections. This was unintentional, but + some packages were written to depend on it, so if you need your + :pkg-field:`build-depends` to be local to each section, you must specify + at least ``Cabal-Version: >= 1.8`` in your ``.cabal`` file. + + .. Note:: + + Cabal 1.20 experimentally supported module thinning and + renaming in ``build-depends``; however, this support has since been + removed and should not be used. + +.. pkg-field:: other-modules: identifier list + + A list of modules used by the component but not exposed to users. + For a library component, these would be hidden modules of the + library. For an executable, these would be auxiliary modules to be + linked with the file named in the ``main-is`` field. + + .. Note:: + + Every module in the package *must* be listed in one of + :pkg-field:`other-modules`, :pkg-field:`library:exposed-modules` or + :pkg-field:`executable:main-is` fields. + +.. pkg-field:: hs-source-dirs: directory list + + :default: ``.`` + + Root directories for the module hierarchy. + + For backwards compatibility, the old variant ``hs-source-dir`` is + also recognized. + +.. pkg-field:: default-extensions: identifier list + + A list of Haskell extensions used by every module. These determine + corresponding compiler options enabled for all files. Extension + names are the constructors of the + `Extension <../release/cabal-latest/doc/API/Cabal/Language-Haskell-Extension.html#t:Extension>`__ + type. For example, ``CPP`` specifies that Haskell source files are + to be preprocessed with a C preprocessor. + +.. pkg-field:: other-extensions: identifier list + + A list of Haskell extensions used by some (but not necessarily all) + modules. From GHC version 6.6 onward, these may be specified by + placing a ``LANGUAGE`` pragma in the source files affected e.g. + + .. code-block:: haskell + + {-# LANGUAGE CPP, MultiParamTypeClasses #-} + + In Cabal-1.24 the dependency solver will use this and + :pkg-field:`default-extensions` information. Cabal prior to 1.24 will abort + compilation if the current compiler doesn't provide the extensions. + + If you use some extensions conditionally, using CPP or conditional + module lists, it is good to replicate the condition in + :pkg-field:`other-extensions` declarations: + + :: + + other-extensions: CPP + if impl(ghc >= 7.5) + other-extensions: PolyKinds + + You could also omit the conditionally used extensions, as they are + for information only, but it is recommended to replicate them in + :pkg-field:`other-extensions` declarations. + +.. pkg-field:: extensions: identifier list + :deprecated: + + Deprecated in favor of :pkg-field:`default-extensions`. + +.. pkg-field:: build-tool-depends: package:executable list + :since: 2.0 + + A list of Haskell programs needed to build this component. + Each is specified by the package containing the executable and the name of the executable itself, separated by a colon, and optionally followed by a version bound. + It is fine for the package to be the current one, in which case this is termed an *internal*, rather than *external* executable dependency. + + External dependencies can (and should) contain a version bound like conventional :pkg-field:`build-depends` dependencies. + Internal deps should not contain a version bound, as they will be always resolved within the same configuration of the package in the build plan. + Specifically, version bounds that include the package's version will be warned for being extraneous, and version bounds that exclude the package's version will raise an error for being impossible to follow. + + Cabal can make sure that specified programs are built and on the ``PATH`` before building the component in question. + It will always do so for internal dependencies, and also do so for external dependencies when using Nix-style local builds. + + :pkg-field:`build-tool-depends` was added in Cabal 2.0, and it will + be ignored (with a warning) with old versions of Cabal. See + :pkg-field:`build-tools` for more information about backwards + compatibility. + +.. pkg-field:: build-tools: program list + :deprecated: + + Deprecated in favor of :pkg-field:`build-tool-depends`, but :ref:`see below for backwards compatibility information `. + + A list of Haskell programs needed to build this component. + Each may be followed by an optional version bound. + Confusingly, each program in the list either refer to one of three things: + + 1. Another executables in the same package (supported since Cabal 1.12) + + 2. Tool name contained in Cabal's :ref:`hard-coded set of common tools ` + + 3. A pre-built executable that should already be on the ``PATH`` + (supported since Cabal 2.0) + + These cases are listed in order of priority: + an executable in the package will override any of the hard-coded packages with the same name, + and a hard-coded package will override any executable on the ``PATH``. + + In the first two cases, the list entry is desugared into a :pkg-field:`build-tool-depends` entry. + In the first case, the entry is desugared into a :pkg-field:`build-tool-depends` entry by prefixing with ``$pkg:``. + In the second case, it is desugared by looking up the package and executable name in a hard-coded table. + In either case, the optional version bound is passed through unchanged. + Refer to the documentation for :pkg-field:`build-tool-depends` to understand the desugared field's meaning, along with restrictions on version bounds. + + .. _buildtoolsbc: + + **Backward Compatiblity** + + Although this field is deprecated in favor of :pkg-field:`build-tool-depends`, there are some situations where you may prefer to use :pkg-field:`build-tools` in cases (1) and (2), as it is supported by more versions of Cabal. + In case (3), :pkg-field:`build-tool-depends` is better for backwards-compatibility, as it will be ignored by old versions of Cabal; if you add the executable to :pkg-field:`build-tools`, a setup script built against old Cabal will choke. + If an old version of Cabal is used, an end-user will have to manually arrange for the requested executable to be in your ``PATH``. + + .. _buildtoolsmap: + + **Set of Known Tool Names** + + Identifiers specified in :pkg-field:`build-tools` are desugared into their respective equivalent :pkg-field:`build-tool-depends` form according to the table below. Consequently, a legacy specification such as:: + + build-tools: alex >= 3.2.1 && < 3.3, happy >= 1.19.5 && < 1.20 + + is simply desugared into the equivalent specification:: + + build-tool-depends: alex:alex >= 3.2.1 && < 3.3, happy:happy >= 1.19.5 && < 1.20 + + +--------------------------+-----------------------------------+-----------------+ + | :pkg-field:`build-tools` | desugared | Note | + | identifier | :pkg-field:`build-tool-depends` | | + | | identifier | | + +==========================+===================================+=================+ + | ``alex`` | ``alex:alex`` | | + +--------------------------+-----------------------------------+-----------------+ + | ``c2hs`` | ``c2hs:c2hs`` | | + +--------------------------+-----------------------------------+-----------------+ + | ``cpphs`` | ``cpphs:cpphs`` | | + +--------------------------+-----------------------------------+-----------------+ + | ``greencard`` | ``greencard:greencard`` | | + +--------------------------+-----------------------------------+-----------------+ + | ``haddock`` | ``haddock:haddock`` | | + +--------------------------+-----------------------------------+-----------------+ + | ``happy`` | ``happy:happy`` | | + +--------------------------+-----------------------------------+-----------------+ + | ``hsc2hs`` | ``hsc2hs:hsc2hs`` | | + +--------------------------+-----------------------------------+-----------------+ + | ``hscolour`` | ``hscolour:hscolour`` | | + +--------------------------+-----------------------------------+-----------------+ + | ``hspec-discover`` | ``hspec-discover:hspec-discover`` | since Cabal 2.0 | + +--------------------------+-----------------------------------+-----------------+ + + This built-in set can be programmatically extended via ``Custom`` setup scripts; this, however, is of limited use since the Cabal solver cannot access information injected by ``Custom`` setup scripts. + +.. pkg-field:: buildable: boolean + + :default: ``True`` + + Is the component buildable? Like some of the other fields below, + this field is more useful with the slightly more elaborate form of + the simple build infrastructure described in the section on + `system-dependent parameters`_. + +.. pkg-field:: ghc-options: token list + + Additional options for GHC. You can often achieve the same effect + using the :pkg-field:`extensions` field, which is preferred. + + Options required only by one module may be specified by placing an + ``OPTIONS_GHC`` pragma in the source file affected. + + As with many other fields, whitespace can be escaped by using + Haskell string syntax. Example: + ``ghc-options: -Wcompat "-with-rtsopts=-T -I1" -Wall``. + +.. pkg-field:: ghc-prof-options: token list + + Additional options for GHC when the package is built with profiling + enabled. + + Note that as of Cabal-1.24, the default profiling detail level + defaults to ``exported-functions`` for libraries and + ``toplevel-functions`` for executables. For GHC these correspond to + the flags ``-fprof-auto-exported`` and ``-fprof-auto-top``. Prior to + Cabal-1.24 the level defaulted to ``none``. These levels can be + adjusted by the person building the package with the + ``--profiling-detail`` and ``--library-profiling-detail`` flags. + + It is typically better for the person building the package to pick + the profiling detail level rather than for the package author. So + unless you have special needs it is probably better not to specify + any of the GHC ``-fprof-auto*`` flags here. However if you wish to + override the profiling detail level, you can do so using the + :pkg-field:`ghc-prof-options` field: use ``-fno-prof-auto`` or one of the + other ``-fprof-auto*`` flags. + +.. pkg-field:: ghc-shared-options: token list + + Additional options for GHC when the package is built as shared + library. The options specified via this field are combined with the + ones specified via :pkg-field:`ghc-options`, and are passed to GHC during + both the compile and link phases. + +.. pkg-field:: includes: filename list + + A list of header files to be included in any compilations via C. + This field applies to both header files that are already installed + on the system and to those coming with the package to be installed. + The former files should be found in absolute paths, while the latter + files should be found in paths relative to the top of the source + tree or relative to one of the directories listed in + :pkg-field:`include-dirs`. + + These files typically contain function prototypes for foreign + imports used by the package. This is in contrast to + :pkg-field:`install-includes`, which lists header files that are intended + to be exposed to other packages that transitively depend on this + library. + +.. pkg-field:: install-includes: filename list + + A list of header files from this package to be installed into + ``$libdir/includes`` when the package is installed. Files listed in + :pkg-field:`install-includes` should be found in relative to the top of the + source tree or relative to one of the directories listed in + :pkg-field:`include-dirs`. + + :pkg-field:`install-includes` is typically used to name header files that + contain prototypes for foreign imports used in Haskell code in this + package, for which the C implementations are also provided with the + package. For example, here is a ``.cabal`` file for a hypothetical + ``bindings-clib`` package that bundles the C source code for ``clib``:: + + include-dirs: cbits + c-sources: clib.c + install-includes: clib.h + + Now any package that depends (directly or transitively) on the + ``bindings-clib`` library can use ``clib.h``. + + Note that in order for files listed in :pkg-field:`install-includes` to be + usable when compiling the package itself, they need to be listed in + the :pkg-field:`includes` field as well. + +.. pkg-field:: include-dirs: directory list + + A list of directories to search for header files, when preprocessing + with ``c2hs``, ``hsc2hs``, ``cpphs`` or the C preprocessor, and also + when compiling via C. Directories can be absolute paths (e.g., for + system directories) or paths that are relative to the top of the + source tree. Cabal looks in these directories when attempting to + locate files listed in :pkg-field:`includes` and + :pkg-field:`install-includes`. + +.. pkg-field:: c-sources: filename list + + A list of C source files to be compiled and linked with the Haskell + files. + +.. pkg-field:: cxx-sources: filename list + :since: 2.2 + + A list of C++ source files to be compiled and linked with the Haskell + files. Useful for segregating C and C++ sources when supplying different + command-line arguments to the compiler via the :pkg-field:`cc-options` + and the :pkg-field:`cxx-options` fields. The files listed in the + :pkg-field:`cxx-sources` can reference files listed in the + :pkg-field:`c-sources` field and vice-versa. The object files will be linked + appropriately. + +.. pkg-field:: asm-sources: filename list + + A list of assembly source files to be compiled and linked with the + Haskell files. + +.. pkg-field:: cmm-sources: filename list + + A list of C-- source files to be compiled and linked with the Haskell + files. + +.. pkg-field:: js-sources: filename list + + A list of JavaScript source files to be linked with the Haskell + files (only for JavaScript targets). + +.. pkg-field:: extra-libraries: token list + + A list of extra libraries to link with. + +.. pkg-field:: extra-ghci-libraries: token list + + A list of extra libraries to be used instead of 'extra-libraries' + when the package is loaded with GHCi. + +.. pkg-field:: extra-bundled-libraries: token list + + A list of libraries that are supposed to be copied from the build + directory alongside the produced Haskell libraries. Note that you + are under the obligation to produce those lirbaries in the build + directory (e.g. via a custom setup). Libraries listed here will + be included when ``copy``-ing packages and be listed in the + ``hs-libraries`` of the package configuration. + +.. pkg-field:: extra-lib-dirs: directory list + + A list of directories to search for libraries. + +.. pkg-field:: cc-options: token list + + Command-line arguments to be passed to the C compiler. Since the + arguments are compiler-dependent, this field is more useful with the + setup described in the section on `system-dependent parameters`_. + +.. pkg-field:: cpp-options: token list + + Command-line arguments for pre-processing Haskell code. Applies to + Haskell source and other pre-processed Haskell source like .hsc + .chs. Does not apply to C code, that's what cc-options is for. + +.. pkg-field:: cxx-options: token list + :since: 2.2 + + Command-line arguments to be passed to the compiler when compiling + C++ code. The C++ sources to which these command-line arguments + should be applied can be specified with the :pkg-field:`cxx-sources` + field. Command-line options for C and C++ can be passed separately to + the compiler when compiling both C and C++ sources by segregating the C + and C++ sources with the :pkg-field:`c-sources` and + :pkg-field:`cxx-sources` fields respectively, and providing different + command-line arguments with the :pkg-field:`cc-options` and the + :pkg-field:`cxx-options` fields. + +.. pkg-field:: ld-options: token list + + Command-line arguments to be passed to the linker. Since the + arguments are compiler-dependent, this field is more useful with the + setup described in the section on `system-dependent parameters`_. + +.. pkg-field:: pkgconfig-depends: package list + + A list of + `pkg-config `__ + packages, needed to build this package. They can be annotated with + versions, e.g. ``gtk+-2.0 >= 2.10, cairo >= 1.0``. If no version + constraint is specified, any version is assumed to be acceptable. + Cabal uses ``pkg-config`` to find if the packages are available on + the system and to find the extra compilation and linker options + needed to use the packages. + + If you need to bind to a C library that supports ``pkg-config`` (use + ``pkg-config --list-all`` to find out if it is supported) then it is + much preferable to use this field rather than hard code options into + the other fields. + +.. pkg-field:: frameworks: token list + + On Darwin/MacOS X, a list of frameworks to link to. See Apple's + developer documentation for more details on frameworks. This entry + is ignored on all other platforms. + +.. pkg-field:: extra-frameworks-dirs: directory list + + On Darwin/MacOS X, a list of directories to search for frameworks. + This entry is ignored on all other platforms. + +.. pkg-field:: mixins: mixin list + :since: 2.0 + + Supported only in GHC 8.2 and later. A list of packages mentioned in the + :pkg-field:`build-depends` field, each optionally accompanied by a list of + module and module signature renamings. + + The simplest mixin syntax is simply the name of a package mentioned in the + :pkg-field:`build-depends` field. For example: + + :: + + library + build-depends: + foo >= 1.2.3 && < 1.3 + mixins: + foo + + But this doesn't have any effect. More interesting is to use the mixin + entry to rename one or more modules from the package, like this: + + :: + + library + mixins: + foo (Foo.Bar as AnotherFoo.Bar, Foo.Baz as AnotherFoo.Baz) + + Note that renaming a module like this will hide all the modules + that are not explicitly named. + + Modules can also be hidden: + + :: + + library: + mixins: + foo hiding (Foo.Bar) + + Hiding modules exposes everything that is not explicitly hidden. + + .. Note:: + + The current version of Cabal suffers from an infelicity in how the + entries of :pkg-field:`mixins` are parsed: an entry will fail to parse + if the provided renaming clause has whitespace after the opening + parenthesis. This will be fixed in future versions of Cabal. + + See issues `#5150 `__, + `#4864 `__, and + `#5293 `__. + + There can be multiple mixin entries for a given package, in effect creating + multiple copies of the dependency: + + :: + + library + mixins: + foo (Foo.Bar as AnotherFoo.Bar, Foo.Baz as AnotherFoo.Baz), + foo (Foo.Bar as YetAnotherFoo.Bar) + + The ``requires`` clause is used to rename the module signatures required by + a package: + + :: + + library + mixins: + foo (Foo.Bar as AnotherFoo.Bar) requires (Foo.SomeSig as AnotherFoo.SomeSig) + + Signature-only packages don't have any modules, so only the signatures can + be renamed, with the following syntax: + + :: + + library + mixins: + sigonly requires (SigOnly.SomeSig as AnotherSigOnly.SomeSig) + + See the :pkg-field:`signatures` field for more details. + + Mixin packages are part of the `Backpack + `__ extension to the + Haskell module system. + + The matching of the module signatures required by a + :pkg-field:`build-depends` dependency with the implementation modules + present in another dependency is triggered by a coincidence of names. When + the names of the signature and of the implementation are already the same, + the matching is automatic. But when the names don't coincide, or we want to + instantiate a signature in two different ways, adding mixin entries that + perform renamings becomes necessary. + + .. Warning:: + + Backpack has the limitation that implementation modules that instantiate + signatures required by a :pkg-field:`build-depends` dependency can't + reside in the same component that has the dependency. They must reside + in a different package dependency, or at least in a separate internal + library. + +Configurations +^^^^^^^^^^^^^^ + +Library and executable sections may include conditional blocks, which +test for various system parameters and configuration flags. The flags +mechanism is rather generic, but most of the time a flag represents +certain feature, that can be switched on or off by the package user. +Here is an example package description file using configurations: + +Example: A package containing a library and executable programs +""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +:: + + Name: Test1 + Version: 0.0.1 + Cabal-Version: >= 1.8 + License: BSD3 + Author: Jane Doe + Synopsis: Test package to test configurations + Category: Example + Build-Type: Simple + + Flag Debug + Description: Enable debug support + Default: False + Manual: True + + Flag WebFrontend + Description: Include API for web frontend. + Default: False + Manual: True + + Flag NewDirectory + description: Whether to build against @directory >= 1.2@ + -- This is an automatic flag which the solver will be + -- assign automatically while searching for a solution + + Library + Build-Depends: base >= 4.2 && < 4.9 + Exposed-Modules: Testing.Test1 + Extensions: CPP + + GHC-Options: -Wall + if flag(Debug) + CPP-Options: -DDEBUG + if !os(windows) + CC-Options: "-DDEBUG" + else + CC-Options: "-DNDEBUG" + + if flag(WebFrontend) + Build-Depends: cgi >= 0.42 && < 0.44 + Other-Modules: Testing.WebStuff + CPP-Options: -DWEBFRONTEND + + if flag(NewDirectory) + build-depends: directory >= 1.2 && < 1.4 + Build-Depends: time >= 1.0 && < 1.9 + else + build-depends: directory == 1.1.* + Build-Depends: old-time >= 1.0 && < 1.2 + + Executable test1 + Main-is: T1.hs + Other-Modules: Testing.Test1 + Build-Depends: base >= 4.2 && < 4.9 + + if flag(debug) + CC-Options: "-DDEBUG" + CPP-Options: -DDEBUG + +Layout +"""""" + +Flags, conditionals, library and executable sections use layout to +indicate structure. This is very similar to the Haskell layout rule. +Entries in a section have to all be indented to the same level which +must be more than the section header. Tabs are not allowed to be used +for indentation. + +As an alternative to using layout you can also use explicit braces +``{}``. In this case the indentation of entries in a section does not +matter, though different fields within a block must be on different +lines. Here is a bit of the above example again, using braces: + +Example: Using explicit braces rather than indentation for layout +""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +:: + + Name: Test1 + Version: 0.0.1 + Cabal-Version: >= 1.8 + License: BSD3 + Author: Jane Doe + Synopsis: Test package to test configurations + Category: Example + Build-Type: Simple + + Flag Debug { + Description: Enable debug support + Default: False + Manual: True + } + + Library { + Build-Depends: base >= 4.2 && < 4.9 + Exposed-Modules: Testing.Test1 + Extensions: CPP + if flag(debug) { + CPP-Options: -DDEBUG + if !os(windows) { + CC-Options: "-DDEBUG" + } else { + CC-Options: "-DNDEBUG" + } + } + } + +Configuration Flags +""""""""""""""""""" + +.. pkg-section:: flag name + :synopsis: Flag declaration. + + Flag section declares a flag which can be used in `conditional blocks`_. + + Flag names are case-insensitive and must match ``[[:alnum:]_][[:alnum:]_-]*`` + regular expression, or expressed as ABNF_: + + .. code-block:: abnf + + flag-name = (UALNUM / "_") *(UALNUM / "_" / "-") + + UALNUM = UALPHA / DIGIT + UALPHA = ... ; set of alphabetic Unicode code-points + + .. note:: + + Hackage accepts ASCII-only flags, ``[a-zA-Z0-9_][a-zA-Z0-9_-]*`` regexp. + +.. pkg-field:: description: freeform + + The description of this flag. + +.. pkg-field:: default: boolean + + :default: ``True`` + + The default value of this flag. + + .. note:: + + This value may be `overridden in several + ways `__. The + rationale for having flags default to True is that users usually + want new features as soon as they are available. Flags representing + features that are not (yet) recommended for most users (such as + experimental features or debugging support) should therefore + explicitly override the default to False. + +.. pkg-field:: manual: boolean + + :default: ``False`` + :since: 1.6 + + By default, Cabal will first try to satisfy dependencies with the + default flag value and then, if that is not possible, with the + negated value. However, if the flag is manual, then the default + value (which can be overridden by commandline flags) will be used. + +Conditional Blocks +^^^^^^^^^^^^^^^^^^ + +Conditional blocks may appear anywhere inside a library or executable +section. They have to follow rather strict formatting rules. Conditional +blocks must always be of the shape + +:: + + if condition + property-descriptions-or-conditionals + +or + +:: + + if condition + property-descriptions-or-conditionals + else + property-descriptions-or-conditionals + +Note that the ``if`` and the condition have to be all on the same line. + +Since Cabal 2.2 conditional blocks support ``elif`` construct. + +:: + + if condition1 + property-descriptions-or-conditionals + elif condition2 + property-descriptions-or-conditionals + else + property-descriptions-or-conditionals + +Conditions +"""""""""" + +Conditions can be formed using boolean tests and the boolean operators +``||`` (disjunction / logical "or"), ``&&`` (conjunction / logical +"and"), or ``!`` (negation / logical "not"). The unary ``!`` takes +highest precedence, ``||`` takes lowest. Precedence levels may be +overridden through the use of parentheses. For example, +``os(darwin) && !arch(i386) || os(freebsd)`` is equivalent to +``(os(darwin) && !(arch(i386))) || os(freebsd)``. + +The following tests are currently supported. + +:samp:`os({name})` + Tests if the current operating system is *name*. The argument is + tested against ``System.Info.os`` on the target system. There is + unfortunately some disagreement between Haskell implementations + about the standard values of ``System.Info.os``. Cabal canonicalises + it so that in particular ``os(windows)`` works on all + implementations. If the canonicalised os names match, this test + evaluates to true, otherwise false. The match is case-insensitive. +:samp:`arch({name})` + Tests if the current architecture is *name*. The argument is matched + against ``System.Info.arch`` on the target system. If the arch names + match, this test evaluates to true, otherwise false. The match is + case-insensitive. +:samp:`impl({compiler})` + Tests for the configured Haskell implementation. An optional version + constraint may be specified (for example ``impl(ghc >= 6.6.1)``). If + the configured implementation is of the right type and matches the + version constraint, then this evaluates to true, otherwise false. + The match is case-insensitive. + + Note that including a version constraint in an ``impl`` test causes + it to check for two properties: + + - The current compiler has the specified name, and + + - The compiler's version satisfied the specified version constraint + + As a result, ``!impl(ghc >= x.y.z)`` is not entirely equivalent to + ``impl(ghc < x.y.z)``. The test ``!impl(ghc >= x.y.z)`` checks that: + + - The current compiler is not GHC, or + + - The version of GHC is earlier than version x.y.z. + +:samp:`flag({name})` + Evaluates to the current assignment of the flag of the given name. + Flag names are case insensitive. Testing for flags that have not + been introduced with a flag section is an error. +``true`` + Constant value true. +``false`` + Constant value false. + +Resolution of Conditions and Flags +"""""""""""""""""""""""""""""""""" + +If a package descriptions specifies configuration flags the package user +can `control these in several +ways `__. If the +user does not fix the value of a flag, Cabal will try to find a flag +assignment in the following way. + +- For each flag specified, it will assign its default value, evaluate + all conditions with this flag assignment, and check if all + dependencies can be satisfied. If this check succeeded, the package + will be configured with those flag assignments. + +- If dependencies were missing, the last flag (as by the order in which + the flags were introduced in the package description) is tried with + its alternative value and so on. This continues until either an + assignment is found where all dependencies can be satisfied, or all + possible flag assignments have been tried. + +To put it another way, Cabal does a complete backtracking search to find +a satisfiable package configuration. It is only the dependencies +specified in the :pkg-field:`build-depends` field in conditional blocks that +determine if a particular flag assignment is satisfiable +(:pkg-field:`build-tools` are not considered). The order of the declaration and +the default value of the flags determines the search order. Flags +overridden on the command line fix the assignment of that flag, so no +backtracking will be tried for that flag. + +If no suitable flag assignment could be found, the configuration phase +will fail and a list of missing dependencies will be printed. Note that +this resolution process is exponential in the worst case (i.e., in the +case where dependencies cannot be satisfied). There are some +optimizations applied internally, but the overall complexity remains +unchanged. + +Meaning of field values when using conditionals +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +During the configuration phase, a flag assignment is chosen, all +conditionals are evaluated, and the package description is combined into +a flat package descriptions. If the same field both inside a conditional +and outside then they are combined using the following rules. + +- Boolean fields are combined using conjunction (logical "and"). + +- List fields are combined by appending the inner items to the outer + items, for example + + :: + + other-extensions: CPP + if impl(ghc) + other-extensions: MultiParamTypeClasses + + when compiled using GHC will be combined to + + :: + + other-extensions: CPP, MultiParamTypeClasses + + Similarly, if two conditional sections appear at the same nesting + level, properties specified in the latter will come after properties + specified in the former. + +- All other fields must not be specified in ambiguous ways. For example + + :: + + Main-is: Main.hs + if flag(useothermain) + Main-is: OtherMain.hs + + will lead to an error. Instead use + + :: + + if flag(useothermain) + Main-is: OtherMain.hs + else + Main-is: Main.hs + +Common stanzas +^^^^^^^^^^^^^^ + +.. pkg-section:: common name + :since: 2.2 + :synopsis: Common build info section + +Starting with Cabal-2.2 it's possible to use common build info stanzas. + +:: + + common deps + build-depends: base ^>= 4.11 + ghc-options: -Wall + + common test-deps + build-depends: tasty + + library + import: deps + exposed-modules: Foo + + test-suite tests + import: deps, test-deps + type: exitcode-stdio-1.0 + main-is: Tests.hs + build-depends: foo + +- You can use `build information`_ fields in common stanzas. + +- Common stanzas must be defined before use. + +- Common stanzas can import other common stanzas. + +- You can import multiple stanzas at once. Stanza names must be separated by commas. + +.. Note:: + + The name `import` was chosen, because there is ``includes`` field. + +Source Repositories +^^^^^^^^^^^^^^^^^^^ + +.. pkg-section:: source-repository + :since: 1.6 + +It is often useful to be able to specify a source revision control +repository for a package. Cabal lets you specifying this information in +a relatively structured form which enables other tools to interpret and +make effective use of the information. For example the information +should be sufficient for an automatic tool to checkout the sources. + +Cabal supports specifying different information for various common +source control systems. Obviously not all automated tools will support +all source control systems. + +Cabal supports specifying repositories for different use cases. By +declaring which case we mean automated tools can be more useful. There +are currently two kinds defined: + +- The ``head`` kind refers to the latest development branch of the + package. This may be used for example to track activity of a project + or as an indication to outside developers what sources to get for + making new contributions. + +- The ``this`` kind refers to the branch and tag of a repository that + contains the sources for this version or release of a package. For + most source control systems this involves specifying a tag, id or + hash of some form and perhaps a branch. The purpose is to be able to + reconstruct the sources corresponding to a particular package + version. This might be used to indicate what sources to get if + someone needs to fix a bug in an older branch that is no longer an + active head branch. + +You can specify one kind or the other or both. As an example here are +the repositories for the Cabal library. Note that the ``this`` kind of +repository specifies a tag. + +:: + + source-repository head + type: darcs + location: http://darcs.haskell.org/cabal/ + + source-repository this + type: darcs + location: http://darcs.haskell.org/cabal-branches/cabal-1.6/ + tag: 1.6.1 + +The exact fields are as follows: + +.. pkg-field:: type: token + + The name of the source control system used for this repository. The + currently recognised types are: + + - ``darcs`` + - ``git`` + - ``svn`` + - ``cvs`` + - ``mercurial`` (or alias ``hg``) + - ``bazaar`` (or alias ``bzr``) + - ``arch`` + - ``monotone`` + + This field is required. + +.. pkg-field:: location: URL + + The location of the repository. The exact form of this field depends + on the repository type. For example: + + - for darcs: ``http://code.haskell.org/foo/`` + - for git: ``git://github.com/foo/bar.git`` + - for CVS: ``anoncvs@cvs.foo.org:/cvs`` + + This field is required. + +.. pkg-field:: module: token + + CVS requires a named module, as each CVS server can host multiple + named repositories. + + This field is required for the CVS repository type and should not be + used otherwise. + +.. pkg-field:: branch: token + + Many source control systems support the notion of a branch, as a + distinct concept from having repositories in separate locations. For + example CVS, SVN and git use branches while for darcs uses different + locations for different branches. If you need to specify a branch to + identify a your repository then specify it in this field. + + This field is optional. + +.. pkg-field:: tag: token + + A tag identifies a particular state of a source repository. The tag + can be used with a ``this`` repository kind to identify the state of + a repository corresponding to a particular package version or + release. The exact form of the tag depends on the repository type. + + This field is required for the ``this`` repository kind. + +.. pkg-field:: subdir: directory + + Some projects put the sources for multiple packages under a single + source repository. This field lets you specify the relative path + from the root of the repository to the top directory for the + package, i.e. the directory containing the package's ``.cabal`` + file. + + This field is optional. It default to empty which corresponds to the + root directory of the repository. + +Downloading a package's source +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The ``cabal get`` command allows to access a package's source code - +either by unpacking a tarball downloaded from Hackage (the default) or +by checking out a working copy from the package's source repository. + +:: + + $ cabal get [FLAGS] PACKAGES + +The ``get`` command supports the following options: + +``-d --destdir`` *PATH* + Where to place the package source, defaults to (a subdirectory of) + the current directory. +``-s --source-repository`` *[head\|this\|...]* + Fork the package's source repository using the appropriate version + control system. The optional argument allows to choose a specific + repository kind. +``--index-state`` *[HEAD\|@\|]* + Use source package index state as it existed at a previous time. Accepts + unix-timestamps (e.g. ``@1474732068``), ISO8601 UTC timestamps (e.g. + ``2016-09-24T17:47:48Z``), or ``HEAD`` (default). + This determines which package versions are available as well as which + ``.cabal`` file revision is selected (unless ``--pristine`` is used). +``--pristine`` + Unpack the original pristine tarball, rather than updating the + ``.cabal`` file with the latest revision from the package archive. + +Custom setup scripts +-------------------- + +Since Cabal 1.24, custom ``Setup.hs`` are required to accurately track +their dependencies by declaring them in the ``.cabal`` file rather than +rely on dependencies being implicitly in scope. Please refer +`this article `__ +for more details. + +Declaring a ``custom-setup`` stanza also enables the generation of +``MIN_VERSION_package_(A,B,C)`` CPP macros for the Setup component. + +.. pkg-section:: custom-setup + :synopsis: Custom Setup.hs build information. + :since: 1.24 + + The optional :pkg-section:`custom-setup` stanza contains information needed + for the compilation of custom ``Setup.hs`` scripts, + +:: + + custom-setup + setup-depends: + base >= 4.5 && < 4.11, + Cabal >= 1.14 && < 1.25 + +.. pkg-field:: setup-depends: package list + :since: 1.24 + + The dependencies needed to compile ``Setup.hs``. See the + :pkg-field:`build-depends` field for a description of the syntax expected by + this field. + +Backward compatibility and ``custom-setup`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Versions prior to Cabal 1.24 don't recognise ``custom-setup`` stanzas, +and will behave agnostic to them (except for warning about an unknown +section). Consequently, versions prior to Cabal 1.24 can't ensure the +declared dependencies ``setup-depends`` are in scope, and instead +whatever is registered in the current package database environment +will become eligible (and resolved by the compiler) for the +``Setup.hs`` module. + +The availability of the +``MIN_VERSION_package_(A,B,C)`` CPP macros +inside ``Setup.hs`` scripts depends on the condition that either + +- a ``custom-setup`` section has been declared (or ``cabal new-build`` is being + used which injects an implicit hard-coded ``custom-setup`` stanza if it's missing), or +- GHC 8.0 or later is used (which natively injects package version CPP macros) + +Consequently, if you need to write backward compatible ``Setup.hs`` +scripts using CPP, you should declare a ``custom-setup`` stanza and +use the pattern below: + +.. code-block:: haskell + + {-# LANGUAGE CPP #-} + import Distribution.Simple + + #if defined(MIN_VERSION_Cabal) + -- version macros are available and can be used as usual + # if MIN_VERSION_Cabal(a,b,c) + -- code specific to lib:Cabal >= a.b.c + # else + -- code specific to lib:Cabal < a.b.c + # endif + #else + # warning Enabling heuristic fall-back. Please upgrade cabal-install to 1.24 or later if Setup.hs fails to compile. + + -- package version macros not available; except for exotic environments, + -- you can heuristically assume that lib:Cabal's version is correlated + -- with __GLASGOW_HASKELL__, and specifically since we can assume that + -- GHC < 8.0, we can assume that lib:Cabal is version 1.22 or older. + #endif + + main = ... + +The simplified (heuristic) CPP pattern shown below is useful if all you need +is to distinguish ``Cabal < 2.0`` from ``Cabal >= 2.0``. + +.. code-block:: haskell + + {-# LANGUAGE CPP #-} + import Distribution.Simple + + #if !defined(MIN_VERSION_Cabal) + # define MIN_VERSION_Cabal(a,b,c) 0 + #endif + + #if MIN_VERSION_Cabal(2,0,0) + -- code for lib:Cabal >= 2.0 + #else + -- code for lib:Cabal < 2.0 + #endif + + main = ... + + + +Autogenerated modules +--------------------- + +Modules that are built automatically at setup, created with a custom +setup script, must appear on :pkg-field:`other-modules` for the library, +executable, test-suite or benchmark stanzas or also on +:pkg-field:`library:exposed-modules` for libraries to be used, but are not +really on the package when distributed. This makes commands like sdist fail +because the file is not found. + +These special modules must appear again on the :pkg-field:`autogen-modules` +field of the stanza that is using it, besides :pkg-field:`other-modules` or +:pkg-field:`library:exposed-modules`. With this there is no need to create +complex build hooks for this poweruser case. + +.. pkg-field:: autogen-modules: module list + :since: 2.0 + + .. TODO: document autogen-modules field + +Right now :pkg-field:`executable:main-is` modules are not supported on +:pkg-field:`autogen-modules`. + +:: + + Library + default-language: Haskell2010 + build-depends: base + exposed-modules: + MyLibrary + MyLibHelperModule + other-modules: + MyLibModule + autogen-modules: + MyLibHelperModule + + Executable Exe + default-language: Haskell2010 + main-is: Dummy.hs + build-depends: base + other-modules: + MyExeModule + MyExeHelperModule + autogen-modules: + MyExeHelperModule + +Accessing data files from package code +-------------------------------------- + +The placement on the target system of files listed in +the :pkg-field:`data-files` field varies between systems, and in some cases +one can even move packages around after installation (see `prefix +independence `__). To +enable packages to find these files in a portable way, Cabal generates a +module called :file:`Paths_{pkgname}` (with any hyphens in *pkgname* +replaced by underscores) during building, so that it may be imported by +modules of the package. This module defines a function + +.. code-block:: haskell + + getDataFileName :: FilePath -> IO FilePath + +If the argument is a filename listed in the :pkg-field:`data-files` field, the +result is the name of the corresponding file on the system on which the +program is running. + +.. Note:: + + If you decide to import the :file:`Paths_{pkgname}` module then it + *must* be listed in the :pkg-field:`other-modules` field just like any other + module in your package and on :pkg-field:`autogen-modules` as the file is + autogenerated. + +The :file:`Paths_{pkgname}` module is not platform independent, as any +other autogenerated module, so it does not get included in the source +tarballs generated by ``sdist``. + +The :file:`Paths_{pkgname}` module also includes some other useful +functions and values, which record the version of the package and some +other directories which the package has been configured to be installed +into (e.g. data files live in ``getDataDir``): + +.. code-block:: haskell + + version :: Version + + getBinDir :: IO FilePath + getLibDir :: IO FilePath + getDynLibDir :: IO FilePath + getDataDir :: IO FilePath + getLibexecDir :: IO FilePath + getSysconfDir :: IO FilePath + +The actual location of all these directories can be individually +overridden at runtime using environment variables of the form +``pkg_name_var``, where ``pkg_name`` is the name of the package with all +hyphens converted into underscores, and ``var`` is either ``bindir``, +``libdir``, ``dynlibdir``, ``datadir``, ``libexedir`` or ``sysconfdir``. For example, +the configured data directory for ``pretty-show`` is controlled with the +``pretty_show_datadir`` environment variable. + +Accessing the package version +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The aforementioned auto generated :file:`Paths_{pkgname}` module also +exports the constant ``version ::`` +`Version `__ +which is defined as the version of your package as specified in the +``version`` field. + +System-dependent parameters +--------------------------- + +For some packages, especially those interfacing with C libraries, +implementation details and the build procedure depend on the build +environment. The ``build-type`` ``Configure`` can be used to handle many +such situations. In this case, ``Setup.hs`` should be: + +.. code-block:: haskell + + import Distribution.Simple + main = defaultMainWithHooks autoconfUserHooks + +Most packages, however, would probably do better using the ``Simple`` +build type and `configurations`_. + +The :pkg-field:`build-type` ``Configure`` differs from ``Simple`` in two ways: + +- The package root directory must contain a shell script called + ``configure``. The configure step will run the script. This + ``configure`` script may be produced by + `autoconf `__ or may be + hand-written. The ``configure`` script typically discovers + information about the system and records it for later steps, e.g. by + generating system-dependent header files for inclusion in C source + files and preprocessed Haskell source files. (Clearly this won't work + for Windows without MSYS or Cygwin: other ideas are needed.) + +- If the package root directory contains a file called + *package*\ ``.buildinfo`` after the configuration step, subsequent + steps will read it to obtain additional settings for `build + information`_ fields,to be merged with the ones + given in the ``.cabal`` file. In particular, this file may be + generated by the ``configure`` script mentioned above, allowing these + settings to vary depending on the build environment. + +The build information file should have the following structure: + + *buildinfo* + + ``executable:`` *name* *buildinfo* + + ``executable:`` *name* *buildinfo* ... + +where each *buildinfo* consists of settings of fields listed in the +section on `build information`_. The first one (if +present) relates to the library, while each of the others relate to the +named executable. (The names must match the package description, but you +don't have to have entries for all of them.) + +Neither of these files is required. If they are absent, this setup +script is equivalent to ``defaultMain``. + +Example: Using autoconf +^^^^^^^^^^^^^^^^^^^^^^^ + +This example is for people familiar with the +`autoconf `__ tools. + +In the X11 package, the file ``configure.ac`` contains: + +.. code-block:: shell + + AC_INIT([Haskell X11 package], [1.1], [libraries@haskell.org], [X11]) + + # Safety check: Ensure that we are in the correct source directory. + AC_CONFIG_SRCDIR([X11.cabal]) + + # Header file to place defines in + AC_CONFIG_HEADERS([include/HsX11Config.h]) + + # Check for X11 include paths and libraries + AC_PATH_XTRA + AC_TRY_CPP([#include ],,[no_x=yes]) + + # Build the package if we found X11 stuff + if test "$no_x" = yes + then BUILD_PACKAGE_BOOL=False + else BUILD_PACKAGE_BOOL=True + fi + AC_SUBST([BUILD_PACKAGE_BOOL]) + + AC_CONFIG_FILES([X11.buildinfo]) + AC_OUTPUT + +Then the setup script will run the ``configure`` script, which checks +for the presence of the X11 libraries and substitutes for variables in +the file ``X11.buildinfo.in``: + +:: + + buildable: @BUILD_PACKAGE_BOOL@ + cc-options: @X_CFLAGS@ + ld-options: @X_LIBS@ + +This generates a file ``X11.buildinfo`` supplying the parameters needed +by later stages: + +:: + + buildable: True + cc-options: -I/usr/X11R6/include + ld-options: -L/usr/X11R6/lib + +The ``configure`` script also generates a header file +``include/HsX11Config.h`` containing C preprocessor defines recording +the results of various tests. This file may be included by C source +files and preprocessed Haskell source files in the package. + +.. Note:: + + Packages using these features will also need to list additional + files such as ``configure``, templates for ``.buildinfo`` files, files + named only in ``.buildinfo`` files, header files and so on in the + :pkg-field:`extra-source-files` field to ensure that they are included in + source distributions. They should also list files and directories generated + by ``configure`` in the :pkg-field:`extra-tmp-files` field to ensure that + they are removed by ``setup clean``. + +Quite often the files generated by ``configure`` need to be listed +somewhere in the package description (for example, in the +:pkg-field:`install-includes` field). However, we usually don't want generated +files to be included in the source tarball. The solution is again +provided by the ``.buildinfo`` file. In the above example, the following +line should be added to ``X11.buildinfo``: + +:: + + install-includes: HsX11Config.h + +In this way, the generated ``HsX11Config.h`` file won't be included in +the source tarball in addition to ``HsX11Config.h.in``, but it will be +copied to the right location during the install process. Packages that +use custom ``Setup.hs`` scripts can update the necessary fields +programmatically instead of using the ``.buildinfo`` file. + +Conditional compilation +----------------------- + +Sometimes you want to write code that works with more than one version +of a dependency. You can specify a range of versions for the dependency +in the :pkg-field:`build-depends`, but how do you then write the code that can +use different versions of the API? + +Haskell lets you preprocess your code using the C preprocessor (either +the real C preprocessor, or ``cpphs``). To enable this, add +``extensions: CPP`` to your package description. When using CPP, Cabal +provides some pre-defined macros to let you test the version of +dependent packages; for example, suppose your package works with either +version 3 or version 4 of the ``base`` package, you could select the +available version in your Haskell modules like this: + +.. code-block:: cpp + + #if MIN_VERSION_base(4,0,0) + ... code that works with base-4 ... + #else + ... code that works with base-3 ... + #endif + +In general, Cabal supplies a macro +``MIN_VERSION_``\ *``package``*\ ``_(A,B,C)`` for each package depended +on via :pkg-field:`build-depends`. This macro is true if the actual version of +the package in use is greater than or equal to ``A.B.C`` (using the +conventional ordering on version numbers, which is lexicographic on the +sequence, but numeric on each component, so for example 1.2.0 is greater +than 1.0.3). + +Since version 1.20, the ``MIN_TOOL_VERSION_``\ *``tool``* +family of macros lets you condition on the version of build tools used to +build the program (e.g. ``hsc2hs``). + +Since version 1.24, the macro ``CURRENT_COMPONENT_ID``, which +expands to the string of the component identifier that uniquely +identifies this component. Furthermore, if the package is a library, +the macro ``CURRENT_PACKAGE_KEY`` records the identifier that was passed +to GHC for use in symbols and for type equality. + +Since version 2.0, the macro ``CURRENT_PACKAGE_VERSION`` expands +to the string version number of the current package. + +Cabal places the definitions of these macros into an +automatically-generated header file, which is included when +preprocessing Haskell source code by passing options to the C +preprocessor. + +Cabal also allows to detect when the source code is being used for +generating documentation. The ``__HADDOCK_VERSION__`` macro is defined +only when compiling via Haddock_ +instead of a normal Haskell compiler. The value of the +``__HADDOCK_VERSION__`` macro is defined as ``A*1000 + B*10 + C``, where +``A.B.C`` is the Haddock version. This can be useful for working around +bugs in Haddock or generating prettier documentation in some special +cases. + +More complex packages +--------------------- + +For packages that don't fit the simple schemes described above, you have +a few options: + +- By using the :pkg-field:`build-type` ``Custom``, you can supply your own + ``Setup.hs`` file, and customize the simple build infrastructure + using *hooks*. These allow you to perform additional actions before + and after each command is run, and also to specify additional + preprocessors. A typical ``Setup.hs`` may look like this: + + .. code-block:: haskell + + import Distribution.Simple + main = defaultMainWithHooks simpleUserHooks { postHaddock = posthaddock } + + posthaddock args flags desc info = .... + + See ``UserHooks`` in + `Distribution.Simple <../release/cabal-latest/doc/API/Cabal/Distribution-Simple.html>`__ + for the details, but note that this interface is experimental, and + likely to change in future releases. + + If you use a custom ``Setup.hs`` file you should strongly consider + adding a :pkg-section:`custom-setup` stanza with a + :pkg-field:`custom-setup:setup-depends` field to ensure that your setup + script does not break with future dependency versions. + +- You could delegate all the work to ``make``, though this is unlikely + to be very portable. Cabal supports this with the :pkg-field:`build-type` + ``Make`` and a trivial setup library + `Distribution.Make <../release/cabal-latest/doc/API/Cabal/Distribution-Make.html>`__, + which simply parses the command line arguments and invokes ``make``. + Here ``Setup.hs`` should look like this: + + .. code-block:: haskell + + import Distribution.Make + main = defaultMain + + The root directory of the package should contain a ``configure`` + script, and, after that has run, a ``Makefile`` with a default target + that builds the package, plus targets ``install``, ``register``, + ``unregister``, ``clean``, ``dist`` and ``docs``. Some options to + commands are passed through as follows: + + - The ``--with-hc-pkg``, ``--prefix``, ``--bindir``, ``--libdir``, + ``--dynlibdir``, ``--datadir``, ``--libexecdir`` and ``--sysconfdir`` options to + the ``configure`` command are passed on to the ``configure`` + script. In addition the value of the ``--with-compiler`` option is + passed in a ``--with-hc`` option and all options specified with + ``--configure-option=`` are passed on. + + - The ``--destdir`` option to the ``copy`` command becomes a setting + of a ``destdir`` variable on the invocation of ``make copy``. The + supplied ``Makefile`` should provide a ``copy`` target, which will + probably look like this: + + .. code-block:: make + + copy : + $(MAKE) install prefix=$(destdir)/$(prefix) \ + bindir=$(destdir)/$(bindir) \ + libdir=$(destdir)/$(libdir) \ + dynlibdir=$(destdir)/$(dynlibdir) \ + datadir=$(destdir)/$(datadir) \ + libexecdir=$(destdir)/$(libexecdir) \ + sysconfdir=$(destdir)/$(sysconfdir) \ + +- Finally, with the :pkg-field:`build-type` ``Custom``, you can also write your + own setup script from scratch. It must conform to the interface + described in the section on `building and installing + packages `__, and you may use the Cabal + library for all or part of the work. One option is to copy the source + of ``Distribution.Simple``, and alter it for your needs. Good luck. + + +.. include:: references.inc diff --git a/doc/users-guide/_sources/file-format-changelog.rst.txt b/doc/users-guide/_sources/file-format-changelog.rst.txt new file mode 100644 --- /dev/null +++ b/doc/users-guide/_sources/file-format-changelog.rst.txt @@ -0,0 +1,25 @@ +Cabal file format changelog +=========================== + +Changes in 2.4 +-------------- + +* Wildcard matching has been expanded. All previous wildcard + expressions are still valid; some will match strictly more files + than before. Specifically: + + * Double-star (``**``) wildcards are now accepted for recursive + matching immediately before the final slash; they must be followed + by a filename wildcard (e.g., ``foo/**/*.html`` is valid; + ``foo/**/bar/*.html`` and ``foo/**/**/*.html``, + ``foo/**/bar.html`` are all invalid). As ``**`` was an error in + globs before, this does not affect any existing ``.cabal`` files + that previously worked. + + * Wildcards now match when the pattern's extensions form a suffix of + the candidate file's extension, rather than requiring strict + equality (e.g., previously ``*.html`` did not match + ``foo.en.html``, but now it does). + +* License fields use identifiers from SPDX License List version + ``3.2 2018-07-10`` diff --git a/doc/users-guide/_sources/index.rst.txt b/doc/users-guide/_sources/index.rst.txt new file mode 100644 --- /dev/null +++ b/doc/users-guide/_sources/index.rst.txt @@ -0,0 +1,15 @@ + +Welcome to the Cabal User Guide +=============================== + +.. toctree:: + :maxdepth: 2 + :numbered: + + intro + config-and-install + concepts-and-development + bugs-and-stability + nix-local-build-overview + nix-integration + file-format-changelog diff --git a/doc/users-guide/_sources/installing-packages.rst.txt b/doc/users-guide/_sources/installing-packages.rst.txt new file mode 100644 --- /dev/null +++ b/doc/users-guide/_sources/installing-packages.rst.txt @@ -0,0 +1,1730 @@ +Configuration +============= + +.. highlight:: cabal + +Overview +-------- + +The global configuration file for ``cabal-install`` is +``~/.cabal/config``. If you do not have this file, ``cabal`` will create +it for you on the first call to ``cabal update``. Alternatively, you can +explicitly ask ``cabal`` to create it for you using + +.. code-block:: console + + $ cabal user-config update + +Most of the options in this configuration file are also available as +command line arguments, and the corresponding documentation can be used +to lookup their meaning. The created configuration file only specifies +values for a handful of options. Most options are left at their default +value, which it documents; for instance, + +:: + + -- executable-stripping: True + +means that the configuration file currently does not specify a value for +the ``executable-stripping`` option (the line is commented out), and +that the default is ``True``; if you wanted to disable stripping of +executables by default, you would change this line to + +:: + + executable-stripping: False + +You can also use ``cabal user-config update`` to migrate configuration +files created by older versions of ``cabal``. + +Repository specification +------------------------ + +An important part of the configuration if the specification of the +repository. When ``cabal`` creates a default config file, it configures +the repository to be the central Hackage server: + +:: + + repository hackage.haskell.org + url: http://hackage.haskell.org/ + +The name of the repository is given on the first line, and can be +anything; packages downloaded from this repository will be cached under +``~/.cabal/packages/hackage.haskell.org`` (or whatever name you specify; +you can change the prefix by changing the value of +``remote-repo-cache``). If you want, you can configure multiple +repositories, and ``cabal`` will combine them and be able to download +packages from any of them. + +Using secure repositories +^^^^^^^^^^^^^^^^^^^^^^^^^ + +For repositories that support the TUF security infrastructure (this +includes Hackage), you can enable secure access to the repository by +specifying: + +:: + + repository hackage.haskell.org + url: http://hackage.haskell.org/ + secure: True + root-keys: + key-threshold: + +The ```` and ```` values are used for +bootstrapping. As part of the TUF infrastructure the repository will +contain a file ``root.json`` (for instance, +http://hackage.haskell.org/root.json) which the client needs to do +verification. However, how can ``cabal`` verify the ``root.json`` file +*itself*? This is known as bootstrapping: if you specify a list of root +key IDs and a corresponding threshold, ``cabal`` will verify that the +downloaded ``root.json`` file has been signed with at least +```` keys from your set of ````. + +You can, but are not recommended to, omit these two fields. In that case +``cabal`` will download the ``root.json`` field and use it without +verification. Although this bootstrapping step is then unsafe, all +subsequent access is secure (provided that the downloaded ``root.json`` +was not tempered with). Of course, adding ``root-keys`` and +``key-threshold`` to your repository specification only shifts the +problem, because now you somehow need to make sure that the key IDs you +received were the right ones. How that is done is however outside the +scope of ``cabal`` proper. + +More information about the security infrastructure can be found at +https://github.com/well-typed/hackage-security. + +Legacy repositories +^^^^^^^^^^^^^^^^^^^ + +Currently ``cabal`` supports two kinds of “legacy” repositories. The +first is specified using + +:: + + remote-repo: hackage.haskell.org:http://hackage.haskell.org/packages/archive + +This is just syntactic sugar for + +:: + + repository hackage.haskell.org + url: hackage.haskell.org:http://hackage.haskell.org/packages/archive + +although, in (and only in) the specific case of Hackage, the URL +``http://hackage.haskell.org/packages/archive`` will be silently +translated to ``http://hackage.haskell.org/``. + +The second kind of legacy repositories are so-called “local” +repositories: + +:: + + local-repo: my-local-repo:/path/to/local/repo + +This can be used to access repositories on the local file system. +However, the layout of these local repositories is different from the +layout of remote repositories, and usage of these local repositories is +deprecated. + +Secure local repositories +^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you want to use repositories on your local file system, it is +recommended instead to use a *secure* local repository: + +:: + + repository my-local-repo + url: file:/path/to/local/repo + secure: True + root-keys: + key-threshold: + +The layout of these secure local repos matches the layout of remote +repositories exactly; the :hackage-pkg:`hackage-repo-tool` +can be used to create and manage such repositories. + +.. _installing-packages: + +Building and installing packages +================================ + +.. highlight:: console + +After you've unpacked a Cabal package, you can build it by moving into +the root directory of the package and running the ``cabal`` tool there: + +:: + + $ cabal [command] [option...] + +The *command* argument selects a particular step in the build/install +process. + +You can also get a summary of the command syntax with + +:: + + $ cabal help + +Alternatively, you can also use the ``Setup.hs`` or ``Setup.lhs`` +script: + +:: + + $ runhaskell Setup.hs [command] [option...] + +For the summary of the command syntax, run: + +:: + + $ cabal help + +or + +:: + + $ runhaskell Setup.hs --help + +Building and installing a system package +---------------------------------------- + +:: + + $ runhaskell Setup.hs configure --ghc + $ runhaskell Setup.hs build + $ runhaskell Setup.hs install + +The first line readies the system to build the tool using GHC; for +example, it checks that GHC exists on the system. The second line +performs the actual building, while the last both copies the build +results to some permanent place and registers the package with GHC. + +Building and installing a user package +-------------------------------------- + +:: + + $ runhaskell Setup.hs configure --user + $ runhaskell Setup.hs build + $ runhaskell Setup.hs install + +The package is installed under the user's home directory and is +registered in the user's package database (:option:`setup configure --user`). + +Installing packages from Hackage +-------------------------------- + +The ``cabal`` tool also can download, configure, build and install a +Hackage_ package and all of its +dependencies in a single step. To do this, run: + +:: + + $ cabal install [PACKAGE...] + +To browse the list of available packages, visit the +Hackage_ web site. + +Developing with sandboxes +------------------------- + +By default, any dependencies of the package are installed into the +global or user package databases (e.g. using +``cabal install --only-dependencies``). If you're building several +different packages that have incompatible dependencies, this can cause +the build to fail. One way to avoid this problem is to build each +package in an isolated environment ("sandbox"), with a sandbox-local +package database. Because sandboxes are per-project, inconsistent +dependencies can be simply disallowed. + +For more on sandboxes, see also `this +article `__. + +Sandboxes: basic usage +^^^^^^^^^^^^^^^^^^^^^^ + +To initialise a fresh sandbox in the current directory, run +``cabal sandbox init``. All subsequent commands (such as ``build`` and +``install``) from this point will use the sandbox. + +:: + + $ cd /path/to/my/haskell/library + $ cabal sandbox init # Initialise the sandbox + $ cabal install --only-dependencies # Install dependencies into the sandbox + $ cabal build # Build your package inside the sandbox + +It can be useful to make a source package available for installation in +the sandbox - for example, if your package depends on a patched or an +unreleased version of a library. This can be done with the +``cabal sandbox add-source`` command - think of it as "local Hackage_". +If an add-source dependency is later modified, it is reinstalled automatically. + +:: + + $ cabal sandbox add-source /my/patched/library # Add a new add-source dependency + $ cabal install --dependencies-only # Install it into the sandbox + $ cabal build # Build the local package + $ $EDITOR /my/patched/library/Source.hs # Modify the add-source dependency + $ cabal build # Modified dependency is automatically reinstalled + +Normally, the sandbox settings (such as optimisation level) are +inherited from the main Cabal config file (``$HOME/cabal/config``). +Sometimes, though, you need to change some settings specifically for a +single sandbox. You can do this by creating a ``cabal.config`` file in +the same directory with your ``cabal.sandbox.config`` (which was created +by ``sandbox init``). This file has the same syntax as the main Cabal +config file. + +:: + + $ cat cabal.config + documentation: True + constraints: foo == 1.0, bar >= 2.0, baz + $ cabal build # Uses settings from the cabal.config file + +When you have decided that you no longer want to build your package +inside a sandbox, just delete it: + +:: + + $ cabal sandbox delete # Built-in command + $ rm -rf .cabal-sandbox cabal.sandbox.config # Alternative manual method + +Sandboxes: advanced usage +^^^^^^^^^^^^^^^^^^^^^^^^^ + +The default behaviour of the ``add-source`` command is to track +modifications done to the added dependency and reinstall the sandbox +copy of the package when needed. Sometimes this is not desirable: in +these cases you can use ``add-source --snapshot``, which disables the +change tracking. In addition to ``add-source``, there are also +``list-sources`` and ``delete-source`` commands. + +Sometimes one wants to share a single sandbox between multiple packages. +This can be easily done with the ``--sandbox`` option: + +:: + + $ mkdir -p /path/to/shared-sandbox + $ cd /path/to/shared-sandbox + $ cabal sandbox init --sandbox . + $ cd /path/to/package-a + $ cabal sandbox init --sandbox /path/to/shared-sandbox + $ cd /path/to/package-b + $ cabal sandbox init --sandbox /path/to/shared-sandbox + +Note that ``cabal sandbox init --sandbox .`` puts all sandbox files into +the current directory. By default, ``cabal sandbox init`` initialises a +new sandbox in a newly-created subdirectory of the current working +directory (``./.cabal-sandbox``). + +Using multiple different compiler versions simultaneously is also +supported, via the ``-w`` option: + +:: + + $ cabal sandbox init + $ cabal install --only-dependencies -w /path/to/ghc-1 # Install dependencies for both compilers + $ cabal install --only-dependencies -w /path/to/ghc-2 + $ cabal configure -w /path/to/ghc-1 # Build with the first compiler + $ cabal build + $ cabal configure -w /path/to/ghc-2 # Build with the second compiler + $ cabal build + +It can be occasionally useful to run the compiler-specific package +manager tool (e.g. ``ghc-pkg``) tool on the sandbox package DB directly +(for example, you may need to unregister some packages). The +``cabal sandbox hc-pkg`` command is a convenient wrapper that runs the +compiler-specific package manager tool with the arguments: + +:: + + $ cabal -v sandbox hc-pkg list + Using a sandbox located at /path/to/.cabal-sandbox + 'ghc-pkg' '--global' '--no-user-package-conf' + '--package-conf=/path/to/.cabal-sandbox/i386-linux-ghc-7.4.2-packages.conf.d' + 'list' + [...] + +The ``--require-sandbox`` option makes all sandbox-aware commands +(``install``/``build``/etc.) exit with error if there is no sandbox +present. This makes it harder to accidentally modify the user package +database. The option can be also turned on via the per-user +configuration file (``~/.cabal/config``) or the per-project one +(``$PROJECT_DIR/cabal.config``). The error can be squelched with +``--no-require-sandbox``. + +The option ``--sandbox-config-file`` allows to specify the location of +the ``cabal.sandbox.config`` file (by default, ``cabal`` searches for it +in the current directory). This provides the same functionality as +shared sandboxes, but sometimes can be more convenient. Example: + +:: + + $ mkdir my/sandbox + $ cd my/sandbox + $ cabal sandbox init + $ cd /path/to/my/project + $ cabal --sandbox-config-file=/path/to/my/sandbox/cabal.sandbox.config install + # Uses the sandbox located at /path/to/my/sandbox/.cabal-sandbox + $ cd ~ + $ cabal --sandbox-config-file=/path/to/my/sandbox/cabal.sandbox.config install + # Still uses the same sandbox + +The sandbox config file can be also specified via the +``CABAL_SANDBOX_CONFIG`` environment variable. + +Finally, the flag ``--ignore-sandbox`` lets you temporarily ignore an +existing sandbox: + +:: + + $ mkdir my/sandbox + $ cd my/sandbox + $ cabal sandbox init + $ cabal --ignore-sandbox install text + # Installs 'text' in the user package database ('~/.cabal'). + +Creating a binary package +------------------------- + +When creating binary packages (e.g. for Red Hat or Debian) one needs to +create a tarball that can be sent to another system for unpacking in the +root directory: + +:: + + $ runhaskell Setup.hs configure --prefix=/usr + $ runhaskell Setup.hs build + $ runhaskell Setup.hs copy --destdir=/tmp/mypkg + $ tar -czf mypkg.tar.gz /tmp/mypkg/ + +If the package contains a library, you need two additional steps: + +:: + + $ runhaskell Setup.hs register --gen-script + $ runhaskell Setup.hs unregister --gen-script + +This creates shell scripts ``register.sh`` and ``unregister.sh``, which +must also be sent to the target system. After unpacking there, the +package must be registered by running the ``register.sh`` script. The +``unregister.sh`` script would be used in the uninstall procedure of the +package. Similar steps may be used for creating binary packages for +Windows. + +The following options are understood by all commands: + +.. program:: setup + +.. option:: --help, -h or -? + + List the available options for the command. + +.. option:: --verbose=n or -v n + + Set the verbosity level (0-3). The normal level is 1; a missing *n* + defaults to 2. + + There is also an extended version of this command which can be + used to fine-tune the verbosity of output. It takes the + form ``[silent|normal|verbose|debug]``\ *flags*, where *flags* + is a list of ``+`` flags which toggle various aspects of + output. At the moment, only ``+callsite`` and ``+callstack`` + are supported, which respectively toggle call site and call + stack printing (these are only supported if Cabal + is built with a sufficiently recent GHC.) + +The various commands and the additional options they support are +described below. In the simple build infrastructure, any other options +will be reported as errors. + +.. _setup-configure: + +setup configure +--------------- + +.. program:: setup configure + +Prepare to build the package. Typically, this step checks that the +target platform is capable of building the package, and discovers +platform-specific features that are needed during the build. + +The user may also adjust the behaviour of later stages using the options +listed in the following subsections. In the simple build infrastructure, +the values supplied via these options are recorded in a private file +read by later stages. + +If a user-supplied ``configure`` script is run (see the section on +`system-dependent +parameters `__ or +on `complex +packages `__), it is +passed the :option:`--with-hc-pkg`, :option:`--prefix`, :option:`--bindir`, +:option:`--libdir`, :option:`--dynlibdir`, :option:`--datadir`, :option:`--libexecdir` and +:option:`--sysconfdir` options. In addition the value of the +:option:`--with-compiler` option is passed in a :option:`--with-hc-pkg` option +and all options specified with :option:`--configure-option` are passed on. + +.. note:: + `GNU autoconf places restrictions on paths, including the directory + that the package is built from. + `_ + The errors produced when this happens can be obscure; Cabal attempts to + detect and warn in this situation, but it is not perfect. + +In Cabal 2.0, support for a single positional argument was added to +``setup configure`` This makes Cabal configure a the specific component +to be configured. Specified names can be qualified with ``lib:`` or +``exe:`` in case just a name is ambiguous (as would be the case for a +package named ``p`` which has a library and an executable named ``p``.) +This has the following effects: + +- Subsequent invocations of ``cabal build``, ``register``, etc. operate only + on the configured component. + +- Cabal requires all "internal" dependencies (e.g., an executable + depending on a library defined in the same package) must be found in + the set of databases via :option:`--package-db` (and related flags): these + dependencies are assumed to be up-to-date. A dependency can be + explicitly specified using :option:`--dependency` simply by giving the name + of the internal library; e.g., the dependency for an internal library + named ``foo`` is given as + ``--dependency=pkg-internal=pkg-1.0-internal-abcd``. + +- Only the dependencies needed for the requested component are + required. Similarly, when :option:`--exact-configuration` is specified, + it's only necessary to specify :option:`--dependency` for the component. + (As mentioned previously, you *must* specify internal dependencies as + well.) + +- Internal ``build-tool-depends`` and ``build-tools`` dependencies are expected + to be in the ``PATH`` upon subsequent invocations of ``setup``. + +Full details can be found in the `Componentized Cabal +proposal `__. + +Programs used for building +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following options govern the programs used to process the source +files of a package: + +.. option:: --ghc or -g, --jhc, --lhc, --uhc + + Specify which Haskell implementation to use to build the package. At + most one of these flags may be given. If none is given, the + implementation under which the setup script was compiled or + interpreted is used. + +.. option:: --with-compiler=path or -w *path* + + Specify the path to a particular compiler. If given, this must match + the implementation selected above. The default is to search for the + usual name of the selected implementation. + + This flag also sets the default value of the :option:`--with-hc-pkg` + option to the package tool for this compiler. Check the output of + ``setup configure -v`` to ensure that it finds the right package + tool (or use :option:`--with-hc-pkg` explicitly). + +.. option:: --with-hc-pkg=path + + Specify the path to the package tool, e.g. ``ghc-pkg``. The package + tool must be compatible with the compiler specified by + :option:`--with-compiler`. If this option is omitted, the default value is + determined from the compiler selected. + +.. option:: --with-prog=path + + Specify the path to the program *prog*. Any program known to Cabal + can be used in place of *prog*. It can either be a fully path or the + name of a program that can be found on the program search path. For + example: ``--with-ghc=ghc-6.6.1`` or + ``--with-cpphs=/usr/local/bin/cpphs``. The full list of accepted + programs is not enumerated in this user guide. Rather, run + ``cabal install --help`` to view the list. + +.. option:: --prog-options=options + + Specify additional options to the program *prog*. Any program known + to Cabal can be used in place of *prog*. For example: + ``--alex-options="--template=mytemplatedir/"``. The *options* is + split into program options based on spaces. Any options containing + embedded spaced need to be quoted, for example + ``--foo-options='--bar="C:\Program File\Bar"'``. As an alternative + that takes only one option at a time but avoids the need to quote, + use :option:`--prog-option` instead. + +.. option:: --prog-option=option + + Specify a single additional option to the program *prog*. For + passing an option that contain embedded spaces, such as a file name + with embedded spaces, using this rather than :option:`--prog-options` + means you do not need an additional level of quoting. Of course if you + are using a command shell you may still need to quote, for example + ``--foo-options="--bar=C:\Program File\Bar"``. + +All of the options passed with either :option:`--prog-options` +or :option:`--prog-option` are passed in the order they were +specified on the configure command line. + +Installation paths +^^^^^^^^^^^^^^^^^^ + +The following options govern the location of installed files from a +package: + +.. option:: --prefix=dir + + The root of the installation. For example for a global install you + might use ``/usr/local`` on a Unix system, or ``C:\Program Files`` + on a Windows system. The other installation paths are usually + subdirectories of *prefix*, but they don't have to be. + + In the simple build system, *dir* may contain the following path + variables: ``$pkgid``, ``$pkg``, ``$version``, ``$compiler``, + ``$os``, ``$arch``, ``$abi``, ``$abitag`` + +.. option:: --bindir=dir + + Executables that the user might invoke are installed here. + + In the simple build system, *dir* may contain the following path + variables: ``$prefix``, ``$pkgid``, ``$pkg``, ``$version``, + ``$compiler``, ``$os``, ``$arch``, ``$abi``, ``$abitag`` + +.. option:: --libdir=dir + + Object-code libraries are installed here. + + In the simple build system, *dir* may contain the following path + variables: ``$prefix``, ``$bindir``, ``$pkgid``, ``$pkg``, + ``$version``, ``$compiler``, ``$os``, ``$arch``, ``$abi``, + ``$abitag`` + +.. option:: --dynlibdir=dir + + Dynamic libraries are installed here. + + By default, this is set to `$libdir/$abi`, which is usually not equal to + `$libdir/$libsubdir`. + + In the simple build system, *dir* may contain the following path + variables: ``$prefix``, ``$bindir``, ``$libdir``, ``$pkgid``, ``$pkg``, + ``$version``, ``$compiler``, ``$os``, ``$arch``, ``$abi``, + ``$abitag`` + +.. option:: --libexecdir=dir + + Executables that are not expected to be invoked directly by the user + are installed here. + + In the simple build system, *dir* may contain the following path + variables: ``$prefix``, ``$bindir``, ``$libdir``, ``$libsubdir``, + ``$pkgid``, ``$pkg``, ``$version``, ``$compiler``, ``$os``, + ``$arch``, ``$abi``, ``$abitag`` + +.. option:: --datadir=dir + + Architecture-independent data files are installed here. + + In the simple build system, *dir* may contain the following path + variables: ``$prefix``, ``$bindir``, ``$libdir``, ``$libsubdir``, + ``$pkgid``, ``$pkg``, ``$version``, ``$compiler``, ``$os``, + ``$arch``, ``$abi``, ``$abitag`` + +.. option:: --sysconfdir=dir + + Installation directory for the configuration files. + + In the simple build system, *dir* may contain the following path + variables: ``$prefix``, ``$bindir``, ``$libdir``, ``$libsubdir``, + ``$pkgid``, ``$pkg``, ``$version``, ``$compiler``, ``$os``, + ``$arch``, ``$abi``, ``$abitag`` + +In addition the simple build system supports the following installation +path options: + +.. option:: --libsubdir=dir + + A subdirectory of *libdir* in which libraries are actually installed. For + example, in the simple build system on Unix, the default *libdir* is + ``/usr/local/lib``, and *libsubdir* contains the compiler ABI and package + identifier, + e.g. ``x86_64-linux-ghc-8.0.2/mypkg-0.1.0-IxQNmCA7qrSEQNkoHSF7A``, so + libraries would be installed in + ``/usr/local/lib/x86_64-linux-ghc-8.0.2/mypkg-0.1.0-IxQNmCA7qrSEQNkoHSF7A/``. + + *dir* may contain the following path variables: ``$pkgid``, + ``$pkg``, ``$version``, ``$compiler``, ``$os``, ``$arch``, ``$abi``, + ``$abitag`` + +.. option:: --libexecsubdir=dir + + A subdirectory of *libexecdir* in which private executables are + installed. For example, in the simple build system on Unix, the default + *libexecdir* is ``/usr/local/libexec``, and *libsubdir* is + ``x86_64-linux-ghc-8.0.2/mypkg-0.1.0``, so private executables would be + installed in ``/usr/local/libexec/x86_64-linux-ghc-8.0.2/mypkg-0.1.0/`` + + *dir* may contain the following path variables: ``$pkgid``, + ``$pkg``, ``$version``, ``$compiler``, ``$os``, ``$arch``, ``$abi``, + ``$abitag`` + +.. option:: --datasubdir=dir + + A subdirectory of *datadir* in which data files are actually + installed. + + *dir* may contain the following path variables: ``$pkgid``, + ``$pkg``, ``$version``, ``$compiler``, ``$os``, ``$arch``, ``$abi``, + ``$abitag`` + +.. option:: --docdir=dir + + Documentation files are installed relative to this directory. + + *dir* may contain the following path variables: ``$prefix``, + ``$bindir``, ``$libdir``, ``$libsubdir``, ``$datadir``, + ``$datasubdir``, ``$pkgid``, ``$pkg``, ``$version``, ``$compiler``, + ``$os``, ``$arch``, ``$abi``, ``$abitag`` + +.. option:: --htmldir=dir + + HTML documentation files are installed relative to this directory. + + *dir* may contain the following path variables: ``$prefix``, + ``$bindir``, ``$libdir``, ``$libsubdir``, ``$datadir``, + ``$datasubdir``, ``$docdir``, ``$pkgid``, ``$pkg``, ``$version``, + ``$compiler``, ``$os``, ``$arch``, ``$abi``, ``$abitag`` + +.. option:: --program-prefix=prefix + + Prepend *prefix* to installed program names. + + *prefix* may contain the following path variables: ``$pkgid``, + ``$pkg``, ``$version``, ``$compiler``, ``$os``, ``$arch``, ``$abi``, + ``$abitag`` + +.. option:: --program-suffix=suffix + + Append *suffix* to installed program names. The most obvious use for + this is to append the program's version number to make it possible + to install several versions of a program at once: + ``--program-suffix='$version'``. + + *suffix* may contain the following path variables: ``$pkgid``, + ``$pkg``, ``$version``, ``$compiler``, ``$os``, ``$arch``, ``$abi``, + ``$abitag`` + +Path variables in the simple build system +""""""""""""""""""""""""""""""""""""""""" + +For the simple build system, there are a number of variables that can be +used when specifying installation paths. The defaults are also specified +in terms of these variables. A number of the variables are actually for +other paths, like ``$prefix``. This allows paths to be specified +relative to each other rather than as absolute paths, which is important +for building relocatable packages (see `prefix +independence <#prefix-independence>`__). + +$prefix + The path variable that stands for the root of the installation. For + an installation to be relocatable, all other installation paths must + be relative to the ``$prefix`` variable. +$bindir + The path variable that expands to the path given by the :option:`--bindir` + configure option (or the default). +$libdir + As above but for :option:`--libdir` +$libsubdir + As above but for :option:`--libsubdir` +$dynlibdir + As above but for :option:`--dynlibdir` +$datadir + As above but for :option:`--datadir` +$datasubdir + As above but for :option:`--datasubdir` +$docdir + As above but for :option:`--docdir` +$pkgid + The name and version of the package, e.g. ``mypkg-0.2`` +$pkg + The name of the package, e.g. ``mypkg`` +$version + The version of the package, e.g. ``0.2`` +$compiler + The compiler being used to build the package, e.g. ``ghc-6.6.1`` +$os + The operating system of the computer being used to build the + package, e.g. ``linux``, ``windows``, ``osx``, ``freebsd`` or + ``solaris`` +$arch + The architecture of the computer being used to build the package, + e.g. ``i386``, ``x86_64``, ``ppc`` or ``sparc`` +$abitag + An optional tag that a compiler can use for telling incompatible + ABI's on the same architecture apart. GHCJS encodes the underlying + GHC version in the ABI tag. +$abi + A shortcut for getting a path that completely identifies the + platform in terms of binary compatibility. Expands to the same value + as ``$arch-$os-compiler-$abitag`` if the compiler uses an abi tag, + ``$arch-$os-$compiler`` if it doesn't. + +Paths in the simple build system +"""""""""""""""""""""""""""""""" + +For the simple build system, the following defaults apply: + +.. list-table:: Default installation paths + + * - Option + - Unix Default + - Windows Default + * - :option:`--prefix` (global) + - ``/usr/local`` + - ``%PROGRAMFILES%\Haskell`` + * - :option:`--prefix` (per-user) + - ``$HOME/.cabal`` + - ``%APPDATA%\cabal`` + * - :option:`--bindir` + - ``$prefix/bin`` + - ``$prefix\bin`` + * - :option:`--libdir` + - ``$prefix/lib`` + - ``$prefix`` + * - :option:`--libsubdir` (others) + - ``$pkgid/$compiler`` + - ``$pkgid\$compiler`` + * - :option:`--dynlibdir` + - ``$libdir/$abi`` + - ``$libdir\$abi`` + * - :option:`--libexecdir` + - ``$prefix/libexec`` + - ``$prefix\$pkgid`` + * - :option:`--datadir` (executable) + - ``$prefix/share`` + - ``$prefix`` + * - :option:`--datadir` (library) + - ``$prefix/share`` + - ``%PROGRAMFILES%\Haskell`` + * - :option:`--datasubdir` + - ``$pkgid`` + - ``$pkgid`` + * - :option:`--docdir` + - ``$datadir/doc/$pkgid`` + - ``$prefix\doc\$pkgid`` + * - :option:`--sysconfdir` + - ``$prefix/etc`` + - ``$prefix\etc`` + * - :option:`--htmldir` + - ``$docdir/html`` + - ``$docdir\html`` + * - :option:`--program-prefix` + - (empty) + - (empty) + * - :option:`--program-suffix` + - (empty) + - (empty) + +Prefix-independence +""""""""""""""""""" + +On Windows it is possible to obtain the pathname of the running program. +This means that we can construct an installable executable package that +is independent of its absolute install location. The executable can find +its auxiliary files by finding its own path and knowing the location of +the other files relative to ``$bindir``. Prefix-independence is +particularly useful: it means the user can choose the install location +(i.e. the value of ``$prefix``) at install-time, rather than having to +bake the path into the binary when it is built. + +In order to achieve this, we require that for an executable on Windows, +all of ``$bindir``, ``$libdir``, ``$dynlibdir``, ``$datadir`` and ``$libexecdir`` begin +with ``$prefix``. If this is not the case then the compiled executable +will have baked-in all absolute paths. + +The application need do nothing special to achieve prefix-independence. +If it finds any files using ``getDataFileName`` and the `other functions +provided for the +purpose `__, +the files will be accessed relative to the location of the current +executable. + +A library cannot (currently) be prefix-independent, because it will be +linked into an executable whose file system location bears no relation +to the library package. + +Controlling Flag Assignments +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Flag assignments (see the `resolution of conditions and +flags `__) +can be controlled with the following command line options. + +.. option:: -f flagname or -f -flagname + + Force the specified flag to ``true`` or ``false`` (if preceded with + a ``-``). Later specifications for the same flags will override + earlier, i.e., specifying ``-fdebug -f-debug`` is equivalent to + ``-f-debug`` + +.. option:: --flags=flagspecs + + Same as ``-f``, but allows specifying multiple flag assignments at + once. The parameter is a space-separated list of flag names (to + force a flag to ``true``), optionally preceded by a ``-`` (to force + a flag to ``false``). For example, + ``--flags="debug -feature1 feature2"`` is equivalent to + ``-fdebug -f-feature1 -ffeature2``. + +Building Test Suites +^^^^^^^^^^^^^^^^^^^^ + +.. option:: --enable-tests + + Build the test suites defined in the package description file during + the ``build`` stage. Check for dependencies required by the test + suites. If the package is configured with this option, it will be + possible to run the test suites with the ``test`` command after the + package is built. + +.. option:: --disable-tests + + (default) Do not build any test suites during the ``build`` stage. + Do not check for dependencies required only by the test suites. It + will not be possible to invoke the ``test`` command without + reconfiguring the package. + +.. option:: --enable-coverage + + Build libraries and executables (including test suites) with Haskell + Program Coverage enabled. Running the test suites will automatically + generate coverage reports with HPC. + +.. option:: --disable-coverage + + (default) Do not enable Haskell Program Coverage. + +Miscellaneous options +^^^^^^^^^^^^^^^^^^^^^ + +.. option:: --user + + Does a per-user installation. This changes the `default installation + prefix <#paths-in-the-simple-build-system>`__. It also allow + dependencies to be satisfied by the user's package database, in + addition to the global database. This also implies a default of + ``--user`` for any subsequent ``install`` command, as packages + registered in the global database should not depend on packages + registered in a user's database. + +.. option:: --global + + (default) Does a global installation. In this case package + dependencies must be satisfied by the global package database. All + packages in the user's package database will be ignored. Typically + the final installation step will require administrative privileges. + +.. option:: --package-db=db + + Allows package dependencies to be satisfied from this additional + package database *db* in addition to the global package database. + All packages in the user's package database will be ignored. The + interpretation of *db* is implementation-specific. Typically it will + be a file or directory. Not all implementations support arbitrary + package databases. + + This pushes an extra db onto the db stack. The :option:`--global` and + :option:`--user` mode switches add the respective [Global] and [Global, + User] dbs to the initial stack. There is a compiler-implementation + constraint that the global db must appear first in the stack, and if + the user one appears at all, it must appear immediately after the + global db. + + To reset the stack, use ``--package-db=clear``. + +.. option:: --ipid=ipid + + Specifies the *installed package identifier* of the package to be + built; this identifier is passed on to GHC and serves as the basis + for linker symbols and the ``id`` field in a ``ghc-pkg`` + registration. When a package has multiple components, the actual + component identifiers are derived off of this identifier (e.g., an + internal library ``foo`` from package ``p-0.1-abcd`` will get the + identifier ``p-0.1-abcd-foo``. + +.. option:: --cid=cid + + Specifies the *component identifier* of the component being built; + this is only valid if you are configuring a single component. + +.. option:: --default-user-config=file + + Allows a "default" ``cabal.config`` freeze file to be passed in + manually. This file will only be used if one does not exist in the + project directory already. Typically, this can be set from the + global cabal ``config`` file so as to provide a default set of + partial constraints to be used by projects, providing a way for + users to peg themselves to stable package collections. + +.. option:: --enable-optimization[=n] or -O [n] + + (default) Build with optimization flags (if available). This is + appropriate for production use, taking more time to build faster + libraries and programs. + + The optional *n* value is the optimisation level. Some compilers + support multiple optimisation levels. The range is 0 to 2. Level 0 + is equivalent to :option:`--disable-optimization`, level 1 is the + default if no *n* parameter is given. Level 2 is higher optimisation + if the compiler supports it. Level 2 is likely to lead to longer + compile times and bigger generated code. + + When optimizations are enabled, Cabal passes ``-O2`` to the C compiler. + +.. option:: --disable-optimization + + Build without optimization. This is suited for development: building + will be quicker, but the resulting library or programs will be + slower. + +.. option:: --enable-profiling + + Build libraries and executables with profiling enabled (for + compilers that support profiling as a separate mode). For this to + work, all libraries used by this package must also have been built + with profiling support. For libraries this involves building an + additional instance of the library in addition to the normal + non-profiling instance. For executables it changes the single + executable to be built in profiling mode. + + This flag covers both libraries and executables, but can be + overridden by the :option:`--enable-library-profiling` flag. + + See also the :option:`--profiling-detail` flag below. + +.. option:: --disable-profiling + + (default) Do not enable profiling in generated libraries and + executables. + +.. option:: --enable-library-profiling or -p + + As with :option:`--enable-profiling` above, but it applies only for + libraries. So this generates an additional profiling instance of the + library in addition to the normal non-profiling instance. + + The :option:`--enable-profiling` flag controls the profiling mode for both + libraries and executables, but if different modes are desired for + libraries versus executables then use :option:`--enable-library-profiling` + as well. + +.. option:: --disable-library-profiling + + (default) Do not generate an additional profiling version of the library. + +.. option:: --profiling-detail[=level] + + Some compilers that support profiling, notably GHC, can allocate + costs to different parts of the program and there are different + levels of granularity or detail with which this can be done. In + particular for GHC this concept is called "cost centers", and GHC + can automatically add cost centers, and can do so in different ways. + + This flag covers both libraries and executables, but can be + overridden by the :option:`--library-profiling-detail` flag. + + Currently this setting is ignored for compilers other than GHC. The + levels that cabal currently supports are: + + default + For GHC this uses ``exported-functions`` for libraries and + ``toplevel-functions`` for executables. + none + No costs will be assigned to any code within this component. + exported-functions + Costs will be assigned at the granularity of all top level + functions exported from each module. In GHC specifically, this + is for non-inline functions. + toplevel-functions + Costs will be assigned at the granularity of all top level + functions in each module, whether they are exported from the + module or not. In GHC specifically, this is for non-inline + functions. + all-functions + Costs will be assigned at the granularity of all functions in + each module, whether top level or local. In GHC specifically, + this is for non-inline toplevel or where-bound functions or + values. + + This flag is new in Cabal-1.24. Prior versions used the equivalent + of ``none`` above. + +.. option:: --library-profiling-detail[=level] + + As with :option:`--profiling-detail` above, but it applies only for + libraries. + + The level for both libraries and executables is set by the + :option:`--profiling-detail` flag, but if different levels are desired + for libraries versus executables then use + :option:`--library-profiling-detail` as well. + +.. option:: --enable-library-vanilla + + (default) Build ordinary libraries (as opposed to profiling + libraries). This is independent of the + :option:`--enable-library-profiling` option. If you enable both, you get + both. + +.. option:: --disable-library-vanilla + + Do not build ordinary libraries. This is useful in conjunction with + :option:`--enable-library-profiling` to build only profiling libraries, + rather than profiling and ordinary libraries. + +.. option:: --enable-library-for-ghci + + (default) Build libraries suitable for use with GHCi. + +.. option:: --disable-library-for-ghci + + Not all platforms support GHCi and indeed on some platforms, trying + to build GHCi libs fails. In such cases this flag can be used as a + workaround. + +.. option:: --enable-split-objs + + Use the GHC ``-split-objs`` feature when building the library. This + reduces the final size of the executables that use the library by + allowing them to link with only the bits that they use rather than + the entire library. The downside is that building the library takes + longer and uses considerably more memory. + +.. option:: --disable-split-objs + + (default) Do not use the GHC ``-split-objs`` feature. This makes + building the library quicker but the final executables that use the + library will be larger. + +.. option:: --enable-executable-stripping + + (default) When installing binary executable programs, run the + ``strip`` program on the binary. This can considerably reduce the + size of the executable binary file. It does this by removing + debugging information and symbols. While such extra information is + useful for debugging C programs with traditional debuggers it is + rarely helpful for debugging binaries produced by Haskell compilers. + + Not all Haskell implementations generate native binaries. For such + implementations this option has no effect. + +.. option:: --disable-executable-stripping + + Do not strip binary executables during installation. You might want + to use this option if you need to debug a program using gdb, for + example if you want to debug the C parts of a program containing + both Haskell and C code. Another reason is if your are building a + package for a system which has a policy of managing the stripping + itself (such as some Linux distributions). + +.. option:: --enable-shared + + Build shared library. This implies a separate compiler run to + generate position independent code as required on most platforms. + +.. option:: --disable-shared + + (default) Do not build shared library. + +.. option:: --enable-static + + Build a static library. This passes ``-staticlib`` to GHC (available + for iOS, and with 8.4 more platforms). The result is an archive ``.a`` + containing all dependent haskell libararies combined. + +.. option:: --disable-static + + (default) Do not build a static library. + +.. option:: --enable-executable-dynamic + + Link executables dynamically. The executable's library dependencies + should be built as shared objects. This implies :option:`--enable-shared` + unless :option:`--disable-shared` is explicitly specified. + +.. option:: --disable-executable-dynamic + + (default) Link executables statically. + +.. option:: --configure-option=str + + An extra option to an external ``configure`` script, if one is used + (see the section on `system-dependent + parameters `__). + There can be several of these options. + +.. option:: --extra-include-dirs[=dir] + + An extra directory to search for C header files. You can use this + flag multiple times to get a list of directories. + + You might need to use this flag if you have standard system header + files in a non-standard location that is not mentioned in the + package's ``.cabal`` file. Using this option has the same affect as + appending the directory *dir* to the ``include-dirs`` field in each + library and executable in the package's ``.cabal`` file. The + advantage of course is that you do not have to modify the package at + all. These extra directories will be used while building the package + and for libraries it is also saved in the package registration + information and used when compiling modules that use the library. + +.. option:: --extra-lib-dirs[=dir] + + An extra directory to search for system libraries files. You can use + this flag multiple times to get a list of directories. + +.. option:: --extra-framework-dirs[=dir] + + An extra directory to search for frameworks (OS X only). You can use + this flag multiple times to get a list of directories. + + You might need to use this flag if you have standard system + libraries in a non-standard location that is not mentioned in the + package's ``.cabal`` file. Using this option has the same affect as + appending the directory *dir* to the ``extra-lib-dirs`` field in + each library and executable in the package's ``.cabal`` file. The + advantage of course is that you do not have to modify the package at + all. These extra directories will be used while building the package + and for libraries it is also saved in the package registration + information and used when compiling modules that use the library. + +.. option:: --dependency[=pkgname=ipid] + + Specify that a particular dependency should used for a particular + package name. In particular, it declares that any reference to + *pkgname* in a ``build-depends`` should be resolved to *ipid*. + +.. option:: --exact-configuration + + This changes Cabal to require every dependency be explicitly + specified using :option:`--dependency`, rather than use Cabal's (very + simple) dependency solver. This is useful for programmatic use of + Cabal's API, where you want to error if you didn't specify enough + :option:`--dependency` flags. + +.. option:: --allow-newer[=pkgs], --allow-older[=pkgs] + + Selectively relax upper or lower bounds in dependencies without + editing the package description respectively. + + The following description focuses on upper bounds and the + :option:`--allow-newer` flag, but applies analogously to + :option:`--allow-older` and lower bounds. :option:`--allow-newer` + and :option:`--allow-older` can be used at the same time. + + If you want to install a package A that depends on B >= 1.0 && < + 2.0, but you have the version 2.0 of B installed, you can compile A + against B 2.0 by using ``cabal install --allow-newer=B A``. This + works for the whole package index: if A also depends on C that in + turn depends on B < 2.0, C's dependency on B will be also relaxed. + + Example: + + :: + + $ cd foo + $ cabal configure + Resolving dependencies... + cabal: Could not resolve dependencies: + [...] + $ cabal configure --allow-newer + Resolving dependencies... + Configuring foo... + + Additional examples: + + :: + + # Relax upper bounds in all dependencies. + $ cabal install --allow-newer foo + + # Relax upper bounds only in dependencies on bar, baz and quux. + $ cabal install --allow-newer=bar,baz,quux foo + + # Relax the upper bound on bar and force bar==2.1. + $ cabal install --allow-newer=bar --constraint="bar==2.1" foo + + It's also possible to limit the scope of :option:`--allow-newer` to single + packages with the ``--allow-newer=scope:dep`` syntax. This means + that the dependency on ``dep`` will be relaxed only for the package + ``scope``. + + Example: + + :: + + # Relax upper bound in foo's dependency on base; also relax upper bound in + # every package's dependency on lens. + $ cabal install --allow-newer=foo:base,lens + + # Relax upper bounds in foo's dependency on base and bar's dependency + # on time; also relax the upper bound in the dependency on lens specified by + # any package. + $ cabal install --allow-newer=foo:base,lens --allow-newer=bar:time + + Finally, one can enable :option:`--allow-newer` permanently by setting + ``allow-newer: True`` in the ``~/.cabal/config`` file. Enabling + 'allow-newer' selectively is also supported in the config file + (``allow-newer: foo, bar, baz:base``). + +.. option:: --constraint=constraint + + Restrict solutions involving a package to given version + bounds, flag settings, and other properties. For example, to + consider only install plans that use version 2.1 of ``bar`` + or do not use ``bar`` at all, write: + + :: + + $ cabal install --constraint="bar == 2.1" + + Version bounds have the same syntax as ``build-depends``. As + a special case, the following prevents ``bar`` from being + used at all: + + :: + + # Note: this is just syntax sugar for '> 1 && < 1', and is + # supported by build-depends. + $ cabal install --constraint="bar -none" + + You can also specify flag assignments: + + :: + + # Require bar to be installed with the foo flag turned on and + # the baz flag turned off. + $ cabal install --constraint="bar +foo -baz" + + To specify multiple constraints, you may pass the + ``constraint`` option multiple times. + + There are also some more specialized constraints, which most people + don't generally need: + + :: + + # Require that a version of bar be used that is already installed in + # the global package database. + $ cabal install --constraint="bar installed" + + # Require the local source copy of bar to be used. + # (Note: By default, if we have a local package we will + # automatically use it, so it will generally not be necessary to + # specify this.) + $ cabal install --constraint="bar source" + + # Require that bar have test suites and benchmarks enabled. + $ cabal install --constraint="bar test" --constraint="bar bench" + + By default, constraints only apply to build dependencies + (``build-depends``), build dependencies of build + dependencies, and so on. Constraints normally do not apply to + dependencies of the ``Setup.hs`` script of any package + (``setup-depends``) nor do they apply to build tools + (``build-tool-depends``) or the dependencies of build + tools. To explicitly apply a constraint to a setup or build + tool dependency, you can add a qualifier to the constraint as + follows: + + :: + + # Example use of the 'any' qualifier. This constraint + # applies to package bar anywhere in the dependency graph. + $ cabal install --constraint="any.bar == 1.0" + + :: + + # Example uses of 'setup' qualifiers. + + # This constraint applies to package bar when it is a + # dependency of any Setup.hs script. + $ cabal install --constraint="setup.bar == 1.0" + + # This constraint applies to package bar when it is a + # dependency of the Setup.hs script of package foo. + $ cabal install --constraint="foo:setup.bar == 1.0" + + .. TODO: Uncomment this example once we decide on a syntax for 'exe'. + .. # Example use of the 'exe' (executable build tool) + # qualifier. This constraint applies to package baz when it + # is a dependency of the build tool bar being used to + # build package foo. + $ cabal install --constraint="foo:bar:exe.baz == 1.0" + +.. option:: --preference=preference + + Specify a soft constraint on versions of a package. The solver will + attempt to satisfy these preferences on a "best-effort" basis. + +.. option:: --disable-response-files + + Enable workaround for older versions of programs such as ``ar`` or + ``ld`` that do not support response file arguments (i.e. ``@file`` + arguments). You may want this flag only if you specify custom ar + executable. For system ``ar`` or the one bundled with ``ghc`` on + Windows the ``cabal`` should do the right thing and hence should + normally not require this flag. + +.. _setup-build: + +setup build +----------- + +Perform any preprocessing or compilation needed to make this package +ready for installation. + +This command takes the following options: + +.. program:: setup build + +.. option:: --prog-options=options, --prog-option=option + + These are mostly the same as the `options configure + step <#setup-configure>`__. Unlike the options specified at the + configure step, any program options specified at the build step are + not persistent but are used for that invocation only. They options + specified at the build step are in addition not in replacement of + any options specified at the configure step. + +.. _setup-haddock: + +setup haddock +------------- + +.. program:: setup haddock + +Build the documentation for the package using Haddock_. +By default, only the documentation for the exposed modules is generated +(but see the :option:`--executables` and :option:`--internal` flags below). + +This command takes the following options: + +.. option:: --hoogle + + Generate a file ``dist/doc/html/``\ *pkgid*\ ``.txt``, which can be + converted by Hoogle_ into a + database for searching. This is equivalent to running Haddock_ + with the ``--hoogle`` flag. + +.. option:: --html-location=url + + Specify a template for the location of HTML documentation for + prerequisite packages. The substitutions (`see + listing <#paths-in-the-simple-build-system>`__) are applied to the + template to obtain a location for each package, which will be used + by hyperlinks in the generated documentation. For example, the + following command generates links pointing at Hackage_ pages: + + setup haddock + --html-location='http://hackage.haskell.org/packages/archive/$pkg/latest/doc/html' + + Here the argument is quoted to prevent substitution by the shell. If + this option is omitted, the location for each package is obtained + using the package tool (e.g. ``ghc-pkg``). + +.. option:: --executables + + Also run Haddock_ for the modules of all the executable programs. By default + Haddock_ is run only on the exported modules. + +.. option:: --internal + + Run Haddock_ for the all + modules, including unexposed ones, and make + Haddock_ generate documentation + for unexported symbols as well. + +.. option:: --css=path + + The argument *path* denotes a CSS file, which is passed to + Haddock_ and used to set the + style of the generated documentation. This is only needed to + override the default style that + Haddock_ uses. + +.. option:: --hyperlink-source + + Generate Haddock_ documentation integrated with HsColour_ . First, + HsColour_ is run to generate colourised code. Then Haddock_ is run to + generate HTML documentation. Each entity shown in the documentation is + linked to its definition in the colourised code. + +.. option:: --hscolour-css=path + + The argument *path* denotes a CSS file, which is passed to HsColour_ as in + + runhaskell Setup.hs hscolour --css=*path* + +.. _setup-hscolour: + +setup hscolour +-------------- + +Produce colourised code in HTML format using HsColour_. Colourised code for +exported modules is put in ``dist/doc/html/``\ *pkgid*\ ``/src``. + +This command takes the following options: + +.. program:: setup hscolour + +.. option:: --executables + + Also run HsColour_ on the sources of all executable programs. Colourised + code is put in ``dist/doc/html/``\ *pkgid*/*executable*\ ``/src``. + +.. option:: --css=path + + Use the given CSS file for the generated HTML files. The CSS file + defines the colours used to colourise code. Note that this copies + the given CSS file to the directory with the generated HTML files + (renamed to ``hscolour.css``) rather than linking to it. + +.. _setup-install: + +setup install +------------- + +.. program:: setup install + +Copy the files into the install locations and (for library packages) +register the package with the compiler, i.e. make the modules it +contains available to programs. + +The `install locations <#installation-paths>`__ are determined by +options to `setup configure`_. + +This command takes the following options: + +.. option:: --global + + Register this package in the system-wide database. (This is the + default, unless the :option:`setup configure --user` option was supplied + to the ``configure`` command.) + +.. option:: --user + + Register this package in the user's local package database. (This is + the default if the :option:`setup configure --user` option was supplied + to the ``configure`` command.) + +.. _setup-copy: + +setup copy +---------- + +Copy the files without registering them. This command is mainly of use +to those creating binary packages. + +This command takes the following option: + +.. program:: setup copy + +.. option:: --destdir=path + + Specify the directory under which to place installed files. If this is + not given, then the root directory is assumed. + +.. _setup-register: + +setup register +-------------- + +Register this package with the compiler, i.e. make the modules it +contains available to programs. This only makes sense for library +packages. Note that the ``install`` command incorporates this action. +The main use of this separate command is in the post-installation step +for a binary package. + +This command takes the following options: + +.. program:: setup register + +.. option:: --global + + Register this package in the system-wide database. (This is the + default.) + +.. option:: --user + + Register this package in the user's local package database. + +.. option:: --gen-script + + Instead of registering the package, generate a script containing + commands to perform the registration. On Unix, this file is called + ``register.sh``, on Windows, ``register.bat``. This script might be + included in a binary bundle, to be run after the bundle is unpacked + on the target system. + +.. option:: --gen-pkg-config[=path] + + Instead of registering the package, generate a package registration + file (or directory, in some circumstances). This only applies to + compilers that support package registration files which at the + moment is only GHC. The file should be used with the compiler's + mechanism for registering packages. This option is mainly intended + for packaging systems. If possible use the :option:`--gen-script` option + instead since it is more portable across Haskell implementations. + The *path* is optional and can be used to specify a particular + output file to generate. Otherwise, by default the file is the + package name and version with a ``.conf`` extension. + + This option outputs a directory if the package requires multiple + registrations: this can occur if internal/convenience libraries are + used. These configuration file names are sorted so that they can be + registered in order. + +.. option:: --inplace + + Registers the package for use directly from the build tree, without + needing to install it. This can be useful for testing: there's no + need to install the package after modifying it, just recompile and + test. + + This flag does not create a build-tree-local package database. It + still registers the package in one of the user or global databases. + + However, there are some caveats. It only works with GHC (currently). + It only works if your package doesn't depend on having any + supplemental files installed --- plain Haskell libraries should be + fine. + +.. _setup-unregister: + +setup unregister +---------------- + +.. program:: setup unregister + +Deregister this package with the compiler. + +This command takes the following options: + +.. option:: --global + + Deregister this package in the system-wide database. (This is the + default.) + +.. option:: --user + + Deregister this package in the user's local package database. + +.. option:: --gen-script + + Instead of deregistering the package, generate a script containing + commands to perform the deregistration. On Unix, this file is called + ``unregister.sh``, on Windows, ``unregister.bat``. This script might + be included in a binary bundle, to be run on the target system. + +.. _setup-clean: + +setup clean +----------- + +Remove any local files created during the ``configure``, ``build``, +``haddock``, ``register`` or ``unregister`` steps, and also any files +and directories listed in the :pkg-field:`extra-tmp-files` field. + +This command takes the following options: + +.. program:: setup clean + +.. option:: --save-configure, -s + + Keeps the configuration information so it is not necessary to run + the configure step again before building. + +setup test +---------- + +Run the test suites specified in the package description file. Aside +from the following flags, Cabal accepts the name of one or more test +suites on the command line after ``test``. When supplied, Cabal will run +only the named test suites, otherwise, Cabal will run all test suites in +the package. + +.. program:: setup test + +.. option:: --builddir=dir + + The directory where Cabal puts generated build files (default: + ``dist``). Test logs will be located in the ``test`` subdirectory. + +.. option:: --human-log=path + + The template used to name human-readable test logs; the path is + relative to ``dist/test``. By default, logs are named according to + the template ``$pkgid-$test-suite.log``, so that each test suite + will be logged to its own human-readable log file. Template + variables allowed are: ``$pkgid``, ``$compiler``, ``$os``, + ``$arch``, ``$abi``, ``$abitag``, ``$test-suite``, and ``$result``. + +.. option:: --machine-log=path + + The path to the machine-readable log, relative to ``dist/test``. The + default template is ``$pkgid.log``. Template variables allowed are: + ``$pkgid``, ``$compiler``, ``$os``, ``$arch``, ``$abi``, ``$abitag`` + and ``$result``. + +.. option:: --show-details=filter + + Determines if the results of individual test cases are shown on the + terminal. May be ``always`` (always show), ``never`` (never show), + ``failures`` (show only failed results), or ``streaming`` (show all + results in real time). + +.. option:: --test-options=options + Give extra options to the test executables. + +.. option:: --test-option=option + + give an extra option to the test executables. There is no need to + quote options containing spaces because a single option is assumed, + so options will not be split on spaces. + +.. _setup-sdist: + +setup sdist +----------- + +Create a system- and compiler-independent source distribution in a file +*package*-*version*\ ``.tar.gz`` in the ``dist`` subdirectory, for +distribution to package builders. When unpacked, the commands listed in +this section will be available. + +The files placed in this distribution are the package description file, +the setup script, the sources of the modules named in the package +description file, and files named in the ``license-file``, ``main-is``, +``c-sources``, ``asm-sources``, ``cmm-sources``, ``js-sources``, +``data-files``, ``extra-source-files`` and ``extra-doc-files`` fields. + +This command takes the following option: + +.. program:: setup sdist + +.. option:: --snapshot + + Append today's date (in "YYYYMMDD" format) to the version number for + the generated source package. The original package is unaffected. + + +.. include:: references.inc diff --git a/doc/users-guide/_sources/intro.rst.txt b/doc/users-guide/_sources/intro.rst.txt new file mode 100644 --- /dev/null +++ b/doc/users-guide/_sources/intro.rst.txt @@ -0,0 +1,200 @@ +.. highlight:: console + +Cabal is the standard package system for +Haskell_ software. It helps people to +configure, build and install Haskell software and to distribute it +easily to other users and developers. + +There is a command line tool called ``cabal`` for working with Cabal +packages. It helps with installing existing packages and also helps +people developing their own packages. It can be used to work with local +packages or to install packages from online package archives, including +automatically installing dependencies. By default it is configured to +use Hackage_ which is Haskell's central +package archive that contains thousands of libraries and applications in +the Cabal package format. + +Introduction +============ + +Cabal is a package system for Haskell software. The point of a package +system is to enable software developers and users to easily distribute, +use and reuse software. A package system makes it easier for developers +to get their software into the hands of users. Equally importantly, it +makes it easier for software developers to be able to reuse software +components written by other developers. + +Packaging systems deal with packages and with Cabal we call them *Cabal +packages*. The Cabal package is the unit of distribution. Every Cabal +package has a name and a version number which are used to identify the +package, e.g. ``filepath-1.0``. + +Cabal packages can depend on other Cabal packages. There are tools to +enable automated package management. This means it is possible for +developers and users to install a package plus all of the other Cabal +packages that it depends on. It also means that it is practical to make +very modular systems using lots of packages that reuse code written by +many developers. + +Cabal packages are source based and are typically (but not necessarily) +portable to many platforms and Haskell implementations. The Cabal +package format is designed to make it possible to translate into other +formats, including binary packages for various systems. + +When distributed, Cabal packages use the standard compressed tarball +format, with the file extension ``.tar.gz``, e.g. +``filepath-1.0.tar.gz``. + +Note that packages are not part of the Haskell language, rather they are +a feature provided by the combination of Cabal and GHC (and several +other Haskell implementations). + +A tool for working with packages +-------------------------------- + +There is a command line tool, called "``cabal``", that users and +developers can use to build and install Cabal packages. It can be used +for both local packages and for packages available remotely over the +network. It can automatically install Cabal packages plus any other +Cabal packages they depend on. + +Developers can use the tool with packages in local directories, e.g. + +:: + + $ cd foo/ + $ cabal install + +While working on a package in a local directory, developers can run the +individual steps to configure and build, and also generate documentation +and run test suites and benchmarks. + +It is also possible to install several local packages at once, e.g. + +:: + + $ cabal install foo/ bar/ + +Developers and users can use the tool to install packages from remote +Cabal package archives. By default, the ``cabal`` tool is configured to +use the central Haskell package archive called +Hackage_ but it is possible to use it +with any other suitable archive. + +:: + + $ cabal install xmonad + +This will install the ``xmonad`` package plus all of its dependencies. + +In addition to packages that have been published in an archive, +developers can install packages from local or remote tarball files, for +example + +:: + + $ cabal install foo-1.0.tar.gz + $ cabal install http://example.com/foo-1.0.tar.gz + +Cabal provides a number of ways for a user to customise how and where a +package is installed. They can decide where a package will be installed, +which Haskell implementation to use and whether to build optimised code +or build with the ability to profile code. It is not expected that users +will have to modify any of the information in the ``.cabal`` file. + +For full details, see the section on `building and installing +packages `__. + +Note that ``cabal`` is not the only tool for working with Cabal +packages. Due to the standardised format and a library for reading +``.cabal`` files, there are several other special-purpose tools. + +What's in a package +------------------- + +A Cabal package consists of: + +- Haskell software, including libraries, executables and tests +- metadata about the package in a standard human and machine readable + format (the "``.cabal``" file) +- a standard interface to build the package (the "``Setup.hs``" file) + +The ``.cabal`` file contains information about the package, supplied by +the package author. In particular it lists the other Cabal packages that +the package depends on. + +For full details on what goes in the ``.cabal`` and ``Setup.hs`` files, +and for all the other features provided by the build system, see the +section on `developing packages `__. + +Cabal featureset +---------------- + +Cabal and its associated tools and websites covers: + +- a software build system +- software configuration +- packaging for distribution +- automated package management + + - natively using the ``cabal`` command line tool; or + - by translation into native package formats such as RPM or deb + +- web and local Cabal package archives + + - central Hackage website with 1000's of Cabal packages + +Some parts of the system can be used without others. In particular the +built-in build system for simple packages is optional: it is possible to +use custom build systems. + +Similar systems +--------------- + +The Cabal system is roughly comparable with the system of Python Eggs, +Ruby Gems or Perl distributions. Each system has a notion of +distributable packages, and has tools to manage the process of +distributing and installing packages. + +Hackage is an online archive of Cabal packages. It is roughly comparable +to CPAN but with rather fewer packages (around 5,000 vs 28,000). + +Cabal is often compared with autoconf and automake and there is some +overlap in functionality. The most obvious similarity is that the +command line interface for actually configuring and building packages +follows the same steps and has many of the same configuration +parameters. + +:: + + $ ./configure --prefix=... + $ make + $ make install + +compared to + +:: + + $ cabal configure --prefix=... + $ cabal build + $ cabal install + +Cabal's build system for simple packages is considerably less flexible +than make/automake, but has builtin knowledge of how to build Haskell +code and requires very little manual configuration. Cabal's simple build +system is also portable to Windows, without needing a Unix-like +environment such as cygwin/mingwin. + +Compared to autoconf, Cabal takes a somewhat different approach to +package configuration. Cabal's approach is designed for automated +package management. Instead of having a configure script that tests for +whether dependencies are available, Cabal packages specify their +dependencies. There is some scope for optional and conditional +dependencies. By having package authors specify dependencies it makes it +possible for tools to install a package and all of its dependencies +automatically. It also makes it possible to translate (in a +mostly-automatically way) into another package format like RPM or deb +which also have automatic dependency resolution. + + +.. include:: references.inc diff --git a/doc/users-guide/_sources/misc.rst.txt b/doc/users-guide/_sources/misc.rst.txt new file mode 100644 --- /dev/null +++ b/doc/users-guide/_sources/misc.rst.txt @@ -0,0 +1,103 @@ +Reporting bugs and deficiencies +=============================== + +Please report any flaws or feature requests in the `bug +tracker `__. + +For general discussion or queries email the libraries mailing list +libraries@haskell.org. There is also a development mailing list +cabal-devel@haskell.org. + +Stability of Cabal interfaces +============================= + +The Cabal library and related infrastructure is still under active +development. New features are being added and limitations and bugs are +being fixed. This requires internal changes and often user visible +changes as well. We therefore cannot promise complete future-proof +stability, at least not without halting all development work. + +This section documents the aspects of the Cabal interface that we can +promise to keep stable and which bits are subject to change. + +Cabal file format +----------------- + +This is backwards compatible and mostly forwards compatible. New fields +can be added without breaking older versions of Cabal. Fields can be +deprecated without breaking older packages. + +Command-line interface +---------------------- + +Very Stable Command-line interfaces +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- ``./setup configure`` +- ``--prefix`` +- ``--user`` +- ``--ghc``, ``--uhc`` +- ``--verbose`` +- ``--prefix`` + +- ``./setup build`` +- ``./setup install`` +- ``./setup register`` +- ``./setup copy`` + +Stable Command-line interfaces +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Unstable command-line +~~~~~~~~~~~~~~~~~~~~~ + +Functions and Types +------------------- + +The Cabal library follows the `Package Versioning Policy`_. +This means that within a stable major release, for example 1.2.x, there +will be no incompatible API changes. But minor versions increments, for +example 1.2.3, indicate compatible API additions. + +The Package Versioning Policy does not require any API guarantees +between major releases, for example between 1.2.x and 1.4.x. In practise +of course not everything changes between major releases. Some parts of +the API are more prone to change than others. The rest of this section +gives some informal advice on what level of API stability you can expect +between major releases. + +Very Stable API +~~~~~~~~~~~~~~~ + +- ``defaultMain`` + +- ``defaultMainWithHooks defaultUserHooks`` + +But regular ``defaultMainWithHooks`` isn't stable since ``UserHooks`` +changes. + +Semi-stable API +~~~~~~~~~~~~~~~ + +- ``UserHooks`` The hooks API will change in the future + +- ``Distribution.*`` is mostly declarative information about packages + and is somewhat stable. + +Unstable API +~~~~~~~~~~~~ + +Everything under ``Distribution.Simple.*`` has no stability guarantee. + +Hackage +------- + +The index format is a partly stable interface. It consists of a tar.gz +file that contains directories with ``.cabal`` files in. In future it +may contain more kinds of files so do not assume every file is a +``.cabal`` file. Incompatible revisions to the format would involve +bumping the name of the index file, i.e., ``00-index.tar.gz``, +``01-index.tar.gz`` etc. + + +.. include:: references.inc diff --git a/doc/users-guide/_sources/nix-integration.rst.txt b/doc/users-guide/_sources/nix-integration.rst.txt new file mode 100644 --- /dev/null +++ b/doc/users-guide/_sources/nix-integration.rst.txt @@ -0,0 +1,49 @@ +Nix Integration +=============== + +`Nix `_ is a package manager popular with some Haskell developers due to its focus on reliability and reproducibility. ``cabal`` now has the ability to integrate with Nix for dependency management during local package development. + +Enabling Nix Integration +------------------------ + +To enable Nix integration, simply pass the ``--enable-nix`` global option when you call ``cabal``. To use this option everywhere, edit your ``$HOME/.cabal/config`` file to include: + +.. code-block:: cabal + + nix: True + +If the package (which must be locally unpacked) provides a ``shell.nix`` or ``default.nix`` file, this flag will cause ``cabal`` to run most commands through ``nix-shell``. If both expressions are present, ``shell.nix`` is preferred. The following commands are affected: + +- ``cabal configure`` +- ``cabal build`` +- ``cabal repl`` +- ``cabal install`` (only if installing into a sandbox) +- ``cabal haddock`` +- ``cabal freeze`` +- ``cabal gen-bounds`` +- ``cabal run`` + +If the package does not provide an expression, ``cabal`` runs normally. + +Creating Nix Expressions +------------------------ + +The Nix package manager is based on a lazy, pure, functional programming language; packages are defined by expressions in this language. The fastest way to create a Nix expression for a Cabal package is with the `cabal2nix `_ tool. To create a ``shell.nix`` expression for the package in the current directory, run this command: + +.. code-block:: console + + $ cabal2nix --shell ./. >shell.nix + +Nix Expression Evaluation +------------------------- + +(This section describes for advanced users how Nix expressions are evaluated.) + +First, the Nix expression (``shell.nix`` or ``default.nix``) is instantiated with ``nix-instantiate``. The ``--add-root`` and ``--indirect`` options are used to create an indirect root in the Cabal build directory, preventing Nix from garbage collecting the derivation while in use. The ``IN_NIX_SHELL`` environment variable is set so that ``builtins.getEnv`` works as it would in ``nix-shell``. + +Next, the commands above are run through ``nix-shell`` using the instantiated derivation. Again, ``--add-root`` and ``--indirect`` are used to prevent Nix from garbage collecting the packages in the environment. The child ``cabal`` process reads the ``CABAL_IN_NIX_SHELL`` environment variable to prevent it from spawning additional child shells. + +Further Reading +---------------- + +The `Nix manual `_ provides further instructions for writing Nix expressions. The `Nixpkgs manual `_ describes the infrastructure provided for Haskell packages. diff --git a/doc/users-guide/_sources/nix-local-build-overview.rst.txt b/doc/users-guide/_sources/nix-local-build-overview.rst.txt new file mode 100644 --- /dev/null +++ b/doc/users-guide/_sources/nix-local-build-overview.rst.txt @@ -0,0 +1,43 @@ +Nix-style Local Builds +====================== + +Nix-style local builds are a new build system implementation inspired by Nix. +The Nix-style local build system is commonly called "new-build" for short +after the ``cabal new-*`` family of commands that control it. However, those +names are only temporary until Nix-style local builds become the default. +This is expected to happen soon. For those who do not wish to use the new +functionality, the classic project style will not be removed immediately, +but these legacy commands will require the usage of the ``v1-`` prefix as of +Cabal 3.0 and will be removed in a future release. For a future-proof +way to use these commands in a script or tutorial that anticipates the +possibility of another UI paradigm being devised in the future, there +are also ``v2-`` prefixed versions that will reference the same functionality +until such a point as it is completely removed from Cabal. + +Nix-style local builds combine the best of non-sandboxed and sandboxed Cabal: + +1. Like sandboxed Cabal today, we build sets of independent local + packages deterministically and independent of any global state. + new-build will never tell you that it can't build your package + because it would result in a "dangerous reinstall." Given a + particular state of the Hackage index, your build is completely + reproducible. For example, you no longer need to compile packages + with profiling ahead of time; just request profiling and new-build + will rebuild all its dependencies with profiling automatically. + +2. Like non-sandboxed Cabal today, builds of external packages are + cached in ``~/.cabal/store``, so that a package can be built once, + and then reused anywhere else it is also used. No need to continually + rebuild dependencies whenever you make a new sandbox: dependencies + which can be shared, are shared. + +Nix-style local builds were first released as beta in cabal-install 1.24. +They currently work with all versions of GHC supported by that release: GHC 7.0 and later. + +Some features described in this manual are not implemented. If you need +them, please give us a shout and we'll prioritize accordingly. + + + +.. toctree:: + nix-local-build diff --git a/doc/users-guide/_sources/nix-local-build.rst.txt b/doc/users-guide/_sources/nix-local-build.rst.txt new file mode 100644 --- /dev/null +++ b/doc/users-guide/_sources/nix-local-build.rst.txt @@ -0,0 +1,2037 @@ +.. highlight:: console + +Quickstart +========== + +Suppose that you are in a directory containing a single Cabal package +which you wish to build. You can configure and build it using Nix-style +local builds with this command (configuring is not necessary): + +:: + + $ cabal new-build + +To open a GHCi shell with this package, use this command: + +:: + + $ cabal new-repl + +To run an executable defined in this package, use this command: + +:: + + $ cabal new-run [executable args] + +Developing multiple packages +---------------------------- + +Many Cabal projects involve multiple packages which need to be built +together. To build multiple Cabal packages, you need to first create a +``cabal.project`` file which declares where all the local package +directories live. For example, in the Cabal repository, there is a root +directory with a folder per package, e.g., the folders ``Cabal`` and +``cabal-install``. The ``cabal.project`` file specifies each folder as +part of the project: + +.. code-block:: cabal + + packages: Cabal/ + cabal-install/ + +The expectation is that a ``cabal.project`` is checked into your source +control, to be used by all developers of a project. If you need to make +local changes, they can be placed in ``cabal.project.local`` (which +should not be checked in.) + +Then, to build every component of every package, from the top-level +directory, run the command: (using cabal-install-2.0 or greater.) + +:: + + $ cabal new-build + +To build a specific package, you can either run ``new-build`` from the +directory of the package in question: + +:: + + $ cd cabal-install + $ cabal new-build + +or you can pass the name of the package as an argument to +``cabal new-build`` (this works in any subdirectory of the project): + +:: + + $ cabal new-build cabal-install + +You can also specify a specific component of the package to build. For +example, to build a test suite named ``package-tests``, use the command: + +:: + + $ cabal new-build package-tests + +Targets can be qualified with package names. So to request +``package-tests`` *from* the ``Cabal`` package, use +``Cabal:package-tests``. + +Unlike sandboxes, there is no need to setup a sandbox or ``add-source`` +projects; just check in ``cabal.project`` to your repository and +``new-build`` will just work. + +Cookbook +======== + +How can I profile my library/application? +----------------------------------------- + +Create or edit your ``cabal.project.local``, adding the following +line:: + + profiling: True + +Now, ``cabal new-build`` will automatically build all libraries and +executables with profiling. You can fine-tune the profiling settings +for each package using :cfg-field:`profiling-detail`:: + + package p + profiling-detail: toplevel-functions + +Alternately, you can call ``cabal new-build --enable-profiling`` to +temporarily build with profiling. + +How it works +============ + +Local versus external packages +------------------------------ + +One of the primary innovations of Nix-style local builds is the +distinction between local packages, which users edit and recompile and +must be built per-project, versus external packages, which can be cached +across projects. To be more precise: + +1. A **local package** is one that is listed explicitly in the + ``packages``, ``optional-packages`` or ``extra-packages`` field of a + project. Usually, these refer to packages whose source code lives + directly in a folder in your project (although, you can list an + arbitrary Hackage package in ``extra-packages`` to force it to be + treated as local). + +Local packages, as well as the external packages (below) which depend on +them, are built **inplace**, meaning that they are always built +specifically for the project and are not installed globally. Inplace +packages are not cached and not given unique hashes, which makes them +suitable for packages which you want to edit and recompile. + +2. An **external package** is any package which is not listed in the + ``packages`` field. The source code for external packages is usually + retrieved from Hackage. + +When an external package does not depend on an inplace package, it can +be built and installed to a **global** store, which can be shared across +projects. These build products are identified by a hash that over all of +the inputs which would influence the compilation of a package (flags, +dependency selection, etc.). Just as in Nix, these hashes uniquely +identify the result of a build; if we compute this identifier and we +find that we already have this ID built, we can just use the already +built version. + +The global package store is ``~/.cabal/store`` (configurable via +global `store-dir` option); if you need to clear your store for +whatever reason (e.g., to reclaim disk space or because the global +store is corrupted), deleting this directory is safe (``new-build`` +will just rebuild everything it needs on its next invocation). + +This split motivates some of the UI choices for Nix-style local build +commands. For example, flags passed to ``cabal new-build`` are only +applied to *local* packages, so that adding a flag to +``cabal new-build`` doesn't necessitate a rebuild of *every* transitive +dependency in the global package store. + +In cabal-install 2.0 and above, Nix-style local builds also take advantage of a +new Cabal library feature, `per-component +builds `__, +where each component of a package is configured and built separately. +This can massively speed up rebuilds of packages with lots of components +(e.g., a package that defines multiple executables), as only one +executable needs to be rebuilt. Packages that use Custom setup scripts +are not currently built on a per-component basis. + +Where are my build products? +---------------------------- + +A major deficiency in the current implementation of new-build is that +there is no programmatic way to access the location of build products. +The location of the build products is intended to be an internal +implementation detail of new-build, but we also understand that many +unimplemented features can only be reasonably worked around by +accessing build products directly. + +The location where build products can be found varies depending on the +version of cabal-install: + +- In cabal-install-1.24, the dist directory for a package ``p-0.1`` is + stored in ``dist-newstyle/build/p-0.1``. For example, if you built an + executable or test suite named ``pexe``, it would be located at + ``dist-newstyle/build/p-0.1/build/pexe/pexe``. + +- In cabal-install-2.0 and above, the dist directory for a package ``p-0.1`` + defining a library built with GHC 8.0.1 on 64-bit Linux is + ``dist-newstyle/build/x86_64-linux/ghc-8.0.1/p-0.1``. When + per-component builds are enabled (any non-Custom package), a + subcomponent like an executable or test suite named ``pexe`` will be + stored at + ``dist-newstyle/build/x86_64-linux/ghc-8.0.1/p-0.1/c/pexe``; thus, + the full path of the executable is + ``dist-newstyle/build/x86_64-linux/ghc-8.0.1/p-0.1/c/pexe/build/pexe/pexe`` + (you can see why we want this to be an implementation detail!) + +The paths are a bit longer in 2.0 and above but the benefit is that you can +transparently have multiple builds with different versions of GHC. We +plan to add the ability to create aliases for certain build +configurations, and more convenient paths to access particularly useful +build products like executables. + +Caching +------- + +Nix-style local builds sport a robust caching system which help reduce +the time it takes to execute a rebuild cycle. While the details of how +``cabal-install`` does caching are an implementation detail and may +change in the future, knowing what gets cached is helpful for +understanding the performance characteristics of invocations to +``new-build``. The cached intermediate results are stored in +``dist-newstyle/cache``; this folder can be safely deleted to clear the +cache. + +The following intermediate results are cached in the following files in +this folder (the most important two are first): + +``solver-plan`` (binary) + The result of calling the dependency solver, assuming that the + Hackage index, local ``cabal.project`` file, and local ``cabal`` + files are unmodified. (Notably, we do NOT have to dependency solve + again if new build products are stored in the global store; the + invocation of the dependency solver is independent of what is + already available in the store.) +``source-hashes`` (binary) + The hashes of all local source files. When all local source files of + a local package are unchanged, ``cabal new-build`` will skip + invoking ``setup build`` entirely (saving us from a possibly + expensive call to ``ghc --make``). The full list of source files + participating in compilation are determined using + ``setup sdist --list-sources`` (thus, if you do not list all your + source files in a Cabal file, you may fail to recompile when you + edit them.) +``config`` (same format as ``cabal.project``) + The full project configuration, merged from ``cabal.project`` (and + friends) as well as the command line arguments. +``compiler`` (binary) + The configuration of the compiler being used to build the project. +``improved-plan`` (binary) + Like ``solver-plan``, but with all non-inplace packages improved + into pre-existing copies from the store. +``plan.json`` (JSON) + A JSON serialization of the computed install plan intended + for integrating ``cabal`` with external tooling. + The `cabal-plan `__ + package provides a library for parsing ``plan.json`` files into a + Haskell data structure as well as an example tool showing possible + applications. + + .. todo:: + + Document JSON schema (including version history of schema) + + +Note that every package also has a local cache managed by the Cabal +build system, e.g., in ``$distdir/cache``. + +There is another useful file in ``dist-newstyle/cache``, +``plan.json``, which is a JSON serialization of the computed install +plan and is intended for integrating with external tooling. + + + + +Commands +======== + +We now give an in-depth description of all the commands, describing the +arguments and flags they accept. + +cabal new-configure +------------------- + +``cabal new-configure`` takes a set of arguments and writes a +``cabal.project.local`` file based on the flags passed to this command. +``cabal new-configure FLAGS; cabal new-build`` is roughly equivalent to +``cabal new-build FLAGS``, except that with ``new-configure`` the flags +are persisted to all subsequent calls to ``new-build``. + +``cabal new-configure`` is intended to be a convenient way to write out +a ``cabal.project.local`` for simple configurations; e.g., +``cabal new-configure -w ghc-7.8`` would ensure that all subsequent +builds with ``cabal new-build`` are performed with the compiler +``ghc-7.8``. For more complex configuration, we recommend writing the +``cabal.project.local`` file directly (or placing it in +``cabal.project``!) + +``cabal new-configure`` inherits options from ``Cabal``. semantics: + +- Any flag accepted by ``./Setup configure``. + +- Any flag accepted by ``cabal configure`` beyond + ``./Setup configure``, namely ``--cabal-lib-version``, + ``--constraint``, ``--preference`` and ``--solver.`` + +- Any flag accepted by ``cabal install`` beyond ``./Setup configure``. + +- Any flag accepted by ``./Setup haddock``. + +The options of all of these flags apply only to *local* packages in a +project; this behavior is different than that of ``cabal install``, +which applies flags to every package that would be built. The motivation +for this is to avoid an innocuous addition to the flags of a package +resulting in a rebuild of every package in the store (which might need +to happen if a flag actually applied to every transitive dependency). To +apply options to an external package, use a ``package`` stanza in a +``cabal.project`` file. + +cabal new-update +---------------- + +``cabal new-update`` updates the state of the package index. If the +project contains multiple remote package repositories it will update +the index of all of them (e.g. when using overlays). + +Seom examples: + +:: + + $ cabal new-update # update all remote repos + $ cabal new-update head.hackage # update only head.hackage + +cabal new-build +--------------- + +``cabal new-build`` takes a set of targets and builds them. It +automatically handles building and installing any dependencies of these +targets. + +A target can take any of the following forms: + +- A package target: ``package``, which specifies that all enabled + components of a package to be built. By default, test suites and + benchmarks are *not* enabled, unless they are explicitly requested + (e.g., via ``--enable-tests``.) + +- A component target: ``[package:][ctype:]component``, which specifies + a specific component (e.g., a library, executable, test suite or + benchmark) to be built. + +- All packages: ``all``, which specifies all packages within the project. + +- Components of a particular type: ``package:ctypes``, ``all:ctypes``: + which specifies all components of the given type. Where valid + ``ctypes`` are: + - ``libs``, ``libraries``, + - ``flibs``, ``foreign-libraries``, + - ``exes``, ``executables``, + - ``tests``, + - ``benches``, ``benchmarks``. + +In component targets, ``package:`` and ``ctype:`` (valid component types +are ``lib``, ``flib``, ``exe``, ``test`` and ``bench``) can be used to +disambiguate when multiple packages define the same component, or the +same component name is used in a package (e.g., a package ``foo`` +defines both an executable and library named ``foo``). We always prefer +interpreting a target as a package name rather than as a component name. + +Some example targets: + +:: + + $ cabal new-build lib:foo-pkg # build the library named foo-pkg + $ cabal new-build foo-pkg:foo-tests # build foo-tests in foo-pkg + +(There is also syntax for specifying module and file targets, but it +doesn't currently do anything.) + +Beyond a list of targets, ``cabal new-build`` accepts all the flags that +``cabal new-configure`` takes. Most of these flags are only taken into +consideration when building local packages; however, some flags may +cause extra store packages to be built (for example, +``--enable-profiling`` will automatically make sure profiling libraries +for all transitive dependencies are built and installed.) + +cabal new-repl +-------------- + +``cabal new-repl TARGET`` loads all of the modules of the target into +GHCi as interpreted bytecode. In addition to ``cabal new-build``'s flags, +it takes an additional ``--repl-options`` flag. + +To avoid ``ghci`` specific flags from triggering unneeded global rebuilds these +flags are now stripped from the internal configuration. As a result +``--ghc-options`` will no longer (reliably) work to pass flags to ``ghci`` (or +other repls). Instead, you should use the new ``--repl-options`` flag to +specify these options to the invoked repl. (This flag also works on ``cabal +repl`` and ``Setup repl`` on sufficiently new versions of Cabal.) + +Currently, it is not supported to pass multiple targets to ``new-repl`` +(``new-repl`` will just successively open a separate GHCi session for +each target.) + +It also provides a way to experiment with libraries without needing to download +them manually or to install them globally. + +This command opens a REPL with the current default target loaded, and a version +of the ``vector`` package matching that specification exposed. + +:: + + $ cabal new-repl --build-depends "vector >= 0.12 && < 0.13" + +Both of these commands do the same thing as the above, but only exposes ``base``, +``vector``, and the``vector`` package's transitive dependencies even if the user +is in a project context. + +:: + + $ cabal new-repl --ignore-project --build-depends "vector >= 0.12 && < 0.13" + $ cabal new-repl --project='' --build-depends "vector >= 0.12 && < 0.13" + +This command would add ``vector``, but not (for example) ``primitive``, because +it only includes the packages specified on the command line (and ``base``, which +cannot be excluded for technical reasons). + +:: + + $ cabal new-repl --build-depends vector --no-transitive-deps + +cabal new-run +------------- + +``cabal new-run [TARGET [ARGS]]`` runs the executable specified by the +target, which can be a component, a package or can be left blank, as +long as it can uniquely identify an executable within the project. +Tests and benchmarks are also treated as executables. + +See `the new-build section <#cabal-new-build>`__ for the target syntax. + +Except in the case of the empty target, the strings after it will be +passed to the executable as arguments. + +If one of the arguments starts with ``-`` it will be interpreted as +a cabal flag, so if you need to pass flags to the executable you +have to separate them with ``--``. + +:: + + $ cabal new-run target -- -a -bcd --argument + +'new-run' also supports running script files that use a certain format. With +a script that looks like: + +:: + + #!/usr/bin/env cabal + {- cabal: + build-depends: base ^>= 4.11 + , shelly ^>= 1.8.1 + -} + + main :: IO () + main = do + ... + +It can either be executed like any other script, using ``cabal`` as an +interpreter, or through this command: + +:: + + $ cabal new-run script.hs + $ cabal new-run script.hs -- --arg1 # args are passed like this + +cabal new-freeze +---------------- + +``cabal new-freeze`` writes out a **freeze file** which records all of +the versions and flags which that are picked by the solver under the +current index and flags. Default name of this file is +``cabal.project.freeze`` but in combination with a +``--project-file=my.project`` flag (see :ref:`project-file +`) +the name will be ``my.project.freeze``. +A freeze file has the same syntax as ``cabal.project`` and looks +something like this: + +.. highlight:: cabal + +:: + + constraints: HTTP ==4000.3.3, + HTTP +warp-tests -warn-as-error -network23 +network-uri -mtl1 -conduit10, + QuickCheck ==2.9.1, + QuickCheck +templatehaskell, + -- etc... + + +For end-user executables, it is recommended that you distribute the +``cabal.project.freeze`` file in your source repository so that all +users see a consistent set of dependencies. For libraries, this is not +recommended: users often need to build against different versions of +libraries than what you developed against. + +cabal new-bench +--------------- + +``cabal new-bench [TARGETS] [OPTIONS]`` runs the specified benchmarks +(all the benchmarks in the current package by default), first ensuring +they are up to date. + +cabal new-test +-------------- + +``cabal new-test [TARGETS] [OPTIONS]`` runs the specified test suites +(all the test suites in the current package by default), first ensuring +they are up to date. + +cabal new-haddock +----------------- + +``cabal new-haddock [FLAGS] [TARGET]`` builds Haddock documentation for +the specified packages within the project. + +If a target is not a library :cfg-field:`haddock-benchmarks`, +:cfg-field:`haddock-executables`, :cfg-field:`haddock-internal`, +:cfg-field:`haddock-tests` will be implied as necessary. + +cabal new-exec +--------------- + +``cabal new-exec [FLAGS] [--] COMMAND [--] [ARGS]`` runs the specified command +using the project's environment. That is, passing the right flags to compiler +invocations and bringing the project's executables into scope. + +cabal new-install +----------------- + +``cabal new-install [FLAGS] PACKAGES`` builds the specified packages and +symlinks their executables in ``symlink-bindir`` (usually ``~/.cabal/bin``). + +For example this command will build the latest ``cabal-install`` and symlink +its ``cabal`` executable: + +:: + + $ cabal new-install cabal-install + +In addition, it's possible to use ``cabal new-install`` to install components +of a local project. For example, with an up-to-date Git clone of the Cabal +repository, this command will build cabal-install HEAD and symlink the +``cabal`` executable: + +:: + + $ cabal new-install exe:cabal + +It is also possible to "install" libraries using the ``--lib`` flag. For +example, this command will build the latest Cabal library and install it: + +:: + + $ cabal new-install --lib Cabal + +This works by managing GHC environments. By default, it is writing to the +global environment in ``~/.ghc/$ARCH-$OS-$GHCVER/environments/default``. +``new-install`` provides the ``--package-env`` flag to control which of +these environments is modified. + +This command will modify the environment file in the current directory: + +:: + + $ cabal new-install --lib Cabal --package-env . + +This command will modify the enviroment file in the ``~/foo`` directory: + +:: + + $ cabal new-install --lib Cabal --package-env foo/ + +Do note that the results of the previous two commands will be overwritten by +the use of other new-style commands, so it is not reccomended to use them inside +a project directory. + +This command will modify the environment in the "local.env" file in the +current directory: + +:: + + $ cabal new-install --lib Cabal --package-env local.env + +This command will modify the ``myenv`` named global environment: + +:: + + $ cabal new-install --lib Cabal --package-env myenv + +If you wish to create a named environment file in the current directory where +the name does not contain an extension, you must reference it as ``./myenv``. + +You can learn more about how to use these environments in `this section of the +GHC manual `_. + +cabal new-clean +--------------- + +``cabal new-clean [FLAGS]`` cleans up the temporary files and build artifacts +stored in the ``dist-newstyle`` folder. + +By default, it removes the entire folder, but it can also spare the configuration +and caches if the ``--save-config`` option is given, in which case it only removes +the build artefacts (``.hi``, ``.o`` along with any other temporary files generated +by the compiler, along with the build output). + +cabal new-sdist +--------------- + +``cabal new-sdist [FLAGS] [TARGETS]`` takes the crucial files needed to build ``TARGETS`` +and puts them into an archive format ready for upload to Hackage. These archives are stable +and two archives of the same format built from the same source will hash to the same value. + +``cabal new-sdist`` takes the following flags: + +- ``-l``, ``--list-only``: Rather than creating an archive, lists files that would be included. + Output is to ``stdout`` by default. The file paths are relative to the project's root + directory. + +- ``--targz``: Output an archive in ``.tar.gz`` format. + +- ``--zip``: Output an archive in ``.zip`` format. + +- ``-o``, ``--output-dir``: Sets the output dir, if a non-default one is desired. The default is + ``dist-newstyle/sdist/``. ``--output-dir -`` will send output to ``stdout`` + unless multiple archives are being created. + +- ``-z``, ``--null``: Only used with ``--list-only``. Separates filenames with a NUL + byte instead of newlines. + +``new-sdist`` is inherently incompatible with sdist hooks, not due to implementation but due +to fundamental core invariants (same source code should result in the same tarball, byte for +byte) that must be satisfied for it to function correctly in the larger new-build ecosystem. +``autogen-modules`` is able to replace uses of the hooks to add generated modules, along with +the custom publishing of Haddock documentation to Hackage. + +Configuring builds with cabal.project +===================================== + +``cabal.project`` files support a variety of options which configure the +details of your build. The general syntax of a ``cabal.project`` file is +similar to that of a Cabal file: there are a number of fields, some of +which live inside stanzas: + +:: + + packages: */*.cabal + with-compiler: /opt/ghc/8.0.1/bin/ghc + + package cryptohash + optimization: False + +In general, the accepted field names coincide with the accepted command +line flags that ``cabal install`` and other commands take. For example, +``cabal new-configure --enable-profiling`` will write out a project +file with ``profiling: True``. + +The full configuration of a project is determined by combining the +following sources (later entries override earlier ones): + +1. ``~/.cabal/config`` (the user-wide global configuration) + +2. ``cabal.project`` (the project configuratoin) + +3. ``cabal.project.freeze`` (the output of ``cabal new-freeze``) + +4. ``cabal.project.local`` (the output of ``cabal new-configure``) + + +Specifying the local packages +----------------------------- + +The following top-level options specify what the local packages of a +project are: + +.. cfg-field:: packages: package location list (space or comma separated) + :synopsis: Project packages. + + :default: ``./*.cabal`` + + Specifies the list of package locations which contain the local + packages to be built by this project. Package locations can take the + following forms: + + 1. They can specify a Cabal file, or a directory containing a Cabal + file, e.g., ``packages: Cabal cabal-install/cabal-install.cabal``. + + 2. They can specify a glob-style wildcards, which must match one or + more (a) directories containing a (single) Cabal file, (b) Cabal + files (extension ``.cabal``), or (c) tarballs which contain Cabal + packages (extension ``.tar.gz``). + For example, to match all Cabal files in all + subdirectories, as well as the Cabal projects in the parent + directories ``foo`` and ``bar``, use + ``packages: */*.cabal ../{foo,bar}/`` + + 3. [STRIKEOUT:They can specify an ``http``, ``https`` or ``file`` + URL, representing the path to a remote tarball to be downloaded + and built.] (not implemented yet) + + There is no command line variant of this field; see :issue:`3585`. + +.. cfg-field:: optional-packages: package location list (space or comma-separated) + :synopsis: Optional project packages. + + :default: ``./*/*.cabal`` + + Like :cfg-field:`packages`, specifies a list of package locations + containing local packages to be built. Unlike :cfg-field:`packages`, + if we glob for a package, it is permissible for the glob to match against + zero packages. The intended use-case for :cfg-field:`optional-packages` + is to make it so that vendored packages can be automatically picked up if + they are placed in a subdirectory, but not error if there aren't any. + + There is no command line variant of this field. + +.. cfg-field:: extra-packages: package list with version bounds (comma separated) + :synopsis: Adds external pacakges as local + + [STRIKEOUT:Specifies a list of external packages from Hackage which + should be considered local packages.] (Not implemented) + + There is no command line variant of this field. + +[STRIKEOUT:There is also a stanza ``source-repository-package`` for +specifying packages from an external version control.] (Not +implemented.) + +All local packages are *vendored*, in the sense that if other packages +(including external ones from Hackage) depend on a package with the name +of a local package, the local package is preferentially used. This +motivates the default settings:: + + packages: ./*.cabal + optional-packages: ./*/*.cabal + +...any package can be vendored simply by making a checkout in the +top-level project directory, as might be seen in this hypothetical +directory layout:: + + foo.cabal + foo-helper/ # local package + unix/ # vendored external package + +All of these options support globs. ``cabal new-build`` has its own glob +format: + +- Anywhere in a path, as many times as you like, you can specify an + asterisk ``*`` wildcard. E.g., ``*/*.cabal`` matches all ``.cabal`` + files in all immediate subdirectories. Like in glob(7), asterisks do + not match hidden files unless there is an explicit period, e.g., + ``.*/foo.cabal`` will match ``.private/foo.cabal`` (but + ``*/foo.cabal`` will not). + +- You can use braces to specify specific directories; e.g., + ``{vendor,pkgs}/*.cabal`` matches all Cabal files in the ``vendor`` + and ``pkgs`` subdirectories. + +Formally, the format described by the following BNF: + +.. code-block:: abnf + + FilePathGlob ::= FilePathRoot FilePathGlobRel + FilePathRoot ::= {- empty -} # relative to cabal.project + | "/" # Unix root + | [a-zA-Z] ":" [/\\] # Windows root + | "~" # home directory + FilePathGlobRel ::= Glob "/" FilePathGlobRel # Unix directory + | Glob "\\" FilePathGlobRel # Windows directory + | Glob # file + | {- empty -} # trailing slash + Glob ::= GlobPiece * + GlobPiece ::= "*" # wildcard + | [^*{},/\\] * # literal string + | "\\" [*{},] # escaped reserved character + | "{" Glob "," ... "," Glob "}" # union (match any of these) + +Global configuration options +---------------------------- + +The following top-level configuration options are not specific to any +package, and thus apply globally: + +.. cfg-field:: verbose: nat + --verbose=n, -vn + :synopsis: Build verbosity level. + + :default: 1 + + Control the verbosity of ``cabal`` commands, valid values are from 0 + to 3. + + The command line variant of this field is ``--verbose=2``; a short + form ``-v2`` is also supported. + +.. cfg-field:: jobs: nat or $ncpus + --jobs=n, -jn, --jobs=$ncpus + :synopsis: Number of builds running in parallel. + + :default: 1 + + Run *nat* jobs simultaneously when building. If ``$ncpus`` is + specified, run the number of jobs equal to the number of CPUs. + Package building is often quite parallel, so turning on parallelism + can speed up build times quite a bit! + + The command line variant of this field is ``--jobs=2``; a short form + ``-j2`` is also supported; a bare ``--jobs`` or ``-j`` is equivalent + to ``--jobs=$ncpus``. + +.. cfg-field:: keep-going: boolean + --keep-going + :synopsis: Try to continue building on failure. + + :default: False + + If true, after a build failure, continue to build other unaffected + packages. + + The command line variant of this field is ``--keep-going``. + +.. option:: --builddir=DIR + + Specifies the name of the directory where build products for + build will be stored; defaults to ``dist-newstyle``. If a + relative name is specified, this directory is resolved relative + to the root of the project (i.e., where the ``cabal.project`` + file lives.) + + This option cannot be specified via a ``cabal.project`` file. + +.. _cmdoption-project-file: +.. option:: --project-file=FILE + + Specifies the name of the project file used to specify the + rest of the top-level configuration; defaults to ``cabal.project``. + This name not only specifies the name of the main project file, + but also the auxiliary project files ``cabal.project.freeze`` + and ``cabal.project.local``; for example, if you specify + ``--project-file=my.project``, then the other files that will + be probed are ``my.project.freeze`` and ``my.project.local``. + + If the specified project file is a relative path, we will + look for the file relative to the current working directory, + and then for the parent directory, until the project file is + found or we have hit the top of the user's home directory. + + This option cannot be specified via a ``cabal.project`` file. + +.. option:: --store-dir=DIR + + Specifies the name of the directory of the global package store. + +Solver configuration options +---------------------------- + +The following settings control the behavior of the dependency solver: + +.. cfg-field:: constraints: constraints list (comma separated) + --constraint="pkg >= 2.0" + :synopsis: Extra dependencies constraints. + + Add extra constraints to the version bounds, flag settings, + and other properties a solver can pick for a + package. For example: + + :: + + constraints: bar == 2.1 + + A package can be specified multiple times in ``constraints``, in + which case the specified constraints are intersected. This is + useful, since the syntax does not allow you to specify multiple + constraints at once. For example, to specify both version bounds and + flag assignments, you would write: + + :: + + constraints: bar == 2.1, + bar +foo -baz + + Valid constraints take the same form as for the `constraint + command line option + `__. + +.. cfg-field:: preferences: preference (comma separated) + --preference="pkg >= 2.0" + :synopsis: Prefered dependency versions. + + Like :cfg-field:`constraints`, but the solver will attempt to satisfy + these preferences on a best-effort basis. The resulting install is locally + optimal with respect to preferences; specifically, no single package + could be replaced with a more preferred version that still satisfies + the hard constraints. + + Operationally, preferences can cause the solver to attempt certain + version choices of a package before others, which can improve + dependency solver runtime. + + One way to use :cfg-field:`preferences` is to take a known working set of + constraints (e.g., via ``cabal new-freeze``) and record them as + preferences. In this case, the solver will first attempt to use this + configuration, and if this violates hard constraints, it will try to + find the minimal number of upgrades to satisfy the hard constraints + again. + + The command line variant of this field is + ``--preference="pkg >= 2.0"``; to specify multiple preferences, pass + the flag multiple times. + +.. cfg-field:: allow-newer: none, all or list of scoped package names (space or comma separated) + --allow-newer, --allow-newer=[none,all,[scope:][^]pkg] + :synopsis: Lift dependencies upper bound constaints. + + :default: ``none`` + + Allow the solver to pick an newer version of some packages than + would normally be permitted by than the :pkg-field:`build-depends` bounds + of packages in the install plan. This option may be useful if the + dependency solver cannot otherwise find a valid install plan. + + For example, to relax ``pkg``\ s :pkg-field:`build-depends` upper bound on + ``dep-pkg``, write a scoped package name of the form: + + :: + + allow-newer: pkg:dep-pkg + + If the scope shall be limited to specific releases of ``pkg``, the + extended form as in + + :: + + allow-newer: pkg-1.2.3:dep-pkg, pkg-1.1.2:dep-pkg + + can be used to limit the relaxation of dependencies on + ``dep-pkg`` by the ``pkg-1.2.3`` and ``pkg-1.1.2`` releases only. + + The scoped syntax is recommended, as it is often only a single package + whose upper bound is misbehaving. In this case, the upper bounds of + other packages should still be respected; indeed, relaxing the bound + can break some packages which test the selected version of packages. + + The syntax also allows to prefix the dependee package with a + modifier symbol to modify the scope/semantic of the relaxation + transformation in a additional ways. Currently only one modifier + symbol is defined, i.e. ``^`` (i.e. caret) which causes the + relaxation to be applied only to ``^>=`` operators and leave all other + version operators untouched. + + However, in some situations (e.g., when attempting to build packages + on a new version of GHC), it is useful to disregard *all* + upper-bounds, with respect to a package or all packages. This can be + done by specifying just a package name, or using the keyword ``all`` + to specify all packages: + + :: + + -- Disregard upper bounds involving the dependencies on + -- packages bar, baz. For quux only, relax + -- 'quux ^>= ...'-style constraints only. + allow-newer: bar, baz, ^quux + + -- Disregard all upper bounds when dependency solving + allow-newer: all + + -- Disregard all `^>=`-style upper bounds when dependency solving + allow-newer: ^all + + + For consistency, there is also the explicit wildcard scope syntax + ``*`` (or its alphabetic synonym ``all``). Consequently, the + examples above are equivalent to the explicitly scoped variants: + + :: + + allow-newer: all:bar, *:baz, *:^quux + + allow-newer: *:* + allow-newer: all:all + + allow-newer: *:^* + allow-newer: all:^all + + In order to ignore all bounds specified by a package ``pkg-1.2.3`` + you can combine scoping with a right-hand-side wildcard like so + + :: + + -- Disregard any upper bounds specified by pkg-1.2.3 + allow-newer: pkg-1.2.3:* + + -- Disregard only `^>=`-style upper bounds in pkg-1.2.3 + allow-newer: pkg-1.2.3:^* + + + :cfg-field:`allow-newer` is often used in conjunction with a constraint + (in the cfg-field:`constraints` field) forcing the usage of a specific, + newer version of a package. + + The command line variant of this field is e.g. ``--allow-newer=bar``. A + bare ``--allow-newer`` is equivalent to ``--allow-newer=all``. + +.. cfg-field:: allow-older: none, all, list of scoped package names (space or comma separated) + --allow-older, --allow-older=[none,all,[scope:][^]pkg] + :synopsis: Lift dependency lower bound constaints. + :since: 2.0 + + :default: ``none`` + + Like :cfg-field:`allow-newer`, but applied to lower bounds rather than + upper bounds. + + The command line variant of this field is ``--allow-older=all``. A + bare ``--allow-older`` is equivalent to ``--allow-older=all``. + + +.. cfg-field:: index-state: HEAD, unix-timestamp, ISO8601 UTC timestamp. + :synopsis: Use source package index state as it existed at a previous time. + :since: 2.0 + + :default: ``HEAD`` + + This allows to change the source package index state the solver uses + to compute install-plans. This is particularly useful in + combination with freeze-files in order to also freeze the state the + package index was in at the time the install-plan was frozen. + + :: + + -- UNIX timestamp format example + index-state: @1474739268 + + -- ISO8601 UTC timestamp format example + -- This format is used by 'cabal new-configure' + -- for storing `--index-state` values. + index-state: 2016-09-24T17:47:48Z + + +Package configuration options +----------------------------- + +Package options affect the building of specific packages. There are three +ways a package option can be specified: + +- They can be specified at the top-level, in which case they apply only + to **local package**, or + +- They can be specified inside a ``package`` stanza, in which case they + apply to the build of the package, whether or not it is local or + external. + +- They can be specified inside an ``package *`` stanza, in which case they + apply to all packages, local ones from the project and also external + dependencies. + + +For example, the following options specify that :cfg-field:`optimization` +should be turned off for all local packages, and that ``bytestring`` (possibly +an external dependency) should be built with ``-fno-state-hack``:: + + optimization: False + + package bytestring + ghc-options: -fno-state-hack + +``ghc-options`` is not specifically described in this documentation, +but is one of many fields for configuring programs. They take the form +``progname-options`` and ``progname-location``, and +can only be set inside package stanzas. (TODO: They are not supported +at top-level, see :issue:`3579`.) + +At the moment, there is no way to specify an option to apply to all +external packages or all inplace packages. Additionally, it is only +possible to specify these options on the command line for all local +packages (there is no per-package command line interface.) + +Some flags were added by more recent versions of the Cabal library. This +means that they are NOT supported by packages which use Custom setup +scripts that require a version of the Cabal library older than when the +feature was added. + +.. cfg-field:: flags: list of +flagname or -flagname (space separated) + --flags="+foo -bar", -ffoo, -f-bar + :synopsis: Enable or disable package flags. + + Force all flags specified as ``+flagname`` to be true, and all flags + specified as ``-flagname`` to be false. For example, to enable the + flag ``foo`` and disable ``bar``, set: + + :: + + flags: +foo -bar + + If there is no leading punctuation, it is assumed that the flag + should be enabled; e.g., this is equivalent: + + :: + + flags: foo -bar + + Flags are *per-package*, so it doesn't make much sense to specify + flags at the top-level, unless you happen to know that *all* of your + local packages support the same named flags. If a flag is not + supported by a package, it is ignored. + + See also the solver configuration field :cfg-field:`constraints`. + + The command line variant of this flag is ``--flags``. There is also + a shortened form ``-ffoo -f-bar``. + + A common mistake is to say ``cabal new-build -fhans``, where + ``hans`` is a flag for a transitive dependency that is not in the + local package; in this case, the flag will be silently ignored. If + ``haskell-tor`` is the package you want this flag to apply to, try + ``--constraint="haskell-tor +hans"`` instead. + +.. cfg-field:: with-compiler: executable + --with-compiler=executable + :synopsis: Path to compiler executable. + + Specify the path to a particular compiler to be used. If not an + absolute path, it will be resolved according to the :envvar:`PATH` + environment. The type of the compiler (GHC, GHCJS, etc) must be + consistent with the setting of the :cfg-field:`compiler` field. + + The most common use of this option is to specify a different version + of your compiler to be used; e.g., if you have ``ghc-7.8`` in your + path, you can specify ``with-compiler: ghc-7.8`` to use it. + + This flag also sets the default value of :cfg-field:`with-hc-pkg`, using + the heuristic that it is named ``ghc-pkg-7.8`` (if your executable name + is suffixed with a version number), or is the executable named + ``ghc-pkg`` in the same directory as the ``ghc`` directory. If this + heuristic does not work, set :cfg-field:`with-hc-pkg` explicitly. + + For inplace packages, ``cabal new-build`` maintains a separate build + directory for each version of GHC, so you can maintain multiple + build trees for different versions of GHC without clobbering each + other. + + At the moment, it's not possible to set :cfg-field:`with-compiler` on a + per-package basis, but eventually we plan on relaxing this + restriction. If this is something you need, give us a shout. + + The command line variant of this flag is + ``--with-compiler=ghc-7.8``; there is also a short version + ``-w ghc-7.8``. + +.. cfg-field:: with-hc-pkg: executable + --with-hc-pkg=executable + :synopsis: Specifies package tool. + + Specify the path to the package tool, e.g., ``ghc-pkg``. This + package tool must be compatible with the compiler specified by + :cfg-field:`with-compiler` (generally speaking, it should be precisely + the tool that was distributed with the compiler). If this option is + omitted, the default value is determined from :cfg-field:`with-compiler`. + + The command line variant of this flag is + ``--with-hc-pkg=ghc-pkg-7.8``. + +.. cfg-field:: optimization: nat + --enable-optimization + --disable-optimization + :synopsis: Build with optimization. + + :default: ``1`` + + Build with optimization. This is appropriate for production use, + taking more time to build faster libraries and programs. + + The optional *nat* value is the optimisation level. Some compilers + support multiple optimisation levels. The range is 0 to 2. Level 0 + disables optimization, level 1 is the default. Level 2 is higher + optimisation if the compiler supports it. Level 2 is likely to lead + to longer compile times and bigger generated code. If you are not + planning to run code, turning off optimization will lead to better + build times and less code to be rebuilt when a module changes. + + When optimizations are enabled, Cabal passes ``-O2`` to the C compiler. + + We also accept ``True`` (equivalent to 1) and ``False`` (equivalent + to 0). + + Note that as of GHC 8.0, GHC does not recompile when optimization + levels change (see :ghc-ticket:`10923`), so if + you change the optimization level for a local package you may need + to blow away your old build products in order to rebuild with the + new optimization level. + + The command line variant of this flag is ``-O2`` (with ``-O1`` + equivalent to ``-O``). There are also long-form variants + ``--enable-optimization`` and ``--disable-optimization``. + +.. cfg-field:: configure-options: args (space separated) + --configure-option=arg + :synopsis: Options to pass to configure script. + + A list of extra arguments to pass to the external ``./configure`` + script, if one is used. This is only useful for packages which have + the ``Configure`` build type. See also the section on + `system-dependent + parameters `__. + + The command line variant of this flag is ``--configure-option=arg``, + which can be specified multiple times to pass multiple options. + +.. cfg-field:: compiler: ghc, ghcjs, jhc, lhc, uhc or haskell-suite + --compiler=compiler + :synopsis: Compiler to build with. + + :default: ``ghc`` + + Specify which compiler toolchain to be used. This is independent of + ``with-compiler``, because the choice of toolchain affects Cabal's + build logic. + + The command line variant of this flag is ``--compiler=ghc``. + +.. cfg-field:: tests: boolean + --enable-tests + --disable-tests + :synopsis: Build tests. + + :default: ``False`` + + Force test suites to be enabled. For most users this should not be + needed, as we always attempt to solve for test suite dependencies, + even when this value is ``False``; furthermore, test suites are + automatically enabled if they are requested as a built target. + + The command line variant of this flag is ``--enable-tests`` and + ``--disable-tests``. + +.. cfg-field:: benchmarks: boolean + --enable-benchmarks + --disable-benchmarks + :synopsis: Build benchmarks. + + :default: ``False`` + + Force benchmarks to be enabled. For most users this should not be + needed, as we always attempt to solve for benchmark dependencies, + even when this value is ``False``; furthermore, benchmarks are + automatically enabled if they are requested as a built target. + + The command line variant of this flag is ``--enable-benchmarks`` and + ``--disable-benchmarks``. + +.. cfg-field:: extra-prog-path: paths (newline or comma separated) + --extra-prog-path=PATH + :synopsis: Add directories to program search path. + :since: 1.18 + + A list of directories to search for extra required programs. Most + users should not need this, as programs like ``happy`` and ``alex`` + will automatically be installed and added to the path. This can be + useful if a ``Custom`` setup script relies on an exotic extra + program. + + The command line variant of this flag is ``--extra-prog-path=PATH``, + which can be specified multiple times. + +.. cfg-field:: run-tests: boolean + --run-tests + :synopsis: Run package test suite upon installation. + + :default: ``False`` + + Run the package test suite upon installation. This is useful for + saying "When this package is installed, check that the test suite + passes, terminating the rest of the build if it is broken." + + .. warning:: + + One deficiency: the :cfg-field:`run-tests` setting of a package is NOT + recorded as part of the hash, so if you install something without + :cfg-field:`run-tests` and then turn on ``run-tests``, we won't + subsequently test the package. If this is causing you problems, give + us a shout. + + The command line variant of this flag is ``--run-tests``. + +Object code options +^^^^^^^^^^^^^^^^^^^ + +.. cfg-field:: debug-info: integer + --enable-debug-info= + --disable-debug-info + :synopsis: Build with debug info enabled. + :since: 1.22 + + :default: False + + If the compiler (e.g., GHC 7.10 and later) supports outputing OS + native debug info (e.g., DWARF), setting ``debug-info: True`` will + instruct it to do so. See the GHC wiki page on :ghc-wiki:`DWARF` + for more information about this feature. + + (This field also accepts numeric syntax, but until GHC 8.2 this didn't + do anything.) + + The command line variant of this flag is ``--enable-debug-info`` and + ``--disable-debug-info``. + +.. cfg-field:: split-sections: boolean + --enable-split-sections + --disable-split-sections + :synopsis: Use GHC's split sections feature. + :since: 2.1 + + :default: False + + Use the GHC ``-split-sections`` feature when building the library. This + reduces the final size of the executables that use the library by + allowing them to link with only the bits that they use rather than + the entire library. The downside is that building the library takes + longer and uses a bit more memory. + + This feature is supported by GHC 8.0 and later. + + The command line variant of this flag is ``--enable-split-sections`` and + ``--disable-split-sections``. + +.. cfg-field:: split-objs: boolean + --enable-split-objs + --disable-split-objs + :synopsis: Use GHC's split objects feature. + + :default: False + + Use the GHC ``-split-objs`` feature when building the library. This + reduces the final size of the executables that use the library by + allowing them to link with only the bits that they use rather than + the entire library. The downside is that building the library takes + longer and uses considerably more memory. + + It is generally recommend that you use ``split-sections`` instead + of ``split-objs`` where possible. + + The command line variant of this flag is ``--enable-split-objs`` and + ``--disable-split-objs``. + +.. cfg-field:: executable-stripping: boolean + --enable-executable-stripping + --disable-executable-stripping + :synopsis: Strip installed programs. + + :default: True + + When installing binary executable programs, run the ``strip`` + program on the binary. This can considerably reduce the size of the + executable binary file. It does this by removing debugging + information and symbols. + + Not all Haskell implementations generate native binaries. For such + implementations this option has no effect. + + (TODO: Check what happens if you combine this with ``debug-info``.) + + The command line variant of this flag is + ``--enable-executable-stripping`` and + ``--disable-executable-stripping``. + +.. cfg-field:: library-stripping: boolean + --enable-library-stripping + --disable-library-stripping + :synopsis: Strip installed libraries. + :since: 1.19 + + When installing binary libraries, run the ``strip`` program on the + binary, saving space on the file system. See also + ``executable-stripping``. + + The command line variant of this flag is + ``--enable-library-stripping`` and ``--disable-library-stripping``. + +Executable options +^^^^^^^^^^^^^^^^^^ + +.. cfg-field:: program-prefix: prefix + --program-prefix=prefix + :synopsis: Prepend prefix to program names. + + [STRIKEOUT:Prepend *prefix* to installed program names.] (Currently + implemented in a silly and not useful way. If you need this to work + give us a shout.) + + *prefix* may contain the following path variables: ``$pkgid``, + ``$pkg``, ``$version``, ``$compiler``, ``$os``, ``$arch``, ``$abi``, + ``$abitag`` + + The command line variant of this flag is ``--program-prefix=foo-``. + +.. cfg-field:: program-suffix: suffix + --program-suffix=suffix + :synopsis: Append refix to program names. + + [STRIKEOUT:Append *suffix* to installed program names.] (Currently + implemented in a silly and not useful way. If you need this to work + give us a shout.) + + The most obvious use for this is to append the program's version + number to make it possible to install several versions of a program + at once: ``program-suffix: $version``. + + *suffix* may contain the following path variables: ``$pkgid``, + ``$pkg``, ``$version``, ``$compiler``, ``$os``, ``$arch``, ``$abi``, + ``$abitag`` + + The command line variant of this flag is + ``--program-suffix='$version'``. + +Dynamic linking options +^^^^^^^^^^^^^^^^^^^^^^^ + +.. cfg-field:: shared: boolean + --enable-shared + --disable-shared + :synopsis: Build shared library. + + :default: False + + Build shared library. This implies a separate compiler run to + generate position independent code as required on most platforms. + + The command line variant of this flag is ``--enable-shared`` and + ``--disable-shared``. + +.. cfg-field:: executable-dynamic: boolean + --enable-executable-dynamic + --disable-executable-dynamic + :synopsis: Link executables dynamically. + + :default: False + + Link executables dynamically. The executable's library dependencies + should be built as shared objects. This implies ``shared: True`` + unless ``shared: False`` is explicitly specified. + + The command line variant of this flag is + ``--enable-executable-dynamic`` and + ``--disable-executable-dynamic``. + +.. cfg-field:: library-for-ghci: boolean + --enable-library-for-ghci + --disable-library-for-ghci + :synopsis: Build libraries suitable for use with GHCi. + + :default: True + + Build libraries suitable for use with GHCi. This involves an extra + linking step after the build. + + Not all platforms support GHCi and indeed on some platforms, trying + to build GHCi libs fails. In such cases, consider setting + ``library-for-ghci: False``. + + The command line variant of this flag is + ``--enable-library-for-ghci`` and ``--disable-library-for-ghci``. + +.. cfg-field:: relocatable: + --relocatable + :synopsis: Build relocatable package. + :since: 1.21 + + :default: False + + [STRIKEOUT:Build a package which is relocatable.] (TODO: It is not + clear what this actually does, or if it works at all.) + + The command line variant of this flag is ``--relocatable``. + +Static linking options +^^^^^^^^^^^^^^^^^^^^^^ + +.. cfg-field:: static: boolean + --enable-static + --disable-static + :synopsis: Build static library. + + + :default: False + + Roll this and all dependent libraries into a combined ``.a`` archive. + This uses GHCs ``-staticlib`` flag, which is avaiable for iOS and with + GHC 8.4 and later for other platforms as well. + +Foreign function interface options +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. cfg-field:: extra-include-dirs: directories (comma or newline separated list) + --extra-include-dirs=DIR + :synopsis: Adds C header search path. + + An extra directory to search for C header files. You can use this + flag multiple times to get a list of directories. + + You might need to use this flag if you have standard system header + files in a non-standard location that is not mentioned in the + package's ``.cabal`` file. Using this option has the same affect as + appending the directory *dir* to the :pkg-field:`include-dirs` field in each + library and executable in the package's ``.cabal`` file. The + advantage of course is that you do not have to modify the package at + all. These extra directories will be used while building the package + and for libraries it is also saved in the package registration + information and used when compiling modules that use the library. + + The command line variant of this flag is + ``--extra-include-dirs=DIR``, which can be specified multiple times. + +.. cfg-field:: extra-lib-dirs: directories (comma or newline separated list) + --extra-lib-dirs=DIR + :synopsis: Adds library search directory. + + An extra directory to search for system libraries files. + + The command line variant of this flag is ``--extra-lib-dirs=DIR``, + which can be specified multiple times. + +.. cfg-field:: extra-framework-dirs: directories (comma or newline separated list) + --extra-framework-dirs=DIR + :synopsis: Adds framework search directory (OS X only). + + An extra directory to search for frameworks (OS X only). + + You might need to use this flag if you have standard system + libraries in a non-standard location that is not mentioned in the + package's ``.cabal`` file. Using this option has the same affect as + appending the directory *dir* to the :cfg-field:`extra-lib-dirs` field in + each library and executable in the package's ``.cabal`` file. The + advantage of course is that you do not have to modify the package at + all. These extra directories will be used while building the package + and for libraries it is also saved in the package registration + information and used when compiling modules that use the library. + + The command line variant of this flag is + ``--extra-framework-dirs=DIR``, which can be specified multiple + times. + +Profiling options +^^^^^^^^^^^^^^^^^ + +.. cfg-field:: profiling: boolean + --enable-profiling + --disable-profiling + :synopsis: Enable profiling builds. + :since: 1.21 + + :default: False + + Build libraries and executables with profiling enabled (for + compilers that support profiling as a separate mode). It is only + necessary to specify :cfg-field:`profiling` for the specific package you + want to profile; ``cabal new-build`` will ensure that all of its + transitive dependencies are built with profiling enabled. + + To enable profiling for only libraries or executables, see + :cfg-field:`library-profiling` and :cfg-field:`executable-profiling`. + + For useful profiling, it can be important to control precisely what + cost centers are allocated; see :cfg-field:`profiling-detail`. + + The command line variant of this flag is ``--enable-profiling`` and + ``--disable-profiling``. + +.. cfg-field:: profiling-detail: level + --profiling-detail=level + :synopsis: Profiling detail level. + :since: 1.23 + + Some compilers that support profiling, notably GHC, can allocate + costs to different parts of the program and there are different + levels of granularity or detail with which this can be done. In + particular for GHC this concept is called "cost centers", and GHC + can automatically add cost centers, and can do so in different ways. + + This flag covers both libraries and executables, but can be + overridden by the ``library-profiling-detail`` field. + + Currently this setting is ignored for compilers other than GHC. The + levels that cabal currently supports are: + + default + For GHC this uses ``exported-functions`` for libraries and + ``toplevel-functions`` for executables. + none + No costs will be assigned to any code within this component. + exported-functions + Costs will be assigned at the granularity of all top level + functions exported from each module. In GHC, this + is for non-inline functions. Corresponds to ``-fprof-auto-exported``. + toplevel-functions + Costs will be assigned at the granularity of all top level + functions in each module, whether they are exported from the + module or not. In GHC specifically, this is for non-inline + functions. Corresponds to ``-fprof-auto-top``. + all-functions + Costs will be assigned at the granularity of all functions in + each module, whether top level or local. In GHC specifically, + this is for non-inline toplevel or where-bound functions or + values. Corresponds to ``-fprof-auto``. + + The command line variant of this flag is + ``--profiling-detail=none``. + +.. cfg-field:: library-profiling-detail: level + --library-profiling-detail=level + :synopsis: Libraries profiling detail level. + :since: 1.23 + + Like :cfg-field:`profiling-detail`, but applied only to libraries + + The command line variant of this flag is + ``--library-profiling-detail=none``. + +.. cfg-field:: library-vanilla: boolean + --enable-library-vanilla + --disable-library-vanilla + :synopsis: Build libraries without profiling. + + :default: True + + Build ordinary libraries (as opposed to profiling libraries). + Mostly, you can set this to False to avoid building ordinary + libraries when you are profiling. + + The command line variant of this flag is + ``--enable-library-vanilla`` and ``--disable-library-vanilla``. + +.. cfg-field:: library-profiling: boolean + --enable-library-profiling + --disable-library-profiling + :synopsis: Build libraries with profiling enabled. + :since: 1.21 + + :default: False + + Build libraries with profiling enabled. You probably want + to use :cfg-field:`profiling` instead. + + The command line variant of this flag is + ``--enable-library-profiling`` and ``--disable-library-profiling``. + +.. cfg-field:: executable-profiling: boolean + --enable-executable-profiling + --disable-executable-profiling + :synopsis: Build executables with profiling enabled. + :since: 1.21 + + :default: False + + Build executables with profiling enabled. You probably want + to use :cfg-field:`profiling` instead. + + The command line variant of this flag is + ``--enable-executable-profiling`` and + ``--disable-executable-profiling``. + +Coverage options +^^^^^^^^^^^^^^^^ + +.. cfg-field:: coverage: boolean + --enable-coverage + --disable-coverage + :synopsis: Build with coverage enabled. + :since: 1.21 + + :default: False + + Build libraries and executables (including test suites) with Haskell + Program Coverage enabled. Running the test suites will automatically + generate coverage reports with HPC. + + The command line variant of this flag is ``--enable-coverage`` and + ``--disable-coverage``. + +.. cfg-field:: library-coverage: boolean + --enable-library-coverage + --disable-library-coverage + :since: 1.21 + :deprecated: + + :default: False + + Deprecated, use :cfg-field:`coverage`. + + The command line variant of this flag is + ``--enable-library-coverage`` and ``--disable-library-coverage``. + +Haddock options +^^^^^^^^^^^^^^^ + +.. cfg-field:: documentation: boolean + --enable-documentation + --disable-documentation + :synopsis: Enable building of documentation. + + :default: False + + Enables building of Haddock documentation + + The command line variant of this flag is ``--enable-documentation`` + and ``--disable-documentation``. + + `documentation: true` does not imply :cfg-field:`haddock-benchmarks`, + :cfg-field:`haddock-executables`, :cfg-field:`haddock-internal` or + :cfg-field:`haddock-tests`. These need to be enabled separately if + desired. + +.. cfg-field:: doc-index-file: templated path + --doc-index-file=TEMPLATE + :synopsis: Path to haddock templates. + + A central index of Haddock API documentation (template cannot use + ``$pkgid``), which should be updated as documentation is built. + + The command line variant of this flag is + ``--doc-index-file=TEMPLATE`` + +The following commands are equivalent to ones that would be passed when +running ``setup haddock``. (TODO: Where does the documentation get put.) + +.. cfg-field:: haddock-hoogle: boolean + :synopsis: Generate Hoogle file. + + :default: False + + Generate a text file which can be converted by Hoogle_ + into a database for searching. This is equivalent to running ``haddock`` + with the ``--hoogle`` flag. + + The command line variant of this flag is ``--hoogle`` (for the + ``haddock`` command). + +.. cfg-field:: haddock-html: boolean + :synopsis: Build HTML documentation. + + :default: True + + Build HTML documentation. + + The command line variant of this flag is ``--html`` (for the + ``haddock`` command). + +.. cfg-field:: haddock-html-location: templated path + :synopsis: Haddock HTML templates location. + + Specify a template for the location of HTML documentation for + prerequisite packages. The substitutions are applied to the template + to obtain a location for each package, which will be used by + hyperlinks in the generated documentation. For example, the + following command generates links pointing at [Hackage] pages: + + :: + + html-location: 'http://hackage.haskell.org/packages/archive/$pkg/latest/doc/html' + + Here the argument is quoted to prevent substitution by the shell. If + this option is omitted, the location for each package is obtained + using the package tool (e.g. ``ghc-pkg``). + + The command line variant of this flag is ``--html-location`` (for + the ``haddock`` subcommand). + +.. cfg-field:: haddock-executables: boolean + :synopsis: Generate documentation for executables. + + :default: False + + Run haddock on all executable programs. + + The command line variant of this flag is ``--executables`` (for the + ``haddock`` subcommand). + +.. cfg-field:: haddock-tests: boolean + :synopsis: Generate documentation for tests. + + :default: False + + Run haddock on all test suites. + + The command line variant of this flag is ``--tests`` (for the + ``haddock`` subcommand). + +.. cfg-field:: haddock-benchmarks: boolean + :synopsis: Generate documentation for benchmarks. + + :default: False + + Run haddock on all benchmarks. + + The command line variant of this flag is ``--benchmarks`` (for the + ``haddock`` subcommand). + +.. cfg-field:: haddock-all: boolean + :synopsis: Generate documentation for everything + + :default: False + + Run haddock on all components. + + The command line variant of this flag is ``--all`` (for the + ``haddock`` subcommand). + +.. cfg-field:: haddock-internal: boolean + :synopsis: Generate documentation for internal modules + + :default: False + + Build haddock documentation which includes unexposed modules and + symbols. + + The command line variant of this flag is ``--internal`` (for the + ``haddock`` subcommand). + +.. cfg-field:: haddock-css: path + :synopsis: Location of Haddoc CSS file. + + The CSS file that should be used to style the generated + documentation (overriding haddock's default.) + + The command line variant of this flag is ``--css`` (for the + ``haddock`` subcommand). + +.. cfg-field:: haddock-hyperlink-source: boolean + :synopsis: Generate hyperlinked source code for documentation + + :default: False + + Generated hyperlinked source code using `HsColour`_, and have + Haddock documentation link to it. + + The command line variant of this flag is ``--hyperlink-source`` (for + the ``haddock`` subcommand). + +.. cfg-field:: haddock-hscolour-css: path + :synopsis: Location of CSS file for HsColour + + The CSS file that should be used to style the generated hyperlinked + source code (from `HsColour`_). + + The command line variant of this flag is ``--hscolour-css`` (for the + ``haddock`` subcommand). + +.. cfg-field:: haddock-contents-location: URL + :synopsis: URL for contents page. + + A baked-in URL to be used as the location for the contents page. + + The command line variant of this flag is ``--contents-location`` + (for the ``haddock`` subcommand). + +.. cfg-field:: haddock-keep-temp-files: boolean + :synopsis: Keep temporary Haddock files. + + Keep temporary files. + + The command line variant of this flag is ``--keep-temp-files`` (for + the ``haddock`` subcommand). + +Advanced global configuration options +------------------------------------- + +.. cfg-field:: http-transport: curl, wget, powershell, or plain-http + --http-transport=transport + :synopsis: Transport to use with http(s) requests. + + :default: ``curl`` + + Set a transport to be used when making http(s) requests. + + The command line variant of this field is ``--http-transport=curl``. + +.. cfg-field:: ignore-expiry: boolean + --ignore-expiry + :synopsis: Ignore Hackage expiration dates. + + :default: False + + If ``True``, we will ignore expiry dates on metadata from Hackage. + + In general, you should not set this to ``True`` as it will leave you + vulnerable to stale cache attacks. However, it may be temporarily + useful if the main Hackage server is down, and we need to rely on + mirrors which have not been updated for longer than the expiry + period on the timestamp. + + The command line variant of this field is ``--ignore-expiry``. + +.. cfg-field:: remote-repo-cache: directory + --remote-repo-cache=DIR + :synopsis: Location of packages cache. + + :default: ``~/.cabal/packages`` + + [STRIKEOUT:The location where packages downloaded from remote + repositories will be cached.] Not implemented yet. + + The command line variant of this flag is + ``--remote-repo-cache=DIR``. + +.. cfg-field:: logs-dir: directory + --logs-dir=DIR + :synopsis: Directory to store build logs. + + :default: ``~/.cabal/logs`` + + [STRIKEOUT:The location where build logs for packages are stored.] + Not implemented yet. + + The command line variant of this flag is ``--logs-dir=DIR``. + +.. cfg-field:: build-summary: template filepath + --build-summary=TEMPLATE + :synopsis: Build summaries location. + + :default: ``~/.cabal/logs/build.log`` + + [STRIKEOUT:The file to save build summaries. Valid variables which + can be used in the path are ``$pkgid``, ``$compiler``, ``$os`` and + ``$arch``.] Not implemented yet. + + The command line variant of this flag is + ``--build-summary=TEMPLATE``. + +.. cfg-field:: local-repo: directory + --local-repo=DIR + :deprecated: + + [STRIKEOUT:The location of a local repository.] Deprecated. See + "Legacy repositories." + + The command line variant of this flag is ``--local-repo=DIR``. + +.. cfg-field:: world-file: path + --world-file=FILE + :deprecated: + + [STRIKEOUT:The location of the world file.] Deprecated. + + The command line variant of this flag is ``--world-file=FILE``. + +Undocumented fields: ``root-cmd``, ``symlink-bindir``, ``build-log``, +``remote-build-reporting``, ``report-planned-failure``, ``one-shot``, +``offline``. + +Advanced solver options +^^^^^^^^^^^^^^^^^^^^^^^ + +Most users generally won't need these. + +.. cfg-field:: solver: modular + --solver=modular + :synopsis: Which solver to use. + + This field is reserved to allow the specification of alternative + dependency solvers. At the moment, the only accepted option is + ``modular``. + + The command line variant of this field is ``--solver=modular``. + +.. cfg-field:: max-backjumps: nat + --max-backjumps=N + :synopsis: Maximum number of solver backjumps. + + :default: 2000 + + Maximum number of backjumps (backtracking multiple steps) allowed + while solving. Set -1 to allow unlimited backtracking, and 0 to + disable backtracking completely. + + The command line variant of this field is ``--max-backjumps=2000``. + +.. cfg-field:: reorder-goals: boolean + --reorder-goals + --no-reorder-goals + :synopsis: Allow solver to reorder goals. + + :default: False + + When enabled, the solver will reorder goals according to certain + heuristics. Slows things down on average, but may make backtracking + faster for some packages. It's unlikely to help for small projects, + but for big install plans it may help you find a plan when otherwise + this is not possible. See :issue:`1780` for more commentary. + + The command line variant of this field is ``--(no-)reorder-goals``. + +.. cfg-field:: count-conflicts: boolean + --count-conflicts + --no-count-conflicts + :synopsis: Solver prefers versions with less conflicts. + + :default: True + + Try to speed up solving by preferring goals that are involved in a + lot of conflicts. + + The command line variant of this field is + ``--(no-)count-conflicts``. + +.. cfg-field:: strong-flags: boolean + --strong-flags + --no-strong-flags + :synopsis: Do not defer flag choices when solving. + + :default: False + + Do not defer flag choices. (TODO: Better documentation.) + + The command line variant of this field is ``--(no-)strong-flags``. + +.. cfg-field:: allow-boot-library-installs: boolean + --allow-boot-library-installs + --no-allow-boot-library-installs + :synopsis: Allow cabal to install or upgrade any package. + + :default: False + + By default, the dependency solver doesn't allow ``base``, + ``ghc-prim``, ``integer-simple``, ``integer-gmp``, and + ``template-haskell`` to be installed or upgraded. This flag + removes the restriction. + + The command line variant of this field is + ``--(no-)allow-boot-library-installs``. + +.. cfg-field:: cabal-lib-version: version + --cabal-lib-version=version + :synopsis: Version of Cabal library used to build package. + + This field selects the version of the Cabal library which should be + used to build packages. This option is intended primarily for + internal development use (e.g., forcing a package to build with a + newer version of Cabal, to test a new version of Cabal.) (TODO: + Specify its semantics more clearly.) + + The command line variant of this field is + ``--cabal-lib-version=1.24.0.1``. + +.. include:: references.inc diff --git a/doc/users-guide/_static/Cabal-dark.png b/doc/users-guide/_static/Cabal-dark.png new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/Cabal-dark.png differ diff --git a/doc/users-guide/_static/ajax-loader.gif b/doc/users-guide/_static/ajax-loader.gif new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/ajax-loader.gif differ diff --git a/doc/users-guide/_static/basic.css b/doc/users-guide/_static/basic.css new file mode 100644 --- /dev/null +++ b/doc/users-guide/_static/basic.css @@ -0,0 +1,639 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 170px; +} + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +dl { + margin-bottom: 15px; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, .highlighted { + background-color: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +div.code-block-caption { + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +div.code-block-caption + div > div.highlight > pre { + margin-top: 0; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + padding: 1em 1em 0; +} + +div.literal-block-wrapper div.highlight { + margin: 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: relative; + left: 0px; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} diff --git a/doc/users-guide/_static/comment-bright.png b/doc/users-guide/_static/comment-bright.png new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/comment-bright.png differ diff --git a/doc/users-guide/_static/comment-close.png b/doc/users-guide/_static/comment-close.png new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/comment-close.png differ diff --git a/doc/users-guide/_static/comment.png b/doc/users-guide/_static/comment.png new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/comment.png differ diff --git a/doc/users-guide/_static/css/badge_only.css b/doc/users-guide/_static/css/badge_only.css new file mode 100644 --- /dev/null +++ b/doc/users-guide/_static/css/badge_only.css @@ -0,0 +1,2 @@ +.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../font/fontawesome_webfont.eot");src:url("../font/fontawesome_webfont.eot?#iefix") format("embedded-opentype"),url("../font/fontawesome_webfont.woff") format("woff"),url("../font/fontawesome_webfont.ttf") format("truetype"),url("../font/fontawesome_webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:0.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;border-top:solid 10px #343131;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} +/*# sourceMappingURL=badge_only.css.map */ diff --git a/doc/users-guide/_static/css/theme.css b/doc/users-guide/_static/css/theme.css new file mode 100644 --- /dev/null +++ b/doc/users-guide/_static/css/theme.css @@ -0,0 +1,5 @@ +*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}[hidden]{display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:hover,a:active{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;color:#000;text-decoration:none}mark{background:#ff0;color:#000;font-style:italic;font-weight:bold}pre,code,.rst-content tt,.rst-content code,kbd,samp{font-family:monospace,serif;_font-family:"courier new",monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:before,q:after{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}ul,ol,dl{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure{margin:0}form{margin:0}fieldset{border:0;margin:0;padding:0}label{cursor:pointer}legend{border:0;*margin-left:-7px;padding:0;white-space:normal}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0;*width:13px;*height:13px}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top;resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:0.2em 0;background:#ccc;color:#000;padding:0.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none !important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{html,body,section{background:none !important}*{box-shadow:none !important;text-shadow:none !important;filter:none !important;-ms-filter:none !important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,.rst-content .toctree-wrapper p.caption,h3{orphans:3;widows:3}h2,.rst-content .toctree-wrapper p.caption,h3{page-break-after:avoid}}.fa:before,.wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.btn,input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"],select,textarea,.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a,.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a,.wy-nav-top a{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.6.3 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:'FontAwesome';src:url("../fonts/fontawesome-webfont.eot?v=4.6.3");src:url("../fonts/fontawesome-webfont.eot?#iefix&v=4.6.3") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff2?v=4.6.3") format("woff2"),url("../fonts/fontawesome-webfont.woff?v=4.6.3") format("woff"),url("../fonts/fontawesome-webfont.ttf?v=4.6.3") format("truetype"),url("../fonts/fontawesome-webfont.svg?v=4.6.3#fontawesomeregular") format("svg");font-weight:normal;font-style:normal}.fa,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:solid 0.08em #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left,.wy-menu-vertical li span.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-left.toctree-expand,.wy-menu-vertical li.current>a span.fa-pull-left.toctree-expand,.rst-content .fa-pull-left.admonition-title,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content dl dt .fa-pull-left.headerlink,.rst-content p.caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.rst-content code.download span.fa-pull-left:first-child,.fa-pull-left.icon{margin-right:.3em}.fa.fa-pull-right,.wy-menu-vertical li span.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-right.toctree-expand,.wy-menu-vertical li.current>a span.fa-pull-right.toctree-expand,.rst-content .fa-pull-right.admonition-title,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content dl dt .fa-pull-right.headerlink,.rst-content p.caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.rst-content code.download span.fa-pull-right:first-child,.fa-pull-right.icon{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.wy-menu-vertical li span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li.current>a span.pull-left.toctree-expand,.rst-content .pull-left.admonition-title,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content dl dt .pull-left.headerlink,.rst-content p.caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.rst-content code.download span.pull-left:first-child,.pull-left.icon{margin-right:.3em}.fa.pull-right,.wy-menu-vertical li span.pull-right.toctree-expand,.wy-menu-vertical li.on a span.pull-right.toctree-expand,.wy-menu-vertical li.current>a span.pull-right.toctree-expand,.rst-content .pull-right.admonition-title,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content dl dt .pull-right.headerlink,.rst-content p.caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.rst-content code.download span.pull-right:first-child,.pull-right.icon{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s infinite linear;animation:fa-spin 2s infinite linear}.fa-pulse{-webkit-animation:fa-spin 1s infinite steps(8);animation:fa-spin 1s infinite steps(8)}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scale(1, -1);-ms-transform:scale(1, -1);transform:scale(1, -1)}:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-remove:before,.fa-close:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-gear:before,.fa-cog:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-rotate-right:before,.fa-repeat:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.rst-content .admonition-title:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-warning:before,.fa-exclamation-triangle:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-gears:before,.fa-cogs:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-save:before,.fa-floppy-o:before{content:""}.fa-square:before{content:""}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.wy-dropdown .caret:before,.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-unsorted:before,.fa-sort:before{content:""}.fa-sort-down:before,.fa-sort-desc:before{content:""}.fa-sort-up:before,.fa-sort-asc:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-legal:before,.fa-gavel:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-flash:before,.fa-bolt:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-paste:before,.fa-clipboard:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-unlink:before,.fa-chain-broken:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:""}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:""}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:""}.fa-euro:before,.fa-eur:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-rupee:before,.fa-inr:before{content:""}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:""}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:""}.fa-won:before,.fa-krw:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-turkish-lira:before,.fa-try:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li span.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-institution:before,.fa-bank:before,.fa-university:before{content:""}.fa-mortar-board:before,.fa-graduation-cap:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:""}.fa-file-zip-o:before,.fa-file-archive-o:before{content:""}.fa-file-sound-o:before,.fa-file-audio-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-resistance:before,.fa-rebel:before{content:""}.fa-ge:before,.fa-empire:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-y-combinator-square:before,.fa-yc-square:before,.fa-hacker-news:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-send:before,.fa-paper-plane:before{content:""}.fa-send-o:before,.fa-paper-plane-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-soccer-ball-o:before,.fa-futbol-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-hotel:before,.fa-bed:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-yc:before,.fa-y-combinator:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-stop-o:before,.fa-hand-paper-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-tv:before,.fa-television:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-asl-interpreting:before,.fa-american-sign-language-interpreting:before{content:""}.fa-deafness:before,.fa-hard-of-hearing:before,.fa-deaf:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-signing:before,.fa-sign-language:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context{font-family:inherit}.fa:before,.wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before{font-family:"FontAwesome";display:inline-block;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa,a .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,a .rst-content .admonition-title,.rst-content a .admonition-title,a .rst-content h1 .headerlink,.rst-content h1 a .headerlink,a .rst-content h2 .headerlink,.rst-content h2 a .headerlink,a .rst-content h3 .headerlink,.rst-content h3 a .headerlink,a .rst-content h4 .headerlink,.rst-content h4 a .headerlink,a .rst-content h5 .headerlink,.rst-content h5 a .headerlink,a .rst-content h6 .headerlink,.rst-content h6 a .headerlink,a .rst-content dl dt .headerlink,.rst-content dl dt a .headerlink,a .rst-content p.caption .headerlink,.rst-content p.caption a .headerlink,a .rst-content tt.download span:first-child,.rst-content tt.download a span:first-child,a .rst-content code.download span:first-child,.rst-content code.download a span:first-child,a .icon{display:inline-block;text-decoration:inherit}.btn .fa,.btn .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .btn span.toctree-expand,.btn .wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.on a .btn span.toctree-expand,.btn .wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.current>a .btn span.toctree-expand,.btn .rst-content .admonition-title,.rst-content .btn .admonition-title,.btn .rst-content h1 .headerlink,.rst-content h1 .btn .headerlink,.btn .rst-content h2 .headerlink,.rst-content h2 .btn .headerlink,.btn .rst-content h3 .headerlink,.rst-content h3 .btn .headerlink,.btn .rst-content h4 .headerlink,.rst-content h4 .btn .headerlink,.btn .rst-content h5 .headerlink,.rst-content h5 .btn .headerlink,.btn .rst-content h6 .headerlink,.rst-content h6 .btn .headerlink,.btn .rst-content dl dt .headerlink,.rst-content dl dt .btn .headerlink,.btn .rst-content p.caption .headerlink,.rst-content p.caption .btn .headerlink,.btn .rst-content tt.download span:first-child,.rst-content tt.download .btn span:first-child,.btn .rst-content code.download span:first-child,.rst-content code.download .btn span:first-child,.btn .icon,.nav .fa,.nav .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .nav span.toctree-expand,.nav .wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.on a .nav span.toctree-expand,.nav .wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.current>a .nav span.toctree-expand,.nav .rst-content .admonition-title,.rst-content .nav .admonition-title,.nav .rst-content h1 .headerlink,.rst-content h1 .nav .headerlink,.nav .rst-content h2 .headerlink,.rst-content h2 .nav .headerlink,.nav .rst-content h3 .headerlink,.rst-content h3 .nav .headerlink,.nav .rst-content h4 .headerlink,.rst-content h4 .nav .headerlink,.nav .rst-content h5 .headerlink,.rst-content h5 .nav .headerlink,.nav .rst-content h6 .headerlink,.rst-content h6 .nav .headerlink,.nav .rst-content dl dt .headerlink,.rst-content dl dt .nav .headerlink,.nav .rst-content p.caption .headerlink,.rst-content p.caption .nav .headerlink,.nav .rst-content tt.download span:first-child,.rst-content tt.download .nav span:first-child,.nav .rst-content code.download span:first-child,.rst-content code.download .nav span:first-child,.nav .icon{display:inline}.btn .fa.fa-large,.btn .wy-menu-vertical li span.fa-large.toctree-expand,.wy-menu-vertical li .btn span.fa-large.toctree-expand,.btn .rst-content .fa-large.admonition-title,.rst-content .btn .fa-large.admonition-title,.btn .rst-content h1 .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.btn .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .btn .fa-large.headerlink,.btn .rst-content p.caption .fa-large.headerlink,.rst-content p.caption .btn .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .btn span.fa-large:first-child,.btn .rst-content code.download span.fa-large:first-child,.rst-content code.download .btn span.fa-large:first-child,.btn .fa-large.icon,.nav .fa.fa-large,.nav .wy-menu-vertical li span.fa-large.toctree-expand,.wy-menu-vertical li .nav span.fa-large.toctree-expand,.nav .rst-content .fa-large.admonition-title,.rst-content .nav .fa-large.admonition-title,.nav .rst-content h1 .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.nav .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.nav .rst-content p.caption .fa-large.headerlink,.rst-content p.caption .nav .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.nav .rst-content code.download span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.nav .fa-large.icon{line-height:0.9em}.btn .fa.fa-spin,.btn .wy-menu-vertical li span.fa-spin.toctree-expand,.wy-menu-vertical li .btn span.fa-spin.toctree-expand,.btn .rst-content .fa-spin.admonition-title,.rst-content .btn .fa-spin.admonition-title,.btn .rst-content h1 .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.btn .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .btn .fa-spin.headerlink,.btn .rst-content p.caption .fa-spin.headerlink,.rst-content p.caption .btn .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .btn span.fa-spin:first-child,.btn .rst-content code.download span.fa-spin:first-child,.rst-content code.download .btn span.fa-spin:first-child,.btn .fa-spin.icon,.nav .fa.fa-spin,.nav .wy-menu-vertical li span.fa-spin.toctree-expand,.wy-menu-vertical li .nav span.fa-spin.toctree-expand,.nav .rst-content .fa-spin.admonition-title,.rst-content .nav .fa-spin.admonition-title,.nav .rst-content h1 .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.nav .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.nav .rst-content p.caption .fa-spin.headerlink,.rst-content p.caption .nav .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.nav .rst-content code.download span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.nav .fa-spin.icon{display:inline-block}.btn.fa:before,.wy-menu-vertical li span.btn.toctree-expand:before,.rst-content .btn.admonition-title:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content dl dt .btn.headerlink:before,.rst-content p.caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.rst-content code.download span.btn:first-child:before,.btn.icon:before{opacity:0.5;-webkit-transition:opacity 0.05s ease-in;-moz-transition:opacity 0.05s ease-in;transition:opacity 0.05s ease-in}.btn.fa:hover:before,.wy-menu-vertical li span.btn.toctree-expand:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content p.caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.rst-content code.download span.btn:first-child:hover:before,.btn.icon:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li .btn-mini span.toctree-expand:before,.btn-mini .rst-content .admonition-title:before,.rst-content .btn-mini .admonition-title:before,.btn-mini .rst-content h1 .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.btn-mini .rst-content dl dt .headerlink:before,.rst-content dl dt .btn-mini .headerlink:before,.btn-mini .rst-content p.caption .headerlink:before,.rst-content p.caption .btn-mini .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.rst-content tt.download .btn-mini span:first-child:before,.btn-mini .rst-content code.download span:first-child:before,.rst-content code.download .btn-mini span:first-child:before,.btn-mini .icon:before{font-size:14px;vertical-align:-15%}.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.wy-alert-title,.rst-content .admonition-title{color:#fff;font-weight:bold;display:block;color:#fff;background:#6ab0de;margin:-12px;padding:6px 12px;margin-bottom:12px}.wy-alert.wy-alert-danger,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.admonition-todo{background:#fdf3f2}.wy-alert.wy-alert-danger .wy-alert-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .danger .wy-alert-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .danger .admonition-title,.rst-content .error .admonition-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title{background:#f29f97}.wy-alert.wy-alert-warning,.rst-content .wy-alert-warning.note,.rst-content .attention,.rst-content .caution,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.tip,.rst-content .warning,.rst-content .wy-alert-warning.seealso,.rst-content .admonition-todo{background:#ffedcc}.wy-alert.wy-alert-warning .wy-alert-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .attention .wy-alert-title,.rst-content .caution .wy-alert-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .admonition-todo .wy-alert-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .attention .admonition-title,.rst-content .caution .admonition-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .warning .admonition-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .admonition-todo .admonition-title{background:#f0b37e}.wy-alert.wy-alert-info,.rst-content .note,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.rst-content .seealso,.rst-content .wy-alert-info.admonition-todo{background:#e7f2fa}.wy-alert.wy-alert-info .wy-alert-title,.rst-content .note .wy-alert-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.rst-content .note .admonition-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .seealso .admonition-title,.rst-content .wy-alert-info.admonition-todo .admonition-title{background:#6ab0de}.wy-alert.wy-alert-success,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.warning,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.admonition-todo{background:#dbfaf4}.wy-alert.wy-alert-success .wy-alert-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .hint .wy-alert-title,.rst-content .important .wy-alert-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .hint .admonition-title,.rst-content .important .admonition-title,.rst-content .tip .admonition-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.admonition-todo .admonition-title{background:#1abc9c}.wy-alert.wy-alert-neutral,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.admonition-todo{background:#f3f6f6}.wy-alert.wy-alert-neutral .wy-alert-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .admonition-title{color:#404040;background:#e1e4e5}.wy-alert.wy-alert-neutral a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.admonition-todo a{color:#2980B9}.wy-alert p:last-child,.rst-content .note p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.rst-content .seealso p:last-child,.rst-content .admonition-todo p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0px;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,0.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all 0.3s ease-in;-moz-transition:all 0.3s ease-in;transition:all 0.3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27AE60}.wy-tray-container li.wy-tray-item-info{background:#2980B9}.wy-tray-container li.wy-tray-item-warning{background:#E67E22}.wy-tray-container li.wy-tray-item-danger{background:#E74C3C}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width: 768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px 12px;color:#fff;border:1px solid rgba(0,0,0,0.1);background-color:#27AE60;text-decoration:none;font-weight:normal;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:0px 1px 2px -1px rgba(255,255,255,0.5) inset,0px -2px 0px 0px rgba(0,0,0,0.1) inset;outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all 0.1s linear;-moz-transition:all 0.1s linear;transition:all 0.1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:0px -1px 0px 0px rgba(0,0,0,0.05) inset,0px 2px 0px 0px rgba(0,0,0,0.1) inset;padding:8px 12px 6px 12px}.btn:visited{color:#fff}.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:0.4;cursor:not-allowed;box-shadow:none}.btn-disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:0.4;cursor:not-allowed;box-shadow:none}.btn-disabled:hover,.btn-disabled:focus,.btn-disabled:active{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:0.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980B9 !important}.btn-info:hover{background-color:#2e8ece !important}.btn-neutral{background-color:#f3f6f6 !important;color:#404040 !important}.btn-neutral:hover{background-color:#e5ebeb !important;color:#404040}.btn-neutral:visited{color:#404040 !important}.btn-success{background-color:#27AE60 !important}.btn-success:hover{background-color:#295 !important}.btn-danger{background-color:#E74C3C !important}.btn-danger:hover{background-color:#ea6153 !important}.btn-warning{background-color:#E67E22 !important}.btn-warning:hover{background-color:#e98b39 !important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f !important}.btn-link{background-color:transparent !important;color:#2980B9;box-shadow:none;border-color:transparent !important}.btn-link:hover{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:active{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:visited{color:#9B59B6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:before,.wy-btn-group:after{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:solid 1px #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,0.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980B9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:solid 1px #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type="search"]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980B9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned input,.wy-form-aligned textarea,.wy-form-aligned select,.wy-form-aligned .wy-help-inline,.wy-form-aligned label{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{border:0;margin:0;padding:0}legend{display:block;width:100%;border:0;padding:0;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label{display:block;margin:0 0 .3125em 0;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;*zoom:1;max-width:68em;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#E74C3C}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full input[type="text"],.wy-control-group .wy-form-full input[type="password"],.wy-control-group .wy-form-full input[type="email"],.wy-control-group .wy-form-full input[type="url"],.wy-control-group .wy-form-full input[type="date"],.wy-control-group .wy-form-full input[type="month"],.wy-control-group .wy-form-full input[type="time"],.wy-control-group .wy-form-full input[type="datetime"],.wy-control-group .wy-form-full input[type="datetime-local"],.wy-control-group .wy-form-full input[type="week"],.wy-control-group .wy-form-full input[type="number"],.wy-control-group .wy-form-full input[type="search"],.wy-control-group .wy-form-full input[type="tel"],.wy-control-group .wy-form-full input[type="color"],.wy-control-group .wy-form-halves input[type="text"],.wy-control-group .wy-form-halves input[type="password"],.wy-control-group .wy-form-halves input[type="email"],.wy-control-group .wy-form-halves input[type="url"],.wy-control-group .wy-form-halves input[type="date"],.wy-control-group .wy-form-halves input[type="month"],.wy-control-group .wy-form-halves input[type="time"],.wy-control-group .wy-form-halves input[type="datetime"],.wy-control-group .wy-form-halves input[type="datetime-local"],.wy-control-group .wy-form-halves input[type="week"],.wy-control-group .wy-form-halves input[type="number"],.wy-control-group .wy-form-halves input[type="search"],.wy-control-group .wy-form-halves input[type="tel"],.wy-control-group .wy-form-halves input[type="color"],.wy-control-group .wy-form-thirds input[type="text"],.wy-control-group .wy-form-thirds input[type="password"],.wy-control-group .wy-form-thirds input[type="email"],.wy-control-group .wy-form-thirds input[type="url"],.wy-control-group .wy-form-thirds input[type="date"],.wy-control-group .wy-form-thirds input[type="month"],.wy-control-group .wy-form-thirds input[type="time"],.wy-control-group .wy-form-thirds input[type="datetime"],.wy-control-group .wy-form-thirds input[type="datetime-local"],.wy-control-group .wy-form-thirds input[type="week"],.wy-control-group .wy-form-thirds input[type="number"],.wy-control-group .wy-form-thirds input[type="search"],.wy-control-group .wy-form-thirds input[type="tel"],.wy-control-group .wy-form-thirds input[type="color"]{width:100%}.wy-control-group .wy-form-full{float:left;display:block;margin-right:2.35765%;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child{margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n+1){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child{margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control{margin:6px 0 0 0;font-size:90%}.wy-control-no-input{display:inline-block;margin:6px 0 0 0;font-size:90%}.wy-control-group.fluid-input input[type="text"],.wy-control-group.fluid-input input[type="password"],.wy-control-group.fluid-input input[type="email"],.wy-control-group.fluid-input input[type="url"],.wy-control-group.fluid-input input[type="date"],.wy-control-group.fluid-input input[type="month"],.wy-control-group.fluid-input input[type="time"],.wy-control-group.fluid-input input[type="datetime"],.wy-control-group.fluid-input input[type="datetime-local"],.wy-control-group.fluid-input input[type="week"],.wy-control-group.fluid-input input[type="number"],.wy-control-group.fluid-input input[type="search"],.wy-control-group.fluid-input input[type="tel"],.wy-control-group.fluid-input input[type="color"]{width:100%}.wy-form-message-inline{display:inline-block;padding-left:0.3em;color:#666;vertical-align:middle;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;*overflow:visible}input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border 0.3s linear;-moz-transition:border 0.3s linear;transition:border 0.3s linear}input[type="datetime-local"]{padding:.34375em .625em}input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type="search"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}input[type="text"]:focus,input[type="password"]:focus,input[type="email"]:focus,input[type="url"]:focus,input[type="date"]:focus,input[type="month"]:focus,input[type="time"]:focus,input[type="datetime"]:focus,input[type="datetime-local"]:focus,input[type="week"]:focus,input[type="number"]:focus,input[type="search"]:focus,input[type="tel"]:focus,input[type="color"]:focus{outline:0;outline:thin dotted \9;border-color:#333}input.no-focus:focus{border-color:#ccc !important}input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted #333;outline:1px auto #129FEA}input[type="text"][disabled],input[type="password"][disabled],input[type="email"][disabled],input[type="url"][disabled],input[type="date"][disabled],input[type="month"][disabled],input[type="time"][disabled],input[type="datetime"][disabled],input[type="datetime-local"][disabled],input[type="week"][disabled],input[type="number"][disabled],input[type="search"][disabled],input[type="tel"][disabled],input[type="color"][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,textarea:focus:invalid,select:focus:invalid{color:#E74C3C;border:1px solid #E74C3C}input:focus:invalid:focus,textarea:focus:invalid:focus,select:focus:invalid:focus{border-color:#E74C3C}input[type="file"]:focus:invalid:focus,input[type="radio"]:focus:invalid:focus,input[type="checkbox"]:focus:invalid:focus{outline-color:#E74C3C}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border 0.3s linear;-moz-transition:border 0.3s linear;transition:border 0.3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}select[disabled],textarea[disabled],input[readonly],select[readonly],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type="radio"][disabled],input[type="checkbox"][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:solid 1px #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{width:36px;height:12px;margin:12px 0;position:relative;border-radius:4px;background:#ccc;cursor:pointer;-webkit-transition:all 0.2s ease-in-out;-moz-transition:all 0.2s ease-in-out;transition:all 0.2s ease-in-out}.wy-switch:before{position:absolute;content:"";display:block;width:18px;height:18px;border-radius:4px;background:#999;left:-3px;top:-3px;-webkit-transition:all 0.2s ease-in-out;-moz-transition:all 0.2s ease-in-out;transition:all 0.2s ease-in-out}.wy-switch:after{content:"false";position:absolute;left:48px;display:block;font-size:12px;color:#ccc}.wy-switch.active{background:#1e8449}.wy-switch.active:before{left:24px;background:#27AE60}.wy-switch.active:after{content:"true"}.wy-switch.disabled,.wy-switch.active.disabled{cursor:not-allowed}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#E74C3C}.wy-control-group.wy-control-group-error input[type="text"],.wy-control-group.wy-control-group-error input[type="password"],.wy-control-group.wy-control-group-error input[type="email"],.wy-control-group.wy-control-group-error input[type="url"],.wy-control-group.wy-control-group-error input[type="date"],.wy-control-group.wy-control-group-error input[type="month"],.wy-control-group.wy-control-group-error input[type="time"],.wy-control-group.wy-control-group-error input[type="datetime"],.wy-control-group.wy-control-group-error input[type="datetime-local"],.wy-control-group.wy-control-group-error input[type="week"],.wy-control-group.wy-control-group-error input[type="number"],.wy-control-group.wy-control-group-error input[type="search"],.wy-control-group.wy-control-group-error input[type="tel"],.wy-control-group.wy-control-group-error input[type="color"]{border:solid 1px #E74C3C}.wy-control-group.wy-control-group-error textarea{border:solid 1px #E74C3C}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27AE60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#E74C3C}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#E67E22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980B9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width: 480px){.wy-form button[type="submit"]{margin:0.7em 0 0}.wy-form input[type="text"],.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0.3em;display:block}.wy-form label{margin-bottom:0.3em;display:block}.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:0.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0 0}.wy-form .wy-help-inline,.wy-form-message-inline,.wy-form-message{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width: 768px){.tablet-hide{display:none}}@media screen and (max-width: 480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.wy-table,.rst-content table.docutils,.rst-content table.field-list{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.wy-table caption,.rst-content table.docutils caption,.rst-content table.field-list caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td,.wy-table th,.rst-content table.docutils th,.rst-content table.field-list th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.wy-table td:first-child,.rst-content table.docutils td:first-child,.rst-content table.field-list td:first-child,.wy-table th:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list th:first-child{border-left-width:0}.wy-table thead,.rst-content table.docutils thead,.rst-content table.field-list thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.wy-table thead th,.rst-content table.docutils thead th,.rst-content table.field-list thead th{font-weight:bold;border-bottom:solid 2px #e1e4e5}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td{background-color:transparent;vertical-align:middle}.wy-table td p,.rst-content table.docutils td p,.rst-content table.field-list td p{line-height:18px}.wy-table td p:last-child,.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child{margin-bottom:0}.wy-table .wy-table-cell-min,.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min{width:1%;padding-right:0}.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:gray;font-size:90%}.wy-table-tertiary{color:gray;font-size:80%}.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td,.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td{background-color:#f3f6f6}.wy-table-backed{background-color:#f3f6f6}.wy-table-bordered-all,.rst-content table.docutils{border:1px solid #e1e4e5}.wy-table-bordered-all td,.rst-content table.docutils td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.wy-table-bordered-all tbody>tr:last-child td,.rst-content table.docutils tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px 0;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0 !important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980B9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9B59B6}html{height:100%;overflow-x:hidden}body{font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;font-weight:normal;color:#404040;min-height:100%;overflow-x:hidden;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#E67E22 !important}a.wy-text-warning:hover{color:#eb9950 !important}.wy-text-info{color:#2980B9 !important}a.wy-text-info:hover{color:#409ad5 !important}.wy-text-success{color:#27AE60 !important}a.wy-text-success:hover{color:#36d278 !important}.wy-text-danger{color:#E74C3C !important}a.wy-text-danger:hover{color:#ed7669 !important}.wy-text-neutral{color:#404040 !important}a.wy-text-neutral:hover{color:#595959 !important}h1,h2,.rst-content .toctree-wrapper p.caption,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif}p{line-height:24px;margin:0;font-size:16px;margin-bottom:24px}h1{font-size:175%}h2,.rst-content .toctree-wrapper p.caption{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}code,.rst-content tt,.rst-content code{white-space:nowrap;max-width:100%;background:#fff;border:solid 1px #e1e4e5;font-size:75%;padding:0 5px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;color:#E74C3C;overflow-x:auto}code.code-large,.rst-content tt.code-large{font-size:90%}.wy-plain-list-disc,.rst-content .section ul,.rst-content .toctree-wrapper ul,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.wy-plain-list-disc li,.rst-content .section ul li,.rst-content .toctree-wrapper ul li,article ul li{list-style:disc;margin-left:24px}.wy-plain-list-disc li p:last-child,.rst-content .section ul li p:last-child,.rst-content .toctree-wrapper ul li p:last-child,article ul li p:last-child{margin-bottom:0}.wy-plain-list-disc li ul,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li ul,article ul li ul{margin-bottom:0}.wy-plain-list-disc li li,.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,article ul li li{list-style:circle}.wy-plain-list-disc li li li,.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,article ul li li li{list-style:square}.wy-plain-list-disc li ol li,.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,article ul li ol li{list-style:decimal}.wy-plain-list-decimal,.rst-content .section ol,.rst-content ol.arabic,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.wy-plain-list-decimal li,.rst-content .section ol li,.rst-content ol.arabic li,article ol li{list-style:decimal;margin-left:24px}.wy-plain-list-decimal li p:last-child,.rst-content .section ol li p:last-child,.rst-content ol.arabic li p:last-child,article ol li p:last-child{margin-bottom:0}.wy-plain-list-decimal li ul,.rst-content .section ol li ul,.rst-content ol.arabic li ul,article ol li ul{margin-bottom:0}.wy-plain-list-decimal li ul li,.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,article ol li ul li{list-style:disc}.codeblock-example{border:1px solid #e1e4e5;border-bottom:none;padding:24px;padding-top:48px;font-weight:500;background:#fff;position:relative}.codeblock-example:after{content:"Example";position:absolute;top:0px;left:0px;background:#9B59B6;color:#fff;padding:6px 12px}.codeblock-example.prettyprint-example-only{border:1px solid #e1e4e5;margin-bottom:24px}.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight']{border:1px solid #e1e4e5;padding:0px;overflow-x:auto;background:#fff;margin:1px 0 24px 0}.codeblock div[class^='highlight'],pre.literal-block div[class^='highlight'],.rst-content .literal-block div[class^='highlight'],div[class^='highlight'] div[class^='highlight']{border:none;background:none;margin:0}div[class^='highlight'] td.code{width:100%}.linenodiv pre{border-right:solid 1px #e6e9ea;margin:0;padding:12px 12px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;font-size:12px;line-height:1.5;color:#d9d9d9}div[class^='highlight'] pre{white-space:pre;margin:0;padding:12px 12px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;font-size:12px;line-height:1.5;display:block;overflow:auto;color:#404040}@media print{.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight'],div[class^='highlight'] pre{white-space:pre-wrap}}.hll{background-color:#ffc;margin:0 -12px;padding:0 12px;display:block}.c{color:#998;font-style:italic}.err{color:#a61717;background-color:#e3d2d2}.k{font-weight:bold}.o{font-weight:bold}.cm{color:#998;font-style:italic}.cp{color:#999;font-weight:bold}.c1{color:#998;font-style:italic}.cs{color:#999;font-weight:bold;font-style:italic}.gd{color:#000;background-color:#fdd}.gd .x{color:#000;background-color:#faa}.ge{font-style:italic}.gr{color:#a00}.gh{color:#999}.gi{color:#000;background-color:#dfd}.gi .x{color:#000;background-color:#afa}.go{color:#888}.gp{color:#555}.gs{font-weight:bold}.gu{color:purple;font-weight:bold}.gt{color:#a00}.kc{font-weight:bold}.kd{font-weight:bold}.kn{font-weight:bold}.kp{font-weight:bold}.kr{font-weight:bold}.kt{color:#458;font-weight:bold}.m{color:#099}.s{color:#d14}.n{color:#333}.na{color:teal}.nb{color:#0086b3}.nc{color:#458;font-weight:bold}.no{color:teal}.ni{color:purple}.ne{color:#900;font-weight:bold}.nf{color:#900;font-weight:bold}.nn{color:#555}.nt{color:navy}.nv{color:teal}.ow{font-weight:bold}.w{color:#bbb}.mf{color:#099}.mh{color:#099}.mi{color:#099}.mo{color:#099}.sb{color:#d14}.sc{color:#d14}.sd{color:#d14}.s2{color:#d14}.se{color:#d14}.sh{color:#d14}.si{color:#d14}.sx{color:#d14}.sr{color:#009926}.s1{color:#d14}.ss{color:#990073}.bp{color:#999}.vc{color:teal}.vg{color:teal}.vi{color:teal}.il{color:#099}.gc{color:#999;background-color:#EAF2F5}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.wy-breadcrumbs li code,.wy-breadcrumbs li .rst-content tt,.rst-content .wy-breadcrumbs li tt{padding:5px;border:none;background:none}.wy-breadcrumbs li code.literal,.wy-breadcrumbs li .rst-content tt.literal,.rst-content .wy-breadcrumbs li tt.literal{color:#404040}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width: 480px){.wy-breadcrumbs-extra{display:none}.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:before,.wy-menu-horiz:after{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz ul,.wy-menu-horiz li{display:inline-block}.wy-menu-horiz li:hover{background:rgba(255,255,255,0.1)}.wy-menu-horiz li.divide-left{border-left:solid 1px #404040}.wy-menu-horiz li.divide-right{border-right:solid 1px #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{height:32px;display:inline-block;line-height:32px;padding:0 1.618em;margin-bottom:0;display:block;font-weight:bold;text-transform:uppercase;font-size:80%;color:#555;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:solid 1px #404040}.wy-menu-vertical li.divide-bottom{border-bottom:solid 1px #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:gray;border-right:solid 1px #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.wy-menu-vertical li code,.wy-menu-vertical li .rst-content tt,.rst-content .wy-menu-vertical li tt{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li span.toctree-expand{display:block;float:left;margin-left:-1.2em;font-size:0.8em;line-height:1.6em;color:#4d4d4d}.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a{color:#404040;padding:.4045em 1.618em;font-weight:bold;position:relative;background:#fcfcfc;border:none;border-bottom:solid 1px #c9c9c9;border-top:solid 1px #c9c9c9;padding-left:1.618em -4px}.wy-menu-vertical li.on a:hover,.wy-menu-vertical li.current>a:hover{background:#fcfcfc}.wy-menu-vertical li.on a:hover span.toctree-expand,.wy-menu-vertical li.current>a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand{display:block;font-size:0.8em;line-height:1.6em;color:#333}.wy-menu-vertical li.toctree-l1.current li.toctree-l2>ul,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>ul{display:none}.wy-menu-vertical li.toctree-l1.current li.toctree-l2.current>ul,.wy-menu-vertical li.toctree-l2.current li.toctree-l3.current>ul{display:block}.wy-menu-vertical li.toctree-l2.current>a{background:#c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{display:block;background:#c9c9c9;padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l2 span.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3{font-size:0.9em}.wy-menu-vertical li.toctree-l3.current>a{background:#bdbdbd;padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{display:block;background:#bdbdbd;padding:.4045em 5.663em;border-top:none;border-bottom:none}.wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l3 span.toctree-expand{color:#969696}.wy-menu-vertical li.toctree-l4{font-size:0.9em}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical .local-toc li ul{display:block}.wy-menu-vertical li ul li a{margin-bottom:0;color:#b3b3b3;font-weight:normal}.wy-menu-vertical a{display:inline-block;line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#b3b3b3}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover span.toctree-expand{color:#b3b3b3}.wy-menu-vertical a:active{background-color:#2980B9;cursor:pointer;color:#fff}.wy-menu-vertical a:active span.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980B9;text-align:center;padding:.809em;display:block;color:#fcfcfc;margin-bottom:.809em}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em auto;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a{color:#fcfcfc;font-size:100%;font-weight:bold;display:inline-block;padding:4px 6px;margin-bottom:.809em}.wy-side-nav-search>a:hover,.wy-side-nav-search .wy-dropdown>a:hover{background:rgba(255,255,255,0.1)}.wy-side-nav-search>a img.logo,.wy-side-nav-search .wy-dropdown>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search>a.icon img.logo,.wy-side-nav-search .wy-dropdown>a.icon img.logo{margin-top:0.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:normal;color:rgba(255,255,255,0.3)}.wy-nav .wy-menu-vertical header{color:#2980B9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980B9;color:#fff}[data-menu-wrap]{-webkit-transition:all 0.2s ease-in;-moz-transition:all 0.2s ease-in;transition:all 0.2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:left repeat-y #fcfcfc;background-image:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDoxOERBMTRGRDBFMUUxMUUzODUwMkJCOThDMEVFNURFMCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDoxOERBMTRGRTBFMUUxMUUzODUwMkJCOThDMEVFNURFMCI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjE4REExNEZCMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjE4REExNEZDMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+EwrlwAAAAA5JREFUeNpiMDU0BAgwAAE2AJgB9BnaAAAAAElFTkSuQmCC);background-size:300px 1px}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980B9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:before,.wy-nav-top:after{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:bold}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,0.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:#999}footer p{margin-bottom:12px}footer span.commit code,footer span.commit .rst-content tt,.rst-content footer span.commit tt{padding:0px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;font-size:1em;background:none;border:none;color:#999}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:before,.rst-footer-buttons:after{display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:before,.rst-breadcrumbs-buttons:after{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:solid 1px #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:solid 1px #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:gray;font-size:90%}@media screen and (max-width: 768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-side-scroll{width:auto}.wy-side-nav-search{width:auto}.wy-menu.wy-menu-vertical{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width: 1400px){.wy-nav-content-wrap{background:rgba(0,0,0,0.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,footer,.wy-nav-side{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;border-top:solid 10px #343131;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version span.toctree-expand,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content p.caption .headerlink,.rst-content p.caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .icon{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content img{max-width:100%;height:auto !important}.rst-content .highlight>pre{line-height:normal}.rst-content div.figure{margin-bottom:24px}.rst-content div.figure p.caption{font-style:italic}.rst-content div.figure.align-center{text-align:center}.rst-content .section>img,.rst-content .section>a>img{margin-bottom:24px}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content .note .last,.rst-content .attention .last,.rst-content .caution .last,.rst-content .danger .last,.rst-content .error .last,.rst-content .hint .last,.rst-content .important .last,.rst-content .tip .last,.rst-content .warning .last,.rst-content .seealso .last,.rst-content .admonition-todo .last{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,0.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent !important;border-color:rgba(0,0,0,0.1) !important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha li{list-style:upper-alpha}.rst-content .section ol p,.rst-content .section ul p{margin-bottom:12px}.rst-content .line-block{margin-left:24px}.rst-content .topic-title{font-weight:bold;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0px 0px 24px 24px}.rst-content .align-left{float:left;margin:0px 24px 24px 0px}.rst-content .align-center{margin:auto;display:block}.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content .toctree-wrapper p.caption .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink{display:none;visibility:hidden;font-size:14px}.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content .toctree-wrapper p.caption .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content dl dt .headerlink:after,.rst-content p.caption .headerlink:after{visibility:visible;content:"";font-family:FontAwesome;display:inline-block}.rst-content h1:hover .headerlink,.rst-content h2:hover .headerlink,.rst-content .toctree-wrapper p.caption:hover .headerlink,.rst-content h3:hover .headerlink,.rst-content h4:hover .headerlink,.rst-content h5:hover .headerlink,.rst-content h6:hover .headerlink,.rst-content dl dt:hover .headerlink,.rst-content p.caption:hover .headerlink{display:inline-block}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:solid 1px #e1e4e5}.rst-content .sidebar p,.rst-content .sidebar ul,.rst-content .sidebar dl{font-size:90%}.rst-content .sidebar .last{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif;font-weight:bold;background:#e1e4e5;padding:6px 12px;margin:-24px;margin-bottom:24px;font-size:100%}.rst-content .highlighted{background:#F1C40F;display:inline-block;font-weight:bold;padding:0 6px}.rst-content .footnote-reference,.rst-content .citation-reference{vertical-align:super;font-size:90%}.rst-content table.docutils.citation,.rst-content table.docutils.footnote{background:none;border:none;color:#999}.rst-content table.docutils.citation td,.rst-content table.docutils.citation tr,.rst-content table.docutils.footnote td,.rst-content table.docutils.footnote tr{border:none;background-color:transparent !important;white-space:normal}.rst-content table.docutils.citation td.label,.rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}.rst-content table.docutils.citation tt,.rst-content table.docutils.citation code,.rst-content table.docutils.footnote tt,.rst-content table.docutils.footnote code{color:#555}.rst-content table.field-list{border:none}.rst-content table.field-list td{border:none;padding-top:5px}.rst-content table.field-list td>strong{display:inline-block;margin-top:3px}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left;padding-left:0}.rst-content tt,.rst-content tt,.rst-content code{color:#000;padding:2px 5px}.rst-content tt big,.rst-content tt em,.rst-content tt big,.rst-content code big,.rst-content tt em,.rst-content code em{font-size:100% !important;line-height:normal}.rst-content tt.literal,.rst-content tt.literal,.rst-content code.literal{color:#E74C3C}.rst-content tt.xref,a .rst-content tt,.rst-content tt.xref,.rst-content code.xref,a .rst-content tt,a .rst-content code{font-weight:bold;color:#404040}.rst-content a tt,.rst-content a tt,.rst-content a code{color:#2980B9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:bold}.rst-content dl p,.rst-content dl table,.rst-content dl ul,.rst-content dl ol{margin-bottom:12px !important}.rst-content dl dd{margin:0 0 12px 24px}.rst-content dl:not(.docutils){margin-bottom:24px}.rst-content dl:not(.docutils) dt{display:inline-block;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980B9;border-top:solid 3px #6ab0de;padding:6px;position:relative}.rst-content dl:not(.docutils) dt:before{color:#6ab0de}.rst-content dl:not(.docutils) dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dl dt{margin-bottom:6px;border:none;border-left:solid 3px #ccc;background:#f0f0f0;color:#555}.rst-content dl:not(.docutils) dl dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dt:first-child{margin-top:0}.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) code{font-weight:bold}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) code.descclassname{background-color:transparent;border:none;padding:0;font-size:100% !important}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname{font-weight:bold}.rst-content dl:not(.docutils) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:bold}.rst-content dl:not(.docutils) .property{display:inline-block;padding-right:8px}.rst-content .viewcode-link,.rst-content .viewcode-back{display:inline-block;color:#27AE60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:bold}.rst-content tt.download,.rst-content code.download{background:inherit;padding:inherit;font-weight:normal;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content tt.download span:first-child,.rst-content code.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}@media screen and (max-width: 480px){.rst-content .sidebar{width:100%}}span[id*='MathJax-Span']{color:#404040}.math{text-align:center}@font-face{font-family:"Inconsolata";font-style:normal;font-weight:400;src:local("Inconsolata"),local("Inconsolata-Regular"),url(../fonts/Inconsolata-Regular.ttf) format("truetype")}@font-face{font-family:"Inconsolata";font-style:normal;font-weight:700;src:local("Inconsolata Bold"),local("Inconsolata-Bold"),url(../fonts/Inconsolata-Bold.ttf) format("truetype")}@font-face{font-family:"Lato";font-style:normal;font-weight:400;src:local("Lato Regular"),local("Lato-Regular"),url(../fonts/Lato-Regular.ttf) format("truetype")}@font-face{font-family:"Lato";font-style:normal;font-weight:700;src:local("Lato Bold"),local("Lato-Bold"),url(../fonts/Lato-Bold.ttf) format("truetype")}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:400;src:local("Roboto Slab Regular"),local("RobotoSlab-Regular"),url(../fonts/RobotoSlab-Regular.ttf) format("truetype")}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:700;src:local("Roboto Slab Bold"),local("RobotoSlab-Bold"),url(../fonts/RobotoSlab-Bold.ttf) format("truetype")} +/*# sourceMappingURL=theme.css.map */ diff --git a/doc/users-guide/_static/doctools.js b/doc/users-guide/_static/doctools.js new file mode 100644 --- /dev/null +++ b/doc/users-guide/_static/doctools.js @@ -0,0 +1,287 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + */ +jQuery.urldecode = function(x) { + return decodeURIComponent(x).replace(/\+/g, ' '); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s == 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node) { + if (node.nodeType == 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { + var span = document.createElement("span"); + span.className = className; + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this); + }); + } + } + return this.each(function() { + highlight(this); + }); +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated == 'undefined') + return string; + return (typeof translated == 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated == 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('

    ' + _('Hide Search Matches') + '

    ') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) == 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this == '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keyup(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box or textarea + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/doc/users-guide/_static/down-pressed.png b/doc/users-guide/_static/down-pressed.png new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/down-pressed.png differ diff --git a/doc/users-guide/_static/down.png b/doc/users-guide/_static/down.png new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/down.png differ diff --git a/doc/users-guide/_static/file.png b/doc/users-guide/_static/file.png new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/file.png differ diff --git a/doc/users-guide/_static/fonts/Inconsolata-Bold.ttf b/doc/users-guide/_static/fonts/Inconsolata-Bold.ttf new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/fonts/Inconsolata-Bold.ttf differ diff --git a/doc/users-guide/_static/fonts/Inconsolata-Regular.ttf b/doc/users-guide/_static/fonts/Inconsolata-Regular.ttf new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/fonts/Inconsolata-Regular.ttf differ diff --git a/doc/users-guide/_static/fonts/Lato-Bold.ttf b/doc/users-guide/_static/fonts/Lato-Bold.ttf new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/fonts/Lato-Bold.ttf differ diff --git a/doc/users-guide/_static/fonts/Lato-Regular.ttf b/doc/users-guide/_static/fonts/Lato-Regular.ttf new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/fonts/Lato-Regular.ttf differ diff --git a/doc/users-guide/_static/fonts/RobotoSlab-Bold.ttf b/doc/users-guide/_static/fonts/RobotoSlab-Bold.ttf new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/fonts/RobotoSlab-Bold.ttf differ diff --git a/doc/users-guide/_static/fonts/RobotoSlab-Regular.ttf b/doc/users-guide/_static/fonts/RobotoSlab-Regular.ttf new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/fonts/RobotoSlab-Regular.ttf differ diff --git a/doc/users-guide/_static/fonts/fontawesome-webfont.eot b/doc/users-guide/_static/fonts/fontawesome-webfont.eot new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/fonts/fontawesome-webfont.eot differ diff --git a/doc/users-guide/_static/fonts/fontawesome-webfont.svg b/doc/users-guide/_static/fonts/fontawesome-webfont.svg new file mode 100644 --- /dev/null +++ b/doc/users-guide/_static/fonts/fontawesome-webfont.svg @@ -0,0 +1,685 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/users-guide/_static/fonts/fontawesome-webfont.ttf b/doc/users-guide/_static/fonts/fontawesome-webfont.ttf new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/fonts/fontawesome-webfont.ttf differ diff --git a/doc/users-guide/_static/fonts/fontawesome-webfont.woff b/doc/users-guide/_static/fonts/fontawesome-webfont.woff new file mode 100644 Binary files /dev/null and b/doc/users-guide/_static/fonts/fontawesome-webfont.woff differ diff --git a/doc/users-guide/_static/jquery-3.1.0.js b/doc/users-guide/_static/jquery-3.1.0.js new file mode 100644 --- /dev/null +++ b/doc/users-guide/_static/jquery-3.1.0.js @@ -0,0 +1,10074 @@ +/*eslint-disable no-unused-vars*/ +/*! + * jQuery JavaScript Library v3.1.0 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright jQuery Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2016-07-07T21:44Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var document = window.document; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var concat = arr.concat; + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + + + + function DOMEval( code, doc ) { + doc = doc || document; + + var script = doc.createElement( "script" ); + + script.text = code; + doc.head.appendChild( script ).parentNode.removeChild( script ); + } +/* global Symbol */ +// Defining this global in .eslintrc would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.1.0", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }, + + // Support: Android <=4.0 only + // Make sure we trim BOM and NBSP + rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g, + + // Matches dashed string for camelizing + rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g, + + // Used by jQuery.camelCase as callback to replace() + fcamelCase = function( all, letter ) { + return letter.toUpperCase(); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + return num != null ? + + // Return just the one element from the set + ( num < 0 ? this[ num + this.length ] : this[ num ] ) : + + // Return all the elements in a clean array + slice.call( this ); + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !jQuery.isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + src = target[ name ]; + copy = options[ name ]; + + // Prevent never-ending loop + if ( target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = jQuery.isArray( copy ) ) ) ) { + + if ( copyIsArray ) { + copyIsArray = false; + clone = src && jQuery.isArray( src ) ? src : []; + + } else { + clone = src && jQuery.isPlainObject( src ) ? src : {}; + } + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isFunction: function( obj ) { + return jQuery.type( obj ) === "function"; + }, + + isArray: Array.isArray, + + isWindow: function( obj ) { + return obj != null && obj === obj.window; + }, + + isNumeric: function( obj ) { + + // As of jQuery 3.0, isNumeric is limited to + // strings and numbers (primitives or objects) + // that can be coerced to finite numbers (gh-2662) + var type = jQuery.type( obj ); + return ( type === "number" || type === "string" ) && + + // parseFloat NaNs numeric-cast false positives ("") + // ...but misinterprets leading-number strings, particularly hex literals ("0x...") + // subtraction forces infinities to NaN + !isNaN( obj - parseFloat( obj ) ); + }, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + + /* eslint-disable no-unused-vars */ + // See https://github.com/eslint/eslint/issues/6125 + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + type: function( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; + }, + + // Evaluates a script in a global context + globalEval: function( code ) { + DOMEval( code ); + }, + + // Convert dashed to camelCase; used by the css and data modules + // Support: IE <=9 - 11, Edge 12 - 13 + // Microsoft forgot to hump their vendor prefix (#9572) + camelCase: function( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); + }, + + nodeName: function( elem, name ) { + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // Support: Android <=4.0 only + trim: function( text ) { + return text == null ? + "" : + ( text + "" ).replace( rtrim, "" ); + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return concat.apply( [], ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // Bind a function to a context, optionally partially applying any + // arguments. + proxy: function( fn, context ) { + var tmp, args, proxy; + + if ( typeof context === "string" ) { + tmp = fn[ context ]; + context = fn; + fn = tmp; + } + + // Quick check to determine if target is callable, in the spec + // this throws a TypeError, but we will just return undefined. + if ( !jQuery.isFunction( fn ) ) { + return undefined; + } + + // Simulated bind + args = slice.call( arguments, 2 ); + proxy = function() { + return fn.apply( context || this, args.concat( slice.call( arguments ) ) ); + }; + + // Set the guid of unique handler to the same of original handler, so it can be removed + proxy.guid = fn.guid = fn.guid || jQuery.guid++; + + return proxy; + }, + + now: Date.now, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = jQuery.type( obj ); + + if ( type === "function" || jQuery.isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.0 + * https://sizzlejs.com/ + * + * Copyright jQuery Foundation and other contributors + * Released under the MIT license + * http://jquery.org/license + * + * Date: 2016-01-04 + */ +(function( window ) { + +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ({}).hasOwnProperty, + arr = [], + pop = arr.pop, + push_native = arr.push, + push = arr.push, + slice = arr.slice, + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[i] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier + identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), + + rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + + whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), + funescape = function( _, escaped, escapedWhitespace ) { + var high = "0x" + escaped - 0x10000; + // NaN means non-codepoint + // Support: Firefox<24 + // Workaround erroneous numeric interpretation of +"0x" + return high !== high || escapedWhitespace ? + escaped : + high < 0 ? + // BMP codepoint + String.fromCharCode( high + 0x10000 ) : + // Supplemental Plane codepoint (surrogate pair) + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\x80-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + disabledAncestor = addCombinator( + function( elem ) { + return elem.disabled === true; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + (arr = slice.call( preferredDoc.childNodes )), + preferredDoc.childNodes + ); + // Support: Android<4.0 + // Detect silently failing push.apply + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + push_native.apply( target, slice.call(els) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + // Can't trust NodeList.length + while ( (target[j++] = els[i++]) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + + if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { + setDocument( context ); + } + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) { + + // ID selector + if ( (m = match[1]) ) { + + // Document context + if ( nodeType === 9 ) { + if ( (elem = context.getElementById( m )) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && (elem = newContext.getElementById( m )) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[2] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( (m = match[3]) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !compilerCache[ selector + " " ] && + (!rbuggyQSA || !rbuggyQSA.test( selector )) ) { + + if ( nodeType !== 1 ) { + newContext = context; + newSelector = selector; + + // qSA looks outside Element context, which is not what we want + // Thanks to Andrew Dupont for this workaround technique + // Support: IE <=8 + // Exclude object elements + } else if ( context.nodeName.toLowerCase() !== "object" ) { + + // Capture the context ID, setting it first if necessary + if ( (nid = context.getAttribute( "id" )) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", (nid = expando) ); + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[i] = "#" + nid + " " + toSelector( groups[i] ); + } + newSelector = groups.join( "," ); + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + } + + if ( newSelector ) { + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return (cache[ key + " " ] = value); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement("fieldset"); + + try { + return !!fn( el ); + } catch (e) { + return false; + } finally { + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split("|"), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[i] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( (cur = cur.nextSibling) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + // Known :disabled false positives: + // IE: *[disabled]:not(button, input, select, textarea, optgroup, option, menuitem, fieldset) + // not IE: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Check form elements and option elements for explicit disabling + return "label" in elem && elem.disabled === disabled || + "form" in elem && elem.disabled === disabled || + + // Check non-disabled form elements for fieldset[disabled] ancestors + "form" in elem && elem.disabled === false && ( + // Support: IE6-11+ + // Ancestry is covered for us + elem.isDisabled === disabled || + + // Otherwise, assume any non-