tree_sitter_mozcpp/
lib.rs

1// Adapted from tree-sitter-python bindings
2// -*- coding: utf-8 -*-
3// ------------------------------------------------------------------------------------------------
4// Copyright © 2021, tree-sitter-mozcpp authors.
5// See the LICENSE file in this repo for license details.
6// ------------------------------------------------------------------------------------------------
7
8//! This crate provides a Mozcpp grammar for the [tree-sitter][] parsing library.
9//!
10//! Typically, you will use the [language][language func] function to add this grammar to a
11//! tree-sitter [Parser][], and then use the parser to parse some code:
12//!
13//! ```
14//! use tree_sitter::Parser;
15//!
16//! let code = r#"
17//!     int double(int x) {
18//!         return x * 2;
19//!     }
20//! "#;
21//! let mut parser = Parser::new();
22//! parser.set_language(tree_sitter_mozcpp::language()).expect("Error loading Mozcpp grammar");
23//! let parsed = parser.parse(code, None);
24//! # let parsed = parsed.unwrap();
25//! # let root = parsed.root_node();
26//! # assert!(!root.has_error());
27//! ```
28//!
29//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
30//! [language func]: fn.language.html
31//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
32//! [tree-sitter]: https://tree-sitter.github.io/
33
34use tree_sitter::Language;
35
36extern "C" {
37    fn tree_sitter_cpp() -> Language;
38}
39
40/// Returns the tree-sitter [Language][] for this grammar.
41///
42/// [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
43pub fn language() -> Language {
44    unsafe { tree_sitter_cpp() }
45}
46
47/// The source of the Mozcpp tree-sitter grammar description.
48pub const GRAMMAR: &str = include_str!("../../grammar.js");
49
50/// The content of the [`node-types.json`][] file for this grammar.
51///
52/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
53pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
54
55#[cfg(test)]
56mod tests {
57    #[test]
58    fn can_load_grammar() {
59        let mut parser = tree_sitter::Parser::new();
60        parser
61            .set_language(super::language())
62            .expect("Error loading Mozcpp grammar");
63    }
64}