Milky2018/diago/ast - mooncakes.io

This version of the module is deprecated: Moved to moonbit-community/diago. Use moonbit-community/diago@0.4.0 or later and update import paths.

README
- ::newCompileOptions::new
- ::with_dark_theme_idCompileOptions::with_dark_theme_id
- ::with_dark_theme_overridesCompileOptions::with_dark_theme_overrides
- ::with_directionCompileOptions::with_direction
- ::with_layout_engineCompileOptions::with_layout_engine
- ::with_layout_pluginCompileOptions::with_layout_plugin
- ::with_no_xml_tagCompileOptions::with_no_xml_tag
- ::with_omit_versionCompileOptions::with_omit_version
- ::with_output_modeCompileOptions::with_output_mode
- ::with_parse_optionsCompileOptions::with_parse_options
- ::with_route_pluginCompileOptions::with_route_plugin
- ::with_saltCompileOptions::with_salt
- ::with_scaleCompileOptions::with_scale
- ::with_target_specCompileOptions::with_target_spec
- ::with_theme_nameCompileOptions::with_theme_name
- ::with_theme_overridesCompileOptions::with_theme_overrides
T
CompletionItem
T
CompletionKind
T
LayoutEngine
- ::innerLayoutPlugin::inner
- ::newLayoutPlugin::new
- ::runLayoutPlugin::run
T
OutputMode
- ::newParseOptions::new
- ::with_base_pathParseOptions::with_base_path
- ::with_import_resolverParseOptions::with_import_resolver
- ::innerRoutePlugin::inner
- ::newRoutePlugin::new
- ::runRoutePlugin::run
V
compile
V
compile_diagram
V
compile_file
V
get_board_path_at_position
V
get_completion_items
V
get_ref_ranges
V
parse
V
parse_file

Milky2018/diago/ast does not have a README file

ArrayNode

source

pub(all) enum ArrayNode {
  Comment(@Milky2018/diago/lexer.Range
Range, String)
  BlockComment(@Milky2018/diago/lexer.Range
Range, String)
  Substitution(Substitution)
  Import(Import)
  Value(Value)
}

Nodes that can appear inside an array

impl Eq for ArrayNode

impl Show for ArrayNode

ArrayNode::range

source

fn ArrayNode::range(self : ArrayNode) -> @Milky2018/diago/lexer.Range
Range

ArrayValue

source

pub struct ArrayValue {
  range : @Milky2018/diago/lexer.Range
Range
  nodes : Array[ArrayNode]
}

An array value

impl Eq for ArrayValue

impl Show for ArrayValue

ArrayValue::new

source

fn ArrayValue::new(range : @Milky2018/diago/lexer.Range
Range, nodes : Array[ArrayNode]) -> ArrayValue

BlockString

source

pub struct BlockString {
  range : @Milky2018/diago/lexer.Range
Range
  quote : String
  tag : String
  value : String
}

Block string (|md, |sh, etc.)

impl Eq for BlockString

impl Show for BlockString

BlockString::new

source

fn BlockString::new(range : @Milky2018/diago/lexer.Range
Range, quote : String, tag : String, value : String) -> BlockString

DoubleQuotedString

source

pub struct DoubleQuotedString {
  range : @Milky2018/diago/lexer.Range
Range
  value : Array[Interpolation]
}

Double-quoted string that may contain substitutions

impl Eq for DoubleQuotedString

impl Show for DoubleQuotedString

DoubleQuotedString::new

source

fn DoubleQuotedString::new(range : @Milky2018/diago/lexer.Range
Range, value : Array[Interpolation]) -> DoubleQuotedString

DoubleQuotedString::to_string

source

fn DoubleQuotedString::to_string(self : DoubleQuotedString) -> String

Edge

source

pub struct Edge {
  range : @Milky2018/diago/lexer.Range
Range
  src : KeyPath
  src_arrow : String
  dst : KeyPath
  dst_arrow : String
}

An edge between two nodes

impl Eq for Edge

impl Show for Edge

Edge::new

source

fn Edge::new(range : @Milky2018/diago/lexer.Range
Range, src : KeyPath, dst : KeyPath, src_arrow : String, dst_arrow : String) -> Edge

EdgeIndex

source

pub struct EdgeIndex {
  range : @Milky2018/diago/lexer.Range
Range
  index : Int?
  glob : Bool
}

Index into an edge group

impl Eq for EdgeIndex

impl Show for EdgeIndex

EdgeIndex::new

source

fn EdgeIndex::new(range : @Milky2018/diago/lexer.Range
Range, index : Int?, glob : Bool) -> EdgeIndex

Import

source

