Safe Haskell	None
Language	Haskell2010

Distribution.Fields

Contents

Types
Grammar and parsing
Pretty printing
- Transformation from Field

Description

Utilities to work with .cabal like file structure.

Synopsis

data Field ann
- = Field !(Name ann) [FieldLine ann]
- | Section !(Name ann) [SectionArg ann] [Field ann]
data Name ann = Name !ann !FieldName
data FieldLine ann = FieldLine !ann !ByteString
data SectionArg ann
- = SecArgName !ann !ByteString
- | SecArgStr !ann !ByteString
- | SecArgOther !ann !ByteString
type FieldName = ByteString
readFields :: ByteString -> Either ParseError [Field Position]
readFields' :: ByteString -> Either ParseError ([Field Position], [LexWarning])
data ParseResult a
runParseResult :: ParseResult a -> ([PWarning], Either (Maybe Version, NonEmpty PError) a)
parseWarning :: Position -> PWarnType -> String -> ParseResult ()
parseWarnings :: [PWarning] -> ParseResult ()
parseFailure :: Position -> String -> ParseResult ()
parseFatalFailure :: Position -> String -> ParseResult a
data PWarnType
- = PWTOther
- | PWTUTF
- | PWTBoolCase
- | PWTVersionTag
- | PWTNewSyntax
- | PWTOldSyntax
- | PWTDeprecatedField
- | PWTInvalidSubsection
- | PWTUnknownField
- | PWTUnknownSection
- | PWTTrailingFields
- | PWTExtraMainIs
- | PWTExtraTestModule
- | PWTExtraBenchmarkModule
- | PWTLexNBSP
- | PWTLexBOM
- | PWTLexTab
- | PWTQuirkyCabalFile
- | PWTDoubleDash
- | PWTMultipleSingularField
- | PWTBuildTypeDefault
- | PWTVersionOperator
- | PWTVersionWildcard
- | PWTSpecVersion
- | PWTEmptyFilePath
- | PWTInconsistentIndentation
- | PWTExperimental
data PWarning = PWarning !PWarnType !Position String
showPWarning :: FilePath -> PWarning -> String
data PError = PError Position String
showPError :: FilePath -> PError -> String
data CommentPosition
- = CommentBefore [String]
- | CommentAfter [String]
- | NoComment
data PrettyField ann
- = PrettyField ann FieldName Doc
- | PrettySection ann FieldName [Doc] [PrettyField ann]
- | PrettyEmpty
showFields :: (ann -> CommentPosition) -> [PrettyField ann] -> String
genericFromParsecFields :: Applicative f => (FieldName -> [FieldLine ann] -> f Doc) -> (FieldName -> [SectionArg ann] -> f [Doc]) -> [Field ann] -> f [PrettyField ann]
fromParsecFields :: [Field ann] -> [PrettyField ann]

Types

data Field ann Source #

A Cabal-like file consists of a series of fields (foo: bar) and sections (library ...).

Constructors

Field !(Name ann) [FieldLine ann]
Section !(Name ann) [SectionArg ann] [Field ann]

Instances

Instances details

