moonrockz/diagrams-plantuml/data

pub struct Resolution {
  highlights : Array[@moonrockz/diagrams/data-tree.Highlight]
  diagnostics : Array[@moonrockz/diagrams.Diagnostic]
  complete : Bool
}

The result of selector resolution.

pub(all) enum Segment {
  Name(String)
  Occurrence(String, Int)
  Any
  Deep
} derive(Eq, @moonbitlang/core/debug.Debug)

One segment of a #highlight path.

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

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

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

pub struct Selector {
  segments : ReadOnlyArray[Segment]
  stereotype : String?
  span : @moonrockz/diagrams.Span?
} derive(Eq, @moonbitlang/core/debug.Debug)

A typed #highlight selector. The stereotype is inert author metadata; library themes paint every highlight.

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

fn Selector::is_plain(self : Selector) -> Bool

True when the selector has no wildcard and no occurrence number.

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

Equality without the source span.

fn Selector::new(segments : ArrayView[Segment], stereotype? : String, span? : @moonrockz/diagrams.Span) -> Selector

A selector. The constructor copies segments.

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

fn Selector::to_line(self : Selector) -> String

The canonical source line of the selector, without a line break. Names are quoted, so /, * and < in a name stay literal.

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

fn is_highlight_line(text : String) -> Bool

True when the trimmed line is a #highlight statement.

fn member_id(path : ArrayView[Int]) -> String

The identity of the member occurrence at an ownership path, for example m/0/2. Member identities never use names or scalar text.

fn parse_selector(line : String) -> Result[Selector, String]

Parse the text of a #highlight line. A quoted segment keeps /, < and > inside the segment and accepts \", \\ and \* escapes. A quoted * or ** without escapes is a wildcard, as upstream. Upstream PlantUML splits on every / before it removes quotes; this library does not, so a quoted name that contains / selects one member.

fn read_selectors(scan : @moonrockz/diagrams-plantuml/envelope.Scan, prefix : String) -> (Array[Selector], Array[@moonrockz/diagrams.Diagnostic])

Read the selectors of the #highlight statement lines of a scan. A line that does not parse gives an error with the code <prefix>/invalid-highlight.

fn resolve(tree : @moonrockz/diagrams/data-tree.DataTree, selectors : ArrayView[Selector], prefix : String, work_limit? : Int) -> Resolution

Resolve selectors to member identities of tree, in document order. A selector that selects nothing gives a warning and no highlight. A plain selector that selects more than one member occurrence highlights all of them and gives a warning. A stereotype is kept as inert style metadata and gives a warning that it is not applied. Codes use prefix, for example json/unresolved-highlight.

fn value_id(path : ArrayView[Int]) -> String

The identity of the value at an ownership path. The root value is v; the value of member 2 of the value of root member 0 is v/0/2.