Oak LLVM Parser

High-performance incremental LLVM IR parser for the oak ecosystem with flexible configuration, optimized for LLVM intermediate representation processing.

🎯 Overview

Oak LLVM is a robust parser for LLVM IR (Intermediate Representation), designed to handle complete LLVM syntax including modern specifications. Built on the solid foundation of oak-core, it provides both high-level convenience and detailed AST generation for LLVM IR analysis and code generation.

✨ Features

• Complete LLVM IR Syntax: Supports all LLVM IR features including types, instructions, and metadata
• Full AST Generation: Generates comprehensive Abstract Syntax Trees
• Lexer Support: Built-in tokenization with proper span information
• Error Recovery: Graceful handling of syntax errors with detailed diagnostics

🚀 Quick Start

Basic example:

use oak_llvm_ir::{LlirParser, LLvmLanguage};
use oak_core::SourceText;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let parser = LlirParser::new();
    let source = SourceText::new(r#"
        define i32 @add(i32 %a, i32 %b) {
        entry:
            %sum = add i32 %a, %b
            ret i32 %sum
        }
    "#);
    
    let result = parser.parse(&source);
    println!("Parsed LLVM IR successfully.");
    Ok(())
}

📋 Parsing Examples

Function Definition Parsing

use oak_llvm_ir::{LlirParser, LLvmLanguage};
use oak_core::SourceText;

let parser = LlirParser::new();
let source = SourceText::new(r#"
    define i32 @multiply(i32 %a, i32 %b) {
    entry:
        %product = mul i32 %a, %b
        ret i32 %product
    }
"#);

let result = parser.parse(&source);
println!("Function definition parsed successfully.");

Type Declaration Parsing

use oak_llvm_ir::{LlirParser, LLvmLanguage};
use oak_core::SourceText;

let parser = LlirParser::new();
let source = SourceText::new(r#"
    %Person = type { i32, [10 x i8], i8* }
    %ListNode = type { i32, %ListNode* }
"#);

let result = parser.parse(&source);
println!("Type declarations parsed successfully.");

🔧 Advanced Features

Token-Level Parsing

use oak_llvm_ir::{LlirParser, LLvmLanguage};
use oak_core::SourceText;

let parser = LlirParser::new();
let source = SourceText::new("define i32 @test() { ret i32 0 }");
let result = parser.parse(&source);
println!("Token parsing completed.");

Error Handling

use oak_llvm_ir::{LlirParser, LLvmLanguage};
use oak_core::SourceText;

let parser = LlirParser::new();
let source = SourceText::new(r#"
    define i32 @invalid(
        %result = add i32 %a %b
    // Missing closing parenthesis and return
"#);

let result = parser.parse(&source);
if let Some(errors) = result.result.err() {
    println!("Parse errors found: {:?}", errors);
}