Skip to main content

Crate oak_wolfram

Crate oak_wolfram 

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. Wolfram support for the Oak language framework.

Re-exports§

pub use crate::language::WolframLanguage;
pub use crate::lexer::WolframLexer;
pub use crate::parser::WolframParser;
pub use crate::lsp::highlighter::WolframHighlighter;
pub use crate::lsp::WolframLanguageService;
pub use crate::mcp::serve_wolfram_mcp;
pub use lexer::token_type::WolframTokenType;
pub use parser::element_type::WolframElementType;

Modules§

ast
Wolfram Abstract Syntax Tree (AST) Module
language
Wolfram language definition.
lexer
Wolfram lexer implementation.
lsp
Wolfram Language Server Protocol (LSP) support.
mcp
MCP module.
parser
Parser implementation for the Wolfram language.

Structs§

WolframBuilder
Wolfram language AST builder.

Traits§

ElementType
A trait for types that represent an element’s kind in a syntax tree.
TokenType
A trait for types that represent a token’s kind in a specific language.