-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
9 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (asai.Asai.Explicator.Make)</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> » <a href="../../index.html">Asai</a> » <a href="../index.html">Explicator</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>Explicator.Make</span></code></h1><p>Making an explicator.</p></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-Tag"><a href="#argument-1-Tag" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-Tag/index.html">Tag</a></span><span> : <a href="../module-type-Tag/index.html">Tag</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><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 value anchored" id="val-explicate"><a href="#val-explicate" class="anchor"></a><code><span><span class="keyword">val</span> explicate : | ||
| <span><span class="optlabel">?debug</span>:bool <span class="arrow">-></span></span> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (asai.Asai.Explicator.Make)</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> » <a href="../../index.html">Asai</a> » <a href="../index.html">Explicator</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>Explicator.Make</span></code></h1><p>Making an explicator.</p></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-Tag"><a href="#argument-1-Tag" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-Tag/index.html">Tag</a></span><span> : <a href="../module-type-Tag/index.html">Tag</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec value anchored" id="val-explicate"><a href="#val-explicate" class="anchor"></a><code><span><span class="keyword">val</span> explicate : | ||
| <span><span class="optlabel">?line_breaks</span>:<span>[ `Unicode <span>| `Traditional</span> ]</span> <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?block_splitting_threshold</span>:int <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?blend</span>:<span>(<span><a href="argument-1-Tag/index.html#type-t">Tag.t</a> <span class="arrow">-></span></span> <span><a href="argument-1-Tag/index.html#type-t">Tag.t</a> <span class="arrow">-></span></span> <a href="argument-1-Tag/index.html#type-t">Tag.t</a>)</span> <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?debug</span>:bool <span class="arrow">-></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">-></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">debug</span> <p>Whether to enable the debug mode that performs extra checking. The default is <code>false</code>.</p></li></ul><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="raises"><span class="at-tag">raises</span> <a href="#exception-Unexpected_end_of_source"><code>Unexpected_end_of_source</code></a> <p>See <a href="#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="#exception-Unexpected_line_num_increment"><code>Unexpected_line_num_increment</code></a> <p>See <a href="#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="#exception-Unexpected_newline"><code>Unexpected_newline</code></a> <p>See <a href="#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="#exception-Unexpected_position_in_newline"><code>Unexpected_position_in_newline</code></a> <p>See <a href="#exception-Unexpected_position_in_newline"><code>Unexpected_position_in_newline</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-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> |
Oops, something went wrong.