ModuleCabal-syntax-3.18.1.0Haskell2010

Distribution.Fields.Pretty

Cabal-like file AST types: Field, Section etc,

This (intermediate) data type is used for pretty-printing.

Contents

Fields
Transformation from Field

Synopsis

data CommentPosition
data PrettyField
value showFields
value showFields'
value fromParsecFields
value genericFromParsecFields
value prettyFieldLines
value prettySectionArgs

PackageCabal-syntax-3.18.1.0
Exports8
LanguageHaskell2010
LicenceBSD-3-Clause
SourcePretty.hs

Fields

datadata 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

datadata PrettyField ann

Constructors

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

Instances3Functor, Foldable, Traversable

Functor PrettyFieldDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Pretty
Foldable PrettyFieldDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Pretty
Traversable PrettyFieldDefined in Cabal-syntax-3.18.1.0 · Distribution.Fields.Pretty

valueshowFields :: (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.

valueshowFields'

:: (ann -> CommentPosition)
Convert an annotation to lined to precede the field or section.
-> (ann -> [String] -> [String])
Post-process non-annotation produced lines.
-> Int
Indentation level.
-> [PrettyField ann]
Fields/sections to show.
-> String