Skip to main content

Crate oak_vampire

Crate oak_vampire 

Source
Expand description

§🛠️ Developer Guide

Vampire support for the Oak language framework.

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::VampireRoot;
pub use crate::language::VampireLanguage;
pub use crate::lexer::VampireLexer;
pub use crate::parser::VampireParser;
pub use crate::lsp::highlighter::VampireHighlighter;
pub use crate::lsp::VampireLanguageService;
pub use crate::lsp::formatter::VampireFormatter;
pub use crate::mcp::serve_vampire_mcp;
pub use lexer::token_type::VampireTokenType;
pub use parser::element_type::VampireElementType;

Modules§

ast
AST module.
builder
Builder module.
language
Language configuration module.
lexer
Lexer module.
lsp
LSP module.
mcp
MCP module.
parser
Parser module.

Traits§

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