ocaml-trace/ppxlib/Ppxlib/Deriving/Generator/index.html
2025-09-15 14:25:35 +00:00

19 lines
5.5 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Generator (ppxlib.Ppxlib.Deriving.Generator)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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">Index</a> &#x00BB; <a href="../../../index.html">ppxlib</a> &#x00BB; <a href="../../index.html">Ppxlib</a> &#x00BB; <a href="../index.html">Deriving</a> &#x00BB; Generator</nav><header class="odoc-preamble"><h1>Module <code><span>Deriving.Generator</span></code></h1></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>('output_ast, 'input_ast) t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make :
<span><span class="optlabel">?attributes</span>:<span><a href="../../Attribute/index.html#type-packed">Attribute.packed</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?deps</span>:<span><a href="../index.html#type-t">t</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?unused_code_warnings</span>:bool <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<span class="type-var">'f</span>, <span class="type-var">'output_ast</span>)</span> <a href="../Args/index.html#type-t">Args.t</a></span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span><span class="label">loc</span>:<a href="../../Location/index.html#type-t">Location.t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">path</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'input_ast</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'f</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span class="type-var">'output_ast</span>, <span class="type-var">'input_ast</span>)</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>make args gen</code> creates a generator that can be passed to <a href="../index.html#val-add"><code>Deriving.add</code></a> to generate an output AST from an input AST and generator arguments.</p><p><code>deps</code> is a list of derivers that this generator depends on.</p><p><code>attributes</code> is deprecated and unused. It is only kept for backward compatibility.</p><p><code>unused_code_warning</code> controls whether unused code warnings (e.g. warnings 32 and 60) are enabled or suppressed in emitted code. Default is <code>false</code>, which suppresses the warnings.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_noarg"><a href="#val-make_noarg" class="anchor"></a><code><span><span class="keyword">val</span> make_noarg :
<span><span class="optlabel">?attributes</span>:<span><a href="../../Attribute/index.html#type-packed">Attribute.packed</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?deps</span>:<span><a href="../index.html#type-t">t</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?unused_code_warnings</span>:bool <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span><span class="label">loc</span>:<a href="../../Location/index.html#type-t">Location.t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">path</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'input_ast</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'output_ast</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span class="type-var">'output_ast</span>, <span class="type-var">'input_ast</span>)</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Same as <a href="#val-make"><code>make</code></a>, but without arguments.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-V2"><a href="#module-V2" class="anchor"></a><code><span><span class="keyword">module</span> <a href="V2/index.html">V2</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-apply"><a href="#val-apply" class="anchor"></a><code><span><span class="keyword">val</span> apply :
<span><span><span>(<span class="type-var">'output_ast</span>, <span class="type-var">'input_ast</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">ctxt</span>:<a href="../../Expansion_context/Deriver/index.html#type-t">Expansion_context.Deriver.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="type-var">'input_ast</span> <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(string * <a href="../../../Astlib/Ast_500/Parsetree/index.html#type-expression">Astlib.Ast_500.Parsetree.expression</a>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span class="type-var">'output_ast</span></span></code></div></div></div></body></html>