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

24 lines
No EOL
9.6 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>Builtin_attributes (ocaml.Builtin_attributes)</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; Builtin_attributes</nav><header class="odoc-preamble"><h1>Module <code><span>Builtin_attributes</span></code></h1><p>Support for some of the builtin attributes</p><ul><li>ocaml.deprecated</li><li>ocaml.alert</li><li>ocaml.error</li><li>ocaml.ppwarning</li><li>ocaml.warning</li><li>ocaml.warnerror</li><li>ocaml.explicit_arity (for camlp4/camlp5)</li><li>ocaml.warn_on_literal_pattern</li><li>ocaml.deprecated_mutable</li><li>ocaml.immediate</li><li>ocaml.immediate64</li><li>ocaml.boxed / ocaml.unboxed</li></ul><p><b>Warning:</b> this module is unstable and part of <span class="xref-unresolved">compiler-libs</span>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-check_alerts"><a href="#val-check_alerts" class="anchor"></a><code><span><span class="keyword">val</span> check_alerts : <span><a href="../Location/index.html#type-t">Location.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../Parsetree/index.html#type-attributes">Parsetree.attributes</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-check_alerts_inclusion"><a href="#val-check_alerts_inclusion" class="anchor"></a><code><span><span class="keyword">val</span> check_alerts_inclusion :
<span>def:<a href="../Location/index.html#type-t">Location.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>use:<a href="../Location/index.html#type-t">Location.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../Location/index.html#type-t">Location.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../Parsetree/index.html#type-attributes">Parsetree.attributes</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../Parsetree/index.html#type-attributes">Parsetree.attributes</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-alerts_of_attrs"><a href="#val-alerts_of_attrs" class="anchor"></a><code><span><span class="keyword">val</span> alerts_of_attrs : <span><a href="../Parsetree/index.html#type-attributes">Parsetree.attributes</a> <span class="arrow">&#45;&gt;</span></span> <a href="../Misc/index.html#type-alerts">Misc.alerts</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-alerts_of_sig"><a href="#val-alerts_of_sig" class="anchor"></a><code><span><span class="keyword">val</span> alerts_of_sig : <span><a href="../Parsetree/index.html#type-signature">Parsetree.signature</a> <span class="arrow">&#45;&gt;</span></span> <a href="../Misc/index.html#type-alerts">Misc.alerts</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-alerts_of_str"><a href="#val-alerts_of_str" class="anchor"></a><code><span><span class="keyword">val</span> alerts_of_str : <span><a href="../Parsetree/index.html#type-structure">Parsetree.structure</a> <span class="arrow">&#45;&gt;</span></span> <a href="../Misc/index.html#type-alerts">Misc.alerts</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-check_deprecated_mutable"><a href="#val-check_deprecated_mutable" class="anchor"></a><code><span><span class="keyword">val</span> check_deprecated_mutable :
<span><a href="../Location/index.html#type-t">Location.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../Parsetree/index.html#type-attributes">Parsetree.attributes</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-check_deprecated_mutable_inclusion"><a href="#val-check_deprecated_mutable_inclusion" class="anchor"></a><code><span><span class="keyword">val</span> check_deprecated_mutable_inclusion :
<span>def:<a href="../Location/index.html#type-t">Location.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>use:<a href="../Location/index.html#type-t">Location.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../Location/index.html#type-t">Location.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../Parsetree/index.html#type-attributes">Parsetree.attributes</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../Parsetree/index.html#type-attributes">Parsetree.attributes</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-check_no_alert"><a href="#val-check_no_alert" class="anchor"></a><code><span><span class="keyword">val</span> check_no_alert : <span><a href="../Parsetree/index.html#type-attributes">Parsetree.attributes</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-error_of_extension"><a href="#val-error_of_extension" class="anchor"></a><code><span><span class="keyword">val</span> error_of_extension : <span><a href="../Parsetree/index.html#type-extension">Parsetree.extension</a> <span class="arrow">&#45;&gt;</span></span> <a href="../Location/index.html#type-error">Location.error</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-warning_attribute"><a href="#val-warning_attribute" class="anchor"></a><code><span><span class="keyword">val</span> warning_attribute : <span>?ppwarning:bool <span class="arrow">&#45;&gt;</span></span> <span><a href="../Parsetree/index.html#type-attribute">Parsetree.attribute</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Apply warning settings from the specified attribute. &quot;ocaml.warning&quot;/&quot;ocaml.warnerror&quot; (and variants without the prefix) are processed and other attributes are ignored.</p><p>Also implement ocaml.ppwarning (unless ~ppwarning:false is passed).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-warning_scope"><a href="#val-warning_scope" class="anchor"></a><code><span><span class="keyword">val</span> warning_scope :
<span>?ppwarning:bool <span class="arrow">&#45;&gt;</span></span>
<span><a href="../Parsetree/index.html#type-attributes">Parsetree.attributes</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>Execute a function in a new scope for warning settings. This means that the effect of any call to <code>warning_attribute</code> during the execution of this function will be discarded after execution.</p><p>The function also takes a list of attributes which are processed with <code>warning_attribute</code> in the fresh scope before the function is executed.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-warn_on_literal_pattern"><a href="#val-warn_on_literal_pattern" class="anchor"></a><code><span><span class="keyword">val</span> warn_on_literal_pattern : <span><a href="../Parsetree/index.html#type-attributes">Parsetree.attributes</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-explicit_arity"><a href="#val-explicit_arity" class="anchor"></a><code><span><span class="keyword">val</span> explicit_arity : <span><a href="../Parsetree/index.html#type-attributes">Parsetree.attributes</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-immediate"><a href="#val-immediate" class="anchor"></a><code><span><span class="keyword">val</span> immediate : <span><a href="../Parsetree/index.html#type-attributes">Parsetree.attributes</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-immediate64"><a href="#val-immediate64" class="anchor"></a><code><span><span class="keyword">val</span> immediate64 : <span><a href="../Parsetree/index.html#type-attributes">Parsetree.attributes</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-has_unboxed"><a href="#val-has_unboxed" class="anchor"></a><code><span><span class="keyword">val</span> has_unboxed : <span><a href="../Parsetree/index.html#type-attributes">Parsetree.attributes</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-has_boxed"><a href="#val-has_boxed" class="anchor"></a><code><span><span class="keyword">val</span> has_boxed : <span><a href="../Parsetree/index.html#type-attributes">Parsetree.attributes</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div></div></body></html>