Safe Haskell	None
Language	Haskell2010

Distribution.FieldGrammar

Contents

Field grammar type
Concrete grammar implementations
Auxlilary

Description

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

Synopsis

class FieldGrammar g where
uniqueField :: (FieldGrammar g, Parsec a, Pretty a) => FieldName -> ALens' s a -> g s a
optionalField :: (FieldGrammar g, Parsec a, Pretty a) => FieldName -> ALens' s (Maybe a) -> g s (Maybe a)
optionalFieldDef :: (FieldGrammar g, Functor (g s), Parsec a, Pretty a, Eq a, Show a) => FieldName -> LensLike' (Pretext (Maybe a) (Maybe a)) s a -> a -> g s a
optionalFieldDefAla :: (FieldGrammar g, Functor (g s), Parsec b, Pretty b, Newtype b a, Eq a, Show a) => FieldName -> (a -> b) -> LensLike' (Pretext (Maybe a) (Maybe a)) s a -> a -> g s a
monoidalField :: (FieldGrammar g, Parsec a, Pretty a, Monoid a) => FieldName -> ALens' s a -> g s a
deprecatedField' :: FieldGrammar g => String -> g s a -> g s a
data ParsecFieldGrammar s a
type ParsecFieldGrammar' a = ParsecFieldGrammar a a
parseFieldGrammar :: Fields Position -> ParsecFieldGrammar s a -> ParseResult a
fieldGrammarKnownFieldList :: ParsecFieldGrammar s a -> [FieldName]
data PrettyFieldGrammar s a
type PrettyFieldGrammar' a = PrettyFieldGrammar a a
prettyFieldGrammar :: PrettyFieldGrammar s a -> s -> Doc
(^^^) :: a -> (a -> b) -> b
data Section ann = MkSection !(Name ann) [SectionArg ann] [Field ann]
type Fields ann = Map FieldName [NamelessField ann]
partitionFields :: [Field ann] -> (Fields ann, [[Section ann]])
takeFields :: [Field ann] -> (Fields ann, [Field ann])
runFieldParser :: Position -> FieldParser a -> [FieldLine Position] -> ParseResult a
runFieldParser' :: Position -> FieldParser a -> String -> ParseResult a

Field grammar type

class FieldGrammar g where Source #

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

Methods

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

Unfocus, zoom out, blur FieldGrammar.

uniqueFieldAla Source #

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 Source #

Arguments

:: FieldName	field name
-> ALens' s Bool	lens into the field
-> Bool	default
-> g s Bool

Boolean field with a default value.

optionalFieldAla Source #

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.

monoidalFieldAla Source #

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 Source #

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 () Source #

Known field, which we don't parse, neither pretty print.

hiddenField :: g s a -> g s a Source #

Field which is parsed but not pretty printed.

deprecatedSince Source #

Arguments

:: [Int]	version
-> String	deprecation message
-> g s a
-> g s a

Deprecated since

availableSince Source #

Arguments

:: [Int]	spec version
-> g s a
-> g s a

Annotate field with since spec-version.

Instances

FieldGrammar PrettyFieldGrammar #
Instance details Methods blurFieldGrammar :: ALens' a b -> PrettyFieldGrammar b c -> PrettyFieldGrammar a c Source # uniqueFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a Source # booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> PrettyFieldGrammar s Bool Source # optionalFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> PrettyFieldGrammar s (Maybe a) Source # monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a Source # prefixedFields :: FieldName -> ALens' s [(String, String)] -> PrettyFieldGrammar s [(String, String)] Source # knownField :: FieldName -> PrettyFieldGrammar s () Source # hiddenField :: PrettyFieldGrammar s a -> PrettyFieldGrammar s a Source # deprecatedSince :: [Int] -> String -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a Source # availableSince :: [Int] -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a Source #
FieldGrammar ParsecFieldGrammar #
Instance details Methods blurFieldGrammar :: ALens' a b -> ParsecFieldGrammar b c -> ParsecFieldGrammar a c Source # uniqueFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> ParsecFieldGrammar s a Source # booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> ParsecFieldGrammar s Bool Source # optionalFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> ParsecFieldGrammar s (Maybe a) Source # monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> ParsecFieldGrammar s a Source # prefixedFields :: FieldName -> ALens' s [(String, String)] -> ParsecFieldGrammar s [(String, String)] Source # knownField :: FieldName -> ParsecFieldGrammar s () Source # hiddenField :: ParsecFieldGrammar s a -> ParsecFieldGrammar s a Source # deprecatedSince :: [Int] -> String -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a Source # availableSince :: [Int] -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a Source #

uniqueField Source #

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 Source #

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 Source #

Arguments

:: (FieldGrammar g, Functor (g s), Parsec a, Pretty a, Eq a, Show a)
=> FieldName	field name
-> LensLike' (Pretext (Maybe a) (Maybe a)) s a	`Lens' s a`: lens into the field
-> a	default value
-> g s a

Optional field with default value.

optionalFieldDefAla Source #

Arguments

:: (FieldGrammar g, Functor (g s), Parsec b, Pretty b, Newtype b a, Eq a, Show a)
=> FieldName	field name
-> (a -> b)	`Newtype` pack
-> LensLike' (Pretext (Maybe a) (Maybe a)) s a	`Lens' s a`: lens into the field
-> a	default value
-> g s a

