tree_sitter_verilog/
lib.rs

1//! This crate provides Verilog language support for the [tree-sitter][] parsing library.
2//!
3//! Typically, you will use the [LANGUAGE][] constant to add this language to a
4//! tree-sitter [Parser][], and then use the parser to parse some code:
5//!
6//! ```
7//! let code = r#"
8//! module Adder (input a, input b, output sum);
9//!     assign sum = a + b;
10//!     initial $display("Hello, Verilog!");
11//!     initial $finish;
12//! endmodule
13//! "#;
14//! let mut parser = tree_sitter::Parser::new();
15//! let language = tree_sitter_verilog::LANGUAGE;
16//! parser
17//!     .set_language(&language.into())
18//!     .expect("Error loading Verilog parser");
19//! let tree = parser.parse(code, None).unwrap();
20//! assert!(!tree.root_node().has_error());
21//! ```
22//!
23//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
24//! [tree-sitter]: https://tree-sitter.github.io/
25
26use tree_sitter_language::LanguageFn;
27
28extern "C" {
29    fn tree_sitter_verilog() -> *const ();
30}
31
32/// The tree-sitter [`LanguageFn`][LanguageFn] for this grammar.
33///
34/// [LanguageFn]: https://docs.rs/tree-sitter-language/*/tree_sitter_language/struct.LanguageFn.html
35pub const LANGUAGE: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_verilog) };
36
37/// The content of the [`node-types.json`][] file for this grammar.
38///
39/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
40pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
41
42#[cfg(test)]
43mod tests {
44    #[test]
45    fn test_can_load_grammar() {
46        let mut parser = tree_sitter::Parser::new();
47        parser
48            .set_language(&super::LANGUAGE.into())
49            .expect("Error loading Verilog parser");
50    }
51}
tree_sitter_verilog/lib.rs

tree_sitter_verilog/
lib.rs
