Module

Pursfmt.Doc

Package: purescript-pursfmt
Repository: ad-si/pursfmt

#FormatDoc Source

newtype FormatDoc a

Constructors

FormatDoc { doc :: Doc a, isEmpty :: Boolean, leading :: LeadingComment a, multiline :: Boolean, trailing :: TrailingComment a }

Instances

Semigroup (FormatDoc a)
Monoid (FormatDoc a)

#LeadingComment Source

newtype LeadingComment a

Constructors

LeadingComment { doc :: Doc a, left :: ForceBreak, lines :: Int, multiline :: Boolean, right :: ForceBreak }

Instances

Semigroup (LeadingComment a)
Monoid (LeadingComment a)

#TrailingComment Source

newtype TrailingComment a

Constructors

TrailingComment { doc :: Doc a, left :: ForceBreak, multiline :: Boolean, right :: ForceBreak }

Instances

Semigroup (TrailingComment a)
Monoid (TrailingComment a)

#ForceBreak Source

data ForceBreak

Constructors

Instances

#text Source

text :: forall a. String -> FormatDoc a

#leadingLineComment Source

leadingLineComment :: forall a. String -> FormatDoc a -> FormatDoc a

#trailingLineComment Source

trailingLineComment :: forall a. String -> FormatDoc a -> FormatDoc a

#leadingBlockComment Source

leadingBlockComment :: forall a. String -> FormatDoc a -> FormatDoc a

#trailingBlockComment Source

trailingBlockComment :: forall a. String -> FormatDoc a -> FormatDoc a

#anchor Source

anchor :: forall a. FormatDoc a -> FormatDoc a

#flatten Source

flatten :: forall a. FormatDoc a -> FormatDoc a

#flattenMax Source

flattenMax :: forall a. Int -> FormatDoc a -> FormatDoc a

#indent Source

indent :: forall a. FormatDoc a -> FormatDoc a

#align Source

align :: forall a. Int -> FormatDoc a -> FormatDoc a

#alignCurrentColumn Source

alignCurrentColumn :: forall a. FormatDoc a -> FormatDoc a

#locally Source

locally :: forall a. (LocalOptions -> LocalOptions) -> FormatDoc a -> FormatDoc a

#break Source

break :: forall a. FormatDocOperator a

#softBreak Source

softBreak :: forall a. FormatDocOperator a

#spaceBreak Source

spaceBreak :: forall a. FormatDocOperator a

#sourceBreak Source

sourceBreak :: forall a. Int -> FormatDoc a -> FormatDoc a

#forceMinSourceBreaks Source

forceMinSourceBreaks :: forall a. Int -> FormatDoc a -> FormatDoc a

#space Source

space :: forall a. FormatDocOperator a

#softSpace Source

softSpace :: forall a. FormatDocOperator a

#flexSpaceBreak Source

flexSpaceBreak :: forall a. FormatDocOperator a

#flexSpaceOrBreak Source

flexSpaceOrBreak :: forall a. FormatDocOperator a

#flexSoftSpace Source

flexSoftSpace :: forall a. FormatDocOperator a

#flexSoftBreak Source

flexSoftBreak :: forall a. FormatDocOperator a

#flexDoubleBreak Source

flexDoubleBreak :: forall a. FormatDocOperator a

Warning: This is not an associative join operation, and requires right associativity. You will always get double breaks when used with left associativity.

#flexGroup Source

flexGroup :: forall a. FormatDoc a -> FormatDoc a

#fromDoc Source

fromDoc :: forall a. Doc a -> FormatDoc a

#toDoc Source

toDoc :: forall a. FormatDoc a -> Doc a

#mapDoc Source

mapDoc :: forall a. (Doc a -> Doc a) -> FormatDoc a -> FormatDoc a

#breakDoc Source

breakDoc :: forall a. ForceBreak -> Doc a -> Doc a

#breaks Source

breaks :: forall a. ForceBreak -> Int -> Doc a

#joinWithMap Source

joinWithMap :: forall f a b. Foldable f => (FormatDoc a -> FormatDoc a -> FormatDoc a) -> (b -> FormatDoc a) -> f b -> FormatDoc a

#joinWith Source

joinWith :: forall f a. Foldable f => (FormatDoc a -> FormatDoc a -> FormatDoc a) -> f (FormatDoc a) -> FormatDoc a

Modules: Pursfmt; Pursfmt.Doc; Pursfmt.Hang; Pursfmt.Operators; Pursfmt.Operators.Defaults; Pursfmt.Precedence; Pursfmt.Token; Pursfmt.Util