moonrockz/diagrams-svg/railroad-layout

README
- ::equalChannelStyle::equal
- ::hiddenChannelStyle::hidden
- ::newChannelStyle::new
- ::not_equalChannelStyle::not_equal
- ::to_reprChannelStyle::to_repr
- ::equalConnectorCommand::equal
- ::not_equalConnectorCommand::not_equal
- ::to_reprConnectorCommand::to_repr
- ::equalConnectorGeometry::equal
- ::not_equalConnectorGeometry::not_equal
- ::to_reprConnectorGeometry::to_repr
- ::equalConnectorLimits::equal
- ::newConnectorLimits::new
- ::not_equalConnectorLimits::not_equal
- ::to_reprConnectorLimits::to_repr
- ::equalConnectorObstacle::equal
- ::not_equalConnectorObstacle::not_equal
- ::to_reprConnectorObstacle::to_repr
- ::equalConnectorOptions::equal
- ::newConnectorOptions::new
- ::not_equalConnectorOptions::not_equal
- ::to_reprConnectorOptions::to_repr
- ::equalConnectorPath::equal
- ::newConnectorPath::new
- ::not_equalConnectorPath::not_equal
- ::parseConnectorPath::parse
- ::svgConnectorPath::svg
- ::to_reprConnectorPath::to_repr
- ::equalConnectorPoint::equal
- ::not_equalConnectorPoint::not_equal
- ::to_reprConnectorPoint::to_repr
- ::equalConnectorStyle::equal
- ::not_equalConnectorStyle::not_equal
- ::to_reprConnectorStyle::to_repr
- ::equalCrossingMode::equal
- ::not_equalCrossingMode::not_equal
- ::to_reprCrossingMode::to_repr
- ::equalMode::equal
- ::not_equalMode::not_equal
- ::to_reprMode::to_repr
T
NodeBinding
- ::equalNodeBindingKind::equal
- ::not_equalNodeBindingKind::not_equal
- ::to_reprNodeBindingKind::to_repr
T
PathBinding
- ::equalResolvedConnector::equal
- ::not_equalResolvedConnector::not_equal
- ::to_reprResolvedConnector::to_repr
T
Scene
T
SceneResult
- ::connector_geometrySvgRenderer::connector_geometry
- ::newSvgRenderer::new
- ::renderSvgRenderer::render
- ::render_tracedSvgRenderer::render_traced
- ::sceneSvgRenderer::scene
- ::equalTraceHighlight::equal
- ::newTraceHighlight::new
- ::not_equalTraceHighlight::not_equal
- ::to_reprTraceHighlight::to_repr
- ::refusedTracedRender::refused
- ::equalVariant::equal
- ::not_equalVariant::not_equal
- ::to_reprVariant::to_repr
V
bpmn_geometry_path
V
bpmn_path
V
check_connectors
V
flowchart_path
V
inspect_connectors
V
render_architecture
V
render_data_tree
V
render_ebnf
V
render_flowchart
V
render_regex
V
render_sequence
V
render_swimlane
V
swimlane_path

moonrockz/diagrams-svg/railroad-layout does not have a README file

Channel

