Distribution.FieldGrammar.Parsec

This module provides a FieldGrammarParser, one way to parse .cabal -like files.

Fields can be specified multiple times in the .cabal files. The order of such entries is important, but the mutual ordering of different fields is not.Also conditional sections are considered after non-conditional data. The example of this silent-commutation quirk is the fact that

buildable: True
if os(linux)
  buildable: False

and

if os(linux)
  buildable: False
buildable: True

behave the same! This is the limitation of GeneralPackageDescription structure.

So we transform the list of fields [Field ann] into a map of grouped ordinary fields and a list of lists of sections: Fields ann = Map FieldName [NamelessField ann] and [[Section ann]].

We need list of list of sections, because we need to distinguish situations where there are fields in between. For example

if flag(bytestring-lt-0_10_4)
  build-depends: bytestring < 0.10.4

default-language: Haskell2020

else
  build-depends: bytestring >= 0.10.4

is obviously invalid specification.

We can parse Fields like we parse aeson objects, yet we use slightly higher-level API, so we can process unspecified fields, to report unknown fields and save custom x-fields.

Documentation

data ParsecFieldGrammar s a

Instances

FieldGrammar ParsecFieldGrammar

Defined in Distribution.FieldGrammar.Parsec

Methods

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

uniqueFieldAla :: (Parsec b, Pretty 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, Pretty b, Newtype a b) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> ParsecFieldGrammar s (Maybe a)

optionalFieldDefAla :: (Parsec b, Pretty 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, Pretty 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

Functor (ParsecFieldGrammar s)

Defined in Distribution.FieldGrammar.Parsec

Methods

fmap :: (a -> b) -> ParsecFieldGrammar s a -> ParsecFieldGrammar s b

(<$) :: a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s a

Applicative (ParsecFieldGrammar s)

Defined in Distribution.FieldGrammar.Parsec

Methods

pure :: a -> ParsecFieldGrammar s a

(<*>) :: ParsecFieldGrammar s (a -> b) -> ParsecFieldGrammar s a -> ParsecFieldGrammar s b

liftA2 :: (a -> b -> c) -> ParsecFieldGrammar s a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s c

(*>) :: ParsecFieldGrammar s a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s b

(<*) :: ParsecFieldGrammar s a -> ParsecFieldGrammar s b -> ParsecFieldGrammar s a

parseFieldGrammar :: CabalSpecVersion -> Fields Position -> ParsecFieldGrammar s a -> ParseResult a

fieldGrammarKnownFieldList :: ParsecFieldGrammar s a -> [FieldName]

Auxiliary

type Fields ann = Map FieldName [NamelessField ann]

data NamelessField ann

Single field, without name, but with its annotation.

Constructors

MkNamelessField !ann [FieldLine ann]

Instances

Functor NamelessField

Defined in Distribution.FieldGrammar.Parsec

Methods

fmap :: (a -> b) -> NamelessField a -> NamelessField b

(<$) :: a -> NamelessField b -> NamelessField a

Eq ann => Eq (NamelessField ann)

Defined in Distribution.FieldGrammar.Parsec

Methods

(==) :: NamelessField ann -> NamelessField ann -> Bool

(/=) :: NamelessField ann -> NamelessField ann -> Bool

Show ann => Show (NamelessField ann)

Defined in Distribution.FieldGrammar.Parsec

Methods

showsPrec :: Int -> NamelessField ann -> ShowS

show :: NamelessField ann -> String

showList :: [NamelessField ann] -> ShowS

namelessFieldAnn :: NamelessField ann -> ann

data Section ann

The Section constructor of Field.

Constructors

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

Instances

Functor Section

Defined in Distribution.FieldGrammar.Parsec

Methods

fmap :: (a -> b) -> Section a -> Section b

(<$) :: a -> Section b -> Section a

Eq ann => Eq (Section ann)

Defined in Distribution.FieldGrammar.Parsec

Methods

(==) :: Section ann -> Section ann -> Bool

(/=) :: Section ann -> Section ann -> Bool

Show ann => Show (Section ann)

Defined in Distribution.FieldGrammar.Parsec

Methods

showsPrec :: Int -> Section ann -> ShowS

show :: Section ann -> String

showList :: [Section ann] -> ShowS

runFieldParser :: Position -> ParsecParser a -> CabalSpecVersion -> [FieldLine Position] -> ParseResult a

runFieldParser' :: [Position] -> ParsecParser a -> CabalSpecVersion -> FieldLineStream -> ParseResult a

fieldLinesToStream :: [FieldLine ann] -> FieldLineStream