Crate oak_rbq 

🛠️ Developer Guide

Rbq support for the Oak language framework.

This crate provides lexing, parsing, AST generation, and LSP support for the RBQ language.

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.

Re-exports

pub use crate::ast::RbqRoot;

pub use crate::builder::RbqBuilder;

pub use crate::language::RbqLanguage;

pub use crate::lexer::RbqLexer;

pub use crate::lexer::token_type::RbqTokenType;

pub use crate::parser::RbqParser;

pub use crate::parser::element_type::RbqElementType;

pub use crate::lsp::highlighter::RbqHighlighter;

pub use crate::lsp::formatter::RbqFormatter;

pub use crate::lsp::RbqLanguageService;

pub use crate::mcp::serve_rbq_mcp;

Modules

ast

AST module containing node definitions for the RBQ language.

builder

Builder module for constructing RBQ trees.

language

Language configuration and syntax kind definitions.

lexer

Lexer implementation for RBQ.

lsp

LSP-related functionality (hover, completion, highlighting).

mcp

MCP (Model Context Protocol) integration for RBQ.

parser

Parser implementation for RBQ.

Functions

parse

Parses a string into an RBQ AST.

Type Aliases

RbqSyntaxKind

Alias for RbqTokenType to support tests and common usage