Foldable1 Field Source #	Since: Cabal-syntax-3.12.0.0
Instance details Defined in Distribution.Fields.Field Methods fold1 :: Semigroup m => Field m -> m Source # foldMap1 :: Semigroup m => (a -> m) -> Field a -> m Source # foldMap1' :: Semigroup m => (a -> m) -> Field a -> m Source # toNonEmpty :: Field a -> NonEmpty a Source # maximum :: Ord a => Field a -> a Source # minimum :: Ord a => Field a -> a Source # head :: Field a -> a Source # last :: Field a -> a Source # foldrMap1 :: (a -> b) -> (a -> b -> b) -> Field a -> b Source # foldlMap1' :: (a -> b) -> (b -> a -> b) -> Field a -> b Source # foldlMap1 :: (a -> b) -> (b -> a -> b) -> Field a -> b Source # foldrMap1' :: (a -> b) -> (a -> b -> b) -> Field a -> b Source #
Functor Field Source #
Instance details Defined in Distribution.Fields.Field Methods fmap :: (a -> b) -> Field a -> Field b # (<$) :: a -> Field b -> Field a #
Foldable Field Source #
Instance details Defined in Distribution.Fields.Field Methods fold :: Monoid m => Field m -> m # foldMap :: Monoid m => (a -> m) -> Field a -> m # foldMap' :: Monoid m => (a -> m) -> Field a -> m # foldr :: (a -> b -> b) -> b -> Field a -> b # foldr' :: (a -> b -> b) -> b -> Field a -> b # foldl :: (b -> a -> b) -> b -> Field a -> b # foldl' :: (b -> a -> b) -> b -> Field a -> b # foldr1 :: (a -> a -> a) -> Field a -> a # foldl1 :: (a -> a -> a) -> Field a -> a # toList :: Field a -> [a] # null :: Field a -> Bool # length :: Field a -> Int # elem :: Eq a => a -> Field a -> Bool # maximum :: Ord a => Field a -> a # minimum :: Ord a => Field a -> a # sum :: Num a => Field a -> a # product :: Num a => Field a -> a #
Traversable Field Source #
Instance details Defined in Distribution.Fields.Field Methods traverse :: Applicative f => (a -> f b) -> Field a -> f (Field b) # sequenceA :: Applicative f => Field (f a) -> f (Field a) # mapM :: Monad m => (a -> m b) -> Field a -> m (Field b) # sequence :: Monad m => Field (m a) -> m (Field a) #
Show ann => Show (Field ann) Source #
Instance details Defined in Distribution.Fields.Field Methods showsPrec :: Int -> Field ann -> ShowS # show :: Field ann -> String # showList :: [Field ann] -> ShowS #
Eq ann => Eq (Field ann) Source #
Instance details Defined in Distribution.Fields.Field Methods (==) :: Field ann -> Field ann -> Bool # (/=) :: Field ann -> Field ann -> Bool #
Ord ann => Ord (Field ann) Source #	Since: Cabal-syntax-3.12.0.0
Instance details Defined in Distribution.Fields.Field Methods compare :: Field ann -> Field ann -> Ordering # (<) :: Field ann -> Field ann -> Bool # (<=) :: Field ann -> Field ann -> Bool # (>) :: Field ann -> Field ann -> Bool # (>=) :: Field ann -> Field ann -> Bool # max :: Field ann -> Field ann -> Field ann # min :: Field ann -> Field ann -> Field ann #

data Name ann Source #

A field name.

Invariant: ByteString is lower-case ASCII.

Constructors

Name !ann !FieldName

Instances

Instances details

Foldable1 Name Source #	Since: Cabal-syntax-3.12.0.0
Instance details Defined in Distribution.Fields.Field Methods fold1 :: Semigroup m => Name m -> m Source # foldMap1 :: Semigroup m => (a -> m) -> Name a -> m Source # foldMap1' :: Semigroup m => (a -> m) -> Name a -> m Source # toNonEmpty :: Name a -> NonEmpty a Source # maximum :: Ord a => Name a -> a Source # minimum :: Ord a => Name a -> a Source # head :: Name a -> a Source # last :: Name a -> a Source # foldrMap1 :: (a -> b) -> (a -> b -> b) -> Name a -> b Source # foldlMap1' :: (a -> b) -> (b -> a -> b) -> Name a -> b Source # foldlMap1 :: (a -> b) -> (b -> a -> b) -> Name a -> b Source # foldrMap1' :: (a -> b) -> (a -> b -> b) -> Name a -> b Source #
Functor Name Source #
Instance details Defined in Distribution.Fields.Field Methods fmap :: (a -> b) -> Name a -> Name b # (<$) :: a -> Name b -> Name a #
Foldable Name Source #
Instance details Defined in Distribution.Fields.Field Methods fold :: Monoid m => Name m -> m # foldMap :: Monoid m => (a -> m) -> Name a -> m # foldMap' :: Monoid m => (a -> m) -> Name a -> m # foldr :: (a -> b -> b) -> b -> Name a -> b # foldr' :: (a -> b -> b) -> b -> Name a -> b # foldl :: (b -> a -> b) -> b -> Name a -> b # foldl' :: (b -> a -> b) -> b -> Name a -> b # foldr1 :: (a -> a -> a) -> Name a -> a # foldl1 :: (a -> a -> a) -> Name a -> a # toList :: Name a -> [a] # null :: Name a -> Bool # length :: Name a -> Int # elem :: Eq a => a -> Name a -> Bool # maximum :: Ord a => Name a -> a # minimum :: Ord a => Name a -> a # sum :: Num a => Name a -> a # product :: Num a => Name a -> a #
Traversable Name Source #
Instance details Defined in Distribution.Fields.Field Methods traverse :: Applicative f => (a -> f b) -> Name a -> f (Name b) # sequenceA :: Applicative f => Name (f a) -> f (Name a) # mapM :: Monad m => (a -> m b) -> Name a -> m (Name b) # sequence :: Monad m => Name (m a) -> m (Name a) #
Show ann => Show (Name ann) Source #
Instance details Defined in Distribution.Fields.Field Methods showsPrec :: Int -> Name ann -> ShowS # show :: Name ann -> String # showList :: [Name ann] -> ShowS #
Eq ann => Eq (Name ann) Source #
Instance details Defined in Distribution.Fields.Field Methods (==) :: Name ann -> Name ann -> Bool # (/=) :: Name ann -> Name ann -> Bool #
Ord ann => Ord (Name ann) Source #	Since: Cabal-syntax-3.12.0.0
Instance details Defined in Distribution.Fields.Field Methods compare :: Name ann -> Name ann -> Ordering # (<) :: Name ann -> Name ann -> Bool # (<=) :: Name ann -> Name ann -> Bool # (>) :: Name ann -> Name ann -> Bool # (>=) :: Name ann -> Name ann -> Bool # max :: Name ann -> Name ann -> Name ann # min :: Name ann -> Name ann -> Name ann #

