This commit is contained in:
c-cube 2021-03-02 14:51:30 +00:00
parent c2e4236a65
commit c8b4e54de9
5 changed files with 7 additions and 1 deletions

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Bitfield (containers.Containers_codegen.Bitfield)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.2"/><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">containers</a> &#x00BB; <a href="../index.html">Containers_codegen</a> &#x00BB; Bitfield</nav><h1>Module <code>Containers_codegen.Bitfield</code></h1><h3 id="generate-efficient-bitfields-that-fit-in-an-integer"><a href="#generate-efficient-bitfields-that-fit-in-an-integer" class="anchor"></a>Generate efficient bitfields that fit in an integer</h3></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-make"><a href="#val-make" class="anchor"></a><code><span class="keyword">val</span> make : <span>?&#8288;emit_failure_if_too_wide:bool</span> <span>&#45;&gt;</span> <span>name:string</span> <span>&#45;&gt;</span> unit <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p>Make a new bitfield with the given name.</p><dl><dt>parameter name</dt><dd><p>the name of the generated type</p></dd></dl><dl><dt>parameter emit_failure_if_too_wide</dt><dd><p>if true, generated code includes a runtime assertion that <span class="xref-unresolved" title="unresolved reference to &quot;Sys.int_size&quot;"><code>Sys</code>.int_size</span> is wide enough to support this type</p></dd></dl></dd></dl><dl><dt class="spec value" id="val-field_bit"><a href="#val-field_bit" class="anchor"></a><code><span class="keyword">val</span> field_bit : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string <span>&#45;&gt;</span> unit</code></dt><dt class="spec value" id="val-field_int"><a href="#val-field_int" class="anchor"></a><code><span class="keyword">val</span> field_int : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span>width:int</span> <span>&#45;&gt;</span> string <span>&#45;&gt;</span> unit</code></dt><dt class="spec value" id="val-total_width"><a href="#val-total_width" class="anchor"></a><code><span class="keyword">val</span> total_width : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> int</code></dt><dt class="spec value" id="val-gen_mli"><a href="#val-gen_mli" class="anchor"></a><code><span class="keyword">val</span> gen_mli : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="../index.html#type-code">code</a></code></dt><dt class="spec value" id="val-gen_ml"><a href="#val-gen_ml" class="anchor"></a><code><span class="keyword">val</span> gen_ml : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="../index.html#type-code">code</a></code></dt></dl></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Code (containers.Containers_codegen.Code)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.2"/><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">containers</a> &#x00BB; <a href="../index.html">Containers_codegen</a> &#x00BB; Code</nav><h1>Module <code>Containers_codegen.Code</code></h1><h3 id="representation-of-ocaml-code"><a href="#representation-of-ocaml-code" class="anchor"></a>Representation of OCaml code</h3></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code><code> = <a href="../index.html#type-code">code</a></code></dt></dl><dl><dt class="spec value" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span class="keyword">val</span> pp : <span><a href="index.html#type-t">t</a> <a href="../../CCFormat/index.html#type-printer">Fmt.printer</a></span></code></dt><dt class="spec value" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span class="keyword">val</span> to_string : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string</code></dt><dt class="spec value" id="val-mk_pp"><a href="#val-mk_pp" class="anchor"></a><code><span class="keyword">val</span> mk_pp : <span>unit <a href="../../CCFormat/index.html#type-printer">Fmt.printer</a></span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-mk_str"><a href="#val-mk_str" class="anchor"></a><code><span class="keyword">val</span> mk_str : string <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-in_struct"><a href="#val-in_struct" class="anchor"></a><code><span class="keyword">val</span> in_struct : string <span>&#45;&gt;</span> <span><a href="index.html#type-t">t</a> list</span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-in_sig"><a href="#val-in_sig" class="anchor"></a><code><span class="keyword">val</span> in_sig : string <span>&#45;&gt;</span> <span><a href="index.html#type-t">t</a> list</span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt></dl></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Containers_codegen (containers.Containers_codegen)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.2"/><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">containers</a> &#x00BB; Containers_codegen</nav><h1>Module <code>Containers_codegen</code></h1><h2 id="code-generators"><a href="#code-generators" class="anchor"></a>Code generators</h2></header><div class="spec module" id="module-Fmt"><a href="#module-Fmt" class="anchor"></a><code><span class="keyword">module</span> Fmt = <a href="../CCFormat/index.html">CCFormat</a></code></div><dl><dt class="spec type" id="type-code"><a href="#type-code" class="anchor"></a><code><span class="keyword">type</span> code</code></dt></dl><dl><dt class="spec module" id="module-Code"><a href="#module-Code" class="anchor"></a><code><span class="keyword">module</span> <a href="Code/index.html">Code</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd></dd></dl><dl><dt class="spec module" id="module-Bitfield"><a href="#module-Bitfield" class="anchor"></a><code><span class="keyword">module</span> <a href="Bitfield/index.html">Bitfield</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd></dd></dl><dl><dt class="spec value" id="val-emit_file"><a href="#val-emit_file" class="anchor"></a><code><span class="keyword">val</span> emit_file : string <span>&#45;&gt;</span> <span><a href="index.html#type-code">code</a> list</span> <span>&#45;&gt;</span> unit</code></dt><dt class="spec value" id="val-emit_chan"><a href="#val-emit_chan" class="anchor"></a><code><span class="keyword">val</span> emit_chan : Stdlib.out_channel <span>&#45;&gt;</span> <span><a href="index.html#type-code">code</a> list</span> <span>&#45;&gt;</span> unit</code></dt><dt class="spec value" id="val-emit_string"><a href="#val-emit_string" class="anchor"></a><code><span class="keyword">val</span> emit_string : <span><a href="index.html#type-code">code</a> list</span> <span>&#45;&gt;</span> string</code></dt></dl></div></body></html>

File diff suppressed because one or more lines are too long