From c7ba9f550ce93f1fef75b7c6b73a5b16557db937 Mon Sep 17 00:00:00 2001 From: favonia Date: Mon, 13 Nov 2023 05:23:05 +0000 Subject: [PATCH] deploy: db891396bfe7e79516b6215070b7536cac96b726 --- asai/Asai/Explicator/Make/index.html | 6 +++--- asai/Asai/Explicator/index.html | 2 +- asai/Asai/Explicator/module-type-S/index.html | 6 +++--- asai/Asai/Tty/Make/index.html | 4 ++-- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/asai/Asai/Explicator/Make/index.html b/asai/Asai/Explicator/Make/index.html index b6511a2..0202a94 100644 --- a/asai/Asai/Explicator/Make/index.html +++ b/asai/Asai/Explicator/Make/index.html @@ -1,8 +1,8 @@ -Make (asai.Asai.Explicator.Make)

Module Explicator.Make

Making an explicator.

Parameters

module Tag : Tag

Signature

exception Unexpected_end_of_source of Range.position

Unexpected_end_of_source pos means the pos lies beyond the end of source. This usually means the file has been truncated after the parsing.

exception Unexpected_line_num_increment of Range.position

Unexpected_line_num_increment pos means the line number of pos 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.

exception Unexpected_newline of Range.position

Unexpected_newline pos means the line number of pos 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.

exception Unexpected_position_in_newline of Range.position

Unexpected_position_in_newline pos means the position pos is in the middle of a newline. This can happen when the newline consists of multiple bytes, for example 0x0D 0x0A. It usually indicates that there's something wrong with the lexer, or that the file has changed since the parsing.

val explicate : - ?debug:bool -> +Make (asai.Asai.Explicator.Make)

Module Explicator.Make

Making an explicator.

Parameters

module Tag : Tag

Signature

val explicate : ?line_breaks:[ `Unicode | `Traditional ] -> ?block_splitting_threshold:int -> ?blend:(Tag.t -> Tag.t -> Tag.t) -> + ?debug:bool -> (Tag.t * Range.t) list -> - Tag.t Explication.t

Explicate a list of ranges using content from a data reader. This function must be run under SourceReader.run.

  • parameter debug

    Whether to enable the debug mode that performs extra checking. The default is false.

  • parameter line_breaks

    The set of character sequences that are recognized as (hard) line breaks. The `Unicode set contains all Unicode character sequences in Unicode 15.0.0 Table 5-1. The `Traditional set only contains U+000A (LF), U+000D (CR), and U+000D U+000A (CRLF) as line breaks. The default is the `Traditional set.

  • parameter block_splitting_threshold

    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.

  • parameter blend

    The algorithm to blend two tags on a visual range. The default algorithm chooses the more important tag based on priority.

+ Tag.t Explication.t

Explicate a list of ranges using content from a data reader. This function must be run under SourceReader.run.

  • parameter line_breaks

    The set of character sequences that are recognized as (hard) line breaks. The `Unicode set contains all Unicode character sequences in Unicode 15.0.0 Table 5-1. The `Traditional set only contains U+000A (LF), U+000D (CR), and U+000D U+000A (CRLF) as line breaks. The default is the `Traditional set.

  • parameter block_splitting_threshold

    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.

  • parameter blend

    The algorithm to blend two tags on a visual range. The default algorithm chooses the more important tag based on priority.

  • parameter debug

    Whether to enable the debug mode that performs expensive extra checking. The default is false.

diff --git a/asai/Asai/Explicator/index.html b/asai/Asai/Explicator/index.html index 2a490fd..c888e12 100644 --- a/asai/Asai/Explicator/index.html +++ b/asai/Asai/Explicator/index.html @@ -1,2 +1,2 @@ -Explicator (asai.Asai.Explicator)

Module Asai.Explicator

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.

module type Tag = sig ... end

The signature of tags

module type S = sig ... end

The signature of explicators.

