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
// `ok!` and `some!` are less bloaty alternatives to the standard library's try operator (`?`).
// Since we do not need type conversions in this crate we can fall back to much easier match
// patterns that compile faster and produce less bloaty code.
macro_rules! ok {
($expr:expr) => {
match $expr {
Ok(val) => val,
Err(err) => return Err(err),
}
};
}
macro_rules! some {
($expr:expr) => {
match $expr {
Some(val) => val,
None => return None,
}
};
}
/// Hidden utility module for the [`context!`](crate::context!) macro.
#[doc(hidden)]
pub mod __context {
pub use crate::value::merge_object::MergeObject;
use crate::value::{Value, ValueMap};
use crate::Environment;
use std::rc::Rc;
#[inline(always)]
pub fn value_optimization() -> impl Drop {
crate::value::value_optimization()
}
#[inline(always)]
pub fn make() -> ValueMap {
ValueMap::default()
}
#[inline(always)]
pub fn add(ctx: &mut ValueMap, key: &'static str, value: Value) {
ctx.insert(key.into(), value);
}
#[inline(always)]
pub fn build(ctx: ValueMap) -> Value {
Value::from_object(ctx)
}
pub fn thread_local_env() -> Rc<Environment<'static>> {
thread_local! {
static ENV: Rc<Environment<'static>> = Rc::new(Environment::new());
}
ENV.with(|x| x.clone())
}
}
/// Creates a template context from keys and values or merging in another value.
///
/// ```rust
/// # use minijinja::context;
/// let ctx = context!{
/// name => "Peter",
/// location => "World",
/// };
/// ```
///
/// Alternatively if the variable name matches the key name it can
/// be omitted:
///
/// ```rust
/// # use minijinja::context;
/// let name = "Peter";
/// let ctx = context!{ name };
/// ```
///
/// The return value is a [`Value`](crate::value::Value).
///
/// Note that [`context!`](crate::context!) can also be used recursively if you need to
/// create nested objects:
///
/// ```rust
/// # use minijinja::context;
/// let ctx = context! {
/// nav => vec![
/// context!(path => "/", title => "Index"),
/// context!(path => "/downloads", title => "Downloads"),
/// context!(path => "/faq", title => "FAQ"),
/// ]
/// };
/// ```
///
/// Additionally the macro supports a second syntax that can merge other
/// contexts or values. In that case one or more values need to be
/// passed with a leading `..` operator. This is useful to supply extra
/// values into render in a common place. The order of precedence is
/// left to right:
///
/// ```rust
/// # use minijinja::context;
/// let ctx = context! { a => "A" };
/// let ctx = context! { ..ctx, ..context! {
/// b => "B"
/// }};
///
/// // or
///
/// let ctx = context! {
/// a => "A",
/// ..context! {
/// b => "B"
/// }
/// };
/// ```
///
/// The merge works with an value, not just values created by the `context!`
/// macro and is performed lazy. This means it also works with dynamic
/// [`Object`](crate::value::Object)s.
///
/// # Note on Conversions
///
/// This macro uses [`Value::from_serialize`](crate::Value::from_serialize)
/// for conversions.
///
/// This macro currently does not move passed values. Future versions of
/// MiniJinja are going to change the move behavior and it's recommended to not
/// depend on this implicit reference behavior. You should thus pass values
/// with `&value` if you intend on still being able to reference them
/// after the macro invocation.
#[macro_export]
macro_rules! context {
() => {
$crate::__context::build($crate::__context::make())
};
(
$($key:ident $(=> $value:expr)?),*
$(, .. $ctx:expr),* $(,)?
) => {{
let _guard = $crate::__context::value_optimization();
let mut ctx = $crate::__context::make();
$(
$crate::__context_pair!(ctx, $key $(=> $value)?);
)*
let ctx = $crate::__context::build(ctx);
let mut merged_ctx = ::std::vec::Vec::new();
$(
merged_ctx.push($crate::value::Value::from($ctx));
)*;
if merged_ctx.is_empty() {
ctx
} else {
merged_ctx.insert(0, ctx);
$crate::value::Value::from_object($crate::__context::MergeObject(merged_ctx))
}
}};
(
$(.. $ctx:expr),* $(,)?
) => {{
let _guard = $crate::__context::value_optimization();
let mut ctx = ::std::vec::Vec::new();
$(
ctx.push($crate::value::Value::from($ctx));
)*;
$crate::value::Value::from_object($crate::__context::MergeObject(ctx))
}};
}
#[macro_export]
#[doc(hidden)]
macro_rules! __context_pair {
($ctx:ident, $key:ident) => {{
$crate::__context_pair!($ctx, $key => $key);
}};
($ctx:ident, $key:ident => $value:expr) => {
$crate::__context::add(
&mut $ctx,
stringify!($key),
$crate::value::Value::from_serialize(&$value),
);
};
}
/// An utility macro to create arguments for function calls.
///
/// This creates a slice of values on the stack which can be
/// passed to [`call`](crate::value::Value::call),
/// [`call_method`](crate::value::Value::call_method),
/// [`apply_filter`](crate::State::apply_filter),
/// [`perform_test`](crate::State::perform_test) or similar
/// APIs that take slices of values.
///
/// It supports both positional and keyword arguments.
/// To mark a parameter as keyword argument define it as
/// `name => value`, otherwise just use `value`.
///
/// ```
/// # use minijinja::{value::Value, args, Environment};
/// # let env = Environment::default();
/// # let state = &env.empty_state();
/// # let value = Value::from(());
/// value.call(state, args!(1, 2, foo => "bar"));
/// ```
///
/// Note that this like [`context!`](crate::context) goes through
/// [`Value::from_serialize`](crate::value::Value::from_serialize).
#[macro_export]
macro_rules! args {
() => { &[][..] as &[$crate::value::Value] };
($($arg:tt)*) => { $crate::__args_helper!(branch [[$($arg)*]], [$($arg)*]) };
}
/// Utility macro for `args!`
#[macro_export]
#[doc(hidden)]
macro_rules! __args_helper {
// branch helper between `args` and `kwargs`.
//
// It analyzes the first bracket enclosed tt bundle to see if kwargs are
// used. If yes, it uses `kwargs` to handle the second tt
// bundle, otherwise it uses `args`.
(branch [[]], $args:tt) => { $crate::__args_helper!(args $args) };
(branch [[$n:ident => $e:expr]], $args:tt) => { $crate::__args_helper!(kwargs $args) };
(branch [[$n:ident => $e:expr, $($r:tt)*]], $args:tt) => { $crate::__args_helper!(kwargs $args) };
(branch [[$e:expr]], $args:tt) => { $crate::__args_helper!(args $args) };
(branch [[$e:expr, $($rest:tt)*]], $args:tt) => { $crate::__args_helper!(branch [[$($rest)*]], $args) };
// creates args on the stack
(args [$($arg:tt)*]) => {{
let mut args = Vec::<$crate::value::Value>::new();
$crate::__args_helper!(peel args, args, false, [$($arg)*]);
&(&{args})[..]
}};
// creates args with kwargs on the stack
(kwargs [$($arg:tt)*]) => {{
let mut args = Vec::<$crate::value::Value>::new();
let mut kwargs = Vec::<(&str, $crate::value::Value)>::new();
$crate::__args_helper!(peel args, kwargs, false, [$($arg)*]);
args.push($crate::value::Kwargs::from_iter(kwargs.into_iter()).into());
&(&{args})[..]
}};
// Peels a single argument from the arguments and stuffs them into
// `$args` or `$kwargs` depending on type.
(peel $args:ident, $kwargs:ident, $has_kwargs:ident, []) => {};
(peel $args:ident, $kwargs:ident, $has_kwargs:ident, [$name:ident => $expr:expr]) => {
$kwargs.push((stringify!($name), $crate::value::Value::from_serialize(&$expr)));
};
(peel $args:ident, $kwargs:ident, $has_kwargs:ident, [$name:ident => $expr:expr, $($rest:tt)*]) => {
$kwargs.push((stringify!($name), $crate::value::Value::from_serialize(&$expr)));
$crate::__args_helper!(peel $args, $kwargs, true, [$($rest)*]);
};
(peel $args:ident, $kwargs:ident, false, [$expr:expr]) => {
$args.push($crate::value::Value::from_serialize(&$expr));
};
(peel $args:ident, $kwargs:ident, false, [$expr:expr, $($rest:tt)*]) => {
$args.push($crate::value::Value::from_serialize(&$expr));
$crate::__args_helper!(peel $args, $kwargs, false, [$($rest)*]);
};
}
/// A macro similar to [`format!`] but that uses MiniJinja for rendering.
///
/// This can be used to quickly render a MiniJinja template into a string
/// without having to create an environment first which can be useful in
/// some situations. Note however that the template is re-parsed every
/// time the [`render!`](crate::render) macro is called which is potentially
/// slow.
///
/// There are two forms for this macro. The default form takes template
/// source and context variables, the extended form also lets you provide
/// a custom environment that should be used rather than a default one.
/// The context variables are passed the same way as with the
/// [`context!`](crate::context) macro.
///
/// # Example
///
/// Passing context explicitly:
///
/// ```
/// # use minijinja::render;
/// println!("{}", render!("Hello {{ name }}!", name => "World"));
/// ```
///
/// Passing variables with the default name:
///
/// ```
/// # use minijinja::render;
/// let name = "World";
/// println!("{}", render!("Hello {{ name }}!", name));
/// ```
///
/// Passing an explicit environment:
///
/// ```
/// # use minijinja::{Environment, render};
/// let env = Environment::new();
/// println!("{}", render!(in env, "Hello {{ name }}!", name => "World"));
/// ```
///
/// # Panics
///
/// This macro panics if the format string is an invalid template or the
/// template evaluation failed.
#[macro_export]
macro_rules! render {
(
in $env:expr,
$tmpl:expr
$(, $key:ident $(=> $value:expr)?)* $(,)?
) => {
($env).render_str($tmpl, $crate::context! { $($key $(=> $value)? ,)* })
.expect("failed to render expression")
};
(
$tmpl:expr
$(, $key:ident $(=> $value:expr)?)* $(,)?
) => {
$crate::render!(in $crate::__context::thread_local_env(), $tmpl, $($key $(=> $value)? ,)*)
}
}