data FieldLine ann Source #

A line of text representing the value of a field from a Cabal file. A field may contain multiple lines.

Invariant: ByteString has no newlines.

Constructors

FieldLine !ann !ByteString

Instances

Instances details

Foldable1 FieldLine Source #	Since: Cabal-syntax-3.12.0.0
Instance details Defined in Distribution.Fields.Field Methods fold1 :: Semigroup m => FieldLine m -> m Source # foldMap1 :: Semigroup m => (a -> m) -> FieldLine a -> m Source # foldMap1' :: Semigroup m => (a -> m) -> FieldLine a -> m Source # toNonEmpty :: FieldLine a -> NonEmpty a Source # maximum :: Ord a => FieldLine a -> a Source # minimum :: Ord a => FieldLine a -> a Source # head :: FieldLine a -> a Source # last :: FieldLine a -> a Source # foldrMap1 :: (a -> b) -> (a -> b -> b) -> FieldLine a -> b Source # foldlMap1' :: (a -> b) -> (b -> a -> b) -> FieldLine a -> b Source # foldlMap1 :: (a -> b) -> (b -> a -> b) -> FieldLine a -> b Source # foldrMap1' :: (a -> b) -> (a -> b -> b) -> FieldLine a -> b Source #
Functor FieldLine Source #
Instance details Defined in Distribution.Fields.Field Methods fmap :: (a -> b) -> FieldLine a -> FieldLine b # (<$) :: a -> FieldLine b -> FieldLine a #
Foldable FieldLine Source #
Instance details Defined in Distribution.Fields.Field Methods fold :: Monoid m => FieldLine m -> m # foldMap :: Monoid m => (a -> m) -> FieldLine a -> m # foldMap' :: Monoid m => (a -> m) -> FieldLine a -> m # foldr :: (a -> b -> b) -> b -> FieldLine a -> b # foldr' :: (a -> b -> b) -> b -> FieldLine a -> b # foldl :: (b -> a -> b) -> b -> FieldLine a -> b # foldl' :: (b -> a -> b) -> b -> FieldLine a -> b # foldr1 :: (a -> a -> a) -> FieldLine a -> a # foldl1 :: (a -> a -> a) -> FieldLine a -> a # toList :: FieldLine a -> [a] # null :: FieldLine a -> Bool # length :: FieldLine a -> Int # elem :: Eq a => a -> FieldLine a -> Bool # maximum :: Ord a => FieldLine a -> a # minimum :: Ord a => FieldLine a -> a # sum :: Num a => FieldLine a -> a # product :: Num a => FieldLine a -> a #
Traversable FieldLine Source #
Instance details Defined in Distribution.Fields.Field Methods traverse :: Applicative f => (a -> f b) -> FieldLine a -> f (FieldLine b) # sequenceA :: Applicative f => FieldLine (f a) -> f (FieldLine a) # mapM :: Monad m => (a -> m b) -> FieldLine a -> m (FieldLine b) # sequence :: Monad m => FieldLine (m a) -> m (FieldLine a) #
Show ann => Show (FieldLine ann) Source #
Instance details Defined in Distribution.Fields.Field Methods showsPrec :: Int -> FieldLine ann -> ShowS # show :: FieldLine ann -> String # showList :: [FieldLine ann] -> ShowS #
Eq ann => Eq (FieldLine ann) Source #
Instance details Defined in Distribution.Fields.Field Methods (==) :: FieldLine ann -> FieldLine ann -> Bool # (/=) :: FieldLine ann -> FieldLine ann -> Bool #
Ord ann => Ord (FieldLine ann) Source #	Since: Cabal-syntax-3.12.0.0
Instance details Defined in Distribution.Fields.Field Methods compare :: FieldLine ann -> FieldLine ann -> Ordering # (<) :: FieldLine ann -> FieldLine ann -> Bool # (<=) :: FieldLine ann -> FieldLine ann -> Bool # (>) :: FieldLine ann -> FieldLine ann -> Bool # (>=) :: FieldLine ann -> FieldLine ann -> Bool # max :: FieldLine ann -> FieldLine ann -> FieldLine ann # min :: FieldLine ann -> FieldLine ann -> FieldLine ann #

