Crate oak_macros 

🛠️ 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.

Macros

define_rules

Macro for defining language rules.

doc

Macro for generating documentation from templates.

json

Macro for defining JSON-like structures.

test_lexer

Generates a lexer test.

test_parser

Generates a parser test.

Attribute Macros

oak_test

Attribute macro for defining Oak tests.

Derive Macros

AsDocument

Derives the AsDocument trait.

FormatRule

Derives the FormatRule trait.