Milky2018/diago/ir - 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/ir does not have a README file

CompileError

source

pub(all) suberror CompileError {
  InvalidKey(String)
  InvalidValue(String)
  DuplicateField(String)
  InvalidSubstitution(String)
  ImportError(String)
}

Compilation error

impl Eq for CompileError

impl Show for CompileError

Composite

source

pub(all) enum Composite {
  Array(IRArray)
  Map(Map)
}

Composite values (Array or Map)

impl Eq for Composite

impl Show for Composite

Edge

source

pub struct Edge {
  id : EdgeID
  primary : Scalar?
  map : Map?
  references : Array[EdgeReference]
}

An edge in the IR

impl Eq for Edge

impl Show for Edge

Edge::new

source

fn Edge::new(id : EdgeID, primary : Scalar?, map : Map?, references : Array[EdgeReference]) -> Edge

EdgeID

source

pub struct EdgeID {
  src_path : Array[String]
  src_arrow : Bool
  dst_path : Array[String]
  dst_arrow : Bool
  index : Int?
  glob : Bool
}

Unique identifier for an edge

impl Eq for EdgeID

impl Show for EdgeID

EdgeID::copy

source

fn EdgeID::copy(self : EdgeID) -> EdgeID

Create a copy of this EdgeID

EdgeID::matches

source

fn EdgeID::matches(self : EdgeID, other : EdgeID) -> Bool

Check if this EdgeID matches another (for queries)

EdgeID::new

source

fn EdgeID::new(src_path : Array[String], dst_path : Array[String], src_arrow : Bool, dst_arrow : Bool) -> EdgeID

EdgeID::with_glob

source

fn EdgeID::with_glob(src_path : Array[String], dst_path : Array[String], src_arrow : Bool, dst_arrow : Bool) -> EdgeID

EdgeID::with_index

source

fn EdgeID::with_index(src_path : Array[String], dst_path : Array[String], src_arrow : Bool, dst_arrow : Bool, index : Int) -> EdgeID

EdgeReference

source

pub struct EdgeReference {
  range : @Milky2018/diago/lexer.Range
Range
  edge_index : Int
  primary : Bool
  due_to_glob : Bool
  due_to_lazy_glob : Bool
}

Reference to an edge from the AST

impl Eq for EdgeReference

impl Show for EdgeReference

EdgeReference::new

source

fn EdgeReference::new(range : @Milky2018/diago/lexer.Range
Range, edge_index : Int, primary : Bool) -> EdgeReference

Field

source

pub struct Field {
  name : String
  primary : Scalar?
  composite : Composite?
  references : Array[FieldReference]
}

A field in the IR map

impl Eq for Field

impl Show for Field

Field::array

source

fn Field::array(self : Field) -> IRArray?

Get the array composite if this field has one

Field::has_composite

source

fn Field::has_composite(self : Field) -> Bool

Check if this field has a composite value

Field::has_primary

source

fn Field::has_primary(self : Field) -> Bool

Check if this field has a primary value

Field::map

source

fn Field::map(self : Field) -> Map?

Get the map composite if this field has one

Field::new

source

fn Field::new(name : String, primary : Scalar?, composite : Composite?, references : Array[FieldReference]) -> Field

Field::simple

source

fn Field::simple(name : String) -> Field

FieldReference

source

pub struct FieldReference {
  range : @Milky2018/diago/lexer.Range
Range
  string : String
  key_path_index : Int
  primary : Bool
  due_to_glob : Bool
  due_to_lazy_glob : Bool
}

Reference to a field from the AST

impl Eq for FieldReference

impl Show for FieldReference

FieldReference::new

source

fn FieldReference::new(range : @Milky2018/diago/lexer.Range
Range, string : String, key_path_index : Int, primary : Bool) -> FieldReference

FilterContext

source

pub struct FilterContext {
  field : Field
  parent_map : Map
}

Filter context for evaluating ampersand filters

FilterContext::new

source

fn FilterContext::new(field : Field, parent_map : Map) -> FilterContext

IRArray

source

pub struct IRArray {
  values : Array[Value]
}

An array of values

impl Eq for IRArray

impl Show for IRArray

IRArray::new

source

fn IRArray::new(values : Array[Value]) -> IRArray

ImportResolver

source

pub type ImportResolver (String) -> String?

Import resolver function type Takes an import path and returns the file content, or None if not found

ImportResolver::inner

source

#deprecated("Use `struct T(A)` to declare a newtype and use `.0` access the underlying type instead.")
fn ImportResolver::inner(self : ImportResolver) -> ((String) -> String?)

Convert newtype to its underlying type, automatically derived.

ImportResolver::new

source

fn ImportResolver::new(f : (String) -> String?) -> ImportResolver

Create a new import resolver from a function

