ModuleCabal-syntax-3.12.1.0Haskell2010

Distribution.PackageDescription.FieldGrammar

GenericPackageDescription Field descriptions

4 types
29 values

PackageCabal-syntax-3.12.1.0
Exports33
LanguageHaskell2010
LicenceBSD-3-Clause
SourceFieldGrammar.hs

Package description

3 declarations

value

packageDescriptionFieldGrammar :: (FieldGrammar c g, Applicative (g PackageDescription), Applicative (g PackageIdentifier), c (Identity BuildType), c (Identity PackageName), c (Identity Version), c (List FSep FilePathNT String), c (List FSep CompatFilePath String), c (List FSep (Identity (SymbolicPath PackageDir LicenseFile)) (SymbolicPath PackageDir LicenseFile)), c (List FSep TestedWith (CompilerFlavor, VersionRange)), c (List VCat FilePathNT String), c FilePathNT, c CompatLicenseFile, c CompatFilePath, c SpecLicense, c SpecVersion) => g PackageDescription PackageDescription

newtypenewtype CompatFilePath

Compat FilePath accepts empty file path, but issues a warning.

There are simply too many (~1200) package definition files

license-file: ""

and

data-dir: ""

across Hackage to outrule them completely. I suspect some of them are generated (e.g. formatted) by machine.

Constructors

CompatFilePath
- getCompatFilePath :: FilePath

Instances3Parsec, Pretty, Newtype

Parsec CompatFilePathDefined in Cabal-syntax-3.12.1.0 · Distribution.PackageDescription.FieldGrammar
Pretty CompatFilePathDefined in Cabal-syntax-3.12.1.0 · Distribution.PackageDescription.FieldGrammar
Newtype String CompatFilePathDefined in Cabal-syntax-3.12.1.0 · Distribution.PackageDescription.FieldGrammar

newtypenewtype CompatLicenseFile

Constructors

CompatLicenseFile
- getCompatLicenseFile :: [SymbolicPath PackageDir LicenseFile]

Instances3Parsec, Pretty, Newtype

Parsec CompatLicenseFileDefined in Cabal-syntax-3.12.1.0 · Distribution.PackageDescription.FieldGrammar
Pretty CompatLicenseFileDefined in Cabal-syntax-3.12.1.0 · Distribution.PackageDescription.FieldGrammar
Newtype [SymbolicPath PackageDir LicenseFile] CompatLicenseFileDefined in Cabal-syntax-3.12.1.0 · Distribution.PackageDescription.FieldGrammar

Library

1 declaration

valuelibraryFieldGrammar

:: (FieldGrammar c g, Applicative (g Library), Applicative (g BuildInfo), c (Identity LibraryVisibility), c (List CommaFSep (Identity ExeDependency) ExeDependency), c (List CommaFSep (Identity LegacyExeDependency) LegacyExeDependency), c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency), c (List CommaVCat (Identity Dependency) Dependency), c (List CommaVCat (Identity Mixin) Mixin), c (List CommaVCat (Identity ModuleReexport) ModuleReexport), c (List FSep (MQuoted Extension) Extension), c (List FSep (MQuoted Language) Language), c (List FSep FilePathNT String), c (List FSep Token String), c (List NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List VCat FilePathNT String), c (List FSep (Identity (SymbolicPath PackageDir SourceDir)) (SymbolicPath PackageDir SourceDir)), c (List VCat Token String), c (MQuoted Language))
=> LibraryName
-> g Library Library

Foreign library

1 declaration

valueforeignLibFieldGrammar

:: (FieldGrammar c g, Applicative (g ForeignLib), Applicative (g BuildInfo), c (Identity ForeignLibType), c (Identity LibVersionInfo), c (Identity Version), c (List CommaFSep (Identity ExeDependency) ExeDependency), c (List CommaFSep (Identity LegacyExeDependency) LegacyExeDependency), c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency), c (List CommaVCat (Identity Dependency) Dependency), c (List CommaVCat (Identity Mixin) Mixin), c (List FSep (Identity ForeignLibOption) ForeignLibOption), c (List FSep (MQuoted Extension) Extension), c (List FSep (MQuoted Language) Language), c (List FSep FilePathNT String), c (List FSep Token String), c (List FSep (Identity (SymbolicPath PackageDir SourceDir)) (SymbolicPath PackageDir SourceDir)), c (List NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List VCat FilePathNT String), c (List VCat Token String), c (MQuoted Language))
=> UnqualComponentName
-> g ForeignLib ForeignLib

