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
use std::collections::HashMap; use std::fmt; /// Whether to remove the whitespace of a `{% %}` tag #[derive(Clone, Copy, Debug, PartialEq)] pub struct WS { /// `true` if the tag is `{%-` pub left: bool, /// `true` if the tag is `-%}` pub right: bool, } impl Default for WS { fn default() -> Self { WS { left: false, right: false } } } /// All math operators #[derive(Copy, Clone, Debug, PartialEq)] pub enum MathOperator { /// + Add, /// - Sub, /// * Mul, /// / Div, /// % Modulo, } impl fmt::Display for MathOperator { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!( f, "{}", match *self { MathOperator::Add => "+", MathOperator::Sub => "-", MathOperator::Mul => "*", MathOperator::Div => "/", MathOperator::Modulo => "%", } ) } } /// All logic operators #[derive(Copy, Clone, Debug, PartialEq)] pub enum LogicOperator { /// > Gt, /// >= Gte, /// < Lt, /// <= Lte, /// == Eq, /// != NotEq, /// and And, /// or Or, } impl fmt::Display for LogicOperator { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!( f, "{}", match *self { LogicOperator::Gt => ">", LogicOperator::Gte => ">=", LogicOperator::Lt => "<", LogicOperator::Lte => "<=", LogicOperator::Eq => "==", LogicOperator::NotEq => "!=", LogicOperator::And => "and", LogicOperator::Or => "or", } ) } } /// A function call, can be a filter or a global function #[derive(Clone, Debug, PartialEq)] pub struct FunctionCall { /// The name of the function pub name: String, /// The args of the function: key -> value pub args: HashMap<String, Expr>, } /// A mathematical expression #[derive(Clone, Debug, PartialEq)] pub struct MathExpr { /// The left hand side of the expression pub lhs: Box<Expr>, /// The right hand side of the expression pub rhs: Box<Expr>, /// The operator used pub operator: MathOperator, } /// A logical expression #[derive(Clone, Debug, PartialEq)] pub struct LogicExpr { /// The left hand side of the expression pub lhs: Box<Expr>, /// The right hand side of the expression pub rhs: Box<Expr>, /// The operator used pub operator: LogicOperator, } /// Can only be a combination of string + ident or ident + ident #[derive(Clone, Debug, PartialEq)] pub struct StringConcat { /// All the values we're concatening into a string pub values: Vec<ExprVal>, } /// An expression is the node found in variable block, kwargs and conditions. #[derive(Clone, Debug, PartialEq)] #[allow(missing_docs)] pub enum ExprVal { String(String), Int(i64), Float(f64), Bool(bool), Ident(String), Math(MathExpr), Logic(LogicExpr), Test(Test), MacroCall(MacroCall), FunctionCall(FunctionCall), // A vec of Expr, not ExprVal since filters are allowed // on values inside arrays Array(Vec<Expr>), StringConcat(StringConcat), } /// An expression is a value that can be negated and followed by /// optional filters #[derive(Clone, Debug, PartialEq)] pub struct Expr { /// The expression we are evaluating pub val: ExprVal, /// Is it using `not`? pub negated: bool, /// List of filters used on that value pub filters: Vec<FunctionCall>, } impl Expr { /// Create a new basic Expr pub fn new(val: ExprVal) -> Expr { Expr { val, negated: false, filters: vec![] } } /// Create a new negated Expr pub fn new_negated(val: ExprVal) -> Expr { Expr { val, negated: true, filters: vec![] } } /// Create a new basic Expr with some filters pub fn with_filters(val: ExprVal, filters: Vec<FunctionCall>) -> Expr { Expr { val, filters, negated: false } } /// Check if the expr has a default filter as first filter pub fn has_default_filter(&self) -> bool { if self.filters.is_empty() { return false; } self.filters[0].name == "default" } } /// A test node `if my_var is odd` #[derive(Clone, Debug, PartialEq)] pub struct Test { /// Which expression is evaluated pub ident: String, /// Name of the test pub name: String, /// Any optional arg given to the test pub args: Vec<Expr>, } /// A filter section node `{{ filter name(param="value") }} content {{ endfilter }}` #[derive(Clone, Debug, PartialEq)] pub struct FilterSection { /// The filter call itsel pub filter: FunctionCall, /// The filter body pub body: Vec<Node>, } /// Set a variable in the context `{% set val = "hey" %}` #[derive(Clone, Debug, PartialEq)] pub struct Set { /// The name for that value in the context pub key: String, /// The value to assign pub value: Expr, /// Whether we want to set the variable globally or locally /// global_set is only useful in loops pub global: bool, } /// A call to a namespaced macro `macros::my_macro()` #[derive(Clone, Debug, PartialEq)] pub struct MacroCall { /// The namespace we're looking for that macro in pub namespace: String, /// The macro name pub name: String, /// The args for that macro: name -> value pub args: HashMap<String, Expr>, } /// A Macro definition #[derive(Clone, Debug, PartialEq)] pub struct MacroDefinition { /// The macro name pub name: String, /// The args for that macro: name -> optional default value pub args: HashMap<String, Option<Expr>>, /// The macro content pub body: Vec<Node>, } /// A block definition #[derive(Clone, Debug, PartialEq)] pub struct Block { /// The block name pub name: String, /// The block content pub body: Vec<Node>, } /// A forloop: can be over values or key/values #[derive(Clone, Debug, PartialEq)] pub struct Forloop { /// Name of the key in the loop (only when iterating on map-like objects) pub key: Option<String>, /// Name of the local variable for the value in the loop pub value: String, /// Expression being iterated on pub container: Expr, /// What's in the forloop itself pub body: Vec<Node>, } /// An if/elif/else condition with their respective body #[derive(Clone, Debug, PartialEq)] pub struct If { /// First item if the if, all the ones after are elif pub conditions: Vec<(WS, Expr, Vec<Node>)>, /// The optional `else` block pub otherwise: Option<(WS, Vec<Node>)>, } /// All Tera nodes that can be encountered #[derive(Clone, Debug, PartialEq)] pub enum Node { /// A call to `{{ super() }}` in a block Super, /// Some actual text Text(String), /// A `{{ }}` block VariableBlock(Expr), /// A `{% macro hello() %}...{% endmacro %}` MacroDefinition(WS, MacroDefinition, WS), /// The `{% extends "blabla.html" %}` node, contains the template name Extends(WS, String), /// The `{% include "blabla.html" %}` node, contains the template name Include(WS, String), /// The `{% import "macros.html" as macros %}` ImportMacro(WS, String, String), /// The `{% set val = something %}` tag Set(WS, Set), /// The text between `{% raw %}` and `{% endraw %}` Raw(WS, String, WS), /// A filter section node `{{ filter name(param="value") }} content {{ endfilter }}` FilterSection(WS, FilterSection, WS), /// A `{% block name %}...{% endblock %}` Block(WS, Block, WS), /// A `{% for i in items %}...{% endfor %}` Forloop(WS, Forloop, WS), /// A if/elif/else block, WS for the if/elif/else is directly in the struct If(If, WS), /// The `{% break %}` tag Break(WS), /// The `{% continue %}` tag Continue(WS), }