package asai

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

asai
- Asai
  - Diagnostic
    
    Code
  - Explication
  - Explicator
    
    Make
    
    Style
    
    _
    
    Reader
    
    S
    
    Style
    
    Style
  - FileReader
  - GitHub
    
    Make
    
    Code
  - Logger
    
    Make
    
    Code
    
    S
    
    Code
  - Lsp
    
    Make
    
    Code
  - Span
  - Tty
    
    Make
    
    Code

Legend:
Library
Module
Module type
Parameter
Class
Class type

This module provides functions to display or interact with diagnostics in UNIX terminals. A message will look like this:

    🭁 examples/stlc/example.lambda
    │
  1 │ (check (λ ä (λ 123
  2 │   sdaf)) (→ ℕ (→ ℕ ℕ)))
    ┊
 20 │ ahhhhhhhhhhhhhhhhhh
 21 │ noooooooooooooooooo
    ┷
 [E002] Why am I checking the term (→ ℕ (→ ℕ ℕ)),
        which looks amazing?

Parameters

module Code : Diagnostic.Code

Signature

val display : 
  ?show_backtrace:bool ->
  ?line_breaking:[ `Unicode | `Traditional ] ->
  ?block_splitting_threshold:int ->
  ?tab_size:int ->
  Code.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:

    🭁 examples/stlc/example1.lambda
    │
  1 │ (check (λ ä (λ 123
  2 │   sdaf)) (→ ℕ (→ ℕ ℕ)))
    ┊
 20 │ ahhhhhhhhhhhhhhhhhh
 21 │ noooooooooooooooooo
    ┷
    🭁 examples/stlc/example2.lambda
    │
  3 │ let x = 1 // additional information
  4 │ let y = 1
    ┷
    🭁 examples/stlc/example3.lambda
    │
  8 │ assert (asai is cool)
    ┷
 [E002] Why am I checking the term (→ ℕ (→ ℕ ℕ))?

parameter show_backtrace
Whether the backtrace should be shown. The default is false.

parameter line_breaking
The algorithm to recognize (hard) line breaks. The `Unicode algorithm recognizes all Unicode character sequences in Unicode 15.0.0 Table 5-1 as line breaks. The `Traditional algorithm only recognizes U+000A (LF), U+000D (CR), and U+000D U+000A (CRLF) as line breaks. The default is the `Traditional algorithm.

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.

val interactive_trace : 
  ?line_breaking:[ `Unicode | `Traditional ] ->
  ?block_splitting_threshold:int ->
  ?tab_size:int ->
  Code.t Diagnostic.t ->
  unit

interactive_trace d drops the user in a small interactive terminal app where they can cycle through the message provided in d and its backtrace.

parameter line_breaking
The algorithm to recognize (hard) line breaks. The `Unicode algorithm recognizes all Unicode character sequences in Unicode 15.0.0 Table 5-1 as line breaks. The `Traditional algorithm only recognizes U+000A (LF), U+000D (CR), and U+000D U+000A (CRLF) as line breaks. The default is the `Traditional algorithm.

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.