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 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
//! This crate allows you to separate your HTML from your Rust code when using [Yew](https://yew.rs).
//!
//! # Getting Started
//!
//! ## Hello World
//!
//! ```html
//! <div>
//! <p>Hello [name]!</p>
//! </div>
//! ```
//!
//! ```rust
//! # use yew_template::*;
//! # use yew::prelude::*;
//! # fn main() {
//! let html = template_html!("templates/hello.html", name="World");
//! # }
//! ```
//!
//! The code above will actually compile to the following code:
//!
//! ```rust
//! # use yew::prelude::*;
//! # fn main() {
//! let html = html! {
//! <div>
//! <p>{"Hello World!"}</p>
//! </div>
//! };
//! # }
//! ```
//!
//! # Usage
//!
//! - [Attributes](#attributes)
//! - [Variables](#variables)
//! - [Struct fields](#struct-fields)
//! - [Expressions](#expressions)
//! - [Example: Yew callbacks](#example-with-yew-callbacks)
//! - [Optional variables](#optional-variables)
//! - [Optional elements](#optional-elements)
//! - [Iterators](#iterators)
//!
//! ## Attributes
//!
//! ```html
//! <div style=[style]>
//! <p>Hello [name]!</p>
//! </div>
//! ```
//!
//! ```rust
//! # use yew_template::*;
//! # use yew::prelude::*;
//! # fn main() {
//! let html = template_html!("templates/hello.html", name="World", style="color: red;");
//! # }
//! ```
//!
//! ## Variables
//!
//! ```rust
//! # use yew_template::*;
//! # use yew::prelude::*;
//! # fn main() {
//! let name = "World";
//! let html = template_html!("templates/hello.html", name);
//! # }
//! ```
//!
//! Would compile to:
//!
//! ```rust
//! # use yew::prelude::*;
//! # fn main() {
//! let name = "World";
//! let html = html! {
//! <div>
//! <p>{"Hello "}{name}{"!"}</p>
//! </div>
//! };
//! # }
//! ```
//!
//! When the name of your variable isn't the same as the name in the template, you can use the following syntax:
//!
//! ```rust
//! # use yew_template::*;
//! # use yew::prelude::*;
//! # fn main() {
//! let last_name = "World";
//! let html = template_html!("templates/hello.html", name=last_name);
//! # }
//! ```
//!
//! ## Struct fields
//!
//! Sometimes you want to pass many struct fields as variables to your template, but destructuring the struct would be too verbose.
//! Instead, you can pass just the struct and access its fields from the template:
//!
//! ```html
//! <div>
//! <p>Hello [person.first_name] [person.last_name]!</p>
//! </div>
//! ```
//!
//! ```rust
//! # use yew_template::*;
//! # use yew::prelude::*;
//! # fn main() {
//! struct Person {
//! first_name: String,
//! last_name: String,
//! }
//!
//! let person = Person { first_name: "Edouard".to_string(), last_name: "Foobar".to_string() };
//! let html = template_html!("templates/fields.html", person);
//! # }
//! ```
//!
//! ## Expressions
//!
//! ```rust
//! # use yew_template::*;
//! # use yew::prelude::*;
//! # fn main() {
//! let name_reversed = String::from("dlroW");
//! let html = template_html!(
//! "templates/hello.html",
//! name = {
//! let mut name = name_reversed.into_bytes();
//! name.reverse();
//! let name = String::from_utf8(name).unwrap();
//! name
//! }
//! );
//! # }
//! ```
//!
//! Which will also display `Hello World!` as the output is as follows:
//!
//! ```rust
//! # use yew::prelude::*;
//! # fn main() {
//! let name_reversed = String::from("dlroW");
//! let html = html! {
//! <div>
//! <p>
//! {"Hello "}{{
//! let mut name = name_reversed.into_bytes();
//! name.reverse();
//! let name = String::from_utf8(name).unwrap();
//! name
//! }}{"!"}
//! </p>
//! </div>
//! };
//! # }
//! ```
//!
//! Note that the curly brackets around expressions are required for expressions.
//!
//! ## Example with Yew callbacks
//!
//! ```html
//! <div onclick=[onclick]>
//! <p>Hello [name]!</p>
//! </div>
//! ```
//!
//! ```ignore
//! # use yew_template::*;
//! # use yew::prelude::*;
//! # fn main() {
//! let link = ctx.link();
//! let html = template_html!("templates/hello.html", name="World", onclick={link.callback(|_| Msg::AddOne)});
//! # }
//! ```
//!
//! ## Optional variables
//!
//! Optional variables are marked with an `opt_` prefix or an `_opt` suffix, at your option.
//! Their value is expected to be an `Option<T>`.
//!
//! Optional variables work with optional html elements. Mark an element with the `opt` attribute to make it optional. An optional element will only be rendered if *ALL* the optional variables it contains are `Some`. Note that variables contained by smaller optional elements are excluded from this requirement.
//!
//! ```html
//! <div>
//! <p>Hello [name]!</p>
//! <div opt>
//! <h2>Age</h2>
//! <p>You are [opt_age] years old!</p>
//! </div>
//! </div>
//! ```
//!
//! In the example above, the `div` block will not be shown if `opt_age` is `None`.
//!
//! Let's see how optional elements can be nested.
//!
//! ```html
//! <div>
//! <p>Hello [name]!</p>
//! <div opt>
//! <h2>Age</h2>
//! <p>You are [opt_age] years old!</p>
//! <p opt>And you are born in [opt_birth_city].</p>
//! </div>
//! </div>
//! ```
//!
//! Here, both `opt_age` and `opt_birth_city` are optional. `opt_age` would be displayed even if `opt_birth_city` is `None`. However, if `opt_age` is `None`, `opt_birth_city` will not be displayed regardless of its value.
//!
//! From the Rust side, there is no usage difference. Note that curly brackets are required (for now).
//!
//! ```rust
//! # use yew_template::*;
//! # use yew::prelude::*;
//! # fn main() {
//! let opt_age: Option<u8> = Some(20);
//! let opt_birth_city: Option<String> = None;
//! let html = template_html!("templates/opt.html", name="John", opt_age, opt_birth_city);
//! # }
//! ```
//!
//! ## Optional elements
//!
//! Sometimes optional variables are not suitable for making an element optional. You might need a logic that is more complex than just checking if a variable is `Some` or `None`. In this case, you can use optional elements.
//!
//! Elements can be given a `present-if` attribute. The value will be evaluated at runtime as a boolean expression. If the expression is `true`, the element will be rendered. Otherwise, it will be skipped.
//!
//! ```html
//! <div present-if=[condition]>
//! <p>1+1 = 3</p>
//! </div>
//! <div present-if=![condition]> <!-- Negation is supported -->
//! <p>1+1 != 3</p>
//! </div>
//! ```
//!
//! ```rust
//! # use yew_template::*;
//! # use yew::prelude::*;
//! # fn main() {
//! let html = template_html!("templates/present_if.html", condition={ 1+1==3 });
//! # }
//! ```
//!
//! ## Iterators
//!
//! Iterators work similarly to optional variables. The iterator variables are marked with an `iter_` prefix or an `_iter` suffix, at your option.
//! The looping html element is marked with the `iter` attribute. The element will reproduce until one of the iterators it depends on is empty.
//!
//! ```html
//! <div>
//! <h2>Contributors:</h2>
//! <ul>
//! <li iter>[contributors_iter] ([commits_iter] commits)</li>
//! </ul>
//! </div>
//! ```
//!
//! ```rust
//! # use yew_template::*;
//! # use yew::prelude::*;
//! # fn main() {
//! let contributors = vec!["John", "Jane", "Jack"]; // Owned values need to be declared as `let` or they would be freed before the template is rendered.
//! let html = template_html!(
//! "templates/iter.html",
//! contributors_iter = {contributors.iter()},
//! commits_iter = {[42, 21, 7].iter()}
//! );
//! # }
//! ```
//!
//! The code above will act as the following:
//!
//! ```rust
//! # use yew::prelude::*;
//! # fn main() {
//! let contributors = vec!["John", "Jane", "Jack"];
//! let html = html! {
//! <div>
//! <h2>{"Contributors:"}</h2>
//! <ul>
//! {{
//! let mut contributors_iter = { contributors.iter() };
//! let mut commits_iter = { [42, 21, 7].iter() };
//! let mut fragments = Vec::new();
//! while let (Some(contributor), Some(commits)) = (contributors_iter.next(), commits_iter.next()) {
//! fragments.push(html! { <li>{contributor}{" ("}{commits}{" commits)"}</li> });
//! }
//! fragments.into_iter().collect::<Html>()
//! }}
//! </ul>
//! </div>
//! };
//! # }
//! ```
//!
//! # Notes
//!
//! - Litteral values are NOT escaped because they come from your code. Using a litteral value of `value closed by quotes" trailing stuff` will cause problems. This will be fixed in a future version. (Note that dynamic string values are always fine and are even escaped by Yew.)
//!
//! - You can use multiple top-level elements in your html template file.
extern crate proc_macro;
use proc_macro::TokenStream;
mod args;
mod codegen;
mod sink;
pub(crate) use {
crate::args::*,
crate::codegen::*,
crate::sink::*,
proc_macro_error::*,
};
/// Reads a file and replaces the variables it contains with the supplied values. Produces a Yew html! macro invocation.
///
/// ```ignore
/// let html = template_html!("path", arg="value", arg2="value2", arg3={expression});
/// ```
///
/// See top-level documentation for more information.
#[proc_macro]
#[proc_macro_error]
pub fn template_html(args: TokenStream) -> TokenStream {
let args = parse_args(args);
//println!("{args:?}");
let code = generate_code(args);
code.parse().unwrap()
}