Map

source

pub struct Map {
  fields : Array[Field]
  edges : Array[Edge]
}

An IR Map containing fields and edges

impl Eq for Map

impl Show for Map

Map::add_edge

source

fn Map::add_edge(self : Map, edge : Edge) -> Unit

Add an edge to the map

Map::add_field

source

fn Map::add_field(self : Map, field : Field) -> Unit

Add a field to the map

Map::apply_glob_properties

source

fn Map::apply_glob_properties(self : Map, pattern : Array[String], properties : Map, filters : Array[(Bool, String, String)]) -> Unit

Apply properties to fields matching a glob pattern If filters are provided, only apply to fields that pass all filters

Map::delete_field

source

fn Map::delete_field(self : Map, name : String) -> Field?

Delete a field by name, returning it if found

Map::double_glob

source

fn Map::double_glob(self : Map) -> Array[Field]

Collect all fields matching a double glob (**) pattern This recursively collects all descendant fields except board keywords

Map::ensure_field

source

fn Map::ensure_field(self : Map, name : String) -> Field

Get or create a field by name

Map::find_edges

source

fn Map::find_edges(self : Map, id : EdgeID) -> Array[Edge]

Find edges matching an EdgeID

Map::get_field

source

fn Map::get_field(self : Map, name : String) -> Field?

Get a field by name (case-insensitive)

Map::has_field

source

fn Map::has_field(self : Map, name : String) -> Bool

Check if map has a field with given name

Map::multi_glob

source

fn Map::multi_glob(self : Map, pattern : Array[String]) -> (Array[Field], Bool)

Collect fields matching a multi-glob pattern (** or ***) Returns (fields, is_glob_pattern)

Map::new

source

fn Map::new() -> Map

Map::single_glob

source

fn Map::single_glob(self : Map, pattern : Array[String]) -> Array[Field]

Collect fields at one level matching a single glob pattern

Map::triple_glob

source

fn Map::triple_glob(self : Map) -> Array[Field]

Collect all fields matching a triple glob (***) pattern This recursively collects all descendant fields including boards

Node

source

pub(all) enum Node {
  Scalar(Scalar)
  Field(Field)
  Edge(Edge)
  IRArray(IRArray)
  Map(Map)
  Composite(Composite)
  Value(Value)
}

Boxed IR node for generic traversal.

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

Scalar

source

pub struct Scalar {
  value : ScalarValue
  range : @Milky2018/diago/lexer.Range
Range
}

A scalar value in the IR.

Scalars carry a source range for error reporting and reference tracking.

impl Eq for Scalar

impl Show for Scalar

Scalar::as_bool

source

fn Scalar::as_bool(self : Scalar) -> Bool?

Get boolean value if this is a boolean

Scalar::as_double

source

fn Scalar::as_double(self : Scalar) -> Double?

Scalar::as_int

source

fn Scalar::as_int(self : Scalar) -> Int?

Scalar::as_string_value

source

fn Scalar::as_string_value(self : Scalar) -> @Milky2018/diago/ast.StringValue
StringValue?

Get underlying string value (including block-string metadata) if present

Scalar::at

source

fn Scalar::at(range : @Milky2018/diago/lexer.Range
Range, value : ScalarValue) -> Scalar

Scalar::block_string_tag

source

fn Scalar::block_string_tag(self : Scalar) -> String?

Get block-string language tag if this scalar is a block string

Scalar::bool

source

fn Scalar::bool(b : Bool) -> Scalar

Scalar::get_range

source

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

Scalar::is_bool

source

fn Scalar::is_bool(self : Scalar) -> Bool

Check if scalar is a boolean

Scalar::is_null

source

fn Scalar::is_null(self : Scalar) -> Bool

Check if scalar is null

Scalar::is_number

source

fn Scalar::is_number(self : Scalar) -> Bool

Check if scalar is a number

Scalar::is_string

source

fn Scalar::is_string(self : Scalar) -> Bool

Check if scalar is a string

Scalar::new

source

fn Scalar::new(value : ScalarValue) -> Scalar

Scalar::null

source

fn Scalar::null() -> Scalar

Scalar::number

source

fn Scalar::number(n : String) -> Scalar

Scalar::string

source

fn Scalar::string(s : String) -> Scalar

Scalar::to_string

source

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

Get the string representation of a scalar value

ScalarValue

source

pub(all) enum ScalarValue {
  Null
  Bool(String)
  Number(String)
  String(@Milky2018/diago/ast.StringValue
StringValue)
}

Types of scalar values

impl Eq for ScalarValue

impl Show for ScalarValue

Value

source

pub(all) enum Value {
  Scalar(Scalar)
  Array(IRArray)
  Map(Map)
}

Value types in IR

impl Eq for Value

