aboutsummaryrefslogtreecommitdiffhomepage
path: root/lib/pp.mli
blob: 96ef3d3ded3a112e6818647e2ff69cef71386325 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

(*i $Id$ i*)

(*i*)
open Pp_control
(*i*)

(* Pretty-printers. *)

type 'a ppcmd_token

type std_ppcmds = (int*string) ppcmd_token Stream.t

(*s Formatting commands. *)

val sTR  : string -> (int*string) ppcmd_token
val sTRas : int * string -> (int*string) ppcmd_token
val bRK : int * int -> 'a ppcmd_token
val tBRK : int * int -> 'a ppcmd_token
val tAB : 'a ppcmd_token
val fNL : 'a ppcmd_token
val pifB : 'a ppcmd_token
val wS : int -> 'a ppcmd_token

(*s Derived commands. *)

val sPC : 'a ppcmd_token
val cUT : 'a ppcmd_token
val aLIGN : 'a ppcmd_token
val iNT : int -> (int*string) ppcmd_token
val rEAL : float -> (int * string) ppcmd_token
val bOOL : bool -> (int * string) ppcmd_token
val qSTRING : string -> (int * string) ppcmd_token
val qS : string -> (int * string) ppcmd_token

(*s Boxing commands. *)

val h : int -> std_ppcmds -> std_ppcmds
val v : int -> std_ppcmds -> std_ppcmds
val hV : int -> std_ppcmds -> std_ppcmds
val hOV : int -> std_ppcmds -> std_ppcmds
val t : std_ppcmds -> std_ppcmds

(*s Opening and closing of boxes. *)

val hB : int -> 'a ppcmd_token
val vB : int -> 'a ppcmd_token
val hVB : int -> 'a ppcmd_token
val hOVB : int -> 'a ppcmd_token
val tB : 'a ppcmd_token
val cLOSE : 'a ppcmd_token
val tCLOSE : 'a ppcmd_token

(*s Pretty-printing functions \emph{without flush}. *)

val pP_with : Format.formatter -> std_ppcmds -> unit
val pPNL_with : Format.formatter -> std_ppcmds -> unit
val warning_with : Format.formatter -> string -> unit
val wARN_with : Format.formatter -> std_ppcmds -> unit
val pp_flush_with : Format.formatter -> unit -> unit

(*s Pretty-printing functions \emph{with flush}. *)

val mSG_with : Format.formatter -> std_ppcmds -> unit
val mSGNL_with : Format.formatter -> std_ppcmds -> unit


(*s The following functions are instances of the previous ones on
  [std_ft] and [err_ft]. *)

(*s Pretty-printing functions \emph{without flush} on [stdout] and [stderr]. *)

val pP : std_ppcmds -> unit
val pPNL : std_ppcmds -> unit
val pPERR : std_ppcmds -> unit
val pPERRNL : std_ppcmds -> unit
val message : string -> unit       (* = pPNL *)
val warning : string -> unit
val wARN : std_ppcmds -> unit
val pp_flush : unit -> unit
val flush_all: unit -> unit

(*s Pretty-printing functions \emph{with flush} on [stdout] and [stderr]. *)

val mSG : std_ppcmds -> unit
val mSGNL : std_ppcmds -> unit
val mSGERR : std_ppcmds -> unit
val mSGERRNL : std_ppcmds -> unit
val wARNING : std_ppcmds -> unit