Distribution.FieldGrammar.Class

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.