module Pretty_utils: sig
.. end
Pretty-printer utilities.
pretty-printing to a string
val sfprintf : ('a, Format.formatter, unit, string) Pervasives.format4 -> 'a
similar as Format.sprintf, but %a are allowed in the formatting string
val to_string : (Format.formatter -> 'a -> unit) -> 'a -> string
separators
val pp_print_string_fill : Format.formatter -> string -> unit
transforms every space in a string in breakable spaces.
val escape_underscores : string -> string
pretty printers for standard types
type
sformat = (unit, Format.formatter, unit) Pervasives.format
type 'a
formatter = Format.formatter -> 'a -> unit
type ('a, 'b)
formatter2 = Format.formatter -> 'a -> 'b -> unit
val pp_list : ?pre:sformat ->
?sep:sformat ->
?last:sformat ->
?suf:sformat ->
'a formatter -> 'a list formatter
val pp_array : ?pre:sformat ->
?sep:sformat ->
?suf:sformat ->
(int, 'a) formatter2 -> 'a array formatter
pretty prints an array. The optional arguments stands for
- the prefix to output before a non-empty list (default: open a box)
- the separator between two elements (default: nothing)
- the suffix to output after a non-empty list (default: close box)
val pp_iter : ?pre:sformat ->
?sep:sformat ->
?suf:sformat ->
(('a -> unit) -> 'b -> unit) ->
'a formatter -> 'b formatter
pretty prints any structure using an iterator on it. The argument
pre
(resp. suf
) is output before (resp. after) the iterator
is started (resp. has ended). The optional argument sep
is output bewteen
two calls to the 'a formatter
. Default: open a box for pre
, close
a box for suf
, nothing for sep
.
val pp_opt : ?pre:sformat ->
?suf:sformat ->
'a formatter -> 'a option formatter
pretty-prints an optional value. Prefix and suffix default to "@" and "@
"
respectively. Nothing is printed if the option is None
.
val pp_cond : ?pr_false:sformat ->
bool -> sformat formatter
pp_cond cond f s
pretty-prints s
if cond is true
and the optional
pr_false, which defaults to nothing, otherwise
val pp_flowlist : ?left:sformat ->
?sep:sformat ->
?right:sformat ->
'a formatter -> 'a list formatter
val pp_blocklist : ?left:sformat ->
?right:sformat ->
'a formatter -> 'a list formatter
val pp_open_block : Format.formatter -> ('a, Format.formatter, unit) Pervasives.format -> 'a
val pp_close_block : Format.formatter -> ('a, Format.formatter, unit) Pervasives.format -> 'a
val pp_trail : 'a formatter -> 'a formatter
pretty-prints its contents inside an '(** ... **)' horizontal block trailed
with '*'