moonpool/dev/ocaml/Ast_helper/index.html
2023-08-28 17:11:38 +00:00

2 lines
No EOL
14 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>Ast_helper (ocaml.Ast_helper)</title><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><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">ocaml</a> &#x00BB; Ast_helper</nav><header class="odoc-preamble"><h1>Module <code><span>Ast_helper</span></code></h1><p>Helpers to produce Parsetree fragments</p><p><b>Warning</b> This module is unstable and part of <span class="xref-unresolved">compiler-libs</span>.</p></header><nav class="odoc-toc"><ul><li><a href="#default-locations">Default locations</a></li><li><a href="#constants">Constants</a></li><li><a href="#core-language">Core language</a></li><li><a href="#module-language">Module language</a></li><li><a href="#class-language">Class language</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-with_loc"><a href="#type-with_loc" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a with_loc</span></span><span> = <span><span class="type-var">'a</span> <a href="../Location/index.html#type-loc">Location.loc</a></span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-loc"><a href="#type-loc" class="anchor"></a><code><span><span class="keyword">type</span> loc</span><span> = <a href="../Location/index.html#type-t">Location.t</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-lid"><a href="#type-lid" class="anchor"></a><code><span><span class="keyword">type</span> lid</span><span> = <span><a href="../Longident/index.html#type-t">Longident.t</a> <a href="#type-with_loc">with_loc</a></span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-str"><a href="#type-str" class="anchor"></a><code><span><span class="keyword">type</span> str</span><span> = <span>string <a href="#type-with_loc">with_loc</a></span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-str_opt"><a href="#type-str_opt" class="anchor"></a><code><span><span class="keyword">type</span> str_opt</span><span> = <span><span>string option</span> <a href="#type-with_loc">with_loc</a></span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-attrs"><a href="#type-attrs" class="anchor"></a><code><span><span class="keyword">type</span> attrs</span><span> = <span><a href="../Parsetree/index.html#type-attribute">Parsetree.attribute</a> list</span></span></code></div></div><h2 id="default-locations"><a href="#default-locations" class="anchor"></a>Default locations</h2><div class="odoc-spec"><div class="spec value anchored" id="val-default_loc"><a href="#val-default_loc" class="anchor"></a><code><span><span class="keyword">val</span> default_loc : <span><a href="#type-loc">loc</a> <a href="../Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>Default value for all optional location arguments.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_default_loc"><a href="#val-with_default_loc" class="anchor"></a><code><span><span class="keyword">val</span> with_default_loc : <span><a href="#type-loc">loc</a> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span>unit <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Set the <code>default_loc</code> within the scope of the execution of the provided function.</p></div></div><h2 id="constants"><a href="#constants" class="anchor"></a>Constants</h2><div class="odoc-spec"><div class="spec module anchored" id="module-Const"><a href="#module-Const" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Const/index.html">Const</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-Attr"><a href="#module-Attr" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Attr/index.html">Attr</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><h2 id="core-language"><a href="#core-language" class="anchor"></a>Core language</h2><div class="odoc-spec"><div class="spec module anchored" id="module-Typ"><a href="#module-Typ" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Typ/index.html">Typ</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Type expressions</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Pat"><a href="#module-Pat" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Pat/index.html">Pat</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Patterns</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Exp"><a href="#module-Exp" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Exp/index.html">Exp</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Expressions</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Val"><a href="#module-Val" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Val/index.html">Val</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Value declarations</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Type"><a href="#module-Type" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Type/index.html">Type</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Type declarations</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Te"><a href="#module-Te" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Te/index.html">Te</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Type extensions</p></div></div><h2 id="module-language"><a href="#module-language" class="anchor"></a>Module language</h2><div class="odoc-spec"><div class="spec module anchored" id="module-Mty"><a href="#module-Mty" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Mty/index.html">Mty</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Module type expressions</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Mod"><a href="#module-Mod" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Mod/index.html">Mod</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Module expressions</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Sig"><a href="#module-Sig" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Sig/index.html">Sig</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Signature items</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Str"><a href="#module-Str" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Str/index.html">Str</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Structure items</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Md"><a href="#module-Md" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Md/index.html">Md</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Module declarations</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Ms"><a href="#module-Ms" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Ms/index.html">Ms</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Module substitutions</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Mtd"><a href="#module-Mtd" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Mtd/index.html">Mtd</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Module type declarations</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Mb"><a href="#module-Mb" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Mb/index.html">Mb</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Module bindings</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Opn"><a href="#module-Opn" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Opn/index.html">Opn</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Opens</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Incl"><a href="#module-Incl" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Incl/index.html">Incl</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Includes</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Vb"><a href="#module-Vb" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Vb/index.html">Vb</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Value bindings</p></div></div><h2 id="class-language"><a href="#class-language" class="anchor"></a>Class language</h2><div class="odoc-spec"><div class="spec module anchored" id="module-Cty"><a href="#module-Cty" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Cty/index.html">Cty</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Class type expressions</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Ctf"><a href="#module-Ctf" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Ctf/index.html">Ctf</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Class type fields</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Cl"><a href="#module-Cl" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Cl/index.html">Cl</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Class expressions</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Cf"><a href="#module-Cf" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Cf/index.html">Cf</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Class fields</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Ci"><a href="#module-Ci" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Ci/index.html">Ci</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Classes</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Csig"><a href="#module-Csig" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Csig/index.html">Csig</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Class signatures</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Cstr"><a href="#module-Cstr" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Cstr/index.html">Cstr</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Class structures</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Rf"><a href="#module-Rf" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Rf/index.html">Rf</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Row fields</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Of"><a href="#module-Of" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Of/index.html">Of</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Object fields</p></div></div></div></body></html>