moonrockz/diagrams/ebnf

README
- ::equalDiagnostic::equal
- ::errorDiagnostic::error
- ::not_equalDiagnostic::not_equal
- ::to_reprDiagnostic::to_repr
- ::warningDiagnostic::warning
- ::equalPosition::equal
- ::not_equalPosition::not_equal
- ::to_reprPosition::to_repr
- ::equalSeverity::equal
- ::not_equalSeverity::not_equal
- ::to_reprSeverity::to_repr
- ::equalSpan::equal
- ::not_equalSpan::not_equal
- ::to_reprSpan::to_repr
V
version

moonrockz/diagrams/ebnf does not have a README file

Grammar

pub struct Grammar {
  id : String
  items : ReadOnlyArray[Item]
  nodes : ReadOnlyArray[Node]
  title : String?
  accessibility_title : String?
  accessibility_description : String?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One immutable grammar diagram. It describes a grammar; it does not parse input.

Grammar::equal

source

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

Grammar::new

source

fn Grammar::new(id : String, items : ArrayView[Item], nodes : ArrayView[Node], title? : String, accessibility_title? : String, accessibility_description? : String) -> Grammar

Grammar::not_equal

source

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

Grammar::rules

source

fn Grammar::rules(self : Grammar) -> Array[Rule]

The rules of the grammar in source order.

Grammar::to_repr

source

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

Index

source

pub struct Index {
  grammar : Grammar
  order : ReadOnlyArray[String]
  // private fields
}

A validated grammar with constant-time lookups. Each expression node has exactly one owner. References are symbolic and never expand definitions.

Index::build

source

fn Index::build(grammar : Grammar, limits? : Limits) -> IndexResult

Validate identities, ownership, references, counts and limits without recursion. Unresolved and ambiguous names are warnings.

Index::depth

source

fn Index::depth(self : Index, id : String) -> Int?

Index::node

source

fn Index::node(self : Index, id : String) -> Node?

Index::owner

source

fn Index::owner(self : Index, id : String) -> String?

The identity of the rule that owns an expression node.

Index::parent

source

fn Index::parent(self : Index, id : String) -> String?

The parent node of an expression node. The body root has no parent.

Index::resolution

source

fn Index::resolution(self : Index, id : String) -> Resolution?

The resolution of a reference node, or None for another node kind.

Index::rule

source

fn Index::rule(self : Index, id : String) -> Rule?

IndexResult

source

pub struct IndexResult {
  index : Index?
  diagnostics : ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]
}

Item

source

pub(all) enum Item {
  Rule(Rule)
  Note(String, String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One ordered grammar statement: a rule or a free-standing note.

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

Kind

source

pub(all) enum Kind {
  Terminal(String, Quote)
  Reference(String, String?)
  Special(String)
  Empty
  Sequence(ReadOnlyArray[String])
  Choice(ReadOnlyArray[String])
  Optional(String)
  ZeroOrMore(String)
  OneOrMore(String)
  Count(String, String)
  Exclusion(String, String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The meaning of one grammar expression node. Composite kinds name their children by node identity, so a grammar is a flat, bounded arena.

Kind::equal

source

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

Kind::not_equal

source

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

Kind::to_repr

source

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

Limits

source

pub struct Limits {
  nodes : Int
  depth : Int
  work : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Explicit bounds for grammar validation and indexing.

Limits::equal

source

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

Limits::new

source

fn Limits::new(nodes? : Int, depth? : Int, work? : Int) -> Limits

Limits::not_equal

source

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

Limits::to_repr

source

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

Node

source

pub struct Node {
  id : String
  kind : Kind
  notes_above : ReadOnlyArray[String]
  notes_below : ReadOnlyArray[String]
  source : @moonrockz/diagrams.Span
Span?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Node::children

source

fn Node::children(self : Node) -> ReadOnlyArray[String]

The children of node in drawing order. An exclusion lists its left term first and its excluded term second.

Node::equal

source

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

Node::is_leaf

source

fn Node::is_leaf(self : Node) -> Bool

Terminals, references, special sequences and empty terms are leaves.

Node::label

source

fn Node::label(self : Node) -> String

Node::new

source

fn Node::new(id : String, kind : Kind, notes_above? : ArrayView[String], notes_below? : ArrayView[String], source? : @moonrockz/diagrams.Span
Span) -> Node

Node::not_equal

source

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

Node::to_repr

source

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

Quote

source

pub(all) enum Quote {
  Double
  Single
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The quote character of a terminal string.

Quote::equal

source

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

Quote::not_equal

source

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

Quote::to_repr

source

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

Resolution

source

pub(all) enum Resolution {
  Resolved(String)
  Unresolved
  Ambiguous(ReadOnlyArray[String])
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

How a reference resolved. Unresolved and ambiguous names stay renderable.

Resolution::equal

source

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

Resolution::not_equal

source

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

Resolution::to_repr

source

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

Rule

source

pub struct Rule {
  id : String
  name : String
  body : String?
  note_above : String?
  note_below : String?
  source : @moonrockz/diagrams.Span
Span?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One named rule. A rule without a body is an empty definition.

Rule::equal

source

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

Rule::new

source

fn Rule::new(id : String, name : String, body? : String, note_above? : String, note_below? : String, source? : @moonrockz/diagrams.Span
Span) -> Rule

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 grammar validation.

validate

source

fn validate(grammar : Grammar, limits? : Limits) -> ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]

Validate a constructed grammar. Errors prevent rendering; warnings for unresolved or ambiguous names do not.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#Grammar

#Grammar::equal

#Grammar::new

#Grammar::not_equal

#Grammar::rules

#Grammar::to_repr

#Index

#Index::build

#Index::depth

#Index::node

#Index::owner

#Index::parent

#Index::resolution

#Index::rule

#IndexResult

#Item

#Item::equal

#Item::not_equal

#Item::to_repr

#Kind

#Kind::equal

#Kind::not_equal

#Kind::to_repr

#Limits

#Limits::equal

#Limits::new

#Limits::not_equal

#Limits::to_repr

#Node

#Node::children

#Node::equal

#Node::is_leaf

#Node::label

#Node::new

#Node::not_equal

#Node::to_repr

#Quote

#Quote::equal

#Quote::not_equal

#Quote::to_repr

#Resolution

#Resolution::equal

#Resolution::not_equal

#Resolution::to_repr

#Rule

#Rule::equal

#Rule::new

#Rule::not_equal

#Rule::to_repr

#diagnostic_codes

#validate

Source Files

Grammar

Grammar::equal

Grammar::new

Grammar::not_equal

Grammar::rules

Grammar::to_repr

Index

Index::build

Index::depth

Index::node

Index::owner

Index::parent

Index::resolution

Index::rule

IndexResult

Item

Item::equal

Item::not_equal

Item::to_repr

Kind

Kind::equal

Kind::not_equal

Kind::to_repr

Limits

Limits::equal

Limits::new

Limits::not_equal

Limits::to_repr

Node

Node::children

Node::equal

Node::is_leaf

Node::label

Node::new

Node::not_equal

Node::to_repr

Quote

Quote::equal

Quote::not_equal

Quote::to_repr

Resolution

Resolution::equal

Resolution::not_equal

Resolution::to_repr

Rule

Rule::equal

Rule::new

Rule::not_equal

Rule::to_repr

diagnostic_codes

validate