// -*- coding: utf-8 -*- // ------------------------------------------------------------------------------------------------ // Copyright © 2020, tree-sitter-python authors. // See the LICENSE file in this repo for license details. // ------------------------------------------------------------------------------------------------ //! This crate provides a Python grammar for the [tree-sitter][] parsing library. //! //! Typically, you will use the [language][language func] function to add this grammar to a //! tree-sitter [Parser][], and then use the parser to parse some code: //! //! ``` //! use tree_sitter::Parser; //! //! let code = r#" //! def double(x): //! return x * 2 //! "#; //! let mut parser = Parser::new(); //! parser.set_language(tree_sitter_python::language()).expect("Error loading Python grammar"); //! let parsed = parser.parse(code, None); //! # let parsed = parsed.unwrap(); //! # let root = parsed.root_node(); //! # assert!(!root.has_error()); //! ``` //! //! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html //! [language func]: fn.language.html //! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html //! [tree-sitter]: https://tree-sitter.github.io/ use tree_sitter::Language; extern "C" { fn tree_sitter_python() -> Language; } /// Returns the tree-sitter [Language][] for this grammar. /// /// [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html pub fn language() -> Language { unsafe { tree_sitter_python() } } /// The source of the Python tree-sitter grammar description. pub const GRAMMAR: &str = include_str!("../../grammar.js"); /// The syntax highlighting query for this language. pub const HIGHLIGHT_QUERY: &str = include_str!("../../queries/highlights.scm"); /// The content of the [`node-types.json`][] file for this grammar. /// /// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types pub const NODE_TYPES: &str = include_str!("../../src/node-types.json"); /// The symbol tagging query for this language. pub const TAGGING_QUERY: &str = include_str!("../../queries/tags.scm"); #[cfg(test)] mod tests { #[test] fn can_load_grammar() { let mut parser = tree_sitter::Parser::new(); parser .set_language(super::language()) .expect("Error loading Python grammar"); } }