ModuleCabal-syntax-3.18.1.0Haskell2010

Distribution.PackageDescription.FieldGrammar

GenericPackageDescription Field descriptions

4 types
29 values

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

Package description

3 declarations

value

packageDescriptionFieldGrammar :: (FieldGrammar c g, c (Identity BuildType), c (Identity PackageName), c (Identity Version), c (List FSep (RelativePathNT Pkg 'File) (SymbolicPathX 'OnlyRelative Pkg 'File)), c (List VCat (RelativePathNT DataDir 'File) (RelativePath DataDir 'File)), c (List VCat (RelativePathNT Pkg 'File) (RelativePath Pkg 'File)), c (List FSep TestedWith (CompilerFlavor, VersionRange)), c CompatLicenseFile, c CompatDataDir) => g PackageDescription PackageDescription

newtypenewtype CompatDataDir

Newtype for data directory (absolute or relative).

Accepts empty file path, but issues a warning; there are simply too many (~1200) package definition files

data-dir: ""

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

Constructors

CompatDataDir
- getCompatDataDir :: SymbolicPath Pkg ('Dir DataDir)

Instances3Parsec, Pretty, Newtype

Parsec CompatDataDirDefined in Cabal-syntax-3.18.1.0 · Distribution.PackageDescription.FieldGrammar
Pretty CompatDataDirDefined in Cabal-syntax-3.18.1.0 · Distribution.PackageDescription.FieldGrammar
Newtype (SymbolicPath Pkg ('Dir DataDir)) CompatDataDirDefined in Cabal-syntax-3.18.1.0 · Distribution.PackageDescription.FieldGrammar

newtypenewtype CompatLicenseFile

Constructors

CompatLicenseFile
- getCompatLicenseFile :: [RelativePath Pkg 'File]

Instances3Parsec, Pretty, Newtype

Parsec CompatLicenseFileDefined in Cabal-syntax-3.18.1.0 · Distribution.PackageDescription.FieldGrammar
Pretty CompatLicenseFileDefined in Cabal-syntax-3.18.1.0 · Distribution.PackageDescription.FieldGrammar
Newtype [RelativePath Pkg 'File] CompatLicenseFileDefined in Cabal-syntax-3.18.1.0 · Distribution.PackageDescription.FieldGrammar

Library

1 declaration

valuelibraryFieldGrammar

:: (FieldGrammar c g, 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 NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List FSep (SymbolicPathNT Pkg ('Dir Framework)) (SymbolicPath Pkg ('Dir Framework))), c (List FSep (SymbolicPathNT Pkg ('Dir Lib)) (SymbolicPath Pkg ('Dir Lib))), c (List FSep (SymbolicPathNT Pkg ('Dir Source)) (SymbolicPath Pkg ('Dir Source))), c (List FSep (SymbolicPathNT Pkg ('Dir Include)) (SymbolicPath Pkg ('Dir Include))), c (List FSep (SymbolicPathNT Include 'File) (SymbolicPath Include 'File)), c (List FSep (RelativePathNT Framework 'File) (RelativePath Framework 'File)), c (List FSep (RelativePathNT Include 'File) (RelativePath Include 'File)), c (List VCat (SymbolicPathNT Pkg 'File) (SymbolicPath Pkg 'File)), c (List VCat Token String), c (MQuoted Language))
=> LibraryName
-> g Library Library

Foreign library

1 declaration

valueforeignLibFieldGrammar

:: (FieldGrammar c g, 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 (SymbolicPathNT Pkg ('Dir Framework)) (SymbolicPath Pkg ('Dir Framework))), c (List FSep (SymbolicPathNT Pkg ('Dir Lib)) (SymbolicPath Pkg ('Dir Lib))), c (List FSep (SymbolicPathNT Pkg ('Dir Source)) (SymbolicPath Pkg ('Dir Source))), c (List FSep (SymbolicPathNT Pkg ('Dir Include)) (SymbolicPath Pkg ('Dir Include))), c (List FSep (SymbolicPathNT Include 'File) (SymbolicPath Include 'File)), c (List FSep (RelativePathNT Framework 'File) (RelativePath Framework 'File)), c (List FSep (RelativePathNT Include 'File) (RelativePath Include 'File)), c (List FSep (RelativePathNT Source 'File) (RelativePath Source 'File)), c (List VCat (SymbolicPathNT Pkg 'File) (SymbolicPath Pkg 'File)), c (List NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List VCat Token String), c (MQuoted Language))
=> UnqualComponentName
-> g ForeignLib ForeignLib

Executable

1 declaration

valueexecutableFieldGrammar

:: (FieldGrammar c g, 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 (SymbolicPathNT Pkg ('Dir Framework)) (SymbolicPath Pkg ('Dir Framework))), c (List FSep (SymbolicPathNT Pkg ('Dir Lib)) (SymbolicPath Pkg ('Dir Lib))), c (List FSep (SymbolicPathNT Pkg ('Dir Source)) (SymbolicPath Pkg ('Dir Source))), c (List FSep (SymbolicPathNT Pkg ('Dir Include)) (SymbolicPath Pkg ('Dir Include))), c (List FSep (SymbolicPathNT Include 'File) (SymbolicPath Include 'File)), c (List FSep (RelativePathNT Framework 'File) (RelativePath Framework 'File)), c (List FSep (RelativePathNT Include 'File) (RelativePath Include 'File)), c (List VCat (SymbolicPathNT Pkg 'File) (SymbolicPath Pkg 'File)), c (RelativePathNT Source 'File), c (List NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), 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 (RelativePath Source 'File)
- _testStanzaTestModule :: Maybe ModuleName
- _testStanzaBuildInfo :: BuildInfo
- _testStanzaCodeGenerators :: [String]

Instances2HasBuildInfo, FromBuildInfo

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

value

testSuiteFieldGrammar :: (FieldGrammar c g, 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 NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List FSep (SymbolicPathNT Pkg ('Dir Framework)) (SymbolicPath Pkg ('Dir Framework))), c (List FSep (SymbolicPathNT Pkg ('Dir Lib)) (SymbolicPath Pkg ('Dir Lib))), c (List FSep (SymbolicPathNT Pkg ('Dir Source)) (SymbolicPath Pkg ('Dir Source))), c (List FSep (SymbolicPathNT Pkg ('Dir Include)) (SymbolicPath Pkg ('Dir Include))), c (List FSep (SymbolicPathNT Include 'File) (SymbolicPath Include 'File)), c (List FSep (RelativePathNT Framework 'File) (RelativePath Framework 'File)), c (List FSep (RelativePathNT Include 'File) (RelativePath Include 'File)), c (List VCat (SymbolicPathNT Pkg 'File) (SymbolicPath Pkg 'File)), c (RelativePathNT Source 'File), 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 (RelativePath Source 'File))

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 (RelativePath Source 'File)
- _benchmarkStanzaBenchmarkModule :: Maybe ModuleName
- _benchmarkStanzaBuildInfo :: BuildInfo

Instances2HasBuildInfo, FromBuildInfo

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

value

benchmarkFieldGrammar :: (FieldGrammar c g, 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 NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List FSep (SymbolicPathNT Pkg ('Dir Framework)) (SymbolicPath Pkg ('Dir Framework))), c (List FSep (SymbolicPathNT Pkg ('Dir Lib)) (SymbolicPath Pkg ('Dir Lib))), c (List FSep (SymbolicPathNT Pkg ('Dir Source)) (SymbolicPath Pkg ('Dir Source))), c (List FSep (SymbolicPathNT Pkg ('Dir Include)) (SymbolicPath Pkg ('Dir Include))), c (List FSep (SymbolicPathNT Include 'File) (SymbolicPath Include 'File)), c (List FSep (RelativePathNT Framework 'File) (RelativePath Framework 'File)), c (List FSep (RelativePathNT Include 'File) (RelativePath Include 'File)), c (List VCat (SymbolicPathNT Pkg 'File) (SymbolicPath Pkg 'File)), c (RelativePathNT Source 'File), 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

:: [RelativePath Pkg 'File]
-> List VCat (RelativePathNT Pkg 'File) (RelativePath Pkg 'File)

valueformatHsSourceDirs

:: [SymbolicPath Pkg ('Dir Source)]
-> List FSep (SymbolicPathNT Pkg ('Dir Source)) (SymbolicPath Pkg ('Dir Source))

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 (RelativePath Source 'File))

valuebenchmarkStanzaBenchmarkModule :: Lens' BenchmarkStanza (Maybe ModuleName)

valuebenchmarkStanzaBuildInfo :: Lens' BenchmarkStanza BuildInfo

Flag

1 declaration

valueflagFieldGrammar

Source repository

1 declaration

valuesourceRepoFieldGrammar

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

Setup build info

1 declaration

valuesetupBInfoFieldGrammar

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

Component build info

1 declaration

value

buildInfoFieldGrammar :: (FieldGrammar c g, 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 NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List FSep (SymbolicPathNT Pkg ('Dir Framework)) (SymbolicPath Pkg ('Dir Framework))), c (List FSep (SymbolicPathNT Pkg ('Dir Lib)) (SymbolicPath Pkg ('Dir Lib))), c (List FSep (SymbolicPathNT Pkg ('Dir Source)) (SymbolicPath Pkg ('Dir Source))), c (List FSep (SymbolicPathNT Pkg ('Dir Include)) (SymbolicPath Pkg ('Dir Include))), c (List FSep (SymbolicPathNT Include 'File) (SymbolicPath Include 'File)), c (List FSep (RelativePathNT Framework 'File) (RelativePath Framework 'File)), c (List FSep (RelativePathNT Include 'File) (RelativePath Include 'File)), c (List VCat (SymbolicPathNT Pkg 'File) (SymbolicPath Pkg 'File)), c (List VCat Token String), c (MQuoted Language)) => g BuildInfo BuildInfo