Crate oak_c 

🛠️ C Parser Developer Guide

This guide is designed to help you quickly get started with developing and integrating oak-c.

🚦 Quick Start

Basic Parsing Example

The following is a standard workflow for parsing a C function:

use oak_c::{CParser, SourceText, CLanguage};

fn main() {
    // 1. Prepare source code
    let code = r#"
        #include <stdio.h>
        
        int main() {
            printf("Hello, Oak!\n");
            return 0;
        }
    "#;
    let source = SourceText::new(code);

    // 2. Initialize parser
    let config = CLanguage::new();
    let parser = CParser::new(&config);

    // 3. Execute parsing
    let result = parser.parse(&source);

    // 4. Handle results
    if result.is_success() {
        println!("Parsing successful! AST node count: {}", result.node_count());
    } else {
        eprintln!("Errors found during parsing.");
    }
}

🔍 Core API Usage

1. Syntax Tree Traversal

After a successful parse, you can use the built-in visitor pattern or manually traverse the Green/Red Tree to extract C-specific constructs like function definitions, struct members, or preprocessor directives.

2. Incremental Parsing

No need to re-parse the entire translation unit when small changes occur:

// Assuming you have an old parse result 'old_result' and new source text 'new_source'
let new_result = parser.reparse(&new_source, &old_result);

3. Diagnostics

oak-c provides rich error contexts specifically tailored for C developers:

for diag in result.diagnostics() {
    println!("[{}:{}] {}", diag.line, diag.column, diag.message);
}

🏗️ Architecture Overview

• Lexer: Tokenizes C source text into a stream of tokens, handling keywords, operators, and literals.
• Parser: Syntax analyzer based on the Pratt parsing algorithm to handle complex C expression precedence and operator associativity.
• AST: A strongly-typed syntax abstraction layer designed for downstream systems analysis tools.

🔗 Advanced Resources

• Full Examples: Check the examples/ folder in the project root.
• API Documentation: Run cargo doc --open for detailed type definitions.
• Test Cases: See tests/ for handling of various C edge cases and standards. C support for the Oak language framework.

Re-exports

pub use lexer::token_type::CTokenType;

pub use parser::CParser;

pub use parser::element_type::CElementType;

Modules

ast

AST module.

builder

Builder module.

language

Type definition module. Language configuration module.

lexer

Lexer module.

lsp

C Lsp

parser

Parser module.

Enums

LanguageCategory

Represents the broad category a language belongs to.

Traits

ElementType

A trait for types that represent an element’s kind in a syntax tree.

Language

Language definition trait that coordinates all language-related types and behaviors.

TokenType

A trait for types that represent a token’s kind in a specific language.