Skip to main content

Crate oak_groovy

Crate oak_groovy 

Source
Expand description

ยง๐Ÿ› ๏ธ oak-groovy Developer Guide

Groovy support for the Oak language framework.

Welcome to the internal implementation of the Groovy parser. This module provides the core logic for tokenizing and parsing Groovy source code into a high-fidelity syntax tree.

ยง๐Ÿ“ฆ Core Components

  • Lexer: Tokenizes Groovy source code, handling GStrings, closures, and dynamic typing with full fidelity.
  • Parser: Implements the Groovy grammar, producing a Green Tree that represents the concrete syntax.
  • AST: Provides a type-safe Red Tree facade for easy traversal and analysis.
  • Language: Defines the GroovyLanguage configuration and integration with the Oak framework.

ยง๐Ÿš€ Usage Example

ยงBasic Parsing

use oak_groovy::{GroovyParser, SourceText, GroovyLanguage};

fn parse_groovy_code(code: &str) {
    let source = SourceText::new(code);
    let config = GroovyLanguage::new();
    let parser = GroovyParser::new(&config);
    let result = parser.parse(&source);

    if result.is_success() {
        let root = result.root();
        println!("AST Root: {:?}", root);
    }
}

ยงIncremental Parsing

use oak_groovy::{GroovyParser, SourceText, GroovyLanguage};

fn incremental_update(old_code: &str, new_code: &str) {
    let config = GroovyLanguage::new();
    let mut parser = GroovyParser::new(&config);
    
    // Initial parse
    let initial_source = SourceText::new(old_code);
    let _ = parser.parse(&initial_source);
    
    // Incremental update
    let updated_source = SourceText::new(new_code);
    let result = parser.parse(&updated_source);
    
    if result.is_success() {
        println!("Incremental parse completed successfully.");
    }
}

ยง๐Ÿ” Diagnostics

The parser provides detailed diagnostics for syntax errors, including error ranges and helpful messages.

let result = parser.parse(&source);
for diagnostic in result.diagnostics() {
    println!("Error at {:?}: {}", diagnostic.range(), diagnostic.message());
}

Re-exportsยง

pub use crate::ast::GroovyRoot;
pub use crate::builder::GroovyBuilder;
pub use crate::language::GroovyLanguage;
pub use crate::lexer::GroovyLexer;
pub use crate::parser::GroovyParser;
pub use lexer::token_type::GroovyTokenType;
pub use parser::element_type::GroovyElementType;

Modulesยง

ast
Groovy Ast
builder
Groovy Builder
language
๐ŸŒ Groovy Language Integration
lexer
Groovy Lexer Module
lsp
Groovy Lsp
parser
Groovy Parser