pub struct Import {
  range : @Milky2018/diago/lexer.Range
Range
  spread : Bool
  pre : String
  path : Array[StringValue]
}

Import declaration (@path/to/file)

impl Eq for Import

impl Show for Import

Import::new

source

fn Import::new(range : @Milky2018/diago/lexer.Range
Range, spread : Bool, pre : String, path : Array[StringValue]) -> Import

Interpolation

source

pub(all) enum Interpolation {
  Text(String)
  Sub(Substitution)
}

Part of an interpolated string

impl Eq for Interpolation

impl Show for Interpolation

Key

source

pub struct Key {
  range : @Milky2018/diago/lexer.Range
Range
  ampersand : Bool
  not_ampersand : Bool
  key : KeyPath?
  edges : Array[Edge]
  edge_index : EdgeIndex?
  edge_key : KeyPath?
  primary : Scalar?
  value : Value?
}

A key declaration in a map

Examples:

x (simple key)
x: value (key with value)
x -> y (edge)
container.child (nested key path)
(x -> y).label (edge with property)

impl Eq for Key

impl Show for Key

Key::new

source

fn Key::new(range : @Milky2018/diago/lexer.Range
Range, ampersand : Bool, not_ampersand : Bool, key : KeyPath?, edges : Array[Edge], edge_index : EdgeIndex?, edge_key : KeyPath?, primary : Scalar?, value : Value?) -> Key

KeyPath

source

pub struct KeyPath {
  range : @Milky2018/diago/lexer.Range
Range
  path : Array[StringValue]
}

A path of identifiers separated by dots Example: container.child.grandchild

impl Eq for KeyPath

impl Show for KeyPath

KeyPath::has_glob

source

fn KeyPath::has_glob(self : KeyPath) -> Bool

KeyPath::last

source

fn KeyPath::last(self : KeyPath) -> StringValue?

KeyPath::new

source

fn KeyPath::new(range : @Milky2018/diago/lexer.Range
Range, path : Array[StringValue]) -> KeyPath

KeyPath::to_strings

source

fn KeyPath::to_strings(self : KeyPath) -> Array[String]

Map

source

pub struct Map {
  range : @Milky2018/diago/lexer.Range
Range
  nodes : Array[MapNode]
}

A diago file is represented as a Map at the root level

impl Eq for Map

impl Show for Map

Map::new

source

fn Map::new(range : @Milky2018/diago/lexer.Range
Range, nodes : Array[MapNode]) -> Map

MapNode

source

pub(all) enum MapNode {
  Comment(@Milky2018/diago/lexer.Range
Range, String)
  BlockComment(@Milky2018/diago/lexer.Range
Range, String)
  Substitution(Substitution)
  Import(Import)
  Key(Key)
}

Nodes that can appear inside a Map

impl Eq for MapNode

impl Show for MapNode

MapNode::range

source

fn MapNode::range(self : MapNode) -> @Milky2018/diago/lexer.Range
Range

Node

source

pub(all) enum Node {
  Map(Map)
  MapNode(MapNode)
  Key(Key)
  KeyPath(KeyPath)
  Edge(Edge)
  EdgeIndex(EdgeIndex)
  Value(Value)
  ArrayValue(ArrayValue)
  ArrayNode(ArrayNode)
  Scalar(Scalar)
  StringValue(StringValue)
  UnquotedString(UnquotedString)
  DoubleQuotedString(DoubleQuotedString)
  BlockString(BlockString)
  Substitution(Substitution)
  Import(Import)
}

Boxed AST node for generic traversal.

This is intentionally a closed set of variants over the public AST structs/enums.

impl Eq for Node

impl Show for Node

Node::children

source

fn Node::children(self : Node) -> Array[Node]

Node::node_type

source

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

Node::range

source

fn Node::range(self : Node) -> @Milky2018/diago/lexer.Range
Range

Scalar

source

pub(all) enum Scalar {
  Null(@Milky2018/diago/lexer.Range
Range)
  Boolean(@Milky2018/diago/lexer.Range
Range, Bool)
  Number(@Milky2018/diago/lexer.Range
Range, String)
  String(StringValue)
}

Scalar values

impl Eq for Scalar

impl Show for Scalar

Scalar::range

source

fn Scalar::range(self : Scalar) -> @Milky2018/diago/lexer.Range
Range

StringValue

source

pub(all) enum StringValue {
  Unquoted(UnquotedString)
  SingleQuoted(@Milky2018/diago/lexer.Range
Range, String)
  DoubleQuoted(DoubleQuotedString)
  Block(BlockString)
}

String values with their quote style

impl Eq for StringValue

impl Show for StringValue

