Distribution.Fields.Pretty

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

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

Since: 3.0.0.0

Fields

data PrettyField ann

Constructors

PrettyField ann FieldName Doc

PrettySection ann FieldName [Doc] [PrettyField ann]

Instances

Functor PrettyField

Defined in Distribution.Fields.Pretty

Methods

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

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

Foldable PrettyField

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

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 -> [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.

showFields'

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

genericFromParsecFields

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.