moonrockz/diagrams-plantuml/regex

moonrockz/diagrams-plantuml/regex does not have a README file

Conversion

pub struct Conversion {
  regex : @moonrockz/diagrams/regex.Regex
Regex?
  diagnostics : ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]
}

Document

source

pub struct Document {
  name : String?
  statements : ReadOnlyArray[@moonrockz/diagrams-plantuml/envelope.Statement
Statement]
  pattern : Expr
  text : String
  span : @moonrockz/diagrams.Span
Span?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One parsed regex block.

Document::equal

source

fn Document::equal(Document, Document) -> Bool

Document::logical_equal

source

fn Document::logical_equal(self : Document, other : Document) -> Bool

True when two documents have equal logical content. Source locations, source spelling and trivia are not compared.

Document::new

source

fn Document::new(pattern : Expr, name? : String, statements? : ArrayView[@moonrockz/diagrams-plantuml/envelope.Statement
Statement], text? : String) -> Document

Document::not_equal

source

fn Document::not_equal(x : Document, y : Document) -> Bool

Document::to_repr

source

fn Document::to_repr(Document) -> @moonbitlang/core/debug.Repr
Repr

Document::without_spans

source

fn Document::without_spans(self : Document) -> Document

The document without source locations and source spelling.

Expr

source

pub(all) enum Expr {
  Char(String, Bool, @moonrockz/diagrams.Span
Span?)
  Class(@moonrockz/diagrams/regex.ClassKind
ClassKind, @moonrockz/diagrams.Span
Span?)
  Backreference(String, @moonrockz/diagrams.Span
Span?)
  Set(Bool, ReadOnlyArray[@moonrockz/diagrams/regex.SetItem
SetItem], @moonrockz/diagrams.Span
Span?)
  Anchor(@moonrockz/diagrams/regex.AnchorKind
AnchorKind, @moonrockz/diagrams.Span
Span?)
  Concat(ReadOnlyArray[Expr])
  Alt(ReadOnlyArray[Expr])
  Group(@moonrockz/diagrams/regex.GroupKind
GroupKind, Expr, @moonrockz/diagrams.Span
Span?)
  Look(@moonrockz/diagrams/regex.Look
Look, Bool, Expr, @moonrockz/diagrams.Span
Span?)
  Quantified(Expr, @moonrockz/diagrams/regex.Bounds
Bounds, @moonrockz/diagrams.Span
Span?)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One typed regex expression. Composite nodes are flat: a concatenation never holds another concatenation directly, and an alternation never holds another alternation directly.

Expr::equal

source

fn Expr::equal(Expr, Expr) -> Bool

Expr::not_equal

source

fn Expr::not_equal(x : Expr, y : Expr) -> Bool

Expr::to_repr

source

fn Expr::to_repr(Expr) -> @moonbitlang/core/debug.Repr
Repr

Expr::without_spans

source

fn Expr::without_spans(self : Expr) -> Expr

The expression without source locations, for logical comparison.

ReadResult

source

pub struct ReadResult {
  nodes : Array[@moonrockz/diagrams-plantuml/cst.Node
Node]
  document : Document?
  diagnostics : ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]
}

diagnostic_codes

source

let diagnostic_codes : ReadOnlyArray[String]

The stable diagnostic codes of the regex reader and writer.

print_body

source

fn print_body(document : Document, limits? : @moonrockz/diagrams-plantuml/envelope.Limits
Limits) -> Result[String, ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]]

The canonical body of a regex document: one pattern line with a line break.

print_pattern

source

fn print_pattern(expr : Expr, limits? : @moonrockz/diagrams-plantuml/envelope.Limits
Limits) -> Result[String, ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]]

Write a pattern from typed values. An expression that the reader cannot read back to the same value gives a diagnostic instead of text.

read

source

fn read(scan : @moonrockz/diagrams-plantuml/envelope.Scan
Scan, limits? : @moonrockz/diagrams-plantuml/envelope.Limits
Limits) -> ReadResult

Read the body of a scanned regex block. The block has exactly one pattern line; further pattern lines are an error.

to_regex

source

fn to_regex(document : Document, id? : String, limits? : @moonrockz/diagrams-plantuml/envelope.Limits
Limits) -> Conversion

Convert a regex document to the format-independent model. Adjacent characters of a concatenation become one literal term, as PlantUML draws them. Node identities are ordered ownership paths, never labels.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#Conversion

#Document

#Document::equal

#Document::logical_equal

#Document::new

#Document::not_equal

#Document::to_repr

#Document::without_spans

#Expr

#Expr::equal

#Expr::not_equal

#Expr::to_repr

#Expr::without_spans

#ReadResult

#diagnostic_codes

#print_body

#print_pattern

#read

#to_regex

Source Files

Conversion

Document

Document::equal

Document::logical_equal

Document::new

Document::not_equal

Document::to_repr

Document::without_spans

Expr

Expr::equal

Expr::not_equal

Expr::to_repr

Expr::without_spans

ReadResult

diagnostic_codes

print_body

print_pattern

read

to_regex