deploy: 891d627

asai/Asai/Explicator/Make/index.html

@@ -5,4 +5,4 @@
   <span><span class="optlabel">?blend</span>:<span>(<span><a href="argument-1-Tag/index.html#type-t">Tag.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="argument-1-Tag/index.html#type-t">Tag.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="argument-1-Tag/index.html#type-t">Tag.t</a>)</span> <span class="arrow">&#45;&gt;</span></span>
   <span><span class="optlabel">?debug</span>:bool <span class="arrow">&#45;&gt;</span></span>
   <span><span><span>(<a href="argument-1-Tag/index.html#type-t">Tag.t</a> * <a href="../../Range/index.html#type-t">Range.t</a>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
-  <span><a href="argument-1-Tag/index.html#type-t">Tag.t</a> <a href="../../Explication/index.html#type-t">Explication.t</a></span></span></code></div><div class="spec-doc"><p>Explicate a list of ranges using content from a data reader. This function must be run under <code>SourceReader.run</code>.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">line_breaks</span> <p>The set of character sequences that are recognized as (hard) line breaks. The <code>`Unicode</code> set contains all Unicode character sequences in <a href="https://www.unicode.org/versions/Unicode15.0.0/ch05.pdf#G41643">Unicode 15.0.0 Table 5-1.</a> The <code>`Traditional</code> set only contains <code>U+000A (LF)</code>, <code>U+000D (CR)</code>, and <code>U+000D U+000A (CRLF)</code> as line breaks. The default is the <code>`Traditional</code> set.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">block_splitting_threshold</span> <p>The maximum number of consecutive, non-highlighted lines allowed in a block. The function will try to minimize the number of blocks, as long as no block has too many consecutive, non-highlighted lines. A higher threshold will lead to fewer blocks. When the threshold is zero, it means no block can contain any non-highlighted line. The default value is zero.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">blend</span> <p>The algorithm to blend two tags on a visual range. The default algorithm chooses the more important tag based on priority.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">debug</span> <p>Whether to enable the debug mode that performs expensive extra checking. The default is <code>false</code>.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <a href="../index.html#exception-Unexpected_end_of_source"><code>Unexpected_end_of_source</code></a> <p>See <a href="../index.html#exception-Unexpected_end_of_source"><code>Unexpected_end_of_source</code></a>.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <a href="../index.html#exception-Unexpected_line_num_increment"><code>Unexpected_line_num_increment</code></a> <p>See <a href="../index.html#exception-Unexpected_line_num_increment"><code>Unexpected_line_num_increment</code></a>.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <a href="../index.html#exception-Unexpected_newline"><code>Unexpected_newline</code></a> <p>See <a href="../index.html#exception-Unexpected_newline"><code>Unexpected_newline</code></a>.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <a href="../index.html#exception-Unexpected_position_in_newline"><code>Unexpected_position_in_newline</code></a> <p>See <a href="../index.html#exception-Unexpected_position_in_newline"><code>Unexpected_position_in_newline</code></a>.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <a href="../index.html#exception-Invalid_ranges"><code>Invalid_ranges</code></a> <p>See <a href="../index.html#exception-Invalid_ranges"><code>Invalid_ranges</code></a>.</p></li></ul></div></div></div></body></html>
+  <span><a href="argument-1-Tag/index.html#type-t">Tag.t</a> <a href="../../Explication/index.html#type-t">Explication.t</a></span></span></code></div><div class="spec-doc"><p>Explicate a list of ranges using content from a data reader. This function must be run under <code>SourceReader.run</code>.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">line_breaks</span> <p>The set of character sequences that are recognized as (hard) line breaks. The <code>`Unicode</code> set contains all Unicode character sequences in <a href="https://www.unicode.org/versions/Unicode15.0.0/ch05.pdf#G41643">Unicode 15.0.0 Table 5-1.</a> The <code>`Traditional</code> set only contains <code>U+000A (LF)</code>, <code>U+000D (CR)</code>, and <code>U+000D U+000A (CRLF)</code> as line breaks. The default is the <code>`Traditional</code> set.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">block_splitting_threshold</span> <p>The maximum number of consecutive, non-highlighted lines allowed in a block. The function will try to minimize the number of blocks, as long as no block has too many consecutive, non-highlighted lines. A higher threshold will lead to fewer blocks. When the threshold is zero, it means no block can contain any non-highlighted line. The default value is zero.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">blend</span> <p>The algorithm to blend two tags on a visual range. The default algorithm chooses the more important tag based on priority.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">debug</span> <p>Whether to enable the debug mode that performs expensive extra checking. The default is <code>false</code>.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <a href="../index.html#exception-Invalid_range"><code>Invalid_range</code></a> <p>See <a href="../index.html#exception-Invalid_range"><code>Invalid_range</code></a>.</p></li></ul></div></div></div></body></html>

asai/Asai/Explicator/index.html

@@ -1,2 +1,24 @@
 <!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Explicator (asai.Asai.Explicator)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.1"/><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">asai</a> &#x00BB; <a href="../index.html">Asai</a> &#x00BB; Explicator</nav><header class="odoc-preamble"><h1>Module <code><span>Asai.Explicator</span></code></h1><p>Turning location information into highlighted text suitable for rendering. You probably do not need this module unless you want to create your own diagnostic handler.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec exception anchored" id="exception-Unexpected_end_of_source"><a href="#exception-Unexpected_end_of_source" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Unexpected_end_of_source</span> <span class="keyword">of</span> <a href="../Range/index.html#type-position">Range.position</a></span></code></div><div class="spec-doc"><p><code>Unexpected_end_of_source pos</code> means the <code>pos</code> lies beyond the end of source. This usually means the file has been truncated after the parsing.</p></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Unexpected_line_num_increment"><a href="#exception-Unexpected_line_num_increment" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Unexpected_line_num_increment</span> <span class="keyword">of</span> <a href="../Range/index.html#type-position">Range.position</a></span></code></div><div class="spec-doc"><p><code>Unexpected_line_num_increment pos</code> means the line number of <code>pos</code> is larger than than that of its preceding position during explication, but the explicator did not encounter a newline in between. This usually indicates that there's something wrong with the lexer, or that the file has changed since the parsing.</p></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Unexpected_newline"><a href="#exception-Unexpected_newline" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Unexpected_newline</span> <span class="keyword">of</span> <a href="../Range/index.html#type-position">Range.position</a></span></code></div><div class="spec-doc"><p><code>Unexpected_newline pos</code> means the line number of <code>pos</code> is the same as its preceding position during explication, but the explicator encountered a newline in between. This usually indicates that there's something wrong with the lexer, or that the file has changed since the parsing.</p></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Unexpected_position_in_newline"><a href="#exception-Unexpected_position_in_newline" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Unexpected_position_in_newline</span> <span class="keyword">of</span> <a href="../Range/index.html#type-position">Range.position</a></span></code></div><div class="spec-doc"><p><code>Unexpected_position_in_newline pos</code> means the position <code>pos</code> is in the middle of a newline. This can happen when the newline consists of multiple bytes, for example <code>0x0D 0x0A</code>. It usually indicates that there's something wrong with the lexer, or that the file has changed since the parsing.</p></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Invalid_ranges"><a href="#exception-Invalid_ranges" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Invalid_ranges</span> <span class="keyword">of</span> <span>[ `Traditional <span>| `Unicode</span> ]</span> * <span><a href="../Range/index.html#type-t">Range.t</a> list</span></span></code></div><div class="spec-doc"><p><code>Invalid_ranges (line_breaks, ranges)</code> means all the <code>ranges</code> contain invalid line numbers or other impossible values. The <code>line_breaks</code> indicates the set of hard line breaks used to determine line numbers. This exception will be raised only when the debug mode is enabled. See the <code>debug</code> argument of <a href="module-type-S/index.html#val-explicate"><code>Explicator.S.explicate</code></a>.</p></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-Tag"><a href="#module-type-Tag" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-Tag/index.html">Tag</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The signature of tags</p></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The signature of explicators.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_blend"><a href="#val-default_blend" class="anchor"></a><code><span><span class="keyword">val</span> default_blend : <span><span class="label">priority</span>:<span>(<span><span class="type-var">'tag</span> <span class="arrow">&#45;&gt;</span></span> int)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'tag</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'tag</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'tag</span></span></code></div><div class="spec-doc"><p>The default tag blending algorithm that chooses the more important tag based on priority.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> (<a href="Make/argument-1-Tag/index.html">Tag</a> : <a href="module-type-Tag/index.html">Tag</a>) : <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">module</span> <a href="module-type-S/Tag/index.html">Tag</a> := <a href="Make/argument-1-Tag/index.html">Tag</a></span></span></code></div><div class="spec-doc"><p>Making an explicator.</p></div></div></div></body></html>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Explicator (asai.Asai.Explicator)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.1"/><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">asai</a> &#x00BB; <a href="../index.html">Asai</a> &#x00BB; Explicator</nav><header class="odoc-preamble"><h1>Module <code><span>Asai.Explicator</span></code></h1><p>Turning location information into highlighted text suitable for rendering. You probably do not need this module unless you want to create your own diagnostic handler.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec exception anchored" id="exception-Invalid_range"><a href="#exception-Invalid_range" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Invalid_range</span> <span class="keyword">of</span> <a href="../Range/index.html#type-t">Range.t</a>
+  * <span>[ <span>`Begin of
+        <span>[ <span>`Offset of
+            <span>[ <span>`Negative of int</span>
+            <span><span>| `Beyond_end_of_file</span> of int * int</span>
+            <span><span>| `Within_newline</span> of int * <span>(int * int)</span></span> ]</span></span>
+        <span><span>| `Incorrect_start_of_line</span> of int * int</span>
+        <span><span>| `Incorrect_line_num</span> of int * int</span> ]</span></span>
+    <span><span>| `End</span> of
+      <span>[ <span>`Offset of
+          <span>[ <span>`Negative of int</span>
+          <span><span>| `Beyond_end_of_file</span> of int * int</span>
+          <span><span>| `Within_newline</span> of int * <span>(int * int)</span></span> ]</span></span>
+      <span><span>| `Incorrect_start_of_line</span> of int * int</span>
+      <span><span>| `Incorrect_line_num</span> of int * int</span> ]</span></span>
+    <span><span>| `End_of_file</span> of
+      <span>[ <span>`Offset of
+          <span>[ <span>`Negative of int</span>
+          <span><span>| `Beyond_end_of_file</span> of int * int</span>
+          <span><span>| `Within_newline</span> of int * <span>(int * int)</span></span> ]</span></span>
+      <span><span>| `Incorrect_start_of_line</span> of int * int</span>
+      <span><span>| `Incorrect_line_num</span> of int * int</span> ]</span></span>
+    <span><span>| `Not_end_of_file</span> of int * int</span> ]</span></span></code></div><div class="spec-doc"><p><code>Invalid_range (range, reason)</code> means that <code>range</code> is an invalid range because of <code>reason</code>. This exception will be raised only when the debug mode is enabled. See the <code>debug</code> argument of <a href="module-type-S/index.html#val-explicate"><code>Explicator.S.explicate</code></a>.</p></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-Tag"><a href="#module-type-Tag" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-Tag/index.html">Tag</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The signature of tags</p></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The signature of explicators.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_blend"><a href="#val-default_blend" class="anchor"></a><code><span><span class="keyword">val</span> default_blend : <span><span class="label">priority</span>:<span>(<span><span class="type-var">'tag</span> <span class="arrow">&#45;&gt;</span></span> int)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'tag</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'tag</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'tag</span></span></code></div><div class="spec-doc"><p>The default tag blending algorithm that chooses the more important tag based on priority.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> (<a href="Make/argument-1-Tag/index.html">Tag</a> : <a href="module-type-Tag/index.html">Tag</a>) : <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">module</span> <a href="module-type-S/Tag/index.html">Tag</a> := <a href="Make/argument-1-Tag/index.html">Tag</a></span></span></code></div><div class="spec-doc"><p>Making an explicator.</p></div></div></div></body></html>