Expand description
§📖 Go Parser User Guide
Go support for the Oak language framework.
This guide helps you integrate oak-go into your project and perform common parsing tasks efficiently.
§🚀 Quick Start
§Basic Parsing Example
The following is a standard workflow for parsing a Go file:
use oak_go::{GoParser, SourceText, GoLanguage};
fn main() {
// 1. Prepare source code
let code = r#"
package main
import "fmt"
func main() {
fmt.Println("Hello from Oak Go!")
}
"#;
let source = SourceText::new(code);
// 2. Initialize parser
let config = GoLanguage::new();
let parser = GoParser::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 Functionality
§1. Syntax Tree Traversal
After a successful parse, use the built-in visitor pattern or manually traverse the Green/Red Tree to extract Go constructs like package declarations, struct methods, or channel operations.
§2. Incremental Parsing
Optimize performance by only re-parsing changed sections:
// 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 & Error Recovery
oak-go provides detailed error contexts tailored for Go developers:
for diag in result.diagnostics() {
println!("[{}:{}] {}", diag.line, diag.column, diag.message);
}§🛠️ Performance & Reliability
- High-Fidelity AST: Retains all trivia (whitespace and comments), making it ideal for code formatting and refactoring tools.
- Fault Tolerance: Automatically recovers from syntax errors to provide as much information as possible from the rest of the file.
- Memory Efficiency: Leverages immutable data structures (Green Trees) for low-overhead tree management.
Re-exports§
pub use crate::ast::GoRoot;pub use builder::GoBuilder;pub use language::GoLanguage;pub use lexer::GoLexer;pub use parser::GoParser;pub use crate::lsp::highlighter::GoHighlighter;pub use crate::lsp::GoLanguageService;pub use crate::lsp::formatter::GoFormatter;pub use crate::mcp::serve_go_mcp;pub use lexer::token_type::GoTokenType;pub use parser::element_type::GoElementType;