Executable

1 declaration

valueexecutableFieldGrammar

:: (FieldGrammar c g, Applicative (g Executable), Applicative (g BuildInfo), c (Identity ExecutableScope), c (List CommaFSep (Identity ExeDependency) ExeDependency), c (List CommaFSep (Identity LegacyExeDependency) LegacyExeDependency), c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency), c (List CommaVCat (Identity Dependency) Dependency), c (List CommaVCat (Identity Mixin) Mixin), c (List FSep (MQuoted Extension) Extension), c (List FSep (MQuoted Language) Language), c (List FSep FilePathNT String), c (List FSep Token String), c (List FSep (Identity (SymbolicPath PackageDir SourceDir)) (SymbolicPath PackageDir SourceDir)), c (List NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List VCat FilePathNT String), c (List VCat Token String), c (MQuoted Language))
=> UnqualComponentName
-> g Executable Executable

Test suite

4 declarations

datadata TestSuiteStanza

An intermediate type just used for parsing the test-suite stanza. After validation it is converted into the proper TestSuite type.

Constructors

TestSuiteStanza
- _testStanzaTestType :: Maybe TestType
- _testStanzaMainIs :: Maybe FilePath
- _testStanzaTestModule :: Maybe ModuleName
- _testStanzaBuildInfo :: BuildInfo
- _testStanzaCodeGenerators :: [String]

Instances2HasBuildInfo, FromBuildInfo

HasBuildInfo TestSuiteStanzaDefined in Cabal-syntax-3.12.1.0 · Distribution.PackageDescription.FieldGrammar
FromBuildInfo TestSuiteStanzaDefined in Cabal-syntax-3.12.1.0 · Distribution.PackageDescription.Parsec

value

testSuiteFieldGrammar :: (FieldGrammar c g, Applicative (g TestSuiteStanza), Applicative (g BuildInfo), c (Identity ModuleName), c (Identity TestType), c (List CommaFSep (Identity ExeDependency) ExeDependency), c (List CommaFSep (Identity LegacyExeDependency) LegacyExeDependency), c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency), c (List CommaFSep Token String), c (List CommaVCat (Identity Dependency) Dependency), c (List CommaVCat (Identity Mixin) Mixin), c (List FSep (MQuoted Extension) Extension), c (List FSep (MQuoted Language) Language), c (List FSep FilePathNT String), c (List FSep Token String), c (List NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List VCat FilePathNT String), c (List FSep (Identity (SymbolicPath PackageDir SourceDir)) (SymbolicPath PackageDir SourceDir)), c (List VCat Token String), c (MQuoted Language)) => g TestSuiteStanza TestSuiteStanza

valuevalidateTestSuite

valueunvalidateTestSuite :: TestSuite -> TestSuiteStanza

Lenses

valuetestStanzaTestType :: Lens' TestSuiteStanza (Maybe TestType)

valuetestStanzaMainIs :: Lens' TestSuiteStanza (Maybe FilePath)

valuetestStanzaTestModule :: Lens' TestSuiteStanza (Maybe ModuleName)

valuetestStanzaBuildInfo :: Lens' TestSuiteStanza BuildInfo

Benchmark

4 declarations

datadata BenchmarkStanza

An intermediate type just used for parsing the benchmark stanza. After validation it is converted into the proper Benchmark type.

Constructors

BenchmarkStanza
- _benchmarkStanzaBenchmarkType :: Maybe BenchmarkType
- _benchmarkStanzaMainIs :: Maybe FilePath
- _benchmarkStanzaBenchmarkModule :: Maybe ModuleName
- _benchmarkStanzaBuildInfo :: BuildInfo

Instances2HasBuildInfo, FromBuildInfo

