Data.Text.Prettyprint.Doc.Extra

Documentation

type Doc = Doc ()

layoutOneLine :: Doc ann -> SimpleDocStream ann

renderOneLine :: Doc ann -> Text

int :: Applicative f => Int -> f Doc

integer :: Applicative f => Integer -> f Doc

char :: Applicative f => Char -> f Doc

lbrace :: Applicative f => f Doc

rbrace :: Applicative f => f Doc

colon :: Applicative f => f Doc

semi :: Applicative f => f Doc

equals :: Applicative f => f Doc

comma :: Applicative f => f Doc

dot :: Applicative f => f Doc

lparen :: Applicative f => f Doc

rparen :: Applicative f => f Doc

space :: Applicative f => f Doc

brackets :: Functor f => f Doc -> f Doc

braces :: Functor f => f Doc -> f Doc

tupled :: Functor f => f [Doc] -> f Doc

(<+>) :: Applicative f => f Doc -> f Doc -> f Doc infixr 6

vcat :: Functor f => f [Doc] -> f Doc

hcat :: Functor f => f [Doc] -> f Doc

nest :: Functor f => Int -> f Doc -> f Doc

indent :: Functor f => Int -> f Doc -> f Doc

parens :: Functor f => f Doc -> f Doc

emptyDoc :: Applicative f => f Doc

punctuate :: Applicative f => f Doc -> f [Doc] -> f [Doc]

encloseSep :: Applicative f => f Doc -> f Doc -> f Doc -> f [Doc] -> f Doc

enclose :: Applicative f => f Doc -> f Doc -> f Doc -> f Doc

line :: Applicative f => f Doc

line' :: Applicative f => f Doc

softline :: Applicative f => f Doc

softline' :: Applicative f => f Doc

pretty :: (Applicative f, Pretty a) => a -> f Doc

stringS :: Applicative f => Text -> f Doc

string :: Applicative f => Text -> f Doc

squotes :: Applicative f => f Doc -> f Doc

dquotes :: Functor f => f Doc -> f Doc

align :: Functor f => f Doc -> f Doc

hsep :: Functor f => f [Doc] -> f Doc

vsep :: Functor f => f [Doc] -> f Doc

isEmpty :: Doc -> Bool

fill :: Applicative f => Int -> f Doc -> f Doc

column :: Functor f => f (Int -> Doc) -> f Doc

nesting :: Functor f => f (Int -> Doc) -> f Doc

flatAlt :: Applicative f => f Doc -> f Doc -> f Doc

comment :: Applicative f => Text -> Text -> f Doc

squote :: Applicative f => f Doc

newtype LayoutOptions

Options to influence the layout algorithms.

Constructors

LayoutOptions

Fields

• layoutPageWidth :: PageWidth

Instances

Eq LayoutOptions

Defined in Prettyprinter.Internal

Methods

(==) :: LayoutOptions -> LayoutOptions -> Bool

(/=) :: LayoutOptions -> LayoutOptions -> Bool

Ord LayoutOptions

Defined in Prettyprinter.Internal

Methods

compare :: LayoutOptions -> LayoutOptions -> Ordering

(<) :: LayoutOptions -> LayoutOptions -> Bool

(<=) :: LayoutOptions -> LayoutOptions -> Bool

(>) :: LayoutOptions -> LayoutOptions -> Bool

(>=) :: LayoutOptions -> LayoutOptions -> Bool

max :: LayoutOptions -> LayoutOptions -> LayoutOptions

min :: LayoutOptions -> LayoutOptions -> LayoutOptions

Show LayoutOptions

Defined in Prettyprinter.Internal

Methods

showsPrec :: Int -> LayoutOptions -> ShowS

show :: LayoutOptions -> String

showList :: [LayoutOptions] -> ShowS

data PageWidth

Maximum number of characters that fit in one line. The layout algorithms will try not to exceed the set limit by inserting line breaks when applicable (e.g. via softline').

Constructors

AvailablePerLine !Int !Double

Layouters should not exceed the specified space per line.

• The Int is the number of characters, including whitespace, that fit in a line. A typical value is 80.
• The Double is the ribbon with, i.e. the fraction of the total page width that can be printed on. This allows limiting the length of printable text per line. Values must be between 0 and 1, and 0.4 to 1 is typical.

Unbounded

Layouters should not introduce line breaks on their own.

Instances

Eq PageWidth

Defined in Prettyprinter.Internal

Methods

(==) :: PageWidth -> PageWidth -> Bool

(/=) :: PageWidth -> PageWidth -> Bool

Ord PageWidth

Defined in Prettyprinter.Internal

Methods

compare :: PageWidth -> PageWidth -> Ordering

(<) :: PageWidth -> PageWidth -> Bool

(<=) :: PageWidth -> PageWidth -> Bool

(>) :: PageWidth -> PageWidth -> Bool

(>=) :: PageWidth -> PageWidth -> Bool

max :: PageWidth -> PageWidth -> PageWidth

min :: PageWidth -> PageWidth -> PageWidth

Show PageWidth

Defined in Prettyprinter.Internal

Methods

showsPrec :: Int -> PageWidth -> ShowS

show :: PageWidth -> String

showList :: [PageWidth] -> ShowS

layoutCompact :: Doc ann1 -> SimpleDocStream ann2

(layoutCompact x) lays out the document x without adding any indentation and without preserving annotations. Since no 'pretty' printing is involved, this layouter is very fast. The resulting output contains fewer characters than a prettyprinted version and can be used for output that is read by other programs.

>>> let doc = hang 4 (vsep ["lorem", "ipsum", hang 4 (vsep ["dolor", "sit"])])
>>> doc
lorem
    ipsum
    dolor
        sit

>>> let putDocCompact = renderIO System.IO.stdout . layoutCompact
>>> putDocCompact doc
lorem
ipsum
dolor
sit

layoutPretty :: LayoutOptions -> Doc ann -> SimpleDocStream ann

This is the default layout algorithm, and it is used by show, putDoc and hPutDoc.

layoutPretty commits to rendering something in a certain way if the next element fits the layout constraints; in other words, it has one SimpleDocStream element lookahead when rendering. Consider using the smarter, but a bit less performant, layoutSmart algorithm if the results seem to run off to the right before having lots of line breaks.

renderLazy :: SimpleDocStream ann -> Text

(renderLazy sdoc) takes the output sdoc from a rendering function and transforms it to lazy text.

>>> let render = TL.putStrLn . renderLazy . layoutPretty defaultLayoutOptions
>>> let doc = "lorem" <+> align (vsep ["ipsum dolor", parens "foo bar", "sit amet"])
>>> render doc
lorem ipsum dolor
      (foo bar)
      sit amet

Orphan instances

Applicative f => IsString (f Doc)

Methods

fromString :: String -> f Doc