Skip to content

Commit

Permalink
deploy: f02634f
Browse files Browse the repository at this point in the history
  • Loading branch information
@just-max
just-max committed Sep 29, 2024
1 parent c82fdf6 commit 303bd31
Show file tree
Hide file tree
Showing 232 changed files with 273 additions and 276 deletions.
2 changes: 1 addition & 1 deletion sig-builder-no-typ-dup/less-power/Ast_check/Feature/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Feature (less-power.Ast_check.Feature)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">less-power</a> &#x00BB; <a href="../index.html">Ast_check</a> &#x00BB; Feature</nav><header class="odoc-preamble"><h1>Module <code><span>Ast_check.Feature</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> t</span><span> = </span></code><ol><li id="type-t.Array" class="def variant constructor anchored"><a href="#type-t.Array" class="anchor"></a><code><span>| </span><span><span class="constructor">Array</span></span></code></li><li id="type-t.Mutable_member" class="def variant constructor anchored"><a href="#type-t.Mutable_member" class="anchor"></a><code><span>| </span><span><span class="constructor">Mutable_member</span></span></code></li><li id="type-t.Object" class="def variant constructor anchored"><a href="#type-t.Object" class="anchor"></a><code><span>| </span><span><span class="constructor">Object</span></span></code></li><li id="type-t.Loop" class="def variant constructor anchored"><a href="#type-t.Loop" class="anchor"></a><code><span>| </span><span><span class="constructor">Loop</span></span></code></li><li id="type-t.Primitive" class="def variant constructor anchored"><a href="#type-t.Primitive" class="anchor"></a><code><span>| </span><span><span class="constructor">Primitive</span></span></code></li><li id="type-t.Internal_name" class="def variant constructor anchored"><a href="#type-t.Internal_name" class="anchor"></a><code><span>| </span><span><span class="constructor">Internal_name</span></span></code></li><li id="type-t.Alert_control" class="def variant constructor anchored"><a href="#type-t.Alert_control" class="anchor"></a><code><span>| </span><span><span class="constructor">Alert_control</span></span></code></li><li id="type-t.Tail_mod_cons" class="def variant constructor anchored"><a href="#type-t.Tail_mod_cons" class="anchor"></a><code><span>| </span><span><span class="constructor">Tail_mod_cons</span></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Set"><a href="#module-Set" class="anchor"></a><code><span><span class="keyword">module</span> Set</span><span> : <span class="xref-unresolved">Stdlib</span>.Set.S <span class="keyword">with</span> <span><span class="keyword">type</span> <span class="xref-unresolved">elt</span> = <span class="xref-unresolved">t</span></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_identifier"><a href="#val-to_identifier" class="anchor"></a><code><span><span class="keyword">val</span> to_identifier : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p>Unique identifier for this feature.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_identifier"><a href="#val-of_identifier" class="anchor"></a><code><span><span class="keyword">val</span> of_identifier : <span>string <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Provides the feature corresponding to a unique identifier returned by <a href="#val-to_identifier"><code>to_identifier</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-minimum"><a href="#val-minimum" class="anchor"></a><code><span><span class="keyword">val</span> minimum : <span class="xref-unresolved">Set</span>.t</span></code></div><div class="spec-doc"><p><a href="#type-t.Primitive"><code>Primitive</code></a> and <a href="#type-t.Internal_name"><code>Internal_name</code></a>, required to prevent circumventing restrictions.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <span class="xref-unresolved">Set</span>.t</span></code></div><div class="spec-doc"><p>Everything but <a href="#type-t.Tail_mod_cons"><code>Tail_mod_cons</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-all"><a href="#val-all" class="anchor"></a><code><span><span class="keyword">val</span> all : <span class="xref-unresolved">Set</span>.t</span></code></div><div class="spec-doc"><p>Everything.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_message"><a href="#val-to_message" class="anchor"></a><code><span><span class="keyword">val</span> to_message : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p>Provide a message explaining why a feature is prohibited.</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Feature (less-power.Ast_check.Feature)</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">less-power</a> &#x00BB; <a href="../index.html">Ast_check</a> &#x00BB; Feature</nav><header class="odoc-preamble"><h1>Module <code><span>Ast_check.Feature</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> t</span><span> = </span></code><ol><li id="type-t.Array" class="def variant constructor anchored"><a href="#type-t.Array" class="anchor"></a><code><span>| </span><span><span class="constructor">Array</span></span></code></li><li id="type-t.Mutable_member" class="def variant constructor anchored"><a href="#type-t.Mutable_member" class="anchor"></a><code><span>| </span><span><span class="constructor">Mutable_member</span></span></code></li><li id="type-t.Object" class="def variant constructor anchored"><a href="#type-t.Object" class="anchor"></a><code><span>| </span><span><span class="constructor">Object</span></span></code></li><li id="type-t.Loop" class="def variant constructor anchored"><a href="#type-t.Loop" class="anchor"></a><code><span>| </span><span><span class="constructor">Loop</span></span></code></li><li id="type-t.Primitive" class="def variant constructor anchored"><a href="#type-t.Primitive" class="anchor"></a><code><span>| </span><span><span class="constructor">Primitive</span></span></code></li><li id="type-t.Internal_name" class="def variant constructor anchored"><a href="#type-t.Internal_name" class="anchor"></a><code><span>| </span><span><span class="constructor">Internal_name</span></span></code></li><li id="type-t.Alert_control" class="def variant constructor anchored"><a href="#type-t.Alert_control" class="anchor"></a><code><span>| </span><span><span class="constructor">Alert_control</span></span></code></li><li id="type-t.Tail_mod_cons" class="def variant constructor anchored"><a href="#type-t.Tail_mod_cons" class="anchor"></a><code><span>| </span><span><span class="constructor">Tail_mod_cons</span></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Set"><a href="#module-Set" class="anchor"></a><code><span><span class="keyword">module</span> Set</span><span> : <span class="xref-unresolved">Stdlib</span>.Set.S <span class="keyword">with</span> <span><span class="keyword">type</span> <span class="xref-unresolved">elt</span> = <span class="xref-unresolved">t</span></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_identifier"><a href="#val-to_identifier" class="anchor"></a><code><span><span class="keyword">val</span> to_identifier : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p>Unique identifier for this feature.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_identifier"><a href="#val-of_identifier" class="anchor"></a><code><span><span class="keyword">val</span> of_identifier : <span>string <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Provides the feature corresponding to a unique identifier returned by <a href="#val-to_identifier"><code>to_identifier</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-minimum"><a href="#val-minimum" class="anchor"></a><code><span><span class="keyword">val</span> minimum : <span class="xref-unresolved">Set</span>.t</span></code></div><div class="spec-doc"><p><a href="#type-t.Primitive"><code>Primitive</code></a> and <a href="#type-t.Internal_name"><code>Internal_name</code></a>, required to prevent circumventing restrictions.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <span class="xref-unresolved">Set</span>.t</span></code></div><div class="spec-doc"><p>Everything but <a href="#type-t.Tail_mod_cons"><code>Tail_mod_cons</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-all"><a href="#val-all" class="anchor"></a><code><span><span class="keyword">val</span> all : <span class="xref-unresolved">Set</span>.t</span></code></div><div class="spec-doc"><p>Everything.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_message"><a href="#val-to_message" class="anchor"></a><code><span><span class="keyword">val</span> to_message : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p>Provide a message explaining why a feature is prohibited.</p></div></div></div></body></html>
2 changes: 1 addition & 1 deletion sig-builder-no-typ-dup/less-power/Ast_check/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Ast_check (less-power.Ast_check)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">less-power</a> &#x00BB; Ast_check</nav><header class="odoc-preamble"><h1>Module <code><span>Ast_check</span></code></h1><p>AST checker.</p><p>Tool to enforce restrictions on what syntax elements are allowed in OCaml code. Restricts use of the following class features and imperative elements:</p><ul><li>class declarations</li><li>class type declarations</li><li>class method calls</li><li>new class expressions</li><li>setting class and record fields</li><li>array literals</li><li><code>while</code> loops</li><li><code>for</code> loops</li><li>declaring records with mutable entries</li><li><code>external</code> declarations</li><li>internal dune modules (<code>Package__Module</code>)</li></ul><p><code>external</code> declarations and internal dune modules are forbidden, as they can be used to circumvent restrictions in the <code>Stdlib</code> replacement. The sequence operator is not forbidden as there would be no point, <code>a; b</code> can be trivially replaced by <code>let _ = a in b</code>.</p><p>An executable is installed as <code>lp-ast-check</code>. All files passed as arguments, and all <code>.ml</code> files contained recursively in directories passed as arguments, are checked. Exits with code <code>0</code> if no violations are detected, <code>1</code> if violations are found, or <code>2</code> if an error occurs.</p></header><nav class="odoc-toc"><ul><li><a href="#ppxlib-transformations">Ppxlib transformations</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Feature"><a href="#module-Feature" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Feature/index.html">Feature</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-violation"><a href="#type-violation" class="anchor"></a><code><span><span class="keyword">type</span> violation</span><span> = </span><span>{</span></code><ol><li id="type-violation.location" class="def record field anchored"><a href="#type-violation.location" class="anchor"></a><code><span>location : <span class="xref-unresolved">Ppxlib</span>.Location.t;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Location of the violation.</p><span class="comment-delim">*)</span></div></li><li id="type-violation.message" class="def record field anchored"><a href="#type-violation.message" class="anchor"></a><code><span>message : <span>string option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Error message.</p><span class="comment-delim">*)</span></div></li><li id="type-violation.feature" class="def record field anchored"><a href="#type-violation.feature" class="anchor"></a><code><span>feature : <a href="Feature/index.html#type-t">Feature.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Which prohibited feature was used.</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>A violation that occurred in the AST.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ast_violations"><a href="#val-ast_violations" class="anchor"></a><code><span><span class="keyword">val</span> ast_violations :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Ast_check (less-power.Ast_check)</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">less-power</a> &#x00BB; Ast_check</nav><header class="odoc-preamble"><h1>Module <code><span>Ast_check</span></code></h1><p>AST checker.</p><p>Tool to enforce restrictions on what syntax elements are allowed in OCaml code. Restricts use of the following class features and imperative elements:</p><ul><li>class declarations</li><li>class type declarations</li><li>class method calls</li><li>new class expressions</li><li>setting class and record fields</li><li>array literals</li><li><code>while</code> loops</li><li><code>for</code> loops</li><li>declaring records with mutable entries</li><li><code>external</code> declarations</li><li>internal dune modules (<code>Package__Module</code>)</li></ul><p><code>external</code> declarations and internal dune modules are forbidden, as they can be used to circumvent restrictions in the <code>Stdlib</code> replacement. The sequence operator is not forbidden as there would be no point, <code>a; b</code> can be trivially replaced by <code>let _ = a in b</code>.</p><p>An executable is installed as <code>lp-ast-check</code>. All files passed as arguments, and all <code>.ml</code> files contained recursively in directories passed as arguments, are checked. Exits with code <code>0</code> if no violations are detected, <code>1</code> if violations are found, or <code>2</code> if an error occurs.</p></header><nav class="odoc-toc"><ul><li><a href="#ppxlib-transformations">Ppxlib transformations</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Feature"><a href="#module-Feature" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Feature/index.html">Feature</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-violation"><a href="#type-violation" class="anchor"></a><code><span><span class="keyword">type</span> violation</span><span> = </span><span>{</span></code><ol><li id="type-violation.location" class="def record field anchored"><a href="#type-violation.location" class="anchor"></a><code><span>location : <span class="xref-unresolved">Ppxlib</span>.Location.t;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Location of the violation.</p><span class="comment-delim">*)</span></div></li><li id="type-violation.message" class="def record field anchored"><a href="#type-violation.message" class="anchor"></a><code><span>message : <span>string option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Error message.</p><span class="comment-delim">*)</span></div></li><li id="type-violation.feature" class="def record field anchored"><a href="#type-violation.feature" class="anchor"></a><code><span>feature : <a href="Feature/index.html#type-t">Feature.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Which prohibited feature was used.</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>A violation that occurred in the AST.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ast_violations"><a href="#val-ast_violations" class="anchor"></a><code><span><span class="keyword">val</span> ast_violations :
<span><span class="optlabel">?prohibited</span>:<span class="xref-unresolved">Feature</span>.Set.t <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?limit</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Ppxlib</span>.structure <span class="arrow">&#45;&gt;</span></span>
Expand Down
Loading

0 comments on commit 303bd31

Please sign in to comment.