| Safe Haskell | Safe-Inferred |
|---|
Text.PrettyPrint.Compact
Contents
- data Doc
- mempty :: Monoid a => a
- char :: Char -> Doc
- text :: String -> Doc
- (<>) :: Monoid m => m -> m -> m
- nest :: Indentation -> Doc -> Doc
- line :: Doc
- linebreak :: Doc
- group :: Doc -> Doc
- softline :: Doc
- softbreak :: Doc
- align :: Doc -> Doc
- hang :: Indentation -> Doc -> Doc
- indent :: Indentation -> Doc -> Doc
- encloseSep :: Doc -> Doc -> Doc -> [Doc] -> Doc
- list :: [Doc] -> Doc
- tupled :: [Doc] -> Doc
- semiBraces :: [Doc] -> Doc
- (<+>) :: Doc -> Doc -> Doc
- (<$>) :: Functor f => (a -> b) -> f a -> f b
- (</>) :: Doc -> Doc -> Doc
- (<$$>) :: Doc -> Doc -> Doc
- (<//>) :: Doc -> Doc -> Doc
- hsep :: [Doc] -> Doc
- vsep :: [Doc] -> Doc
- fillSep :: [Doc] -> Doc
- sep :: [Doc] -> Doc
- hcat :: [Doc] -> Doc
- vcat :: [Doc] -> Doc
- fillCat :: [Doc] -> Doc
- cat :: [Doc] -> Doc
- punctuate :: Doc -> [Doc] -> [Doc]
- fill :: Indentation -> Doc -> Doc
- fillBreak :: Indentation -> Doc -> Doc
- enclose :: Doc -> Doc -> Doc -> Doc
- squotes :: Doc -> Doc
- dquotes :: Doc -> Doc
- parens :: Doc -> Doc
- angles :: Doc -> Doc
- braces :: Doc -> Doc
- brackets :: Doc -> Doc
- lparen :: Doc
- rparen :: Doc
- langle :: Doc
- rangle :: Doc
- lbrace :: Doc
- rbrace :: Doc
- lbracket :: Doc
- rbracket :: Doc
- squote :: Doc
- dquote :: Doc
- semi :: Doc
- colon :: Doc
- comma :: Doc
- space :: Doc
- dot :: Doc
- backslash :: Doc
- equals :: Doc
- string :: String -> Doc
- int :: Int -> Doc
- integer :: Integer -> Doc
- float :: Float -> Doc
- double :: Double -> Doc
- rational :: Rational -> Doc
- bool :: Bool -> Doc
- render :: Double -> Indentation -> Doc -> String
Documents
Basic combinators
mempty :: Monoid a => a
(<>) :: Monoid m => m -> m -> m
The line document advances to the next line and indents to the
current nesting level. Document line behaves like (text " ")
if the line break is undone by group.
The linebreak document advances to the next line and indents to
the current nesting level. Document linebreak behaves like
empty if the line break is undone by group.
The document softbreak behaves like empty if the resulting
output fits the page, otherwise it behaves like line.
softbreak = group linebreak
Alignment
The document (align x) renders document x with the nesting
level set to the current column. It is used for example to
implement hang.
As an example, we will put a document right above another one, regardless of the current nesting level:
x $$ y = align (x <$$$> y)
test = text "hi" <+> (text "nice" $$ text "world")
which will be layed out as:
hi nice
world
hang :: Indentation -> Doc -> DocSource
The hang combinator implements hanging indentation. The document
(hang i x) renders document x with a nesting level set to the
current column plus i. The following example uses hanging
indentation for some text:
test = hang 4 (fillSep (map text
(words "the hang combinator indents these words !")))
Which lays out on a page with a width of 20 characters as:
the hang combinator
indents these
words !
The hang combinator is implemented as:
hang i x = align (nest i x)
indent :: Indentation -> Doc -> DocSource
The document (indent i x) indents document x with i spaces.
test = indent 4 (fillSep (map text
(words "the indent combinator indents these words !")))
Which lays out with a page width of 20 as:
the indent
combinator
indents these
words !
encloseSep :: Doc -> Doc -> Doc -> [Doc] -> DocSource
The document (enclosure l r sep xs) concatenates the documents
xs separated by sep and encloses the resulting document by l
and r. The documents are rendered horizontally if that fits the
page. Otherwise they are aligned vertically. All separators are put
in front of the elements. For example, the combinator list can be
defined with enclosure:
list xs = enclosure lbracket rbracket comma xs test = text "list" <+> (list (map int [10,200,3000]))
Which is layed out with a page width of 20 as:
list [10,200,3000]
But when the page width is 15, it is layed out as:
list [10
,200
,3000]
The document (list xs) comma separates the documents xs and
encloses them in square brackets. The documents are rendered
horizontally if that fits the page. Otherwise they are aligned
vertically. All comma separators are put in front of the elements.
The document (tupled xs) comma separates the documents xs and
encloses them in parenthesis. The documents are rendered
horizontally if that fits the page. Otherwise they are aligned
vertically. All comma separators are put in front of the elements.
semiBraces :: [Doc] -> DocSource
The document (semiBraces xs) separates the documents xs with
semi colons and encloses them in braces. The documents are rendered
horizontally if that fits the page. Otherwise they are aligned
vertically. All semi colons are put in front of the elements.
Operators
(<+>) :: Doc -> Doc -> DocSource
The document (x <+> y) concatenates document x and y with a
space in between. (infixr 6)
(<$>) :: Functor f => (a -> b) -> f a -> f b
(</>) :: Doc -> Doc -> DocSource
The document (x </> y) concatenates document x and y with a
softline in between. This effectively puts x and y either
next to each other (with a space in between) or underneath each
other. (infixr 5)
(<$$>) :: Doc -> Doc -> DocSource
The document (x <$$> y) concatenates document x and y with
a linebreak in between. (infixr 5)
(<//>) :: Doc -> Doc -> DocSource
The document (x <//> y) concatenates document x and y with
a softbreak in between. This effectively puts x and y either
right next to each other or underneath each other. (infixr 5)
List combinators
The document (hsep xs) concatenates all documents xs
horizontally with (<+>).
The document (vsep xs) concatenates all documents xs
vertically with (<$>). If a group undoes the line breaks
inserted by vsep, all documents are separated with a space.
someText = map text (words ("text to lay out"))
test = text "some" <+> vsep someText
This is layed out as:
some text to lay out
The align combinator can be used to align the documents under
their first element
test = text "some" <+> align (vsep someText)
Which is printed as:
some text
to
lay
out
The document (fillSep xs) concatenates documents xs
horizontally with (<+>) as long as its fits the page, than
inserts a line and continues doing that for all documents in
xs.
fillSep xs = foldr (\<\/\>) empty xs
The document (sep xs) concatenates all documents xs either
horizontally with (<+>), if it fits the page, or vertically with
(<$>).
sep xs = group (vsep xs)
The document (hcat xs) concatenates all documents xs
horizontally with (<>).
The document (vcat xs) concatenates all documents xs
vertically with (<$$>). If a group undoes the line breaks
inserted by vcat, all documents are directly concatenated.
The document (fillCat xs) concatenates documents xs
horizontally with (<>) as long as its fits the page, than inserts
a linebreak and continues doing that for all documents in xs.
fillCat xs = foldr (\<\/\/\>) empty xs
The document (cat xs) concatenates all documents xs either
horizontally with (<>), if it fits the page, or vertically with
(<$$>).
cat xs = group (vcat xs)
punctuate :: Doc -> [Doc] -> [Doc]Source
(punctuate p xs) concatenates all documents in xs with
document p except for the last document.
someText = map text ["words","in","a","tuple"] test = parens (align (cat (punctuate comma someText)))
This is layed out on a page width of 20 as:
(words,in,a,tuple)
But when the page width is 15, it is layed out as:
(words, in, a, tuple)
(If you want put the commas in front of their elements instead of
at the end, you should use tupled or, in general, encloseSep.)
Fillers
fill :: Indentation -> Doc -> DocSource
The document (fill i x) renders document x. It than appends
spaces until the width is equal to i. If the width of x is
already larger, nothing is appended. This combinator is quite
useful in practice to output a list of bindings. The following
example demonstrates this.
types = [("empty","Doc")
,("nest","Indentation -> Doc -> Doc")
,("linebreak","Doc")]
ptype (name,tp)
= fill 6 (text name) <+> text "::" <+> text tp
test = text "let" <+> align (vcat (map ptype types))
Which is layed out as:
let empty :: Doc
nest :: Indentation -> Doc -> Doc
linebreak :: Doc
fillBreak :: Indentation -> Doc -> DocSource
The document (fillBreak i x) first renders document x. It
than appends spaces until the width is equal to i. If the
width of x is already larger than i, the nesting level is
increased by i and a line is appended. When we redefine ptype
in the previous example to use fillBreak, we get a useful
variation of the previous output:
ptype (name,tp)
= fillBreak 6 (text name) <+> text "::" <+> text tp
The output will now be:
let empty :: Doc
nest :: Indentation -> Doc -> Doc
linebreak
:: Doc
Bracketing combinators
enclose :: Doc -> Doc -> Doc -> DocSource
The document (enclose l r x) encloses document x between
documents l and r using (<>).
Document (brackets x) encloses document x in square brackets,
"[" and "]".
Character documents
Primitive type documents
The document (string s) concatenates all characters in s
using line for newline characters and char for all other
characters. It is used instead of text whenever the text contains
newline characters.