| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Distribution.Fields.Pretty
Contents
Description
Cabal-like file AST types: Field, Section etc,
This (intermediate) data type is used for pretty-printing.
Since: Cabal-3.0.0.0
Synopsis
- data PrettyField ann
- = PrettyField ann FieldName Doc
- | PrettySection ann FieldName [Doc] [PrettyField ann]
- showFields :: (ann -> [String]) -> [PrettyField ann] -> String
- showFields' :: (ann -> [String]) -> (ann -> [String] -> [String]) -> Int -> [PrettyField ann] -> String
- fromParsecFields :: [Field ann] -> [PrettyField ann]
- genericFromParsecFields :: Applicative f => (FieldName -> [FieldLine ann] -> f Doc) -> (FieldName -> [SectionArg ann] -> f [Doc]) -> [Field ann] -> f [PrettyField ann]
- prettyFieldLines :: FieldName -> [FieldLine ann] -> Doc
- prettySectionArgs :: FieldName -> [SectionArg ann] -> [Doc]
Fields
data PrettyField ann #
Constructors
| PrettyField ann FieldName Doc | |
| PrettySection ann FieldName [Doc] [PrettyField ann] |
Instances
showFields :: (ann -> [String]) -> [PrettyField ann] -> String #
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.
Arguments
| :: (ann -> [String]) | Convert an annotation to lined to preceed the field or section. |
| -> (ann -> [String] -> [String]) | Post-process non-annotation produced lines. |
| -> Int | Indentation level. |
| -> [PrettyField ann] | Fields/sections to show. |
| -> String |
showFields with user specified indentation.
Transformation from Field
fromParsecFields :: [Field ann] -> [PrettyField ann] #
Simple variant of genericFromParsecField
Arguments
| :: Applicative f | |
| => (FieldName -> [FieldLine ann] -> f Doc) | transform field contents |
| -> (FieldName -> [SectionArg ann] -> f [Doc]) | transform section arguments |
| -> [Field ann] | |
| -> f [PrettyField ann] |
prettyFieldLines :: FieldName -> [FieldLine ann] -> Doc #
Used in fromParsecFields.
prettySectionArgs :: FieldName -> [SectionArg ann] -> [Doc] #
Used in fromParsecFields.