val default_blend : priority:('tag -> int) -> 'tag -> 'tag -> 'tag

The default tag blending algorithm that chooses the more important tag based on priority.

module Make (Tag : Tag) : S with module Tag := Tag

Making an explicator.

+Explicator (asai.Asai.Explicator)

Module Asai.Explicator

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.

exception Unexpected_end_of_source of Range.position

Unexpected_end_of_source pos means the pos lies beyond the end of source. This usually means the file has been truncated after the parsing.

exception Unexpected_line_num_increment of Range.position

Unexpected_line_num_increment pos means the line number of pos 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.

exception Unexpected_newline of Range.position

Unexpected_newline pos means the line number of pos 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.

exception Unexpected_position_in_newline of Range.position

Unexpected_position_in_newline pos means the position pos is in the middle of a newline. This can happen when the newline consists of multiple bytes, for example 0x0D 0x0A. It usually indicates that there's something wrong with the lexer, or that the file has changed since the parsing.

exception Invalid_ranges of [ `Traditional | `Unicode ] * Range.t list

Invalid_ranges (line_breaks, ranges) means all the ranges contain invalid line numbers or other impossible values. The line_breaks 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 debug argument of Explicator.S.explicate.

module type Tag = sig ... end

The signature of tags

module type S = sig ... end

The signature of explicators.

val default_blend : priority:('tag -> int) -> 'tag -> 'tag -> 'tag

The default tag blending algorithm that chooses the more important tag based on priority.

module Make (Tag : Tag) : S with module Tag := Tag

Making an explicator.

diff --git a/asai/Asai/Explicator/module-type-S/index.html b/asai/Asai/Explicator/module-type-S/index.html index 33992da..49971bc 100644 --- a/asai/Asai/Explicator/module-type-S/index.html +++ b/asai/Asai/Explicator/module-type-S/index.html @@ -1,8 +1,8 @@ -S (asai.Asai.Explicator.S)

Module type Explicator.S

The signature of explicators.

module Tag : Tag
exception Unexpected_end_of_source of Range.position

Unexpected_end_of_source pos means the pos lies beyond the end of source. This usually means the file has been truncated after the parsing.

exception Unexpected_line_num_increment of Range.position

Unexpected_line_num_increment pos means the line number of pos 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.

exception Unexpected_newline of Range.position

Unexpected_newline pos means the line number of pos 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.

exception Unexpected_position_in_newline of Range.position

Unexpected_position_in_newline pos means the position pos is in the middle of a newline. This can happen when the newline consists of multiple bytes, for example 0x0D 0x0A. It usually indicates that there's something wrong with the lexer, or that the file has changed since the parsing.

val explicate : - ?debug:bool -> +S (asai.Asai.Explicator.S)

Module type Explicator.S

The signature of explicators.

module Tag : Tag
val explicate : ?line_breaks:[ `Unicode | `Traditional ] -> ?block_splitting_threshold:int -> ?blend:(Tag.t -> Tag.t -> Tag.t) -> + ?debug:bool -> (Tag.t * Range.t) list -> - Tag.t Explication.t

Explicate a list of ranges using content from a data reader. This function must be run under SourceReader.run.

  • parameter debug

    Whether to enable the debug mode that performs extra checking. The default is false.

  • parameter line_breaks

    The set of character sequences that are recognized as (hard) line breaks. The `Unicode set contains all Unicode character sequences in Unicode 15.0.0 Table 5-1. The `Traditional set only contains U+000A (LF), U+000D (CR), and U+000D U+000A (CRLF) as line breaks. The default is the `Traditional set.

  • parameter block_splitting_threshold

    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.

  • parameter blend

    The algorithm to blend two tags on a visual range. The default algorithm chooses the more important tag based on priority.

+ Tag.t Explication.t

Explicate a list of ranges using content from a data reader. This function must be run under SourceReader.run.

  • parameter line_breaks

    The set of character sequences that are recognized as (hard) line breaks. The `Unicode set contains all Unicode character sequences in Unicode 15.0.0 Table 5-1. The `Traditional set only contains U+000A (LF), U+000D (CR), and U+000D U+000A (CRLF) as line breaks. The default is the `Traditional set.

  • parameter block_splitting_threshold

    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.

  • parameter blend

    The algorithm to blend two tags on a visual range. The default algorithm chooses the more important tag based on priority.

  • parameter debug

    Whether to enable the debug mode that performs expensive extra checking. The default is false.

diff --git a/asai/Asai/Tty/Make/index.html b/asai/Asai/Tty/Make/index.html index 2b73f15..391d47e 100644 --- a/asai/Asai/Tty/Make/index.html +++ b/asai/Asai/Tty/Make/index.html @@ -1,6 +1,5 @@ Make (asai.Asai.Tty.Make)

Module Tty.Make

This module provides functions to display or interact with diagnostics in UNIX terminals.

Parameters

Signature

val display : - ?debug:bool -> ?output:Stdlib.out_channel -> ?use_ansi:bool -> ?use_color:bool -> @@ -8,6 +7,7 @@ ?line_breaks:[ `Unicode | `Traditional ] -> ?block_splitting_threshold:int -> ?tab_size:int -> + ?debug:bool -> Message.t Diagnostic.t -> unit

display d prints the diagnostic d to the standard output, using terminal control characters for formatting. A message will look like this (but with coloring):

 ￫ warning[hello]
  ╭ ￭ /path/to/file.cool
@@ -17,4 +17,4 @@
  ￭ /path/to/file.cool
  2 | bbbbbbbbbb
  3 | cccccccccc
-   ^ could not say hi here
  • parameter debug

    Whether to enable the debug mode that performs extra checking. The default is false.

  • parameter output

    The output channel, such as stdout or stderr. By default, it is stdout, the standard output.

  • parameter use_ansi

    Whether ANSI escape sequences should be used, overwriting the auto-detection. By default, the auto-detection checks whether the output is a TTY and whether the environment variable TERM is set to a non-empty value other than dumb. Note that this handler is currently using exclusively ANSI escape sequences for highlighting, which means turning them off will lose the precise location. (This may change in the future.)

  • parameter use_color

    Whether colors should be use when ANSI escape sequences are used, overwriting the auto-detection. By default, the auto-detection will turn off the colors if a non-empty value was assigned to the environment variable NO_COLOR. Note that even when the colors are turned off, the handler may still use the bold style, the faint style, and underlines for highlighting. This parameter has no effects if ANSI escape sequences are not used.

  • parameter show_backtrace

    Whether the backtrace should be shown. The default is true.

  • parameter line_breaks

    The set of character sequences that are recognized as (hard) line breaks. The `Unicode set contains all Unicode character sequences in Unicode 15.0.0 Table 5-1. The `Traditional set only contains U+000A (LF), U+000D (CR), and U+000D U+000A (CRLF) as line breaks. The default is the `Traditional set.

  • parameter block_splitting_threshold

    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 5.

  • parameter tab_size

    The number of spaces that should be used to replace a horizontal tab. Note that a horizontal tab is always expanded to the same number of spaces. The result should still be visually appealing as long as horizontal tabs are only used at the beginning of lines. The default value is 8.

  • raises Invalid_argument

    if tab_size < 0.

+ ^ could not say hi here