data SectionArg ann Source #

Section arguments, e.g. name of the library

Constructors

SecArgName !ann !ByteString	identifier, or something which looks like number. Also many dot numbers, i.e. "7.6.3"
SecArgStr !ann !ByteString	quoted string
SecArgOther !ann !ByteString	everything else, mm. operators (e.g. in if-section conditionals)

Instances

Instances details

Foldable1 SectionArg Source #	Since: Cabal-syntax-3.12.0.0
Instance details Defined in Distribution.Fields.Field Methods fold1 :: Semigroup m => SectionArg m -> m Source # foldMap1 :: Semigroup m => (a -> m) -> SectionArg a -> m Source # foldMap1' :: Semigroup m => (a -> m) -> SectionArg a -> m Source # toNonEmpty :: SectionArg a -> NonEmpty a Source # maximum :: Ord a => SectionArg a -> a Source # minimum :: Ord a => SectionArg a -> a Source # head :: SectionArg a -> a Source # last :: SectionArg a -> a Source # foldrMap1 :: (a -> b) -> (a -> b -> b) -> SectionArg a -> b Source # foldlMap1' :: (a -> b) -> (b -> a -> b) -> SectionArg a -> b Source # foldlMap1 :: (a -> b) -> (b -> a -> b) -> SectionArg a -> b Source # foldrMap1' :: (a -> b) -> (a -> b -> b) -> SectionArg a -> b Source #
Functor SectionArg Source #
Instance details Defined in Distribution.Fields.Field Methods fmap :: (a -> b) -> SectionArg a -> SectionArg b # (<$) :: a -> SectionArg b -> SectionArg a #
Foldable SectionArg Source #
Instance details Defined in Distribution.Fields.Field Methods fold :: Monoid m => SectionArg m -> m # foldMap :: Monoid m => (a -> m) -> SectionArg a -> m # foldMap' :: Monoid m => (a -> m) -> SectionArg a -> m # foldr :: (a -> b -> b) -> b -> SectionArg a -> b # foldr' :: (a -> b -> b) -> b -> SectionArg a -> b # foldl :: (b -> a -> b) -> b -> SectionArg a -> b # foldl' :: (b -> a -> b) -> b -> SectionArg a -> b # foldr1 :: (a -> a -> a) -> SectionArg a -> a # foldl1 :: (a -> a -> a) -> SectionArg a -> a # toList :: SectionArg a -> [a] # null :: SectionArg a -> Bool # length :: SectionArg a -> Int # elem :: Eq a => a -> SectionArg a -> Bool # maximum :: Ord a => SectionArg a -> a # minimum :: Ord a => SectionArg a -> a # sum :: Num a => SectionArg a -> a # product :: Num a => SectionArg a -> a #
Traversable SectionArg Source #
Instance details Defined in Distribution.Fields.Field Methods traverse :: Applicative f => (a -> f b) -> SectionArg a -> f (SectionArg b) # sequenceA :: Applicative f => SectionArg (f a) -> f (SectionArg a) # mapM :: Monad m => (a -> m b) -> SectionArg a -> m (SectionArg b) # sequence :: Monad m => SectionArg (m a) -> m (SectionArg a) #
Show ann => Show (SectionArg ann) Source #
Instance details Defined in Distribution.Fields.Field Methods showsPrec :: Int -> SectionArg ann -> ShowS # show :: SectionArg ann -> String # showList :: [SectionArg ann] -> ShowS #
Eq ann => Eq (SectionArg ann) Source #
Instance details Defined in Distribution.Fields.Field Methods (==) :: SectionArg ann -> SectionArg ann -> Bool # (/=) :: SectionArg ann -> SectionArg ann -> Bool #
Ord ann => Ord (SectionArg ann) Source #	Since: Cabal-syntax-3.12.0.0
Instance details Defined in Distribution.Fields.Field Methods compare :: SectionArg ann -> SectionArg ann -> Ordering # (<) :: SectionArg ann -> SectionArg ann -> Bool # (<=) :: SectionArg ann -> SectionArg ann -> Bool # (>) :: SectionArg ann -> SectionArg ann -> Bool # (>=) :: SectionArg ann -> SectionArg ann -> Bool # max :: SectionArg ann -> SectionArg ann -> SectionArg ann # min :: SectionArg ann -> SectionArg ann -> SectionArg ann #

