A Doc is a bit of enriched text. Docs are concatenated using <> from class Monoid, which is right-associative.

The empty Doc

An associative operation.

>>> [1,2,3] <> [4,5,6]
[1,2,3,4,5,6]

a <?> b is a <> b if a is not empty, else empty

a <+> b is a followed by b with a space in between if both are non-empty

a $$ b is a above b

a $+$ b is a above b with an empty line in between if both are non-empty

Pile Docs vertically

Pile Docs vertically, with a blank line in between

Concatenate Docs horizontally

Concatenate Docs horizontally with a space as separator

A Doc representing a "-"

A Doc representing a newline

A Doc representing a "+"

A Doc representing a space (" ")

A Doc representing a "\"

A Doc that represents "("

A Doc that represents ")"

parens d = lparen <> d <> rparen

Turn a Doc into a sentence. This appends a ".".

text creates a Doc from a String, using printable.

hiddenText creates a Doc containing hidden text from a String

invisibleText creates a Doc containing invisible text from a String

wrapText n s is a Doc representing s line-wrapped at n characters

Quote a string for screen output

Given a list of Strings representing the words of a paragraph, format the paragraphs using wrapText and separate them with an empty line.

A variant of wrapText that takes a list of strings as input. Useful when {-# LANGUAGE CPP #-} makes it impossible to use multiline string literals.

Format a list of FilePaths as quoted text. It deliberately refuses to use English.andClauses but rather separates the quoted strings only with a space, because this makes it usable for copy and paste e.g. as arguments to another shell command.

Create a Doc containing a userchunk from a String.

Userchunks are used for printing arbitrary bytes stored in prim patches:

• old and new preference values in ChangePref prims
• tokenChars, old token and new token in TokReplace prims
• old and new content lines in Hunk prims

In colored mode they are printed such that trailing whitespace before the end of a line is made visible by marking the actual line ending with a red $ char (unless DARCS_DONT_ESCAPE_TRAILING_SPACES or even DARCS_DONT_ESCAPE_ANYTHING are set in the environment).

packedString builds a Doc from a ByteString using printable

invisiblePS creates a Doc with invisible text from a ByteString

Create a Doc representing a user chunk from a ByteString; see userchunk for details.

renders a Doc into a String with control codes for the special features of the Doc.

renders a Doc into a String using a given set of printers. If content is only available as ByteString, decode according to the current locale.

renders a Doc into ByteString with control codes for the special features of the Doc. See also readerString.

renders a Doc into a ByteString using a given set of printers.

renders a Doc into a list of PackedStrings, one for each line.

renders a Doc into a list of PackedStrings, one for each chunk of text that was added to the Doc, using the given set of printers.

A set of printers to print different types of text to a handle.

simplePrinters is a Printers which uses the set 'simplePriners'' on any handle.

invisiblePrinter is the Printer for hidden text. It just replaces the document with empty. It's useful to have a printer that doesn't actually do anything because this allows you to have tunable policies, for example, only printing some text if it's to the terminal, but not if it's to a file or vice-versa.

simplePrinter is the simplest Printer: it just concatenates together the pieces of the Doc

A Printable is either a String, a packed string, or a chunk of text with both representations.

Creates a Doc from any Printable.

Creates an invisible Doc from any Printable.

Creates a hidden Doc from any Printable.

Creates a userchunk from any Printable; see userchunk for details.

colorText creates a Doc containing colored text from a String

hputDoc puts a Doc on the given handle using simplePrinters

hputDocLn puts a Doc, followed by a newline on the given handle using simplePrinters.

putDoc puts a Doc on stdout using the simple printer simplePrinters.

putDocLn puts a Doc, followed by a newline on stdout using simplePrinters

hputDocWith puts a Doc on the given handle using the given printer.

hputDocLnWith puts a Doc, followed by a newline on the given handle using the given printer.

putDocWith puts a Doc on stdout using the given printer.

putDocLnWith puts a Doc, followed by a newline on stdout using the given printer.

like hPutDoc but with compress data before writing

Write a Doc to stderr if debugging is turned on.

unsafeText creates a Doc from a String, using simplePrinter directly

unsafeBoth builds a Doc from a String and a ByteString representing the same text, but does not check that they do.

unsafeBothText builds a Doc from a String. The string is stored in the Doc as both a String and a ByteString.

unsafeChar creates a Doc containing just one character.

unsafePackedString builds a Doc from a ByteString using simplePrinter