ModuleCabal-syntax-3.18.1.0Haskell2010

Distribution.FieldGrammar

This module provides a way to specify a grammar of .cabal -like files.

6 types
1 class
14 values

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

Field grammar type

5 declarations

class

class (c SpecVersion, c TestedWith, c SpecLicense, c Token, c Token', c FilePathNT, forall s. Applicative (g s)) => FieldGrammar (c :: Type -> Constraint) (g :: Type -> Type -> Type) | g -> c where

g is parametrised by

s which is a structure we are parsing. We need this to provide prettyprinter functionality
a type of the field.

Methods

blurFieldGrammar :: ALens' a b -> g b d -> g a d
Unfocus, zoom out, blur FieldGrammar.
uniqueFieldAla :: (c b, Newtype a b) => FieldName -> (a -> b) -> ALens' s a -> g s a
Field which should be defined, exactly once.
booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> g s Bool
Boolean field with a default value.
optionalFieldAla :: (c b, Newtype a b) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> g s (Maybe a)
Optional field.
optionalFieldDefAla :: (c b, Newtype a b, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> g s a
Optional field with default value.
freeTextField :: FieldName -> ALens' s (Maybe String) -> g s (Maybe String)
freeTextFieldDef :: FieldName -> ALens' s String -> g s String
freeTextFieldDefST :: FieldName -> ALens' s ShortText -> g s ShortText
monoidalFieldAla :: (c b, Monoid a, Newtype a b) => FieldName -> (a -> b) -> ALens' s a -> g s a
Monoidal field.
Values are combined with mappend.
Note: optionalFieldAla is a monoidalField with Last monoid.
prefixedFields :: FieldName -> ALens' s [(String, String)] -> 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, nor pretty print.
hiddenField :: g s a -> g s a
Field which is parsed but not pretty printed.
deprecatedSince :: CabalSpecVersion -> String -> g s a -> g s a
Deprecated since
removedIn :: CabalSpecVersion -> String -> g s a -> g s a
Removed in. If we encounter removed field, parsing fails.
availableSince :: CabalSpecVersion -> a -> g s a -> g s a
Annotate field with since spec-version.
availableSinceWarn :: CabalSpecVersion -> g s a -> g s a
Annotate field with since spec-version. This is used to recognise, but warn about the field. It is used to process other-extensions field.
Default implementation is to not warn.

Instances3FieldGrammar

FieldGrammar ParsecPretty FieldDescrsDefined in Cabal-syntax-3.18.1.0 · Distribution.FieldGrammar.FieldDescrs
Note: default values are printed.
FieldGrammar Parsec ParsecFieldGrammarDefined in Cabal-syntax-3.18.1.0 · Distribution.FieldGrammar.Parsec
FieldGrammar Pretty PrettyFieldGrammarDefined in Cabal-syntax-3.18.1.0 · Distribution.FieldGrammar.Pretty

valueuniqueField

:: (FieldGrammar c g, c (Identity a))
=> FieldName
field name
-> ALens' s a
lens into the field
-> g s a

Field which can be defined at most once.

valueoptionalField

:: (FieldGrammar c g, c (Identity a))
=> FieldName
field name
-> ALens' s (Maybe a)
lens into the field
-> g s (Maybe a)

Field which can be defined at most once.

valueoptionalFieldDef

:: (FieldGrammar c g, c (Identity 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.

valuemonoidalField

:: (FieldGrammar c g, c (Identity 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.

Concrete grammar implementations

8 declarations

datadata ParsecFieldGrammar s a

Instances3FieldGrammar, Functor, Applicative

FieldGrammar Parsec ParsecFieldGrammarDefined in Cabal-syntax-3.18.1.0 · Distribution.FieldGrammar.Parsec
Functor (ParsecFieldGrammar s)Defined in Cabal-syntax-3.18.1.0 · Distribution.FieldGrammar.Parsec
Applicative (ParsecFieldGrammar s)Defined in Cabal-syntax-3.18.1.0 · Distribution.FieldGrammar.Parsec

typetype ParsecFieldGrammar' a = ParsecFieldGrammar a a

valueparseFieldGrammar

valueparseFieldGrammarCheckingStanzas

Parse a ParsecFieldGrammar and check for fields that should be stanzas.

valuefieldGrammarKnownFieldList :: ParsecFieldGrammar s a -> [FieldName]

newtypenewtype PrettyFieldGrammar s a

Instances3FieldGrammar, Functor, Applicative

FieldGrammar Pretty PrettyFieldGrammarDefined in Cabal-syntax-3.18.1.0 · Distribution.FieldGrammar.Pretty
Functor (PrettyFieldGrammar s)Defined in Cabal-syntax-3.18.1.0 · Distribution.FieldGrammar.Pretty
Applicative (PrettyFieldGrammar s)Defined in Cabal-syntax-3.18.1.0 · Distribution.FieldGrammar.Pretty

typetype PrettyFieldGrammar' a = PrettyFieldGrammar a a

valueprettyFieldGrammar

:: CabalSpecVersion
-> PrettyFieldGrammar s a
-> s
-> [PrettyField ()]

We can use PrettyFieldGrammar to pp print the s.

Note: there is not trailing ($+$ text "").

Auxiliary

8 declarations

value(^^^) :: a -> (a -> b) -> b

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."

datadata Section ann

The Section constructor of Field.

Constructors

MkSection !(Name ann) [SectionArg ann] [Field ann]

Instances3Functor, Eq, Show

Functor SectionDefined in Cabal-syntax-3.18.1.0 · Distribution.FieldGrammar.Parsec
Eq ann => Eq (Section ann)Defined in Cabal-syntax-3.18.1.0 · Distribution.FieldGrammar.Parsec
Show ann => Show (Section ann)Defined in Cabal-syntax-3.18.1.0 · Distribution.FieldGrammar.Parsec

typetype Fields ann = Map FieldName [NamelessField ann]

valuepartitionFields :: [Field ann] -> (Fields ann, [[Section ann]])

Partition field list into field map and groups of sections. Groups sections between fields. This means that the following snippet contains two section groups:

-- first group
some-section
    field: value
another-section
    field: value
foo: bar
-- second group
yet-another-section
    field: value

valuetakeFields :: [Field ann] -> (Fields ann, [Field ann])

Take all fields from the front.

valuerunFieldParser

valuerunFieldParser'

valuedefaultFreeTextFieldDefST

:: FieldGrammar c g
=> FieldName
-> ALens' s ShortText
lens into the field
-> g s ShortText

Default implementation for freeTextFieldDefST.

Newtypes

0 declarations

module Distribution.FieldGrammar.Newtypes