Safe Haskell	Safe-Inferred
Language	Haskell2010

Distribution.Fields

Contents

Types
Grammar and parsing
Pretty printing
- Transformation from Field

Description

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

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

data Name ann Source #

A field name.

Invariant: ByteString is lower-case ASCII.

Constructors

Name !ann !FieldName

Instances

Instances details

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

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

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

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

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

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' :: 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 Source # (<>) :: ParseResult (a -> b) -> ParseResult a -> ParseResult b Source # liftA2 :: (a -> b -> c) -> ParseResult a -> ParseResult b -> ParseResult c Source # (>) :: ParseResult a -> ParseResult b -> ParseResult b Source # (<*) :: ParseResult a -> ParseResult b -> ParseResult a Source #
Functor ParseResult Source #
Instance details Defined in Distribution.Fields.ParseResult Methods fmap :: (a -> b) -> ParseResult a -> ParseResult b Source # (<$) :: a -> ParseResult b -> ParseResult a Source #
Monad ParseResult Source #
Instance details Defined in Distribution.Fields.ParseResult Methods (>>=) :: ParseResult a -> (a -> ParseResult b) -> ParseResult b Source # (>>) :: ParseResult a -> ParseResult b -> ParseResult b Source # return :: a -> ParseResult a Source #

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 ""
PWTExperimental	Experimental feature

Instances

Instances details

Bounded PWarnType Source #
Instance details Defined in Distribution.Parsec.Warning Methods minBound :: PWarnType Source # maxBound :: PWarnType Source #
Enum PWarnType Source #
Instance details Defined in Distribution.Parsec.Warning Methods succ :: PWarnType -> PWarnType Source # pred :: PWarnType -> PWarnType Source # toEnum :: Int -> PWarnType Source # fromEnum :: PWarnType -> Int Source # enumFrom :: PWarnType -> [PWarnType] Source # enumFromThen :: PWarnType -> PWarnType -> [PWarnType] Source # enumFromTo :: PWarnType -> PWarnType -> [PWarnType] Source # enumFromThenTo :: PWarnType -> PWarnType -> PWarnType -> [PWarnType] Source #
Generic PWarnType Source #
Instance details Defined in Distribution.Parsec.Warning Associated Types type Rep PWarnType :: Type -> Type Source # Methods from :: PWarnType -> Rep PWarnType x Source # to :: Rep PWarnType x -> PWarnType Source #
Show PWarnType Source #
Instance details Defined in Distribution.Parsec.Warning Methods showsPrec :: Int -> PWarnType -> ShowS Source # show :: PWarnType -> String Source # showList :: [PWarnType] -> ShowS Source #
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 #
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.7.0.0" '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 "PWTExperimental" 'PrefixI 'False) (U1 :: Type -> Type))))))

data PWarning Source #

Parser warning.

Constructors

PWarning !PWarnType !Position String

Instances

Instances details

Generic PWarning Source #
Instance details Defined in Distribution.Parsec.Warning Associated Types type Rep PWarning :: Type -> Type Source # Methods from :: PWarning -> Rep PWarning x Source # to :: Rep PWarning x -> PWarning Source #
Show PWarning Source #
Instance details Defined in Distribution.Parsec.Warning Methods showsPrec :: Int -> PWarning -> ShowS Source # show :: PWarning -> String Source # showList :: [PWarning] -> ShowS Source #
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 #
type Rep PWarning Source #
Instance details Defined in Distribution.Parsec.Warning type Rep PWarning = D1 ('MetaData "PWarning" "Distribution.Parsec.Warning" "Cabal-syntax-3.7.0.0" '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

Generic PError Source #
Instance details Defined in Distribution.Parsec.Error Associated Types type Rep PError :: Type -> Type Source # Methods from :: PError -> Rep PError x Source # to :: Rep PError x -> PError Source #
Show PError Source #
Instance details Defined in Distribution.Parsec.Error Methods showsPrec :: Int -> PError -> ShowS Source # show :: PError -> String Source # showList :: [PError] -> ShowS Source #
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 #
type Rep PError Source #
Instance details Defined in Distribution.Parsec.Error type Rep PError = D1 ('MetaData "PError" "Distribution.Parsec.Error" "Cabal-syntax-3.7.0.0" '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

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

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