Distribution.FieldGrammar.Class

Documentation

class (c SpecVersion, c TestedWith, c SpecLicense, c Token, c Token', c FilePathNT) => FieldGrammar c g | g -> c 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, freeTextField, freeTextFieldDef, freeTextFieldDefST, monoidalFieldAla, prefixedFields, knownField, hiddenField, deprecatedSince, removedIn, availableSince

Methods

blurFieldGrammar :: ALens' a b -> g b d -> g a d

Unfocus, zoom out, blur FieldGrammar.

uniqueFieldAla

Arguments

:: (c b, Newtype a b)

=> 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

:: (c b, Newtype a b)

=> FieldName

field name

-> (a -> b)

pack

-> ALens' s (Maybe a)

lens into the field

-> g s (Maybe a)

Optional field.

optionalFieldDefAla

Arguments

:: (c b, Newtype a b, 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.

freeTextField

Arguments

:: FieldName

-> ALens' s (Maybe String)

lens into the field

-> g s (Maybe String)

freeTextFieldDef

Arguments

:: FieldName

-> ALens' s String

lens into the field

-> g s String

freeTextFieldDefST

Arguments

:: FieldName

-> ALens' s ShortText

lens into the field

-> g s ShortText

Since: 3.2.0.0

monoidalFieldAla

Arguments

:: (c b, Monoid a, Newtype a b)

=> 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, nor pretty print.

hiddenField :: g s a -> g s a

Field which is parsed but not pretty printed.

deprecatedSince

Arguments

:: CabalSpecVersion

version

-> String

deprecation message

-> g s a

-> g s a

Deprecated since

removedIn

Arguments

:: CabalSpecVersion

version

-> String

removal message

-> g s a

-> g s a

Removed in. If we encounter removed field, parsing fails.

availableSince

Arguments

:: CabalSpecVersion

spec version

-> a

default value

-> g s a

-> g s a

Annotate field with since spec-version.

availableSinceWarn

Arguments

:: CabalSpecVersion

spec version

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

Since: 3.4.0.0

Instances

FieldGrammar Pretty PrettyFieldGrammar

Defined in Distribution.FieldGrammar.Pretty

Methods

blurFieldGrammar :: ALens' a b -> PrettyFieldGrammar b d -> PrettyFieldGrammar a d

uniqueFieldAla :: (Pretty b, Newtype a b) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> PrettyFieldGrammar s Bool

optionalFieldAla :: (Pretty b, Newtype a b) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> PrettyFieldGrammar s (Maybe a)

optionalFieldDefAla :: (Pretty b, Newtype a b, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> PrettyFieldGrammar s a

freeTextField :: FieldName -> ALens' s (Maybe String) -> PrettyFieldGrammar s (Maybe String)

freeTextFieldDef :: FieldName -> ALens' s String -> PrettyFieldGrammar s String

freeTextFieldDefST :: FieldName -> ALens' s ShortText -> PrettyFieldGrammar s ShortText

monoidalFieldAla :: (Pretty b, Monoid a, Newtype a b) => 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 :: CabalSpecVersion -> String -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a

removedIn :: CabalSpecVersion -> String -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a

availableSince :: CabalSpecVersion -> a -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a

availableSinceWarn :: CabalSpecVersion -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a

FieldGrammar Parsec ParsecFieldGrammar

Defined in Distribution.FieldGrammar.Parsec

Methods

blurFieldGrammar :: ALens' a b -> ParsecFieldGrammar b d -> ParsecFieldGrammar a d

uniqueFieldAla :: (Parsec b, Newtype a b) => FieldName -> (a -> b) -> ALens' s a -> ParsecFieldGrammar s a

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> ParsecFieldGrammar s Bool

optionalFieldAla :: (Parsec b, Newtype a b) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> ParsecFieldGrammar s (Maybe a)

optionalFieldDefAla :: (Parsec b, Newtype a b, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> ParsecFieldGrammar s a

freeTextField :: FieldName -> ALens' s (Maybe String) -> ParsecFieldGrammar s (Maybe String)

freeTextFieldDef :: FieldName -> ALens' s String -> ParsecFieldGrammar s String

freeTextFieldDefST :: FieldName -> ALens' s ShortText -> ParsecFieldGrammar s ShortText

monoidalFieldAla :: (Parsec b, Monoid a, Newtype a b) => 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 :: CabalSpecVersion -> String -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a

removedIn :: CabalSpecVersion -> String -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a

availableSince :: CabalSpecVersion -> a -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a

availableSinceWarn :: CabalSpecVersion -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a

uniqueField

Arguments

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

optionalField

Arguments

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

optionalFieldDef

Arguments

:: (FieldGrammar c g, Functor (g s), 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.

monoidalField

Arguments

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

defaultFreeTextFieldDefST

Arguments

:: (Functor (g s), FieldGrammar c g)

=> FieldName

-> ALens' s ShortText

lens into the field

-> g s ShortText

Default implementation for freeTextFieldDefST.