simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-06 03:05:28 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

deploy: a8449e9847

Browse source
This commit is contained in:
c-cube 2023-06-01 19:07:43 +00:00
parent 7260b7f28a
commit d5615cb2bc
9 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
dev/containers/Containers_pp/Dump/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Dump (containers.Containers_pp.Dump)</title><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> &#x00BB; <a href="../index.html">Containers_pp</a> &#x00BB; Dump</nav><header class="odoc-preamble"><h1>Module <code><span>Containers_pp.Dump</span></code></h1><p>Printers that correspond closely to OCaml's syntax.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-list"><a href="#val-list" class="anchor"></a><code><span><span class="keyword">val</span> list : <span><span><a href="../index.html#type-t">t</a> list</span> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-t">t</a></span></code></div></div></div></body></html>

2
dev/containers/Containers_pp/Ext/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Ext (containers.Containers_pp.Ext)</title><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> &#x00BB; <a href="../index.html">Containers_pp</a> &#x00BB; Ext</nav><header class="odoc-preamble"><h1>Module <code><span>Containers_pp.Ext</span></code></h1><p>Extension node.</p><p>Custom nodes can be used to add user-defined behavior to the rendered output. For example, documents might be annotated with ANSI-terminal colors, or with HTML tags.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span><span> = </span><span>{</span></code><ol><li id="type-t.pre" class="def record field anchored"><a href="#type-t.pre" class="anchor"></a><code><span>pre : <span><a href="../Out/index.html#type-t">Out.t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Printed before the wrapped value.</p><span class="comment-delim">*)</span></div></li><li id="type-t.post" class="def record field anchored"><a href="#type-t.post" class="anchor"></a><code><span>post : <span><a href="../Out/index.html#type-t">Out.t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Printed after the wrapped value.</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>An extension is a custom document node. It takes a value of type <code>'a</code>, and a document <code>d</code>, and can output what it wants based on the custom value before and after <code>d</code> is printed.</p><p>The extension is considered to have width <code>0</code>.</p></div></div></div></body></html>

2
dev/containers/Containers_pp/Flatten/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Flatten (containers.Containers_pp.Flatten)</title><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> &#x00BB; <a href="../index.html">Containers_pp</a> &#x00BB; Flatten</nav><header class="odoc-preamble"><h1>Module <code><span>Containers_pp.Flatten</span></code></h1><p>Trivial printing, on a single line.</p><p>This is generally ugly, but it's simple and fast when we do not care about looks.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-to_out"><a href="#val-to_out" class="anchor"></a><code><span><span class="keyword">val</span> to_out : <span><a href="../Out/index.html#type-t">Out.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_buffer"><a href="#val-to_buffer" class="anchor"></a><code><span><span class="keyword">val</span> to_buffer : <span><a href="../../../ocaml/Stdlib/Buffer/index.html#type-t">Stdlib.Buffer.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span><span class="keyword">val</span> to_string : <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div></div></body></html>

2
dev/containers/Containers_pp/Infix/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.Containers_pp.Infix)</title><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> &#x00BB; <a href="../index.html">Containers_pp</a> &#x00BB; Infix</nav><header class="odoc-preamble"><h1>Module <code><span>Containers_pp.Infix</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-(^)"><a href="#val-(^)" class="anchor"></a><code><span><span class="keyword">val</span> (^) : <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-t">t</a></span></code></div><div class="spec-doc"><p>Alias of <a href="../index.html#val-append"><code>append</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(^+)"><a href="#val-(^+)" class="anchor"></a><code><span><span class="keyword">val</span> (^+) : <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-t">t</a></span></code></div><div class="spec-doc"><p><code>x ^+ y</code> is <code>x ^ text &quot; &quot; ^ y</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(^/)"><a href="#val-(^/)" class="anchor"></a><code><span><span class="keyword">val</span> (^/) : <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-t">t</a></span></code></div><div class="spec-doc"><p><code>x ^/ y</code> is <code>x ^ newline ^ y</code></p></div></div></div></body></html>

2
dev/containers/Containers_pp/Out/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Out (containers.Containers_pp.Out)</title><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> &#x00BB; <a href="../index.html">Containers_pp</a> &#x00BB; Out</nav><header class="odoc-preamble"><h1>Module <code><span>Containers_pp.Out</span></code></h1><p>Arbitrary output.</p><p>This is used for user-provided output.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = </span><span>{</span></code><ol><li id="type-t.char" class="def record field anchored"><a href="#type-t.char" class="anchor"></a><code><span>char : <span>char <span class="arrow">&#45;&gt;</span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Output a single char. The char is assumed not to be <code>'\n'</code>.</p><span class="comment-delim">*)</span></div></li><li id="type-t.sub_string" class="def record field anchored"><a href="#type-t.sub_string" class="anchor"></a><code><span>sub_string : <span>string <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Output a string slice (optim for <code>string</code>)</p><span class="comment-delim">*)</span></div></li><li id="type-t.string" class="def record field anchored"><a href="#type-t.string" class="anchor"></a><code><span>string : <span>string <span class="arrow">&#45;&gt;</span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Output a string</p><span class="comment-delim">*)</span></div></li><li id="type-t.newline" class="def record field anchored"><a href="#type-t.newline" class="anchor"></a><code><span>newline : <span>unit <span class="arrow">&#45;&gt;</span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Output a newline</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_buffer"><a href="#val-of_buffer" class="anchor"></a><code><span><span class="keyword">val</span> of_buffer : <span><a href="../../../ocaml/Stdlib/Buffer/index.html#type-t">Stdlib.Buffer.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-char"><a href="#val-char" class="anchor"></a><code><span><span class="keyword">val</span> char : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>char <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string"><a href="#val-string" class="anchor"></a><code><span><span class="keyword">val</span> string : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sub_string"><a href="#val-sub_string" class="anchor"></a><code><span><span class="keyword">val</span> sub_string : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-newline"><a href="#val-newline" class="anchor"></a><code><span><span class="keyword">val</span> newline : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>

