|
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Pp (infer.IStdlib.Pp)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">infer</a> » <a href="../index.html">IStdlib</a> » Pp</nav><h1>Module <code>IStdlib.Pp</code></h1></header><div class="spec module" id="module-F"><a href="#module-F" class="anchor"></a><code><span class="keyword">module</span> F = Stdlib.Format</code></div><aside><p>Pretty Printing</p></aside><dl><dt class="spec type" id="type-color"><a href="#type-color" class="anchor"></a><code><span class="keyword">type</span> color</code><code> = </code><table class="variant"><tr id="type-color.Black" class="anchored"><td class="def constructor"><a href="#type-color.Black" class="anchor"></a><code>| </code><code><span class="constructor">Black</span></code></td></tr><tr id="type-color.Blue" class="anchored"><td class="def constructor"><a href="#type-color.Blue" class="anchor"></a><code>| </code><code><span class="constructor">Blue</span></code></td></tr><tr id="type-color.Green" class="anchored"><td class="def constructor"><a href="#type-color.Green" class="anchor"></a><code>| </code><code><span class="constructor">Green</span></code></td></tr><tr id="type-color.Orange" class="anchored"><td class="def constructor"><a href="#type-color.Orange" class="anchor"></a><code>| </code><code><span class="constructor">Orange</span></code></td></tr><tr id="type-color.Red" class="anchored"><td class="def constructor"><a href="#type-color.Red" class="anchor"></a><code>| </code><code><span class="constructor">Red</span></code></td></tr></table></dt><dd><p>Colors supported in printing</p></dd></dl><div><div class="spec include"><div class="doc"><dl><dt class="spec value" id="val-compare_color"><a href="#val-compare_color" class="anchor"></a><code><span class="keyword">val</span> compare_color : <a href="index.html#type-color">color</a> <span>-></span> <a href="index.html#type-color">color</a> <span>-></span> int</code></dt></dl></div></div></div><dl><dt class="spec value" id="val-equal_color"><a href="#val-equal_color" class="anchor"></a><code><span class="keyword">val</span> equal_color : <a href="index.html#type-color">color</a> <span>-></span> <a href="index.html#type-color">color</a> <span>-></span> bool</code></dt></dl><dl><dt class="spec type" id="type-colormap"><a href="#type-colormap" class="anchor"></a><code><span class="keyword">type</span> colormap</code><code> = Stdlib.Obj.t <span>-></span> <a href="index.html#type-color">color</a></code></dt><dd><p>map subexpressions (as Obj.t element compared by physical equality) to colors</p></dd></dl><dl><dt class="spec type" id="type-simple_kind"><a href="#type-simple_kind" class="anchor"></a><code><span class="keyword">type</span> simple_kind</code><code> = </code><table class="variant"><tr id="type-simple_kind.SIM_DEFAULT" class="anchored"><td class="def constructor"><a href="#type-simple_kind.SIM_DEFAULT" class="anchor"></a><code>| </code><code><span class="constructor">SIM_DEFAULT</span></code></td></tr><tr id="type-simple_kind.SIM_WITH_TYP" class="anchored"><td class="def constructor"><a href="#type-simple_kind.SIM_WITH_TYP" class="anchor"></a><code>| </code><code><span class="constructor">SIM_WITH_TYP</span></code></td></tr></table></dt><dd><p>Kind of simple printing: default or with full types</p></dd></dl><dl><dt class="spec type" id="type-print_kind"><a href="#type-print_kind" class="anchor"></a><code><span class="keyword">type</span> print_kind</code><code> = </code><table class="variant"><tr id="type-print_kind.TEXT" class="anchored"><td class="def constructor"><a href="#type-print_kind.TEXT" class="anchor"></a><code>| </code><code><span class="constructor">TEXT</span></code></td></tr><tr id="type-print_kind.HTML" class="anchored"><td class="def constructor"><a href="#type-print_kind.HTML" class="anchor"></a><code>| </code><code><span class="constructor">HTML</span></code></td></tr></table></dt><dd><p>Kind of printing</p></dd></dl><div><div class="spec include"><div class="doc"><dl><dt class="spec value" id="val-compare_print_kind"><a href="#val-compare_print_kind" class="anchor"></a><code><span class="keyword">val</span> compare_print_kind : <a href="index.html#type-print_kind">print_kind</a> <span>-></span> <a href="index.html#type-print_kind">print_kind</a> <span>-></span> int</code></dt></dl></div></div></div><dl><dt class="spec value" id="val-equal_print_kind"><a href="#val-equal_print_kind" class="anchor"></a><code><span class="keyword">val</span> equal_print_kind : <a href="index.html#type-print_kind">print_kind</a> <span>-></span> <a href="index.html#type-print_kind">print_kind</a> <span>-></span> bool</code></dt></dl><dl><dt class="spec type" id="type-env"><a href="#type-env" class="anchor"></a><code><span class="keyword">type</span> env</code><code> = </code><code>{</code><table class="record"><tr id="type-env.opt" class="anchored"><td class="def field"><a href="#type-env.opt" class="anchor"></a><code>opt : <a href="index.html#type-simple_kind">simple_kind</a>;</code></td><td class="doc"><p>Current option for simple printing</p></td></tr><tr id="type-env.kind" class="anchored"><td class="def field"><a href="#type-env.kind" class="anchor"></a><code>kind : <a href="index.html#type-print_kind">print_kind</a>;</code></td><td class="doc"><p>Current kind of printing</p></td></tr><tr id="type-env.break_lines" class="anchored"><td class="def field"><a href="#type-env.break_lines" class="anchor"></a><code>break_lines : bool;</code></td><td class="doc"><p>whether to let Format add its own line breaks or not (false by default)</p></td></tr><tr id="type-env.cmap_norm" class="anchored"><td class="def field"><a href="#type-env.cmap_norm" class="anchor"></a><code>cmap_norm : <a href="index.html#type-colormap">colormap</a>;</code></td><td class="doc"><p>Current colormap for the normal part</p></td></tr><tr id="type-env.cmap_foot" class="anchored"><td class="def field"><a href="#type-env.cmap_foot" class="anchor"></a><code>cmap_foot : <a href="index.html#type-colormap">colormap</a>;</code></td><td class="doc"><p>Current colormap for the footprint part</p></td></tr><tr id="type-env.color" class="anchored"><td class="def field"><a href="#type-env.color" class="anchor"></a><code>color : <a href="index.html#type-color">color</a>;</code></td><td class="doc"><p>Current color</p></td></tr><tr id="type-env.obj_sub" class="anchored"><td class="def field"><a href="#type-env.obj_sub" class="anchor"></a><code>obj_sub : <span><span>(Stdlib.Obj.t <span>-></span> Stdlib.Obj.t)</span> option</span>;</code></td><td class="doc"><p>generic object substitution</p></td></tr></table><code>}</code></dt><dd><p>Print environment threaded through all the printing functions</p></dd></dl><dl><dt class="spec value" id="val-reset_obj_sub"><a href="#val-reset_obj_sub" class="anchor"></a><code><span class="keyword">val</span> reset_obj_sub : <a href="index.html#type-env">env</a> <span>-></span> <a href="index.html#type-env">env</a></code></dt><dd><p>Reset the object substitution, so that no substitution takes place</p></dd></dl><dl><dt class="spec value" id="val-set_obj_sub"><a href="#val-set_obj_sub" class="anchor"></a><code><span class="keyword">val</span> set_obj_sub : <a href="index.html#type-env">env</a> <span>-></span> <span>(<span class="type-var">'a</span> <span>-></span> <span class="type-var">'a</span>)</span> <span>-></span> <a href="index.html#type-env">env</a></code></dt><dd><p>Set the object substitution, which is supposed to preserve the type. Currently only used for a map from (identifier) expressions to the program var containing them</p></dd></dl><dl><dt class="spec value" id="val-extend_colormap"><a href="#val-extend_colormap" class="anchor"></a><code><span class="keyword">val</span> extend_colormap : <a href="index.html#type-env">env</a> <span>-></span> Stdlib.Obj.t <span>-></span> <a href="index.html#type-color">color</a> <span>-></span> <a href="index.html#type-env">env</a></code></dt><dd><p>Extend the normal colormap for the given object with the given color</p></dd></dl><dl><dt class="spec value" id="val-color_wrapper"><a href="#val-color_wrapper" class="anchor"></a><code><span class="keyword">val</span> color_wrapper : <a href="index.html#type-env">env</a> <span>-></span> <a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> <span>f:<span>(<a href="index.html#type-env">env</a> <span>-></span> <a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit)</span></span> <span>-></span> unit</code></dt><dt class="spec value" id="val-text"><a href="#val-text" class="anchor"></a><code><span class="keyword">val</span> text : <a href="index.html#type-env">env</a></code></dt><dd><p>Default text print environment</p></dd></dl><dl><dt class="spec value" id="val-text_break"><a href="#val-text_break" class="anchor"></a><code><span class="keyword">val</span> text_break : <a href="index.html#type-env">env</a></code></dt><dd><p>text print environment that allows line breaks</p></dd></dl><dl><dt class="spec value" id="val-html"><a href="#val-html" class="anchor"></a><code><span class="keyword">val</span> html : <a href="index.html#type-color">color</a> <span>-></span> <a href="index.html#type-env">env</a></code></dt><dd><p>Default html print environment</p></dd></dl><dl><dt class="spec value" id="val-color_string"><a href="#val-color_string" class="anchor"></a><code><span class="keyword">val</span> color_string : <a href="index.html#type-color">color</a> <span>-></span> string</code></dt><dd><p>string representation of colors</p></dd></dl><dl><dt class="spec value" id="val-html_with_color"><a href="#val-html_with_color" class="anchor"></a><code><span class="keyword">val</span> html_with_color : <a href="index.html#type-color">color</a> <span>-></span> <span>(<a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit)</span> <span>-></span> <a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit</code></dt><dt class="spec value" id="val-option"><a href="#val-option" class="anchor"></a><code><span class="keyword">val</span> option : <span>(<a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit)</span> <span>-></span> <a href="index.html#module-F">F</a>.formatter <span>-></span> <span><span class="type-var">'a</span> option</span> <span>-></span> unit</code></dt><dt class="spec value" id="val-cli_args"><a href="#val-cli_args" class="anchor"></a><code><span class="keyword">val</span> cli_args : <a href="index.html#module-F">F</a>.formatter <span>-></span> <span>string list</span> <span>-></span> unit</code></dt><dd><p>pretty print command line arguments, expanding argument files to print their contents</p></dd></dl><dl><dt class="spec value" id="val-cli_args_with_verbosity"><a href="#val-cli_args_with_verbosity" class="anchor"></a><code><span class="keyword">val</span> cli_args_with_verbosity : <span>verbose:bool</span> <span>-></span> <a href="index.html#module-F">F</a>.formatter <span>-></span> <span>string list</span> <span>-></span> unit</code></dt><dd><p>pretty print command line arguments, and expand argument files if <code>verbose</code> is true</p></dd></dl><dl><dt class="spec value" id="val-seq"><a href="#val-seq" class="anchor"></a><code><span class="keyword">val</span> seq : <span>?⁠print_env:<a href="index.html#type-env">env</a></span> <span>-></span> <span>?⁠sep:string</span> <span>-></span> <span>?⁠sep_html:string</span> <span>-></span> <span>(<a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit)</span> <span>-></span> <a href="index.html#module-F">F</a>.formatter <span>-></span> <span><span class="type-var">'a</span> list</span> <span>-></span> unit</code></dt><dd><p>Pretty print a sequence with <code>sep</code> followed by a space between each element. By default, <code>print_env</code> is <code>text</code>, <code>sep</code> is "", and <code>sep_html</code> set to <code>sep</code>.</p></dd></dl><dl><dt class="spec value" id="val-comma_seq"><a href="#val-comma_seq" class="anchor"></a><code><span class="keyword">val</span> comma_seq : <span>?⁠print_env:<a href="index.html#type-env">env</a></span> <span>-></span> <span>(<a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit)</span> <span>-></span> <a href="index.html#module-F">F</a>.formatter <span>-></span> <span><span class="type-var">'a</span> list</span> <span>-></span> unit</code></dt><dd><p>Pretty print a comma-separated sequence.</p></dd></dl><dl><dt class="spec value" id="val-comma_seq_diff"><a href="#val-comma_seq_diff" class="anchor"></a><code><span class="keyword">val</span> comma_seq_diff : <span>(<a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit)</span> <span>-></span> <a href="index.html#type-env">env</a> <span>-></span> <a href="index.html#module-F">F</a>.formatter <span>-></span> <span><span class="type-var">'a</span> list</span> <span>-></span> unit</code></dt><dt class="spec value" id="val-semicolon_seq"><a href="#val-semicolon_seq" class="anchor"></a><code><span class="keyword">val</span> semicolon_seq : <span>?⁠print_env:<a href="index.html#type-env">env</a></span> <span>-></span> <span>(<a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit)</span> <span>-></span> <a href="index.html#module-F">F</a>.formatter <span>-></span> <span><span class="type-var">'a</span> list</span> <span>-></span> unit</code></dt><dd><p>Pretty print a ;-separated sequence</p></dd></dl><dl><dt class="spec value" id="val-of_string"><a href="#val-of_string" class="anchor"></a><code><span class="keyword">val</span> of_string : <span>f:<span>(<span class="type-var">'a</span> <span>-></span> string)</span></span> <span>-></span> <a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit</code></dt><dd><p>If all you have is to_string, but you need pp_foo.</p></dd></dl><dl><dt class="spec value" id="val-string_of_pp"><a href="#val-string_of_pp" class="anchor"></a><code><span class="keyword">val</span> string_of_pp : <span>(<a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit)</span> <span>-></span> <span class="type-var">'a</span> <span>-></span> string</code></dt><dd><p>If all you have is pp_foo, but you need to_string.</p></dd></dl><dl><dt class="spec value" id="val-pair"><a href="#val-pair" class="anchor"></a><code><span class="keyword">val</span> pair : <span>fst:<span>(<a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit)</span></span> <span>-></span> <span>snd:<span>(<a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'b</span> <span>-></span> unit)</span></span> <span>-></span> <a href="index.html#module-F">F</a>.formatter <span>-></span> <span>(<span class="type-var">'a</span> * <span class="type-var">'b</span>)</span> <span>-></span> unit</code></dt><dt class="spec value" id="val-in_backticks"><a href="#val-in_backticks" class="anchor"></a><code><span class="keyword">val</span> in_backticks : <span>(<a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit)</span> <span>-></span> <a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit</code></dt><dt class="spec value" id="val-collection"><a href="#val-collection" class="anchor"></a><code><span class="keyword">val</span> collection : <span>fold:<span><span>(<span class="type-var">'t</span>, <span class="type-var">'item</span>, bool)</span> <a href="../index.html#module-IStd">IStdlib.IStd</a>.Container.fold</span></span> <span>-></span> <span>sep:string</span> <span>-></span> <span>pp_item:<span>(<a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'item</span> <span>-></span> unit)</span></span> <span>-></span> <a href="index.html#module-F">F</a>.formatter <span>-></span> <span class="type-var">'t</span> <span>-></span> unit</code></dt></dl></div></body></html> |