Expand description
THIS FILE IS GENERATED FROM xtask/templates/lib.stpl.rs; DO NOT EDIT MANUALLY
§arborium-odin
Odin grammar for tree-sitter.
An open source systems programming language designed for the modern computer and programmer.
| Inventor | Bill Hall |
| Year | 2016 |
§Usage
use arborium_odin::language;
use tree_sitter_patched_arborium::Parser;
let mut parser = Parser::new();
parser.set_language(&language()).expect("Error loading odin grammar");
let source_code = "/* your odin code here */";
let tree = parser.parse(source_code, None).unwrap();
println!("{}", tree.root_node().to_sexp());For most use cases, prefer the main arborium crate:
[dependencies]
arborium = { version = "*", features = ["odin"] }Or use this crate directly:
[dependencies]
arborium-odin = "*"§About Arborium
This crate is part of Arborium, a collection of tree-sitter grammars packaged as Rust crates, maintained by Amos Wenger.
This crate packages a parser.c file generated by the tree-sitter CLI. It exports a language() function returning the tree-sitter Language for odin.
Why separate crates? Tree-sitter parsers can be large (some exceed 1MB of generated C). Splitting languages into separate crates means you only compile what you need, and parallel/incremental builds are more effective.
§Build Requirements
- Rust: MSRV is 1.85.0 (Rust 2024 edition)
- C compiler: This crate compiles C code via the
cccrate
§Supported Targets
- All major platforms: Linux, macOS, Windows
- WebAssembly:
wasm32-unknown-unknown(with custom sysroot)
§Upstream Grammar
| Repository | tree-sitter-grammars/tree-sitter-odin |
| Commit | d2ca8efb4487e156a60d5bd6db2598b872629403 |
| License | MIT |
To regenerate after upstream updates:
cargo xtask gen --name odinFound a grammar bug? Please report it to the upstream repository.
§Safety
This crate uses unsafe for FFI bindings to the tree-sitter C library. The unsafe surface is minimal and limited to what tree-sitter requires. The generated parser code is produced by tree-sitter’s own code generator.
§Versioning
Crate versions track Arborium releases, not upstream grammar versions. The upstream commit is recorded above. A major version bump occurs when grammar changes affect node names or structure (breaking for query consumers).
§License
- Generated parser code (
parser.c): MIT (from upstream grammar) - Arborium glue code: MIT OR Apache-2.0
§Contributing
- Issues: github.com/bearcove/arborium/issues
- Repository: github.com/bearcove/arborium
Constants§
- HIGHLIGHTS_
QUERY - The highlights query for odin.
- INJECTIONS_
QUERY - The injections query for odin.
- LOCALS_
QUERY - The locals query for odin.
Functions§
- language
- Returns the odin tree-sitter
LanguageFn.