tree_sitter_xml/
lib.rs

1//! This crate provides XML and DTD language support for the [tree-sitter][] parsing library.
2//!
3//! Typically, you will use the [LANGUAGE_XML][] 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//! <?xml version="1.0" encoding="UTF-8"?>
11//! <note>
12//!   <to>Tove</to>
13//!   <from>Jani</from>
14//!   <heading>Reminder</heading>
15//!   <body>Don't forget me this weekend!</body>
16//! </note>
17//! "#;
18//! let mut parser = Parser::new();
19//! let language = tree_sitter_xml::LANGUAGE_XML;
20//! parser
21//!     .set_language(&language.into())
22//!     .expect("Error loading XML parser");
23//! let tree = parser.parse(code, None).unwrap();
24//! assert!(!tree.root_node().has_error());
25//! ```
26//!
27//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
28//! [tree-sitter]: https://tree-sitter.github.io/
29
30use tree_sitter_language::LanguageFn;
31
32extern "C" {
33    fn tree_sitter_dtd() -> *const ();
34    fn tree_sitter_xml() -> *const ();
35}
36
37/// The tree-sitter [`LanguageFn`][LanguageFn] for the DTD grammar.
38///
39/// [LanguageFn]: https://docs.rs/tree-sitter-language/*/tree_sitter_language/struct.LanguageFn.html
40pub const LANGUAGE_DTD: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_dtd) };
41
42/// The tree-sitter [`LanguageFn`][LanguageFn] for the XML grammar.
43///
44/// [LanguageFn]: https://docs.rs/tree-sitter-language/*/tree_sitter_language/struct.LanguageFn.html
45pub const LANGUAGE_XML: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_xml) };
46
47/// The syntax highlighting queries for XML.
48pub const XML_HIGHLIGHT_QUERY: &str = include_str!("../../queries/xml/highlights.scm");
49
50/// The syntax highlighting queries for DTD.
51pub const DTD_HIGHLIGHT_QUERY: &str = include_str!("../../queries/dtd/highlights.scm");
52
53/// The content of the [`node-types.json`][] file for XML.
54///
55/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
56pub const XML_NODE_TYPES: &str = include_str!("../../xml/src/node-types.json");
57
58/// The content of the [`node-types.json`][] file for DTD.
59///
60/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
61pub const DTD_NODE_TYPES: &str = include_str!("../../dtd/src/node-types.json");
62
63#[cfg(test)]
64mod tests {
65    #[test]
66    fn test_can_load_xml_grammar() {
67        let mut parser = tree_sitter::Parser::new();
68        parser
69            .set_language(&super::LANGUAGE_XML.into())
70            .expect("Error loading XML parser");
71    }
72
73    #[test]
74    fn test_can_load_dtd_grammar() {
75        let mut parser = tree_sitter::Parser::new();
76        parser
77            .set_language(&super::LANGUAGE_DTD.into())
78            .expect("Error loading DTD parser");
79    }
80}
tree_sitter_xml/lib.rs

tree_sitter_xml/
lib.rs
