1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
//! [`syn`]-powered parser for JSX-like [`TokenStream`]s, aka RSX. The parsed result is a //! nested [`Node`] structure, similar to the browser DOM, where node name and //! value are syn expressions to support building proc macros. //! //! ```rust //! use quote::quote; //! use syn_rsx::parse2; //! //! let tokens = quote! { <hello world>"hi"</hello> }; //! //! let nodes = parse2(tokens).unwrap(); //! assert_eq!(nodes[0].name_as_string().unwrap(), "hello"); //! assert_eq!(nodes[0].attributes[0].name_as_string().unwrap(), "world"); //! assert_eq!(nodes[0].children[0].value_as_string().unwrap(), "hi"); //! ``` //! //! ## Features //! //! //! - **Not opinionated** //! //! Every tag or attribute name is valid //! //! ```rust //! # use quote::quote; //! # use syn_rsx::parse2; //! # parse2(quote! { //! <hello world /> //! # }).unwrap(); //! ``` //! //! - **Text nodes** //! //! ```rust //! # use quote::quote; //! # use syn_rsx::parse2; //! # parse2(quote! { //! <div>"String literal"</div> //! # }).unwrap(); //! ``` //! //! Support for [unquoted text is planned] //! //! - **Node names separated by dash, colon or double colon** //! //! ```rust //! # use quote::quote; //! # use syn_rsx::parse2; //! # parse2(quote! { //! <tag-name attribute-key="value" /> //! <tag:name attribute:key="value" /> //! <tag::name attribute::key="value" /> //! # }).unwrap(); //! ``` //! //! - **Node names with reserved keywords** //! //! ```rust //! # use quote::quote; //! # use syn_rsx::parse2; //! # parse2(quote! { //! <input type="submit" /> //! # }).unwrap(); //! ``` //! //! - **Attribute values can be any valid syn expression without requiring braces** //! //! ```rust //! # use quote::quote; //! # use syn_rsx::parse2; //! # parse2(quote! { //! <div key=some::value() /> //! # }).unwrap(); //! ``` //! //! - **Braced blocks are parsed as arbitrary Rust code** //! //! ```rust //! # use quote::quote; //! # use syn_rsx::parse2; //! # parse2(quote! { //! <div>{ let block = "in node position"; }</div> //! <div { let block = "in attribute position"; } /> //! <div key={ let block = "in attribute value position"; } /> //! # }).unwrap(); //! ``` //! //! - **Helpful error reporting out of the box** //! //! ```ignore //! error: open tag has no corresponding close tag and is not self-closing //! --> examples/html-to-string-macro/tests/lib.rs:5:24 //! | //! 5 | html_to_string! { <div> }; //! | ^^^ //! ``` //! //! - **Customization** //! //! A [`ParserConfig`] to customize parsing behavior is available, so if you have //! slightly different requirements for parsing and it's not yet customizable //! feel free to open an issue or pull request to extend the configuration. //! //! //! [`syn`]: /syn //! [`TokenStream`]: https://doc.rust-lang.org/proc_macro/struct.TokenStream.html //! [`Node`]: struct.Node.html //! [`ParserConfig`]: struct.ParserConfig.html //! [mod style path]: https://docs.rs/syn/1.0.40/syn/struct.Path.html#method.parse_mod_style //! [unquoted text is planned]: https://github.com/stoically/syn-rsx/issues/2 extern crate proc_macro; use syn::{ parse::{ParseStream, Parser as _}, Result, }; mod node; mod parser; pub mod punctuation { //! Custom syn punctuations use syn::custom_punctuation; custom_punctuation!(Dash, -); } pub use node::{Node, NodeName, NodeType}; pub use parser::{Parser, ParserConfig}; /// Parse the given [`proc-macro::TokenStream`] into a [`Node`] tree /// /// [`proc-macro::TokenStream`]: https://doc.rust-lang.org/proc_macro/struct.TokenStream.html /// [`Node`]: struct.Node.html pub fn parse(tokens: proc_macro::TokenStream) -> Result<Vec<Node>> { let parser = move |input: ParseStream| Parser::new(ParserConfig::default()).parse(input); parser.parse(tokens) } /// Parse the given [`proc-macro::TokenStream`] into a [`Node`] tree with custom [`ParserConfig`] /// /// [`proc-macro::TokenStream`]: https://doc.rust-lang.org/proc_macro/struct.TokenStream.html /// [`Node`]: struct.Node.html /// [`ParserConfig`]: struct.ParserConfig.html pub fn parse_with_config( tokens: proc_macro::TokenStream, config: ParserConfig, ) -> Result<Vec<Node>> { let parser = move |input: ParseStream| Parser::new(config).parse(input); parser.parse(tokens) } /// Parse the given [`proc-macro2::TokenStream`] into a [`Node`] tree /// /// [`proc-macro2::TokenStream`]: https://docs.rs/proc-macro2/latest/proc_macro2/struct.TokenStream.html /// [`Node`]: struct.Node.html pub fn parse2(tokens: proc_macro2::TokenStream) -> Result<Vec<Node>> { let parser = move |input: ParseStream| Parser::new(ParserConfig::default()).parse(input); parser.parse2(tokens) } /// Parse the given [`proc-macro2::TokenStream`] into a [`Node`] tree with custom [`ParserConfig`] /// /// [`proc-macro2::TokenStream`]: https://docs.rs/proc-macro2/latest/proc_macro2/struct.TokenStream.html /// [`Node`]: struct.Node.html /// [`ParserConfig`]: struct.ParserConfig.html pub fn parse2_with_config( tokens: proc_macro2::TokenStream, config: ParserConfig, ) -> Result<Vec<Node>> { let parser = move |input: ParseStream| Parser::new(config).parse(input); parser.parse2(tokens) }