2
dev/containers/Containers_pp/Pretty/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Pretty (containers.Containers_pp.Pretty)</title><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> &#x00BB; <a href="../index.html">Containers_pp</a> &#x00BB; Pretty</nav><header class="odoc-preamble"><h1>Module <code><span>Containers_pp.Pretty</span></code></h1><p>Pretty-printing.</p><p>These functions are parametrized by a width, and will try to fit the result within this width.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-to_out"><a href="#val-to_out" class="anchor"></a><code><span><span class="keyword">val</span> to_out : <span>width:int <span class="arrow">&#45;&gt;</span></span> <span><a href="../Out/index.html#type-t">Out.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Render to an arbitrary output.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span><span class="keyword">val</span> to_string : <span>width:int <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p>Render to a string.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_buffer"><a href="#val-to_buffer" class="anchor"></a><code><span><span class="keyword">val</span> to_buffer : <span>width:int <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../ocaml/Stdlib/Buffer/index.html#type-t">Stdlib.Buffer.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Render to a buffer.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_format"><a href="#val-to_format" class="anchor"></a><code><span><span class="keyword">val</span> to_format : <span>width:int <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>

2
dev/containers/Containers_pp/Term_color/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Term_color (containers.Containers_pp.Term_color)</title><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> &#x00BB; <a href="../index.html">Containers_pp</a> &#x00BB; Term_color</nav><header class="odoc-preamble"><h1>Module <code><span>Containers_pp.Term_color</span></code></h1><p>Simple colors in terminals</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-color"><a href="#type-color" class="anchor"></a><code><span><span class="keyword">type</span> color</span><span> = </span><span>[ </span></code><ol><li id="type-color.Black" class="def constructor anchored"><a href="#type-color.Black" class="anchor"></a><code><span>| </span></code><code><span>`Black</span></code></li><li id="type-color.Blue" class="def constructor anchored"><a href="#type-color.Blue" class="anchor"></a><code><span>| </span></code><code><span>`Blue</span></code></li><li id="type-color.Cyan" class="def constructor anchored"><a href="#type-color.Cyan" class="anchor"></a><code><span>| </span></code><code><span>`Cyan</span></code></li><li id="type-color.Green" class="def constructor anchored"><a href="#type-color.Green" class="anchor"></a><code><span>| </span></code><code><span>`Green</span></code></li><li id="type-color.Magenta" class="def constructor anchored"><a href="#type-color.Magenta" class="anchor"></a><code><span>| </span></code><code><span>`Magenta</span></code></li><li id="type-color.Red" class="def constructor anchored"><a href="#type-color.Red" class="anchor"></a><code><span>| </span></code><code><span>`Red</span></code></li><li id="type-color.White" class="def constructor anchored"><a href="#type-color.White" class="anchor"></a><code><span>| </span></code><code><span>`White</span></code></li><li id="type-color.Yellow" class="def constructor anchored"><a href="#type-color.Yellow" class="anchor"></a><code><span>| </span></code><code><span>`Yellow</span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-style"><a href="#type-style" class="anchor"></a><code><span><span class="keyword">type</span> style</span><span> = </span><span>[ </span></code><ol><li id="type-style.BG" class="def constructor anchored"><a href="#type-style.BG" class="anchor"></a><code><span>| </span></code><code><span>`BG <span class="keyword">of</span> <a href="#type-color">color</a></span></code></li><li id="type-style.Bold" class="def constructor anchored"><a href="#type-style.Bold" class="anchor"></a><code><span>| </span></code><code><span>`Bold</span></code></li><li id="type-style.FG" class="def constructor anchored"><a href="#type-style.FG" class="anchor"></a><code><span>| </span></code><code><span>`FG <span class="keyword">of</span> <a href="#type-color">color</a></span></code></li><li id="type-style.Reset" class="def constructor anchored"><a href="#type-style.Reset" class="anchor"></a><code><span>| </span></code><code><span>`Reset</span></code></li><li id="type-style.Underline" class="def constructor anchored"><a href="#type-style.Underline" class="anchor"></a><code><span>| </span></code><code><span>`Underline</span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-color"><a href="#val-color" class="anchor"></a><code><span><span class="keyword">val</span> color : <span><a href="#type-color">color</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-style_l"><a href="#val-style_l" class="anchor"></a><code><span><span class="keyword">val</span> style_l : <span><span><a href="#type-style">style</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-t">t</a></span></code></div></div></div></body></html>

2
dev/containers/Containers_pp/index.html Normal file
View file

File diff suppressed because one or more lines are too long

2
dev/containers/index.html
View file

File diff suppressed because one or more lines are too long