jon.recoil.org

Module Format_doc.Doc

Definitions and immutable API for composing documents

Type definitions and core functions

type box_type =
  1. | H
  2. | V
  3. | HV
  4. | HoV
  5. | B

Format box types

type stag = Stdlib.Format.stag
type element =
  1. | Text of string
  2. | With_size of int
  3. | Open_box of {
    1. kind : Merlin_utils.Format_doc.Doc.box_type;
    2. indent : int;
    }
  4. | Close_box
  5. | Open_tag of Stdlib.Format.stag
  6. | Close_tag
  7. | Open_tbox
  8. | Tab_break of {
    1. width : int;
    2. offset : int;
    }
  9. | Set_tab
  10. | Close_tbox
  11. | Simple_break of {
    1. spaces : int;
    2. indent : int;
    }
  12. | Break of {
    1. fits : (string * int * string) as 'a;
    2. breaks : 'a;
    }
  13. | Flush of {
    1. newline : bool;
    }
  14. | Newline
  15. | If_newline
  16. | Deprecated of Stdlib.Format.formatter -> unit
    (*

    Escape hatch: a Format printer used to provide backward-compatibility for user-defined printer (from the #install_printer toplevel directive for instance).

    *)

Base formatting instruction recognized by Format

type t

Immutable document type

type 'a printer = 'a -> Merlin_utils.Format_doc.Doc.printer0

Empty document

format ppf doc sends the format instruction of doc to the Format's formatter doc.

val fold : ('acc -> Merlin_utils.Format_doc.Doc.element -> 'acc) -> 'acc -> Merlin_utils.Format_doc.Doc.t -> 'acc

Fold over a document as a sequence of instructions

msg and kmsg produce a document from a format string and its argument

printf and kprintf produce a printer from a format string and its argument

The functions below mirror Format printers, without the pp_print_ prefix naming convention

val text : string Merlin_utils.Format_doc.Doc.printer
val break : spaces:int -> indent:int -> Merlin_utils.Format_doc.Doc.printer0
val custom_break : fits:((string * int * string) as 'a) -> breaks:'a -> Merlin_utils.Format_doc.Doc.printer0
val tab_break : width:int -> offset:int -> Merlin_utils.Format_doc.Doc.printer0

Alignment functions

val align_prefix : (Merlin_utils.Format_doc.Doc.t * int) list -> Merlin_utils.Format_doc.Doc.t list

Align the right side of one "@{<ralign>...@}" tag box by inserting spaces at the beginning of boxes. Those function do nothing if the tag box appears after a break hint.