pub(all) enum Channel {
  Matched
  NotMatched
  Taken
  Failure
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The four static trace highlight channels.

Channel::equal

source

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

Channel::not_equal

source

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

Channel::to_repr

source

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

Finding

source

pub struct Finding {
  rule : Rule
  identities : ReadOnlyArray[String]
  message : String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Finding::equal

source

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

Finding::not_equal

source

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

Finding::to_repr

source

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

Frame

source

pub struct Frame {
  owner : String
  role : FrameRole
  rect : Rect
  label : Label
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Frame::equal

source

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

Frame::not_equal

source

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

Frame::to_repr

source

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

FrameRole

source

pub(all) enum FrameRole {
  Group
  Except
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

FrameRole::equal

source

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

FrameRole::not_equal

source

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

FrameRole::to_repr

source

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

Geometry

source

pub struct Geometry {
  topology : @moonrockz/diagrams/railroad-trace.Topology
Topology
  width : Double
  height : Double
  title : Label?
  tracks : ReadOnlyArray[TrackBox]
  terms : ReadOnlyArray[TermBox]
  frames : ReadOnlyArray[Frame]
  wires : ReadOnlyArray[Wire]
  notes : ReadOnlyArray[NoteBox]
  // private fields
}

Deterministic railroad geometry. Every drawn connector of the topology has one wire; every term has one box.

Geometry::new

source

fn Geometry::new(topology : @moonrockz/diagrams/railroad-trace.Topology
Topology, width : Double, height : Double, tracks : ArrayView[TrackBox], terms : ArrayView[TermBox], frames : ArrayView[Frame], wires : ArrayView[Wire], notes : ArrayView[NoteBox], points : ArrayView[(String, Point)], title? : Label) -> Geometry

Make geometry from parts, for tests of the legibility checker.

Geometry::point

source

fn Geometry::point(self : Geometry, id : String) -> Point?

The coordinates of a topology point.

Geometry::points

source

fn Geometry::points(self : Geometry) -> Array[(String, Point)]

Label

source

pub struct Label {
  lines : ReadOnlyArray[String]
  x : Double
  size : Double
  weight : Int
  box : Rect
  owner : String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Measured text. x is the horizontal centre and box the text bounds.

Label::equal

source

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

Label::not_equal

source

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

Label::to_repr

source

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

Limits

source

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

Explicit bounds for railroad layout and painting.

Limits::equal

source

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

Limits::new

source

fn Limits::new(nodes? : Int, depth? : Int, work? : Int, width? : Int, output_units? : Int, minimum_approach? : Double) -> 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

Limits::with_minimum_approach

source

fn Limits::with_minimum_approach(self : Limits, minimum_approach : Double) -> Limits

Model

source

pub(all) enum Model {
  Regex(@moonrockz/diagrams/regex.Regex
Regex)
  Ebnf(@moonrockz/diagrams/ebnf.Grammar
Grammar)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The two railroad source models.

Model::equal

source

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

Model::not_equal

source

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

Model::to_repr

source

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

NoteBox

source

pub struct NoteBox {
  id : String
  rect : Rect
  label : Label
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

NoteBox::equal

source

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

NoteBox::not_equal

source

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

NoteBox::to_repr

source

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

Point

source

pub(all) struct Point {
  x : Double
  y : Double
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Point::equal

source

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

Point::not_equal

source

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

Point::to_repr

source

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

Rect

source

pub(all) struct Rect {
  x : Double
  y : Double
  width : Double
  height : Double
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Rect::contains

source

fn Rect::contains(self : Rect, other : Rect, tolerance? : Double) -> Bool

Rect::equal

source

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

Rect::not_equal

source

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

Rect::overlaps

source

fn Rect::overlaps(self : Rect, other : Rect) -> Bool

Rect::to_repr

source

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

Result

source

pub struct Result {
  geometry : Geometry?
  diagnostics : ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]
}

Rule

source

pub(all) enum Rule {
  Overlap
  Fit
  Contrast
  Endpoint
  Length
  Limit
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Rule::equal

source

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

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

Shape

source

pub(all) enum Shape {
  Pill
  Square
  Class
  Special
  Anchor
  Lookaround
  Dot
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The visual form of a term.

Shape::equal

source

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

Shape::not_equal

source

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

Shape::to_repr

source

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

TermBox

source

pub struct TermBox {
  term : @moonrockz/diagrams/railroad-trace.Term
Term
  shape : Shape
  rect : Rect
  label : Label
  notes : ReadOnlyArray[Label]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

TermBox::equal

source

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

TermBox::not_equal

source

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

TermBox::to_repr

source

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

TermBox::with_rect

source

fn TermBox::with_rect(self : TermBox, rect : Rect) -> TermBox

The term with another rectangle, for supplied test geometry.

TrackBox

source

pub struct TrackBox {
  track : @moonrockz/diagrams/railroad-trace.Track
Track
  label : Label
  start : Point
  end : Point
  notes : ReadOnlyArray[Label]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

TrackBox::equal

source

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

TrackBox::not_equal

source

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

TrackBox::to_repr

source

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

Wire

source

pub struct Wire {
  connector : @moonrockz/diagrams/railroad-trace.Connector
Connector
  points : ReadOnlyArray[Point]
  label : Label?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The drawn path of one connector, as a polyline in its semantic direction. Corners are rounded when painted.

Wire::equal

source

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

Wire::length

source

fn Wire::length(self : Wire) -> Double

The polyline length of a wire.

Wire::not_equal

source

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

Wire::path

source

fn Wire::path(self : Wire, radius? : Double) -> String

The SVG path data of a wire, with rounded corners.

Wire::to_repr

source

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

Wire::with_points

source

fn Wire::with_points(self : Wire, points : ArrayView[Point]) -> Wire

The wire with other points, for supplied test geometry.

channel_color

source

fn channel_color(palette : @moonrockz/diagrams-svg/theme.Palette
Palette, channel : Channel) -> @moonrockz/diagrams-svg/theme.Color
Color

The theme colour of a highlight channel.

check

source

fn check(geometry : Geometry, palette : @moonrockz/diagrams-svg/theme.Palette
Palette, work_limit? : Int, highlight_colors? : ArrayView[@moonrockz/diagrams-svg/theme.Color
Color]) -> Array[Finding]

Check attachment, connector length, crossings, label fit and contrast. colors overrides the highlight colours to check, for example caller styles of a trace highlight.

layout

source

fn layout(model : Model, limits? : Limits) -> Result

Lay out a regex or grammar railroad. Rules stay in source order; each drawn connector of the topology gets one wire.

svg_number

source

fn svg_number(value : Double) -> String

Format a coordinate for SVG with at most three decimals.

term_colors

source

fn term_colors(palette : @moonrockz/diagrams-svg/theme.Palette
Palette, shape : Shape) -> (@moonrockz/diagrams-svg/theme.Color
Color, @moonrockz/diagrams-svg/theme.Color
Color, @moonrockz/diagrams-svg/theme.Color
Color)

The fill, stroke and text colours of a term shape in one palette. The painter and the checker use the same choice.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#Channel

#Channel::equal

#Channel::not_equal

#Channel::to_repr

#Finding

#Finding::equal

#Finding::not_equal

#Finding::to_repr

#Frame

#Frame::equal

#Frame::not_equal

#Frame::to_repr

#FrameRole

#FrameRole::equal

#FrameRole::not_equal

#FrameRole::to_repr

#Geometry

#Geometry::new

#Geometry::point

#Geometry::points

#Label

#Label::equal

#Label::not_equal

#Label::to_repr

#Limits

#Limits::equal

#Limits::new

#Limits::not_equal

#Limits::to_repr

#Limits::with_minimum_approach

#Model

#Model::equal

#Model::not_equal

#Model::to_repr

#NoteBox

#NoteBox::equal

#NoteBox::not_equal

#NoteBox::to_repr

#Point

#Point::equal

#Point::not_equal

#Point::to_repr

#Rect

#Rect::contains

#Rect::equal

#Rect::not_equal

#Rect::overlaps

#Rect::to_repr

#Result

#Rule

#Rule::equal

#Rule::not_equal

#Rule::to_repr

#Shape

#Shape::equal

#Shape::not_equal

#Shape::to_repr

#TermBox

#TermBox::equal

#TermBox::not_equal

#TermBox::to_repr

#TermBox::with_rect

#TrackBox

#TrackBox::equal

#TrackBox::not_equal

#TrackBox::to_repr

#Wire

#Wire::equal

#Wire::length

#Wire::not_equal

#Wire::path

#Wire::to_repr

#Wire::with_points

#channel_color

#check

#layout

#svg_number

#term_colors

Source Files

Channel

Channel::equal

Channel::not_equal

Channel::to_repr

Finding

Finding::equal

Finding::not_equal

Finding::to_repr

Frame

Frame::equal

Frame::not_equal

Frame::to_repr

FrameRole

FrameRole::equal

FrameRole::not_equal

FrameRole::to_repr

Geometry

Geometry::new

Geometry::point

Geometry::points

Label

Label::equal

Label::not_equal

Label::to_repr

Limits

Limits::equal

Limits::new

Limits::not_equal

Limits::to_repr

Limits::with_minimum_approach

Model

Model::equal

Model::not_equal

Model::to_repr

NoteBox

NoteBox::equal

NoteBox::not_equal

NoteBox::to_repr

Point

Point::equal

Point::not_equal

Point::to_repr

Rect

Rect::contains

Rect::equal

Rect::not_equal

Rect::overlaps

Rect::to_repr

Result

Rule

Rule::equal

Rule::not_equal

Rule::to_repr

Shape

Shape::equal

Shape::not_equal

Shape::to_repr

TermBox

TermBox::equal

TermBox::not_equal

TermBox::to_repr

TermBox::with_rect

TrackBox

TrackBox::equal

TrackBox::not_equal

TrackBox::to_repr

Wire

Wire::equal

Wire::length

Wire::not_equal

Wire::path

Wire::to_repr

Wire::with_points

channel_color

check

layout

svg_number

term_colors