'tag t represents a document that is not yet rendered. The argument 'tag is the type of tags in the document. For instance tags might be used for styles.

If you want to serialise and deserialise this datastructure, you can use the Ast.t type together with the of_ast and to_ast functions.

A pretty printer that prints nothing

seq x y prints x and then y

concat ?sep l prints elements in l separated by sep. sep defaults to nop.

Convenience function for List.map followed by concat.

Convenience function for List.mapi followed by concat.

An indivisible block of text.

Same as verbatim but take a format string as argument.

A single character.

Print a bunch of text. The line may be broken at any spaces in the text.

Same as text but take a format string as argument.

space instructs the pretty-printing algorithm that the line may be broken at this point. If the algorithm decides not to break the line, a single space will be printed instead.

So for instance verbatim "x" ++ space ++ verbatim "y" might produce "x y" or "x\n<indentation>y".

cut instructs the pretty-printing algorithm that the line may be broken at this point. If the algorithm decides not to break the line, nothing is printed instead.

So for instance verbatim "x" ++ space ++ verbatim "y" might produce "xy" or "x\n<indentation>y".

break is a generalisation of space and cut. It also instructs the pretty-printing algorithm that the line may be broken at this point. If it ends up being broken, shift will be added to the indentation level, otherwise nspaces spaces will be printed. shift can be negative, in which case the indentation will be reduced.

custom_break ~fits:(a, b, c) ~breaks:(x, y, z) is a generalisation of break. It also instructs the pretty-printing algorithm that the line may be broken at this point. If it ends up being broken, x is printed, the line breaks, y will be added to the indentation level and z is printed, otherwise a will be printed, b spaces are printed and then c is printed. The indentation y can be negative, in which case the indentation will be reduced.

Force a newline to be printed. Usage is discourage since it breaks printing with boxes. If you need to add breaks to your text, put your items into boxes and concat with a separating space afterwhich wrapping it in a vbox.

Try to put as much as possible on each line. Additionally, a break hint always break the line if the breaking would reduce the indentation level inside the box (break with negative shift value).

Always break the line when encountering a break hint.

Print everything on one line, no matter what

If possible, print everything on one line. Otherwise, behave as a vbox

Try to put as much as possible on each line. Basically the same as box but without the rule about breaks with negative shift value.

tag x t Tag the material printed by t with x

Convert tags in a documents

Convert tags in a documents, possibly removing some tags.

paragraph s is hovbox (text s). This is useful to preserve the structure of a paragraph of text without worrying about it being broken by a vbox.

paragraphf s is textf s followed by a hovbox. The textf version of paragraph.

enumerate l ~f produces an enumeration of the form:

  - item1
  - item2
  - item3
  ...

chain l ~f is used to print a succession of items that follow each other. It produces an output of this form:

     item1
  -> item2
  -> item3
  ...

Infix operators for Pp.t

Render a document to a classic formatter

Stable representation of Pp.t useful for serialization

of_ast t converts an Ast.t to a Pp.t.

to_ast t converts a Pp.t to an Ast.t.

compare cmp x y compares x and y using cmp to compare tags.