tree_sitter_python/lib.rs
1//! This crate provides Python 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//! use tree_sitter::Parser;
8//!
9//! let code = r#"
10//! def double(x):
11//! return x * 2
12//! "#;
13//! let mut parser = Parser::new();
14//! let language = tree_sitter_python::LANGUAGE;
15//! parser
16//! .set_language(&language.into())
17//! .expect("Error loading Python parser");
18//! let tree = parser.parse(code, None).unwrap();
19//! assert!(!tree.root_node().has_error());
20//! ```
21//!
22//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
23//! [tree-sitter]: https://tree-sitter.github.io/
24
25use tree_sitter_language::LanguageFn;
26
27extern "C" {
28 fn tree_sitter_python() -> *const ();
29}
30
31/// The tree-sitter [`LanguageFn`][LanguageFn] for this grammar.
32///
33/// [LanguageFn]: https://docs.rs/tree-sitter-language/*/tree_sitter_language/struct.LanguageFn.html
34pub const LANGUAGE: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_python) };
35
36/// The content of the [`node-types.json`][] file for this grammar.
37///
38/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
39pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
40
41/// The syntax highlighting query for this language.
42pub const HIGHLIGHTS_QUERY: &str = include_str!("../../queries/highlights.scm");
43
44/// The symbol tagging query for this language.
45pub const TAGS_QUERY: &str = include_str!("../../queries/tags.scm");
46
47#[cfg(test)]
48mod tests {
49 #[test]
50 fn test_can_load_grammar() {
51 let mut parser = tree_sitter::Parser::new();
52 parser
53 .set_language(&super::LANGUAGE.into())
54 .expect("Error loading Python parser");
55 }
56}