type FieldName = ByteString Source #

Grammar and parsing

readFields :: ByteString -> Either ParseError [Field Position] Source #

Parse cabal style ByteString into list of Fields, i.e. the cabal AST.

readFields assumes that input ByteString is valid UTF8, specifically it doesn't validate that file is valid UTF8. Therefore bytestrings inside returned Field will be invalid as UTF8 if the input were.

>>> readFields "foo: \223"
Right [Field (Name (Position 1 1) "foo") [FieldLine (Position 1 6) "\223"]]

readFields won't (necessarily) fail on invalid UTF8 data, but the reported positions may be off.

You may get weird errors on non-UTF8 input, for example readFields will fail on latin1 encoded non-breaking space:

>>> isLeft (readFields "\xa0 foo: bar")
True

That is rejected because parser thinks \xa0 is a section name, and section arguments may not contain colon. If there are just latin1 non-breaking spaces, they become part of the name:

>>> readFields "\xa0\&foo: bar"
Right [Field (Name (Position 1 1) "\160foo") [FieldLine (Position 1 7) "bar"]]

The UTF8 non-breaking space is accepted as an indentation character (but warned about by readFields').

>>> readFields' "\xc2\xa0 foo: bar"
Right ([Field (Name (Position 1 3) "foo") [FieldLine (Position 1 8) "bar"]],[LexWarning LexWarningNBSP (Position 1 1)])

readFields' :: ByteString -> Either ParseError ([Field Position], [LexWarning]) Source #

Like readFields but also return lexer warnings.

ParseResult

data ParseResult a Source #

A monad with failure and accumulating errors and warnings.

Instances

Instances details

Applicative ParseResult Source #
Instance details Defined in Distribution.Fields.ParseResult Methods pure :: a -> ParseResult a # (<>) :: ParseResult (a -> b) -> ParseResult a -> ParseResult b # liftA2 :: (a -> b -> c) -> ParseResult a -> ParseResult b -> ParseResult c # (>) :: ParseResult a -> ParseResult b -> ParseResult b # (<*) :: ParseResult a -> ParseResult b -> ParseResult a #
Functor ParseResult Source #
Instance details Defined in Distribution.Fields.ParseResult Methods fmap :: (a -> b) -> ParseResult a -> ParseResult b # (<$) :: a -> ParseResult b -> ParseResult a #
Monad ParseResult Source #
Instance details Defined in Distribution.Fields.ParseResult Methods (>>=) :: ParseResult a -> (a -> ParseResult b) -> ParseResult b # (>>) :: ParseResult a -> ParseResult b -> ParseResult b # return :: a -> ParseResult a #

runParseResult :: ParseResult a -> ([PWarning], Either (Maybe Version, NonEmpty PError) a) Source #

Destruct a ParseResult into the emitted warnings and either a successful value or list of errors and possibly recovered a spec-version declaration.

parseWarning :: Position -> PWarnType -> String -> ParseResult () Source #

Add a warning. This doesn't fail the parsing process.

parseWarnings :: [PWarning] -> ParseResult () Source #

Add multiple warnings at once.

parseFailure :: Position -> String -> ParseResult () Source #

Add an error, but not fail the parser yet.

For fatal failure use parseFatalFailure

parseFatalFailure :: Position -> String -> ParseResult a Source #

Add an fatal error.

Warnings

data PWarnType Source #

Type of parser warning. We do classify warnings.

Different application may decide not to show some, or have fatal behaviour on others

Constructors

PWTOther	Unclassified warning
PWTUTF	Invalid UTF encoding
PWTBoolCase	`true` or `false`, not `True` or `False`
PWTVersionTag	there are version with tags
PWTNewSyntax	New syntax used, but no `cabal-version: >= 1.2` specified
PWTOldSyntax	Old syntax used, and `cabal-version >= 1.2` specified
PWTDeprecatedField
PWTInvalidSubsection
PWTUnknownField
PWTUnknownSection
PWTTrailingFields
PWTExtraMainIs	extra main-is field
PWTExtraTestModule	extra test-module field
PWTExtraBenchmarkModule	extra benchmark-module field
PWTLexNBSP
PWTLexBOM
PWTLexTab
PWTQuirkyCabalFile	legacy cabal file that we know how to patch
PWTDoubleDash	Double dash token, most likely it's a mistake - it's not a comment
PWTMultipleSingularField	e.g. name or version should be specified only once.
PWTBuildTypeDefault	Workaround for derive-package having build-type: Default. See https://github.com/haskell/cabal/issues/5020.
PWTVersionOperator	Version operators used (without cabal-version: 1.8)
PWTVersionWildcard	Version wildcard used (without cabal-version: 1.6)
PWTSpecVersion	Warnings about cabal-version format.
PWTEmptyFilePath	Empty filepath, i.e. literally ""
PWTInconsistentIndentation	sections contents (sections and fields) are indented inconsistently
PWTExperimental	Experimental feature

Instances

Instances details

Binary PWarnType Source #

Instance details

Defined in Distribution.Parsec.Warning

Methods

put :: PWarnType -> Put Source #

get :: Get PWarnType Source #

putList :: [PWarnType] -> Put Source #

NFData PWarnType Source #

Instance details

Defined in Distribution.Parsec.Warning

Methods

rnf :: PWarnType -> () Source #

Bounded PWarnType Source #

Instance details

Defined in Distribution.Parsec.Warning

Methods

minBound :: PWarnType #

maxBound :: PWarnType #

Enum PWarnType Source #

Instance details

Defined in Distribution.Parsec.Warning

Methods

succ :: PWarnType -> PWarnType #

pred :: PWarnType -> PWarnType #

toEnum :: Int -> PWarnType #

fromEnum :: PWarnType -> Int #

enumFrom :: PWarnType -> [PWarnType] #

enumFromThen :: PWarnType -> PWarnType -> [PWarnType] #

enumFromTo :: PWarnType -> PWarnType -> [PWarnType] #

enumFromThenTo :: PWarnType -> PWarnType -> PWarnType -> [PWarnType] #

Generic PWarnType Source #

Instance details

Defined in Distribution.Parsec.Warning

Associated Types

type Rep PWarnType

Instance details

Defined in Distribution.Parsec.Warning

type Rep PWarnType = D1 ('MetaData "PWarnType" "Distribution.Parsec.Warning" "Cabal-syntax-3.11.0.0-f9cc" 'False) ((((C1 ('MetaCons "PWTOther" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTUTF" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTBoolCase" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "PWTVersionTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTNewSyntax" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTOldSyntax" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "PWTDeprecatedField" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTInvalidSubsection" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTUnknownField" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "PWTUnknownSection" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTTrailingFields" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PWTExtraMainIs" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTExtraTestModule" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "PWTExtraBenchmarkModule" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTLexNBSP" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTLexBOM" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "PWTLexTab" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTQuirkyCabalFile" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PWTDoubleDash" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTMultipleSingularField" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "PWTBuildTypeDefault" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTVersionOperator" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTVersionWildcard" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "PWTSpecVersion" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTEmptyFilePath" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PWTInconsistentIndentation" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTExperimental" 'PrefixI 'False) (U1 :: Type -> Type))))))

Methods

from :: PWarnType -> Rep PWarnType x #

to :: Rep PWarnType x -> PWarnType #

Show PWarnType Source #

Instance details

Defined in Distribution.Parsec.Warning

Methods

showsPrec :: Int -> PWarnType -> ShowS #

show :: PWarnType -> String #

showList :: [PWarnType] -> ShowS #

Eq PWarnType Source #

Instance details

Defined in Distribution.Parsec.Warning

Methods

(==) :: PWarnType -> PWarnType -> Bool #

(/=) :: PWarnType -> PWarnType -> Bool #

Ord PWarnType Source #

Instance details

Defined in Distribution.Parsec.Warning

Methods

compare :: PWarnType -> PWarnType -> Ordering #

(<) :: PWarnType -> PWarnType -> Bool #

(<=) :: PWarnType -> PWarnType -> Bool #

(>) :: PWarnType -> PWarnType -> Bool #

(>=) :: PWarnType -> PWarnType -> Bool #

max :: PWarnType -> PWarnType -> PWarnType #

min :: PWarnType -> PWarnType -> PWarnType #

type Rep PWarnType Source #

Instance details

Defined in Distribution.Parsec.Warning

type Rep PWarnType = D1 ('MetaData "PWarnType" "Distribution.Parsec.Warning" "Cabal-syntax-3.11.0.0-f9cc" 'False) ((((C1 ('MetaCons "PWTOther" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTUTF" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTBoolCase" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "PWTVersionTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTNewSyntax" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTOldSyntax" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "PWTDeprecatedField" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTInvalidSubsection" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTUnknownField" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "PWTUnknownSection" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTTrailingFields" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PWTExtraMainIs" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTExtraTestModule" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "PWTExtraBenchmarkModule" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTLexNBSP" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTLexBOM" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "PWTLexTab" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTQuirkyCabalFile" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PWTDoubleDash" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTMultipleSingularField" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "PWTBuildTypeDefault" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTVersionOperator" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTVersionWildcard" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "PWTSpecVersion" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTEmptyFilePath" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PWTInconsistentIndentation" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTExperimental" 'PrefixI 'False) (U1 :: Type -> Type))))))

data PWarning Source #

Parser warning.

Constructors

PWarning !PWarnType !Position String

Instances

Instances details

Binary PWarning Source #

Instance details

Defined in Distribution.Parsec.Warning

Methods

put :: PWarning -> Put Source #

get :: Get PWarning Source #

putList :: [PWarning] -> Put Source #

NFData PWarning Source #

Instance details

Defined in Distribution.Parsec.Warning

Methods

rnf :: PWarning -> () Source #

Generic PWarning Source #

Instance details

Defined in Distribution.Parsec.Warning

Associated Types

type Rep PWarning

Instance details

Defined in Distribution.Parsec.Warning

type Rep PWarning = D1 ('MetaData "PWarning" "Distribution.Parsec.Warning" "Cabal-syntax-3.11.0.0-f9cc" 'False) (C1 ('MetaCons "PWarning" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PWarnType) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Position) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

Methods

from :: PWarning -> Rep PWarning x #

to :: Rep PWarning x -> PWarning #

Show PWarning Source #

Instance details

Defined in Distribution.Parsec.Warning

Methods

showsPrec :: Int -> PWarning -> ShowS #

show :: PWarning -> String #

showList :: [PWarning] -> ShowS #

Eq PWarning Source #

Instance details

Defined in Distribution.Parsec.Warning

Methods

(==) :: PWarning -> PWarning -> Bool #

(/=) :: PWarning -> PWarning -> Bool #

Ord PWarning Source #

Instance details

Defined in Distribution.Parsec.Warning

Methods

compare :: PWarning -> PWarning -> Ordering #

(<) :: PWarning -> PWarning -> Bool #

(<=) :: PWarning -> PWarning -> Bool #

(>) :: PWarning -> PWarning -> Bool #

(>=) :: PWarning -> PWarning -> Bool #

max :: PWarning -> PWarning -> PWarning #

min :: PWarning -> PWarning -> PWarning #

type Rep PWarning Source #

Instance details

Defined in Distribution.Parsec.Warning

type Rep PWarning = D1 ('MetaData "PWarning" "Distribution.Parsec.Warning" "Cabal-syntax-3.11.0.0-f9cc" 'False) (C1 ('MetaCons "PWarning" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PWarnType) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Position) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

showPWarning :: FilePath -> PWarning -> String Source #

Errors

data PError Source #

Parser error.

Constructors

PError Position String

Instances

Instances details

Binary PError Source #

Instance details

Defined in Distribution.Parsec.Error

Methods

put :: PError -> Put Source #

get :: Get PError Source #

putList :: [PError] -> Put Source #

NFData PError Source #

Instance details

Defined in Distribution.Parsec.Error

Methods

rnf :: PError -> () Source #

Generic PError Source #

Instance details

Defined in Distribution.Parsec.Error

Associated Types

type Rep PError

Instance details

Defined in Distribution.Parsec.Error

type Rep PError = D1 ('MetaData "PError" "Distribution.Parsec.Error" "Cabal-syntax-3.11.0.0-f9cc" 'False) (C1 ('MetaCons "PError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Position) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

Methods

from :: PError -> Rep PError x #

to :: Rep PError x -> PError #

Show PError Source #

Instance details

Defined in Distribution.Parsec.Error

Methods

showsPrec :: Int -> PError -> ShowS #

show :: PError -> String #

showList :: [PError] -> ShowS #

type Rep PError Source #

Instance details

Defined in Distribution.Parsec.Error

type Rep PError = D1 ('MetaData "PError" "Distribution.Parsec.Error" "Cabal-syntax-3.11.0.0-f9cc" 'False) (C1 ('MetaCons "PError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Position) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

showPError :: FilePath -> PError -> String Source #

Pretty printing

data CommentPosition Source #

This type is used to discern when a comment block should go before or after a cabal-like file field, otherwise it would be hardcoded to a single position. It is often used in conjunction with PrettyField.

Constructors

CommentBefore [String]
CommentAfter [String]
NoComment

data PrettyField ann Source #

Constructors

PrettyField ann FieldName Doc
PrettySection ann FieldName [Doc] [PrettyField ann]
PrettyEmpty

Instances

Instances details

Functor PrettyField Source #
Instance details Defined in Distribution.Fields.Pretty Methods fmap :: (a -> b) -> PrettyField a -> PrettyField b # (<$) :: a -> PrettyField b -> PrettyField a #
Foldable PrettyField Source #
Instance details Defined in Distribution.Fields.Pretty Methods fold :: Monoid m => PrettyField m -> m # foldMap :: Monoid m => (a -> m) -> PrettyField a -> m # foldMap' :: Monoid m => (a -> m) -> PrettyField a -> m # foldr :: (a -> b -> b) -> b -> PrettyField a -> b # foldr' :: (a -> b -> b) -> b -> PrettyField a -> b # foldl :: (b -> a -> b) -> b -> PrettyField a -> b # foldl' :: (b -> a -> b) -> b -> PrettyField a -> b # foldr1 :: (a -> a -> a) -> PrettyField a -> a # foldl1 :: (a -> a -> a) -> PrettyField a -> a # toList :: PrettyField a -> [a] # null :: PrettyField a -> Bool # length :: PrettyField a -> Int # elem :: Eq a => a -> PrettyField a -> Bool # maximum :: Ord a => PrettyField a -> a # minimum :: Ord a => PrettyField a -> a # sum :: Num a => PrettyField a -> a # product :: Num a => PrettyField a -> a #
Traversable PrettyField Source #
Instance details Defined in Distribution.Fields.Pretty Methods traverse :: Applicative f => (a -> f b) -> PrettyField a -> f (PrettyField b) # sequenceA :: Applicative f => PrettyField (f a) -> f (PrettyField a) # mapM :: Monad m => (a -> m b) -> PrettyField a -> m (PrettyField b) # sequence :: Monad m => PrettyField (m a) -> m (PrettyField a) #

showFields :: (ann -> CommentPosition) -> [PrettyField ann] -> String Source #

Prettyprint a list of fields.

Note: the first argument should return Strings without newlines and properly prefixes (with --) to count as comments. This unsafety is left in place so one could generate empty lines between comment lines.

Transformation from Field

genericFromParsecFields Source #

Arguments

:: Applicative f
=> (FieldName -> [FieldLine ann] -> f Doc)	transform field contents
-> (FieldName -> [SectionArg ann] -> f [Doc])	transform section arguments
-> [Field ann]
-> f [PrettyField ann]

fromParsecFields :: [Field ann] -> [PrettyField ann] Source #

Simple variant of genericFromParsecField