Cabal-syntax-3.10.1.0: A library for working with .cabal files
Safe HaskellSafe-Inferred
LanguageHaskell2010

Distribution.Fields.Pretty

Description

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

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

Since: Cabal-syntax-3.0.0.0

Synopsis

Fields

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.

showFields' Source #

Arguments

:: (ann -> CommentPosition)

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] Source #

Simple variant of genericFromParsecField

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] 

prettyFieldLines :: FieldName -> [FieldLine ann] -> Doc Source #

Used in fromParsecFields.

prettySectionArgs :: FieldName -> [SectionArg ann] -> [Doc] Source #

Used in fromParsecFields.