Skip to main content

Crate oak_ocaml

Crate oak_ocaml 

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

Re-exportsยง

pub use builder::OCamlBuilder;
pub use language::OCamlLanguage;
pub use lexer::OCamlLexer;
pub use parser::OCamlParser;
pub use crate::lsp::highlighter::HighlightKind;
pub use crate::lsp::highlighter::Highlighter;
pub use crate::lsp::highlighter::OCamlHighlighter;
pub use crate::lsp::OCamlLanguageService;
pub use crate::mcp::serve_ocaml_mcp;
pub use lexer::token_type::OCamlTokenType;
pub use parser::element_type::OCamlElementType;

Modulesยง

ast
Ocaml Ast
builder
language
Ocaml Language
lexer
Ocaml Lexer
lsp
Ocaml Lsp
mcp
MCP module.
parser