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
use crate::lang::Lang; use crate::Tokens; use std::rc::Rc; /// Trait for types that can be formatted in-place into a token stream. /// /// Things implementing [FormatInto] can be used as arguments for /// [interpolation] in the [quote!] macro. /// /// [from_fn()] is a helper function which simplifies the task of creating a /// [FormatInto] implementation on the fly. /// /// [from_fn()]: crate::tokens::from_fn() /// [quote!]: macro.quote.html /// [interpolation]: macro.quote.html#interpolation /// /// # Examples /// /// ```rust /// # fn main() -> genco::fmt::Result { /// use genco::quote_in; /// use genco::tokens::{ItemStr, FormatInto, from_fn, static_literal}; /// use genco::lang::Lang; /// /// fn comment<L>(s: impl Into<ItemStr>) -> impl FormatInto<L> /// where /// L: Lang /// { /// from_fn(move |tokens| { /// let s = s.into(); /// quote_in!(*tokens => #(static_literal("//")) #s); /// }) /// } /// # Ok(()) /// # } /// ``` pub trait FormatInto<L> where L: Lang, { /// Convert the type into tokens in-place. /// /// A simple way to build ad-hoc format_into implementations is by using /// the [from_fn()] function. /// /// [from_fn()]: crate::tokens::from_fn() fn format_into(self, tokens: &mut Tokens<L>); } impl<L> FormatInto<L> for Tokens<L> where L: Lang, { fn format_into(self, tokens: &mut Self) { tokens.extend(self); } } /// Formatting a reference to a token stream is exactly the same as extending /// the token stream with a copy of the stream being formatted. /// /// # Examples /// /// ```rust /// use genco::prelude::*; /// /// # fn main() -> genco::fmt::Result { /// let a: &Tokens = "e!(foo bar); /// /// let result = quote!(#a baz); /// /// assert_eq!("foo bar baz", result.to_string()?); /// # Ok(()) /// # } /// ``` impl<'a, L> FormatInto<L> for &'a Tokens<L> where L: Lang, { fn format_into(self, tokens: &mut Tokens<L>) { tokens.extend(self.iter().cloned()); } } /// Formatting a vector of token streams is like formatting each, one after /// another. /// /// # Examples /// /// ```rust /// use genco::prelude::*; /// /// # fn main() -> genco::fmt::Result { /// let mut vec = Vec::<Tokens>::new(); /// vec.push(quote!(foo)); /// vec.push(quote!(#<space>bar)); /// /// let result = quote!(#vec baz); /// /// assert_eq!("foo bar baz", result.to_string()?); /// # Ok(()) /// # } /// ``` impl<L, T> FormatInto<L> for Vec<T> where L: Lang, T: FormatInto<L>, { fn format_into(self, tokens: &mut Tokens<L>) { for t in self { tokens.append(t); } } } /// Formatting a slice of token streams is like formatting each, one after /// another. /// /// This will cause each token stream to be cloned into the destination stream. /// /// # Examples /// /// ```rust /// use genco::prelude::*; /// /// # fn main() -> genco::fmt::Result { /// let vec = vec!["foo", " ", "bar"]; /// let slice = &vec[..]; /// /// let result: Tokens = quote!(#slice baz); /// /// assert_eq!("foo bar baz", result.to_string()?); /// # Ok(()) /// # } /// ``` impl<'a, L, T> FormatInto<L> for &'a [T] where L: Lang, T: Clone + FormatInto<L>, { fn format_into(self, tokens: &mut Tokens<L>) { for t in self { tokens.append(t.clone()); } } } /// Formatting borrowed string boxed them on the heap. /// /// # Examples /// /// ```rust /// use genco::prelude::*; /// /// # fn main() -> genco::fmt::Result { /// let foo = "foo"; /// let bar = "bar"; /// /// let result: Tokens = quote!(#foo #bar baz); /// /// assert_eq!("foo bar baz", result.to_string()?); /// # Ok(()) /// # } /// ``` impl<'a, L> FormatInto<L> for &'a str where L: Lang, { fn format_into(self, tokens: &mut Tokens<L>) { tokens.item(self.to_string().into()); } } /// Formatting borrowed string boxed them on the heap. /// /// # Examples /// /// ```rust /// use genco::prelude::*; /// /// # fn main() -> genco::fmt::Result { /// let foo = String::from("foo"); /// let bar = String::from("bar"); /// /// let result: Tokens = quote!(#(&foo) #(&bar) baz); /// /// assert_eq!("foo bar baz", result.to_string()?); /// # Ok(()) /// # } /// ``` impl<'a, L> FormatInto<L> for &'a String where L: Lang, { fn format_into(self, tokens: &mut Tokens<L>) { tokens.item(self.clone().into()); } } /// Formatting owned strings takes ownership of the string directly from the /// heap. /// /// # Examples /// /// ```rust /// use genco::prelude::*; /// /// # fn main() -> genco::fmt::Result { /// let foo = String::from("foo"); /// let bar = String::from("bar"); /// /// let result: Tokens = quote!(#foo #bar baz); /// /// assert_eq!("foo bar baz", result.to_string()?); /// # Ok(()) /// # } /// ``` impl<L> FormatInto<L> for String where L: Lang, { fn format_into(self, tokens: &mut Tokens<L>) { tokens.item(self.into()); } } /// Refcounted strings are moved into the token stream without copying. /// /// # Examples /// /// ```rust /// use genco::prelude::*; /// use std::rc::Rc; /// /// # fn main() -> genco::fmt::Result { /// let foo = Rc::new(String::from("foo")); /// let bar = Rc::new(String::from("bar")); /// /// let result: Tokens = quote!(#foo #bar baz); /// /// assert_eq!("foo bar baz", result.to_string()?); /// # Ok(()) /// # } /// ``` impl<L> FormatInto<L> for Rc<String> where L: Lang, { fn format_into(self, tokens: &mut Tokens<L>) { tokens.item(self.into()); } } /// Refcounted strings are cloned and moved into the token stream without /// copying. /// /// # Examples /// /// ```rust /// use genco::prelude::*; /// use std::rc::Rc; /// /// # fn main() -> genco::fmt::Result { /// let foo = Rc::new(String::from("foo")); /// let bar = Rc::new(String::from("bar")); /// /// let result: Tokens = quote!(#(&foo) #(&bar) baz); /// /// assert_eq!("foo bar baz", result.to_string()?); /// # Ok(()) /// # } /// ``` impl<'a, L> FormatInto<L> for &'a Rc<String> where L: Lang, { fn format_into(self, tokens: &mut Tokens<L>) { tokens.item(self.clone().into()); } } /// Optional items are formatted if they are present. /// /// # Examples /// /// ```rust /// use genco::prelude::*; /// use std::rc::Rc; /// /// # fn main() -> genco::fmt::Result { /// let foo = Some("foo"); /// let bar = Some("bar"); /// let biz = None::<&str>; /// /// let result: Tokens = quote!(#foo #bar baz #biz); /// /// assert_eq!("foo bar baz", result.to_string()?); /// # Ok(()) /// # } /// ``` impl<L, T> FormatInto<L> for Option<T> where L: Lang, T: FormatInto<L>, { fn format_into(self, tokens: &mut Tokens<L>) { if let Some(inner) = self { inner.format_into(tokens); } } } macro_rules! impl_display { ($($ty:ty),*) => { $( /// Implementation for primitive type. Uses the corresponding /// [Display][std::fmt::Display] implementation for the /// primitive type. impl<L> FormatInto<L> for $ty where L: Lang, { fn format_into(self, tokens: &mut Tokens<L>) { tokens.append(self.to_string()); } } )* }; } impl_display!(u8, u16, u32, u64, u128, i8, i16, i32, i64, i128, isize, usize);