Documentation
dune._stdune lib
Stdune
. Pp
Module
Pretty printers
A document that is not yet rendered. The argument is the type of tags in the document. For instance tags might be used for styles.
A pretty printer that prints nothing
val seq : 'a t -> 'a t -> 'a t seq x y prints x and then y
val concat : ?sep :'a t -> 'a t -> 'a t concat ?sep l prints elements in l separated by sep. sep defaults to nop.
val concat_map : ?sep :'a t -> 'b list-> f :('b -> 'a t -> 'a t Convenience function for List.map followed by concat
val verbatim : string -> _ t An indivisible block of text
Print a bunch of text. The line may be broken at any spaces in the text.
val textf : ('a , unit, string, _ t format4 -> 'a Same as text but take a format string as argument.
val tag : 'a t -> tag :'a -> 'a t tag t ~tag Tag the material printed by t with tag
Either a newline or a space, depending on whether the line is broken at this point.
Either a newline or nothing, depending on whether the line is broken at this point.
val break : nspaces :int -> shift :int -> _ t Either a newline or nspaces spaces. If it is a newline, shift is added to the indentation level.
Force a newline to be printed
Boxes are the basic components to control the layout of the text. Break hints such as space and cut may cause the line to be broken, depending on the splitting rules. Whenever a line is split, the rest of the material printed in the box is indented with indent.
All functions take a list as argument for convenience. Elements are printed one by one.
val box : ?indent :int -> 'a t -> 'a t 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 (break with negative shift value).
val vbox : ?indent :int -> 'a t -> 'a t Always break the line when encountering a break hint.
val hbox : 'a t -> 'a t Print everything on one line, no matter what
val hvbox : ?indent :int -> 'a t -> 'a t If possible, print everything on one line. Otherwise, behave as a vbox
val hovbox : ?indent :int -> 'a t -> 'a t Try to put as much as possible on each line.
module type Tag = sig ... end A simple renderer that doesn't take tags