Skip to main content

Crate oak_jasm

Crate oak_jasm 

Source
Expand description

ยง๐Ÿ› ๏ธ Developer Guide

This directory contains the core logic implementation of the project. Below are instructions for a quick start.

ยง๐Ÿšฆ Quick Start

ยงCore API Usage

// Example: Basic calling workflow
fn main() {
    // 1. Initialization
    // 2. Execute core logic
    // 3. Handle returned results
}

ยง๐Ÿ” Module Description

  • lib.rs: Exports public interfaces and core traits.
  • parser/ (if exists): Implements specific syntax parsing logic.
  • ast/ (if exists): Defines the syntax tree structure.

ยง๐Ÿ—๏ธ Architecture Design

The project follows the general architectural specifications of the Oak ecosystem, emphasizing:

  1. Immutability: Uses the Green/Red Tree structure to ensure efficient sharing of syntax trees.
  2. Fault Tolerance: Core logic is highly inclusive of erroneous input.
  3. Scalability: Convenient for downstream tools to perform secondary development. Jasm support for the Oak language framework.

Re-exportsยง

pub use crate::ast::JasmRoot;
pub use crate::builder::JasmBuilder;
pub use crate::language::JasmLanguage;
pub use crate::lexer::JasmLexer;
pub use crate::parser::JasmParser;
pub use crate::lsp::highlighter::JasmHighlighter;
pub use crate::lsp::JasmLanguageService;
pub use crate::mcp::serve_jasm_mcp;
pub use lexer::token_type::JasmTokenType;
pub use parser::element_type::JasmElementType;

Modulesยง

ast
AST module. Abstract Syntax Tree for the JASM language.
builder
Builder module. AST builder for the JASM language.
language
Type definitions module. Language configuration module. Language definition for the JASM language.
lexer
Lexer module. Lexer implementation for the JASM language.
lsp
LSP module. LSP service implementation for the JASM language.
mcp
MCP module. MCP service implementation for the JASM language.
parser
Parser module. Parser implementation for the JASM language.