Distribution.PackageDescription.FieldGrammar

GenericPackageDescription Field descriptions

Package description

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

Library

libraryFieldGrammar :: (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

foreignLibFieldGrammar :: (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

executableFieldGrammar :: (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

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

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

Instances

HasBuildInfo TestSuiteStanza

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]

hsc2hsOptions :: 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 [SymbolicPath PackageDir SourceDir]

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]

extraLibsStatic :: Lens' TestSuiteStanza [String]

extraGHCiLibs :: Lens' TestSuiteStanza [String]

extraBundledLibs :: Lens' TestSuiteStanza [String]

extraLibFlavours :: Lens' TestSuiteStanza [String]

extraDynLibFlavours :: Lens' TestSuiteStanza [String]

extraLibDirs :: Lens' TestSuiteStanza [String]

extraLibDirsStatic :: Lens' TestSuiteStanza [String]

includeDirs :: Lens' TestSuiteStanza [FilePath]

includes :: Lens' TestSuiteStanza [FilePath]

autogenIncludes :: Lens' TestSuiteStanza [FilePath]

installIncludes :: Lens' TestSuiteStanza [FilePath]

options :: Lens' TestSuiteStanza (PerCompilerFlavor [String])

profOptions :: Lens' TestSuiteStanza (PerCompilerFlavor [String])

sharedOptions :: Lens' TestSuiteStanza (PerCompilerFlavor [String])

staticOptions :: Lens' TestSuiteStanza (PerCompilerFlavor [String])

customFieldsBI :: Lens' TestSuiteStanza [(String, String)]

targetBuildDepends :: Lens' TestSuiteStanza [Dependency]

mixins :: Lens' TestSuiteStanza [Mixin]

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

validateTestSuite :: CabalSpecVersion -> 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

• _benchmarkStanzaBenchmarkType :: Maybe BenchmarkType
• _benchmarkStanzaMainIs :: Maybe FilePath
• _benchmarkStanzaBenchmarkModule :: Maybe ModuleName
• _benchmarkStanzaBuildInfo :: BuildInfo

Instances

HasBuildInfo BenchmarkStanza

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]

hsc2hsOptions :: 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 [SymbolicPath PackageDir SourceDir]

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]

extraLibsStatic :: Lens' BenchmarkStanza [String]

extraGHCiLibs :: Lens' BenchmarkStanza [String]

extraBundledLibs :: Lens' BenchmarkStanza [String]

extraLibFlavours :: Lens' BenchmarkStanza [String]

extraDynLibFlavours :: Lens' BenchmarkStanza [String]

extraLibDirs :: Lens' BenchmarkStanza [String]

extraLibDirsStatic :: Lens' BenchmarkStanza [String]

includeDirs :: Lens' BenchmarkStanza [FilePath]

includes :: Lens' BenchmarkStanza [FilePath]

autogenIncludes :: Lens' BenchmarkStanza [FilePath]

installIncludes :: Lens' BenchmarkStanza [FilePath]

options :: Lens' BenchmarkStanza (PerCompilerFlavor [String])

profOptions :: Lens' BenchmarkStanza (PerCompilerFlavor [String])

sharedOptions :: Lens' BenchmarkStanza (PerCompilerFlavor [String])

staticOptions :: Lens' BenchmarkStanza (PerCompilerFlavor [String])

customFieldsBI :: Lens' BenchmarkStanza [(String, String)]

targetBuildDepends :: Lens' BenchmarkStanza [Dependency]

mixins :: Lens' BenchmarkStanza [Mixin]

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

validateBenchmark :: CabalSpecVersion -> Position -> BenchmarkStanza -> ParseResult Benchmark

unvalidateBenchmark :: Benchmark -> BenchmarkStanza

Field grammars

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

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

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

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

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

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

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

Lenses

benchmarkStanzaBenchmarkType :: Lens' BenchmarkStanza (Maybe BenchmarkType)

benchmarkStanzaMainIs :: Lens' BenchmarkStanza (Maybe FilePath)

benchmarkStanzaBenchmarkModule :: Lens' BenchmarkStanza (Maybe ModuleName)

benchmarkStanzaBuildInfo :: Lens' BenchmarkStanza BuildInfo

Flag

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

Source repository

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

Setup build info

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

Component build info

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