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
/// Macro that allows you to quickly define a handlebars helper by passing a
/// name and a closure.
///
/// There are several types of arguments available to closure:
///
/// * Parameters are mapped to closure arguments one by one. Any declared
/// parameters are required
/// * Hash are mapped as named arguments and declared in a bracket block.
/// All named arguments are optional so default value is required.
/// * An optional `*args` provides a vector of all helper parameters.
/// * An optional `**kwargs` provides a map of all helper hash.
///
/// # Examples
///
/// ```rust
/// #[macro_use] extern crate handlebars;
/// #[macro_use] extern crate serde_json;
///
/// handlebars_helper!(is_above_10: |x: u64| x > 10);
/// handlebars_helper!(is_above: |x: u64, { compare: u64 = 10 }| x > compare);
///
/// # fn main() {
/// #
/// let mut handlebars = handlebars::Handlebars::new();
/// handlebars.register_helper("is-above-10", Box::new(is_above_10));
/// handlebars.register_helper("is-above", Box::new(is_above));
///
/// let result = handlebars
/// .render_template("{{#if (is-above-10 12)}}great!{{else}}okay{{/if}}", &json!({}))
/// .unwrap();
/// assert_eq!(&result, "great!");
/// let result2 = handlebars
/// .render_template("{{#if (is-above 12 compare=10)}}great!{{else}}okay{{/if}}", &json!({}))
/// .unwrap();
/// assert_eq!(&result2, "great!");
/// # }
/// ```
#[macro_export]
macro_rules! handlebars_helper {
($struct_name:ident: |$($name:ident: $tpe:tt$(<$($gen:ty),+>)?),*
$($(,)?{$($hash_name:ident: $hash_tpe:tt=$dft_val:literal),*})?
$($(,)?*$args:ident)?
$($(,)?**$kwargs:ident)?|
$body:expr ) => {
#[allow(non_camel_case_types)]
pub struct $struct_name;
impl $crate::HelperDef for $struct_name {
#[allow(unused_assignments)]
fn call_inner<'reg: 'rc, 'rc>(
&self,
h: &$crate::Helper<'reg, 'rc>,
r: &'reg $crate::Handlebars<'reg>,
_: &'rc $crate::Context,
_: &mut $crate::RenderContext<'reg, 'rc>,
) -> Result<$crate::ScopedJson<'reg, 'rc>, $crate::RenderError> {
let mut param_idx = 0;
$(
let $name = h.param(param_idx)
.and_then(|x| {
if r.strict_mode() && x.is_value_missing() {
None
} else {
Some(x.value())
}
})
.ok_or_else(|| $crate::RenderError::new(&format!(
"`{}` helper: Couldn't read parameter {}",
stringify!($struct_name), stringify!($name),
)))
.and_then(|x|
handlebars_helper!(@as_json_value x, $tpe$(<$($gen),+>)?)
.ok_or_else(|| $crate::RenderError::new(&format!(
"`{}` helper: Couldn't convert parameter {} to type `{}`. \
It's {:?} as JSON. Got these params: {:?}",
stringify!($struct_name), stringify!($name), stringify!($tpe$(<$($gen),+>)?),
x, h.params(),
)))
)?;
param_idx += 1;
)*
$(
$(
let $hash_name = h.hash_get(stringify!($hash_name))
.map(|x| x.value())
.map(|x|
handlebars_helper!(@as_json_value x, $hash_tpe)
.ok_or_else(|| $crate::RenderError::new(&format!(
"`{}` helper: Couldn't convert hash {} to type `{}`. \
It's {:?} as JSON. Got these hash: {:?}",
stringify!($struct_name), stringify!($hash_name), stringify!($hash_tpe),
x, h.hash(),
)))
)
.unwrap_or_else(|| Ok($dft_val))?;
)*
)?
$(let $args = h.params().iter().map(|x| x.value()).collect::<Vec<&serde_json::Value>>();)?
$(let $kwargs = h.hash().iter().map(|(k, v)| (k.to_owned(), v.value())).collect::<std::collections::BTreeMap<&str, &serde_json::Value>>();)?
let result = $body;
Ok($crate::ScopedJson::Derived($crate::JsonValue::from(result)))
}
}
};
(@as_json_value $x:ident, object) => { $x.as_object() };
(@as_json_value $x:ident, array) => { $x.as_array() };
(@as_json_value $x:ident, str) => { $x.as_str() };
(@as_json_value $x:ident, i64) => { $x.as_i64() };
(@as_json_value $x:ident, u64) => { $x.as_u64() };
(@as_json_value $x:ident, f64) => { $x.as_f64() };
(@as_json_value $x:ident, bool) => { $x.as_bool() };
(@as_json_value $x:ident, null) => { $x.as_null() };
(@as_json_value $x:ident, Json) => { Some($x) };
(@as_json_value $x:ident, $tpe:tt$(<$($gen:ty),+>)?) => { serde_json::from_value::<$tpe$(<$($gen),+>)?>($x.clone()).ok() };
}
#[cfg(feature = "no_logging")]
#[macro_use]
#[doc(hidden)]
pub mod logging {
/// This macro is defined if the `logging` feature is set.
///
/// It ignores all logging calls inside the library.
#[doc(hidden)]
#[macro_export]
macro_rules! debug {
(target: $target:expr, $($arg:tt)*) => {};
($($arg:tt)*) => {};
}
/// This macro is defined if the `logging` feature is not set.
///
/// It ignores all logging calls inside the library.
#[doc(hidden)]
#[macro_export]
macro_rules! error {
(target: $target:expr, $($arg:tt)*) => {};
($($arg:tt)*) => {};
}
/// This macro is defined if the `logging` feature is not set.
///
/// It ignores all logging calls inside the library.
#[doc(hidden)]
#[macro_export]
macro_rules! info {
(target: $target:expr, $($arg:tt)*) => {};
($($arg:tt)*) => {};
}
/// This macro is defined if the `logging` feature is not set.
///
/// It ignores all logging calls inside the library.
#[doc(hidden)]
#[macro_export]
macro_rules! log {
(target: $target:expr, $($arg:tt)*) => {};
($($arg:tt)*) => {};
}
/// This macro is defined if the `logging` feature is not set.
///
/// It ignores all logging calls inside the library.
#[doc(hidden)]
#[macro_export]
macro_rules! trace {
(target: $target:expr, $($arg:tt)*) => {};
($($arg:tt)*) => {};
}
/// This macro is defined if the `logging` feature is not set.
///
/// It ignores all logging calls inside the library.
#[doc(hidden)]
#[macro_export]
macro_rules! warn {
(target: $target:expr, $($arg:tt)*) => {};
($($arg:tt)*) => {};
}
}