moonrockz/diagrams-plantuml/ebnf

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

Conversion

pub struct Conversion {
  grammar : @moonrockz/diagrams/ebnf.Grammar
Grammar?
  diagnostics : ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]
}

Document

source

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

Document::equal

source

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

Document::logical_equal

source

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

Document::new

source

fn Document::new(items : ArrayView[Item], name? : String, statements? : ArrayView[@moonrockz/diagrams-plantuml/envelope.Statement
Statement]) -> 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

Expr

source

pub(all) enum Expr {
  Terminal(String, @moonrockz/diagrams/ebnf.Quote
Quote, Notes, @moonrockz/diagrams.Span
Span?)
  Name(String, Notes, @moonrockz/diagrams.Span
Span?)
  Special(String, Notes, @moonrockz/diagrams.Span
Span?)
  Concat(ReadOnlyArray[Expr])
  Alt(ReadOnlyArray[Expr])
  Optional(Expr, @moonrockz/diagrams.Span
Span?)
  ZeroOrMore(Expr, @moonrockz/diagrams.Span
Span?)
  OneOrMore(Expr, @moonrockz/diagrams.Span
Span?)
  Count(String, Expr, @moonrockz/diagrams.Span
Span?)
  Not(Expr, @moonrockz/diagrams.Span
Span?)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One typed EBNF expression. Concatenations and alternations are flat. Grouping parentheses are syntax only; the tree records the structure.

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

Item

source

pub(all) enum Item {
  Rule(Rule)
  Note(ReadOnlyArray[String], @moonrockz/diagrams.Span
Span?)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Item::equal

source

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

Item::not_equal

source

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

Item::to_repr

source

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

Notes

source

pub struct Notes {
  above : String?
  below : String?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The note above and the note below a leaf term.

Notes::equal

source

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

Notes::not_equal

source

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

Notes::to_repr

source

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

ReadResult

source

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

Rule

source

pub struct Rule {
  name : String
  body : Expr?
  above : String?
  below : String?
  span : @moonrockz/diagrams.Span
Span?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Rule::equal

source

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

Rule::new

source

fn Rule::new(name : String, body? : Expr, above? : String, below? : String) -> Rule

A rule from typed values, without a source location.

Rule::not_equal

source

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

Rule::to_repr

source

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

diagnostic_codes

source

let diagnostic_codes : ReadOnlyArray[String]

The stable diagnostic codes of the EBNF reader and writer.

no_note

source

let no_note : Notes

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 an EBNF document: one line per rule and per note line, derived from typed values.

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 EBNF block. Statements dispatch in the order of the pinned reader: whole-line notes, multi-line notes, single-line rules and multi-line rules. A rule that PlantUML draws as "Syntax error!" is an error here.

to_grammar

source

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

Convert an EBNF document to the format-independent grammar model. Names stay symbolic references; recursive rules are never expanded. An exclusion constrains the term before it and is never an alternative.

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

#Item

#Item::equal

#Item::not_equal

#Item::to_repr

#Notes

#Notes::equal

#Notes::not_equal

#Notes::to_repr

#ReadResult

#Rule

#Rule::equal

#Rule::new

#Rule::not_equal

#Rule::to_repr

#diagnostic_codes

#no_note

#print_body

#read

#to_grammar

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

Item

Item::equal

Item::not_equal

Item::to_repr

Notes

Notes::equal

Notes::not_equal

Notes::to_repr

ReadResult

Rule

Rule::equal

Rule::new

Rule::not_equal

Rule::to_repr

diagnostic_codes

no_note

print_body

read

to_grammar