impl Show for Value

Value::as_array

source

fn Value::as_array(self : Value) -> IRArray?

Get the array if this is an array

Value::as_map

source

fn Value::as_map(self : Value) -> Map?

Get the map if this is a map

Value::as_scalar

source

fn Value::as_scalar(self : Value) -> Scalar?

Get the scalar value if this is a scalar

compile

source

fn compile(ast : @Milky2018/diago/ast.Map
Map) -> Map raise CompileError

Compile an AST Map to IR Map

compile_with_imports

source

fn compile_with_imports(ast : @Milky2018/diago/ast.Map
Map, resolver : ImportResolver) -> Map raise CompileError

Compile an AST Map with import resolution

evaluate_filter

source

fn evaluate_filter(ctx : FilterContext, filter_key : String, filter_value : String) -> Bool

Evaluate a filter condition against a field Returns true if the field passes the filter

is_board_keyword

source

fn is_board_keyword(name : String) -> Bool

Check if a keyword is a board keyword

is_double_glob

source

fn is_double_glob(pattern : Array[String]) -> Bool

Check if pattern represents a double glob (**) Parser stores ** as ["", "", ""]

is_reserved_keyword

source

fn is_reserved_keyword(name : String) -> Bool

Check if a keyword is reserved

is_triple_glob

source

fn is_triple_glob(pattern : Array[String]) -> Bool

Check if pattern represents a triple glob () Parser stores *** as ["", "", "", "", ""]

match_pattern

source

fn match_pattern(s : String, pattern : Array[String]) -> Bool

Match a string against a glob pattern Pattern is an array where elements are either:

literal text to match
"*" to match any characters

Source Files

Site source Report issue Packages Build queue Skills Statistics

#CompileError

#Composite

#Edge

#Edge::new

#EdgeID

#EdgeID::copy

#EdgeID::matches

#EdgeID::new

#EdgeID::with_glob

#EdgeID::with_index

#EdgeReference

#EdgeReference::new

#Field

#Field::array

#Field::has_composite

#Field::has_primary

#Field::map

#Field::new

#Field::simple

#FieldReference

#FieldReference::new

#FilterContext

#FilterContext::new

#IRArray

#IRArray::new

#ImportResolver

#ImportResolver::inner

#ImportResolver::new

#Map

#Map::add_edge

#Map::add_field

#Map::apply_glob_properties

#Map::delete_field

#Map::double_glob

#Map::ensure_field

#Map::find_edges

#Map::get_field

#Map::has_field

#Map::multi_glob

#Map::new

#Map::single_glob

#Map::triple_glob

#Node

#Node::children

#Node::node_type

#Scalar

#Scalar::as_bool

#Scalar::as_double

#Scalar::as_int

#Scalar::as_string_value

#Scalar::at

#Scalar::block_string_tag

#Scalar::bool

#Scalar::get_range

#Scalar::is_bool

#Scalar::is_null

#Scalar::is_number

#Scalar::is_string

#Scalar::new

#Scalar::null

#Scalar::number

#Scalar::string

#Scalar::to_string

#ScalarValue

#Value

#Value::as_array

#Value::as_map

#Value::as_scalar

#compile

#compile_with_imports

#evaluate_filter

#is_board_keyword

#is_double_glob

#is_reserved_keyword

#is_triple_glob

#match_pattern

Source Files

CompileError

Composite

Edge

Edge::new

EdgeID

EdgeID::copy

EdgeID::matches

EdgeID::new

EdgeID::with_glob

EdgeID::with_index

EdgeReference

EdgeReference::new

Field

Field::array

Field::has_composite

Field::has_primary

Field::map

Field::new

Field::simple

FieldReference

FieldReference::new

FilterContext

FilterContext::new

IRArray

IRArray::new

ImportResolver

ImportResolver::inner

ImportResolver::new

Map

Map::add_edge

Map::add_field

Map::apply_glob_properties

Map::delete_field

Map::double_glob

Map::ensure_field

Map::find_edges

Map::get_field

Map::has_field

Map::multi_glob

Map::new

Map::single_glob

Map::triple_glob

Node

Node::children

Node::node_type

Scalar

Scalar::as_bool

Scalar::as_double

Scalar::as_int

Scalar::as_string_value

Scalar::at

Scalar::block_string_tag

Scalar::bool

Scalar::get_range

Scalar::is_bool

Scalar::is_null

Scalar::is_number

Scalar::is_string

Scalar::new

Scalar::null

Scalar::number

Scalar::string

Scalar::to_string

ScalarValue

Value

Value::as_array

Value::as_map

Value::as_scalar

compile

compile_with_imports

evaluate_filter

is_board_keyword

is_double_glob

is_reserved_keyword

is_triple_glob

match_pattern