StringValue::content

source

fn StringValue::content(self : StringValue) -> String

StringValue::range

source

fn StringValue::range(self : StringValue) -> @Milky2018/diago/lexer.Range
Range

Substitution

source

pub struct Substitution {
  range : @Milky2018/diago/lexer.Range
Range
  spread : Bool
  path : Array[StringValue]
}

Variable substitution ($var or ${var})

impl Eq for Substitution

impl Show for Substitution

Substitution::new

source

fn Substitution::new(range : @Milky2018/diago/lexer.Range
Range, spread : Bool, path : Array[StringValue]) -> Substitution

UnquotedString

source

pub struct UnquotedString {
  range : @Milky2018/diago/lexer.Range
Range
  value : Array[Interpolation]
  pattern : Array[String]
}

Unquoted string that may contain substitutions

impl Eq for UnquotedString

impl Show for UnquotedString

UnquotedString::new

source

fn UnquotedString::new(range : @Milky2018/diago/lexer.Range
Range, value : Array[Interpolation], pattern : Array[String]) -> UnquotedString

UnquotedString::to_string

source

fn UnquotedString::to_string(self : UnquotedString) -> String

Value

source

pub(all) enum Value {
  Scalar(Scalar)
  Array(ArrayValue)
  Map(Map)
  Import(Import)
  BlockScalar(Value, Map)
}

Values that can appear on the right side of a colon

impl Eq for Value

impl Show for Value

Value::range

source

fn Value::range(self : Value) -> @Milky2018/diago/lexer.Range
Range

board_keywords

source

let board_keywords : Array[String]

Board keywords (create new boards)

composite_keywords

source

let composite_keywords : Array[String]

Keywords that hold composites

fill_patterns

source

let fill_patterns : Array[String]

Valid fill patterns

is_board_keyword

source

fn is_board_keyword(s : String) -> Bool

Check if a string is a board keyword

is_reserved_keyword

source

fn is_reserved_keyword(s : String) -> Bool

Check if a string is a reserved keyword

is_style_keyword

source

fn is_style_keyword(s : String) -> Bool

Check if a string is a style keyword

label_positions

source

let label_positions : Array[String]

Label positions

near_constants

source

let near_constants : Array[String]

Near constant positions

simple_reserved_keywords

source

let simple_reserved_keywords : Array[String]

Simple reserved keywords (non-style, non-composite)

style_keywords

source

let style_keywords : Array[String]

Style keywords (must be inside "style" block)

text_transforms

source

let text_transforms : Array[String]

Valid text transforms

Source Files

Site source Report issue Packages Build queue Skills Statistics

#ArrayNode

#ArrayNode::range

#ArrayValue

#ArrayValue::new

#BlockString

#BlockString::new

#DoubleQuotedString

#DoubleQuotedString::new

#DoubleQuotedString::to_string

#Edge

#Edge::new

#EdgeIndex

#EdgeIndex::new

#Import

#Import::new

#Interpolation

#Key

#Key::new

#KeyPath

#KeyPath::has_glob

#KeyPath::last

#KeyPath::new

#KeyPath::to_strings

#Map

#Map::new

#MapNode

#MapNode::range

#Node

#Node::children

#Node::node_type

#Node::range

#Scalar

#Scalar::range

#StringValue

#StringValue::content

#StringValue::range

#Substitution

#Substitution::new

#UnquotedString

#UnquotedString::new

#UnquotedString::to_string

#Value

#Value::range

#board_keywords

#composite_keywords

#fill_patterns

#is_board_keyword

#is_reserved_keyword

#is_style_keyword

#label_positions

#near_constants

#simple_reserved_keywords

#style_keywords

#text_transforms

Source Files

ArrayNode

ArrayNode::range

ArrayValue

ArrayValue::new

BlockString

BlockString::new

DoubleQuotedString

DoubleQuotedString::new

DoubleQuotedString::to_string

Edge

Edge::new

EdgeIndex

EdgeIndex::new

Import

Import::new

Interpolation

Key

Key::new

KeyPath

KeyPath::has_glob

KeyPath::last

KeyPath::new

KeyPath::to_strings

Map

Map::new

MapNode

MapNode::range

Node

Node::children

Node::node_type

Node::range

Scalar

Scalar::range

StringValue

StringValue::content

StringValue::range

Substitution

Substitution::new

UnquotedString

UnquotedString::new

UnquotedString::to_string

Value

Value::range

board_keywords

composite_keywords

fill_patterns

is_board_keyword

is_reserved_keyword

is_style_keyword

label_positions

near_constants

simple_reserved_keywords

style_keywords

text_transforms