The abstract type of documents. A Doc represents a set of layouts. A Doc with no occurrences of Union or NoDoc represents just one layout.

A TextDetails represents a fragment of text that will be output at some point in a Doc.

An annotation (side-metadata) attached at a particular point in a Doc. Allows carrying non-pretty-printed data around in a Doc that is attached at particular points in the structure. Once the Doc is render to an output type (such as String), we can also retrieve where in the rendered document our annotations start and end (see Span and renderSpans).

A document of height and width 1, containing a literal character.

A document of height 1 containing a literal string. text satisfies the following laws:

• text s <> text t = text (s++t)

• text "" <> x = x, if x non-empty

The side condition on the last law is necessary because text "" has height 1, while empty has no height.

Same as text. Used to be used for Bytestrings.

Some text with any width. (text s = sizedText (length s) s)

Some text, but without any width. Use for non-printing text such as a HTML or Latex tags

Apply parens to Doc if boolean is true.

Apply brackets to Doc if boolean is true.

Apply braces to Doc if boolean is true.

Apply quotes to Doc if boolean is true.

Apply doubleQuotes to Doc if boolean is true.

The empty document, with no height and no width. empty is the identity for <>, <+>, $$ and $+$, and anywhere in the argument list for sep, hcat, hsep, vcat, fcat etc.

Beside. <> is associative, with identity empty.

Beside, separated by space, unless one of the arguments is empty. <+> is associative, with identity empty.

List version of <>.

List version of <+>.

Above, except that if the last line of the first argument stops at least one position before the first line of the second begins, these two lines are overlapped. For example:

   text "hi" $$ nest 5 (text "there")

lays out as

   hi   there

rather than

   hi
        there

$$ is associative, with identity empty, and also satisfies

• (x $$ y) <> z = x $$ (y <> z), if y non-empty.

Above, with no overlapping. $+$ is associative, with identity empty.

List version of $$.

Either hsep or vcat.

Either hcat or vcat.

"Paragraph fill" version of sep.

"Paragraph fill" version of cat.

Nest (or indent) a document by a given number of positions (which may also be negative). nest satisfies the laws:

• nest 0 x = x

• nest k (nest k' x) = nest (k+k') x

• nest k (x <> y) = nest k z <> nest k y

• nest k (x $$ y) = nest k x $$ nest k y

• nest k empty = empty

• x <> nest k y = x <> y, if x non-empty

The side condition on the last law is needed because empty is a left identity for <>.

hang d1 n d2 = sep [d1, nest n d2]

punctuate p [d1, ... dn] = [d1 <> p, d2 <> p, ... dn-1 <> p, dn]

Attach an annotation to a document.

Returns True if the document is empty

first returns its first argument if it is non-empty, otherwise its second.

Perform some simplification of a built up GDoc.

Render the Doc to a String using the default Style (see style).

Render an annotated Doc to a String and list of annotations (see Span) using the default Style (see style).

A Span represents the result of an annotation after a Doc has been rendered, capturing where the annotation now starts and ends in the rendered output.

Render out a String, interpreting the annotations as part of the resulting document.

IMPORTANT: the size of the annotation string does NOT figure into the layout of the document, so the document will lay out as though the annotations are not present.

Render a document with annotations, by interpreting the start and end of the annotations, as well as the text details in the context of a monad.

A rendering style. Allows us to specify constraints to choose among the many different rendering options.

The default style (mode=PageMode, lineLength=100, ribbonsPerLine=1.5).

Render the Doc to a String using the given Style.

Rendering mode.

The general rendering interface. Please refer to the Style and Mode types for a description of rendering mode, line length and ribbons.

The general rendering interface, supporting annotations. Please refer to the Style and Mode types for a description of rendering mode, line length and ribbons.