HasBuildInfo BenchmarkStanzaDefined in Cabal-syntax-3.12.1.0 · Distribution.PackageDescription.FieldGrammar
FromBuildInfo BenchmarkStanzaDefined in Cabal-syntax-3.12.1.0 · Distribution.PackageDescription.Parsec

value

benchmarkFieldGrammar :: (FieldGrammar c g, Applicative (g BenchmarkStanza), Applicative (g BuildInfo), c (Identity BenchmarkType), c (Identity ModuleName), c (List CommaFSep (Identity ExeDependency) ExeDependency), c (List CommaFSep (Identity LegacyExeDependency) LegacyExeDependency), c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency), c (List CommaVCat (Identity Dependency) Dependency), c (List CommaVCat (Identity Mixin) Mixin), c (List FSep (MQuoted Extension) Extension), c (List FSep (MQuoted Language) Language), c (List FSep FilePathNT String), c (List FSep Token String), c (List NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List VCat FilePathNT String), c (List FSep (Identity (SymbolicPath PackageDir SourceDir)) (SymbolicPath PackageDir SourceDir)), c (List VCat Token String), c (MQuoted Language)) => g BenchmarkStanza BenchmarkStanza

valuevalidateBenchmark

valueunvalidateBenchmark :: Benchmark -> BenchmarkStanza

Field grammars

7 declarations

valueformatDependencyList

:: [Dependency]
-> List CommaVCat (Identity Dependency) Dependency

valueformatExposedModules

:: [ModuleName]
-> List VCat (MQuoted ModuleName) ModuleName

valueformatExtraSourceFiles :: [FilePath] -> List VCat FilePathNT FilePath

valueformatHsSourceDirs

:: [SymbolicPath PackageDir SourceDir]
-> List FSep (Identity (SymbolicPath PackageDir SourceDir)) (SymbolicPath PackageDir SourceDir)

valueformatMixinList :: [Mixin] -> List CommaVCat (Identity Mixin) Mixin

valueformatOtherExtensions

:: [Extension]
-> List FSep (MQuoted Extension) Extension

valueformatOtherModules

:: [ModuleName]
-> List VCat (MQuoted ModuleName) ModuleName

Lenses

valuebenchmarkStanzaBenchmarkType :: Lens' BenchmarkStanza (Maybe BenchmarkType)

valuebenchmarkStanzaMainIs :: Lens' BenchmarkStanza (Maybe FilePath)

valuebenchmarkStanzaBenchmarkModule :: Lens' BenchmarkStanza (Maybe ModuleName)

valuebenchmarkStanzaBuildInfo :: Lens' BenchmarkStanza BuildInfo

Flag

1 declaration

valueflagFieldGrammar

:: (FieldGrammar c g, Applicative (g PackageFlag))
=> FlagName
-> g PackageFlag PackageFlag

Source repository

1 declaration

valuesourceRepoFieldGrammar

:: (FieldGrammar c g, Applicative (g SourceRepo), c (Identity RepoType), c Token, c FilePathNT)
=> RepoKind
-> g SourceRepo SourceRepo

Setup build info

1 declaration

valuesetupBInfoFieldGrammar

:: (FieldGrammar c g, Functor (g SetupBuildInfo), c (List CommaVCat (Identity Dependency) Dependency))
=> Bool
-> g SetupBuildInfo SetupBuildInfo

Component build info

1 declaration

value

buildInfoFieldGrammar :: (FieldGrammar c g, Applicative (g BuildInfo), c (List CommaFSep (Identity ExeDependency) ExeDependency), c (List CommaFSep (Identity LegacyExeDependency) LegacyExeDependency), c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency), c (List CommaVCat (Identity Dependency) Dependency), c (List CommaVCat (Identity Mixin) Mixin), c (List FSep (MQuoted Extension) Extension), c (List FSep (MQuoted Language) Language), c (List FSep FilePathNT String), c (List FSep Token String), c (List NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List VCat FilePathNT String), c (List FSep (Identity (SymbolicPath PackageDir SourceDir)) (SymbolicPath PackageDir SourceDir)), c (List VCat Token String), c (MQuoted Language)) => g BuildInfo BuildInfo