Text.DocLayout

Synonym for renderPlain.

Render a Doc without using ANSI escapes. renderPlain (Just n) will use a line length of n to reflow text on breakable spaces. renderPlain Nothing will not reflow text.

Render a Doc with ANSI escapes. renderANSI (Just n) will use a line length of n to reflow text on breakable spaces. renderANSI Nothing will not reflow text.

A carriage return. Does nothing if we're at the beginning of a line; otherwise inserts a newline.

Inserts a blank line unless one exists already. (blankline <> blankline has the same effect as blankline.

Inserts blank lines unless they exist already. (blanklines m <> blanklines n has the same effect as blanklines (max m n).

A breaking (reflowable) space.

Create a Doc from a stringlike value.

A literal string. (Like literal, but restricted to String.)

A character.

Uses the specified string as a prefix for every line of the inside document (except the first, if not at the beginning of the line).

Makes a Doc flush against the left margin.

Indents a Doc by the specified number of spaces.

A hanging indent. hang ind start doc prints start, then doc, leaving an indent of ind spaces on every line but the first.

beforeNonBlank d conditionally includes d unless it is followed by blank space.

Makes a Doc non-reflowable.

Content to print only if it comes at the beginning of a line, to be used e.g. for escaping line-initial . in roff man.

lblock n d is a block of width n characters, with text derived from d and aligned to the left.

Like lblock but aligned centered.

Like lblock but aligned to the right.

An expandable border that, when placed next to a box, expands to the height of the box. Strings cycle through the list provided.

Removes leading blank lines from a Doc.

Chomps trailing blank space off of a Doc.

Encloses a Doc inside a start and end Doc.

Puts a Doc in curly braces.

Puts a Doc in square brackets.

Puts a Doc in parentheses.

Wraps a Doc in single quotes.

Wraps a Doc in double quotes.

Puts a Doc in boldface.

Puts a Doc in italics.

Underlines a Doc.

Puts a line through a Doc.

Set foreground color.

Set background color.

Make Doc a hyperlink.

The empty document.

Concatenate a list of Docs, putting breakable spaces between them.

a $$ b puts a above b.

a $+$ b puts a above b, with a blank line between.

Concatenate documents horizontally.

Same as hcat, but putting breakable spaces between the Docs.

List version of $$.

List version of $+$.

True if the document is empty.

Returns the width of a Doc.

Returns the minimal width of a Doc when reflowed at breakable spaces.

Returns the column that would be occupied by the last laid out character (assuming no wrapping).

Returns the height of a block or other Doc.

Returns width of a character in a monospace font: 0 for a combining character, 1 for a regular character, 2 for an East Asian wide character. Ambiguous characters are treated as width 1.

Get real length of string, taking into account combining and double-wide characters. Ambiguous characters are treated as width 1.

Get the real length of a string, taking into account combining and double-wide characters. Ambiguous characters are treated as width 1.

Get the real length of a string, taking into account combining and double-wide characters. Ambiguous characters are treated as width 2.

Like realLengthNarrowContext, but avoids optimizations (shortcuts). This is exposed for testing, to ensure that the optimizations are safe.

Like realLengthWideContext, but avoids optimizations (shortcuts). This is exposed for testing, to ensure that the optimizations are safe.

Checks whether a character is a skin tone modifier.

Checks whether a character is an emoji variation modifier.

Checks whether a character is a zero-width joiner.

Document, including structure relevant for layout.

Class abstracting over various string types that can fold over characters. Minimal definition is foldrChar and foldlChar, but defining the other methods can give better performance.

A sequence of strings with font attributes.