Distribution.FieldGrammar.Class

Documentation

class FieldGrammar g 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, monoidalFieldAla, prefixedFields, knownField, hiddenField, deprecatedSince, availableSince

Methods

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

Unfocus, zoom out, blur FieldGrammar.

uniqueFieldAla

Arguments

:: (Parsec b, Pretty b, Newtype b a)

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

:: (Parsec b, Pretty b, Newtype b a)

=> FieldName

field name

-> (a -> b)

pack

-> ALens' s (Maybe a)

lens into the field

-> g s (Maybe a)

Optional field.

optionalFieldDefAla

Arguments

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

monoidalFieldAla

Arguments

:: (Parsec b, Pretty b, Monoid a, Newtype b a)

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

hiddenField :: g s a -> g s a

Field which is parsed but not pretty printed.

deprecatedSince

Arguments

:: [Int]

version

-> String

deprecation message

-> g s a

-> g s a

Deprecated since

availableSince

Arguments

:: [Int]

spec version

-> a

default value

-> g s a

-> g s a

Annotate field with since spec-version.

Instances

FieldGrammar PrettyFieldGrammar

Defined in Distribution.FieldGrammar.Pretty

Methods

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

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

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

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

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

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

availableSince :: [Int] -> a -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a

FieldGrammar ParsecFieldGrammar

Defined in Distribution.FieldGrammar.Parsec

Methods

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

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

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

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

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

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

availableSince :: [Int] -> a -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a

FieldGrammar FieldDescrs

Note: default values are printed.

Defined in Distribution.FieldGrammar.FieldDescrs

Methods

blurFieldGrammar :: ALens' a b -> FieldDescrs b c -> FieldDescrs a c

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

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

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

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

monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> FieldDescrs s a

prefixedFields :: FieldName -> ALens' s [(String, String)] -> FieldDescrs s [(String, String)]

knownField :: FieldName -> FieldDescrs s ()

hiddenField :: FieldDescrs s a -> FieldDescrs s a

deprecatedSince :: [Int] -> String -> FieldDescrs s a -> FieldDescrs s a

availableSince :: [Int] -> a -> FieldDescrs s a -> FieldDescrs s a

uniqueField

Arguments

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

deprecatedField'

Arguments

:: FieldGrammar g

=> String

deprecation message

-> g s a

-> g s a

Deprecated field. If found, warning is issued.

Note: also it's not pretty printed!