mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
13 lines
4.2 KiB
HTML
13 lines
4.2 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Containers_codegen (containers.Containers_codegen)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../odoc.support/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> » Containers_codegen</nav><header class="odoc-preamble"><h1>Module <code><span>Containers_codegen</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#code-generators">Code generators</a></li></ul></nav><div class="odoc-content"><h2 id="code-generators"><a href="#code-generators" class="anchor"></a>Code generators</h2><p>The code generator library is designed to be used from a build system (for example, from <code>dune</code>) to generate efficient code for features that are harder to provide at runtime.</p><p>The idea is that the build system should invoke some OCaml script that depends on <code>containers.codegen</code>; the script uses the DSL below to describe what code to generate (e.g. a description of a bitfield type) and emits a <code>.ml</code> file (and possibly a <code>.mli</code> file).</p><p>For example, the build script might contain:</p><pre class="language-ocaml"><code>module CG = Containers_codegen
|
||
let () =
|
||
let module B = CG.Bitfield in
|
||
let b = B.make ~name:"t" () in
|
||
B.field_bit b "x";
|
||
B.field_bit b "y";
|
||
B.field_bit b "z";
|
||
B.field_int b ~width:5 "foo";
|
||
|
||
CG.emit_file "foo.mli" [B.gen_mli b];
|
||
CG.emit_file "foo.ml" [B.gen_ml b];
|
||
()</code></pre><p>and this will produce <code>foo.ml</code> and <code>foo.mli</code> with a bitfield containing <code>x</code>, <code>y</code>, and <code>z</code>.</p><div class="odoc-spec"><div class="spec module anchored" id="module-Fmt"><a href="#module-Fmt" class="anchor"></a><code><span><span class="keyword">module</span> Fmt</span><span> = <a href="../CCFormat/index.html">CCFormat</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-code"><a href="#type-code" class="anchor"></a><code><span><span class="keyword">type</span> code</span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Code"><a href="#module-Code" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Code/index.html">Code</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Bitfield"><a href="#module-Bitfield" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Bitfield/index.html">Bitfield</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-emit_file"><a href="#val-emit_file" class="anchor"></a><code><span><span class="keyword">val</span> emit_file : <span>string <span class="arrow">-></span></span> <span><span><a href="#type-code">code</a> list</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>emit_file file cs</code> emits code fragments <code>cs</code> into the given file at path <code>file</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-emit_chan"><a href="#val-emit_chan" class="anchor"></a><code><span><span class="keyword">val</span> emit_chan : <span><span class="xref-unresolved">Stdlib</span>.out_channel <span class="arrow">-></span></span> <span><span><a href="#type-code">code</a> list</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-emit_string"><a href="#val-emit_string" class="anchor"></a><code><span><span class="keyword">val</span> emit_string : <span><span><a href="#type-code">code</a> list</span> <span class="arrow">-></span></span> string</span></code></div></div></div></body></html>
|