Optional field with default value.

monoidalField Source #

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' Source #

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!

Concrete grammar implementations

data ParsecFieldGrammar s a Source #

Instances

FieldGrammar ParsecFieldGrammar #
Instance details Methods blurFieldGrammar :: ALens' a b -> ParsecFieldGrammar b c -> ParsecFieldGrammar a c Source # uniqueFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> ParsecFieldGrammar s a Source # booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> ParsecFieldGrammar s Bool Source # optionalFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> ParsecFieldGrammar s (Maybe a) Source # monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> ParsecFieldGrammar s a Source # prefixedFields :: FieldName -> ALens' s [(String, String)] -> ParsecFieldGrammar s [(String, String)] Source # knownField :: FieldName -> ParsecFieldGrammar s () Source # hiddenField :: ParsecFieldGrammar s a -> ParsecFieldGrammar s a Source # deprecatedSince :: [Int] -> String -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a Source # availableSince :: [Int] -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a Source #
Functor (ParsecFieldGrammar s) #
Instance details Methods fmap :: (a -> b) -> ParsecFieldGrammar s a -> ParsecFieldGrammar s b Source # (<$) :: a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s a Source #
Applicative (ParsecFieldGrammar s) #
Instance details Methods pure :: a -> ParsecFieldGrammar s a Source # (<>) :: ParsecFieldGrammar s (a -> b) -> ParsecFieldGrammar s a -> ParsecFieldGrammar s b Source # liftA2 :: (a -> b -> c) -> ParsecFieldGrammar s a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s c Source # (>) :: ParsecFieldGrammar s a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s b Source # (<*) :: ParsecFieldGrammar s a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s a Source #

type ParsecFieldGrammar' a = ParsecFieldGrammar a a Source #

parseFieldGrammar :: Fields Position -> ParsecFieldGrammar s a -> ParseResult a Source #

fieldGrammarKnownFieldList :: ParsecFieldGrammar s a -> [FieldName] Source #

data PrettyFieldGrammar s a Source #

Instances

FieldGrammar PrettyFieldGrammar #
Instance details Methods blurFieldGrammar :: ALens' a b -> PrettyFieldGrammar b c -> PrettyFieldGrammar a c Source # uniqueFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a Source # booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> PrettyFieldGrammar s Bool Source # optionalFieldAla :: (Parsec b, Pretty b, Newtype b a) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> PrettyFieldGrammar s (Maybe a) Source # monoidalFieldAla :: (Parsec b, Pretty b, Monoid a, Newtype b a) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a Source # prefixedFields :: FieldName -> ALens' s [(String, String)] -> PrettyFieldGrammar s [(String, String)] Source # knownField :: FieldName -> PrettyFieldGrammar s () Source # hiddenField :: PrettyFieldGrammar s a -> PrettyFieldGrammar s a Source # deprecatedSince :: [Int] -> String -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a Source # availableSince :: [Int] -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a Source #
Functor (PrettyFieldGrammar s) #
Instance details Methods fmap :: (a -> b) -> PrettyFieldGrammar s a -> PrettyFieldGrammar s b Source # (<$) :: a -> PrettyFieldGrammar s b -> PrettyFieldGrammar s a Source #
Applicative (PrettyFieldGrammar s) #
Instance details Methods pure :: a -> PrettyFieldGrammar s a Source # (<>) :: PrettyFieldGrammar s (a -> b) -> PrettyFieldGrammar s a -> PrettyFieldGrammar s b Source # liftA2 :: (a -> b -> c) -> PrettyFieldGrammar s a -> PrettyFieldGrammar s b -> PrettyFieldGrammar s c Source # (>) :: PrettyFieldGrammar s a -> PrettyFieldGrammar s b -> PrettyFieldGrammar s b Source # (<*) :: PrettyFieldGrammar s a -> PrettyFieldGrammar s b -> PrettyFieldGrammar s a Source #

type PrettyFieldGrammar' a = PrettyFieldGrammar a a Source #

prettyFieldGrammar :: PrettyFieldGrammar s a -> s -> Doc Source #

We can use PrettyFieldGrammar to pp print the s.

Auxlilary

(^^^) :: a -> (a -> b) -> b infixl 5 Source #

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

data Section ann Source #

The Section constructor of Field.

Constructors

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

Instances

Functor Section #
Instance details Methods fmap :: (a -> b) -> Section a -> Section b Source # (<$) :: a -> Section b -> Section a Source #
Eq ann => Eq (Section ann) #
Instance details Methods (==) :: Section ann -> Section ann -> Bool # (/=) :: Section ann -> Section ann -> Bool #
Show ann => Show (Section ann) #
Instance details Methods showsPrec :: Int -> Section ann -> ShowS Source # show :: Section ann -> String Source # showList :: [Section ann] -> ShowS Source #

type Fields ann = Map FieldName [NamelessField ann] Source #

partitionFields :: [Field ann] -> (Fields ann, [[Section ann]]) Source #

Partition field list into field map and groups of sections.

takeFields :: [Field ann] -> (Fields ann, [Field ann]) Source #

Take all fields from the front.

runFieldParser :: Position -> FieldParser a -> [FieldLine Position] -> ParseResult a Source #

runFieldParser' :: Position -> FieldParser a -> String -> ParseResult a Source #