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 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
//! This module provides two utility macros for testing custom derives. They can //! be used together to eliminate some of the boilerplate required in order to //! declare and test custom derive implementations. // Re-exports used by the decl_derive! and test_derive! pub use syn::{parse_str, parse, DeriveInput}; pub use proc_macro::TokenStream as TokenStream; pub use proc_macro2::TokenStream as TokenStream2; /// The `decl_derive!` macro declares a custom derive wrapper. It will parse the /// incoming `TokenStream` into a `synstructure::Structure` object, and pass it /// into the inner function. /// /// Your inner function should have the following type: /// /// ``` /// # extern crate quote; /// # extern crate proc_macro2; /// # extern crate synstructure; /// fn derive(input: synstructure::Structure) -> proc_macro2::TokenStream { /// unimplemented!() /// } /// ``` /// /// # Usage /// /// ### Without Attributes /// ``` /// # #[macro_use] extern crate quote; /// # extern crate proc_macro2; /// # extern crate synstructure; /// # fn main() {} /// fn derive_interesting(_input: synstructure::Structure) -> proc_macro2::TokenStream { /// quote! { ... } /// } /// /// # const _IGNORE: &'static str = stringify! { /// decl_derive!([Interesting] => derive_interesting); /// # }; /// ``` /// /// ### With Attributes /// ``` /// # #[macro_use] extern crate quote; /// # extern crate proc_macro2; /// # extern crate synstructure; /// # fn main() {} /// fn derive_interesting(_input: synstructure::Structure) -> proc_macro2::TokenStream { /// quote! { ... } /// } /// /// # const _IGNORE: &'static str = stringify! { /// decl_derive!([Interesting, attributes(interesting_ignore)] => derive_interesting); /// # }; /// ``` #[macro_export] macro_rules! decl_derive { // XXX: Switch to using this variant everywhere? ([$derives:ident $($derive_t:tt)*] => $inner:path) => { #[proc_macro_derive($derives $($derive_t)*)] #[allow(non_snake_case)] pub fn $derives( i: $crate::macros::TokenStream ) -> $crate::macros::TokenStream { let parsed = $crate::macros::parse::<$crate::macros::DeriveInput>(i) .expect(concat!("Failed to parse input to `#[derive(", stringify!($derives), ")]`")); $inner($crate::Structure::new(&parsed)).into() } }; } /// Run a test on a custom derive. This macro expands both the original struct /// and the expansion to ensure that they compile correctly, and confirms that /// feeding the original struct into the named derive will produce the written /// output. /// /// You can add `no_build` to the end of the macro invocation to disable /// checking that the written code compiles. This is useful in contexts where /// the procedural macro cannot depend on the crate where it is used during /// tests. /// /// # Usage /// /// ``` /// # #[macro_use] extern crate quote; /// # extern crate proc_macro2; /// # #[macro_use] extern crate synstructure; /// fn test_derive_example(_s: synstructure::Structure) -> proc_macro2::TokenStream { /// quote! { const YOUR_OUTPUT: &'static str = "here"; } /// } /// /// fn main() { /// test_derive!{ /// test_derive_example { /// struct A; /// } /// expands to { /// const YOUR_OUTPUT: &'static str = "here"; /// } /// } /// } /// ``` #[macro_export] macro_rules! test_derive { ($name:path { $($i:tt)* } expands to { $($o:tt)* }) => { { #[allow(dead_code)] fn ensure_compiles() { $($i)* $($o)* } test_derive!($name { $($i)* } expands to { $($o)* } no_build); } }; ($name:path { $($i:tt)* } expands to { $($o:tt)* } no_build) => { { let i = stringify!( $($i)* ); let parsed = $crate::macros::parse_str::<$crate::macros::DeriveInput>(i) .expect(concat!("Failed to parse input to `#[derive(", stringify!($name), ")]`")); let res = $name($crate::Structure::new(&parsed)); let expected = stringify!( $($o)* ) .parse::<$crate::macros::TokenStream2>() .expect("output should be a valid TokenStream"); let mut expected_toks = $crate::macros::TokenStream2::from(expected); if res.to_string() != expected_toks.to_string() { panic!("\ test_derive failed: expected: ``` {} ``` got: ``` {} ```\n", $crate::unpretty_print(&expected_toks), $crate::unpretty_print(&res), ); } // assert_eq!(res, expected_toks) } }; } /// A helper macro for declaring relatively straightforward derive /// implementations. It provides mechanisms for operating over structures /// performing modifications on each field etc. /// /// This macro doesn't define the actual derive, but rather the implementation /// method. Use `decl_derive!` to generate the implementation wrapper. /// /// # Stability Warning /// /// This is an unstable experimental macro API, which may be changed or removed /// in a future version. I'm not yet confident enough that this API is useful /// enough to warrant its complexity and inclusion in `synstructure`. /// /// # Caveat /// /// The `quote!` macro from `quote` must be imported in the calling crate, as /// this macro depends on it. /// /// # Note /// /// This feature is implemented behind the `simple-derive` feature, and is only /// avaliable when that feature is enabled. /// /// # Example /// /// ``` /// extern crate syn; /// #[macro_use] /// extern crate quote; /// #[macro_use] /// extern crate synstructure; /// extern crate proc_macro2; /// # const _IGNORE: &'static str = stringify! { /// decl_derive!([Interest] => derive_interest); /// # }; /// /// simple_derive! { /// // This macro implements the `Interesting` method exported by the `aa` /// // crate. It will explicitly add an `extern crate` invocation to import the /// // crate into the expanded context. /// derive_interest impl synstructure_test_traits::Interest { /// // A "filter" block can be added. It evaluates its body with the (s) /// // variable bound to a mutable reference to the input `Structure` /// // object. /// // /// // This block can be used to perform general transformations, such as /// // filtering out fields which should be ignored by all methods and for /// // the purposes of binding type parameters. /// filter(s) { /// s.filter(|bi| bi.ast().ident != Some(syn::Ident::new("a", /// proc_macro2::Span::call_site()))); /// } /// /// // This is an implementation of a method in the implemented crate. The /// // return value should be the series of match patterns to destructure /// // the `self` argument with. /// fn interesting(&self as s) -> bool { /// s.fold(false, |acc, bi| { /// quote!(#acc || synstructure_test_traits::Interest::interesting(#bi)) /// }) /// } /// } /// } /// /// fn main() { /// test_derive!{ /// derive_interest { /// struct A<T> { /// x: i32, /// a: bool, // Will be ignored by filter /// c: T, /// } /// } /// expands to { /// #[allow(non_upper_case_globals)] /// const _DERIVE_synstructure_test_traits_Interest_FOR_A: () = { /// extern crate synstructure_test_traits; /// impl<T> synstructure_test_traits::Interest for A<T> /// where T: synstructure_test_traits::Interest /// { /// fn interesting(&self) -> bool { /// match *self { /// A { /// x: ref __binding_0, /// c: ref __binding_2, /// .. /// } => { /// false || /// synstructure_test_traits::Interest::interesting(__binding_0) || /// synstructure_test_traits::Interest::interesting(__binding_2) /// } /// } /// } /// } /// }; /// } /// } /// } /// ``` #[cfg(feature = "simple-derive")] #[macro_export] macro_rules! simple_derive { // entry point ( $iname:ident impl $path:path { $($rest:tt)* } ) => { simple_derive!(__I [$iname, $path] { $($rest)* } [] []); }; // Adding a filter block ( __I $opt:tt { filter($s:ident) { $($body:tt)* } $($rest:tt)* } [$($done:tt)*] [$($filter:tt)*] ) => { simple_derive!( __I $opt { $($rest)* } [$($done)*] [ $($filter)* [ st_name = $s, body = { $($body)* }, ] ] ); }; // &self bound method ( __I $opt:tt { fn $fn_name:ident (&self as $s:ident $($params:tt)*) $(-> $t:ty)* { $($body:tt)* } $($rest:tt)* } [$($done:tt)*] [$($filter:tt)*] ) => { simple_derive!( __I $opt { $($rest)* } [ $($done)* [ st_name = $s, bind_style = Ref, body = { $($body)* }, result = result, expanded = { fn $fn_name(&self $($params)*) $(-> $t)* { match *self { #result } } }, ] ] [$($filter)*] ); }; // &mut self bound method ( __I $opt:tt { fn $fn_name:ident (&mut self as $s:ident $($params:tt)*) $(-> $t:ty)* { $($body:tt)* } $($rest:tt)* } [$($done:tt)*] [$($filter:tt)*] ) => { simple_derive!( __I $opt { $($rest)* } [ $($done)* [ st_name = $s, bind_style = RefMut, body = { $($body)* }, result = result, expanded = { fn $fn_name(&mut self $($params)*) $(-> $t)* { match *self { #result } } }, ] ] [$($filter)*] ); }; // self bound method ( __I $opt:tt { fn $fn_name:ident (self as $s:ident $($params:tt)*) $(-> $t:ty)* { $($body:tt)* } $($rest:tt)* } [$($done:tt)*] [$($filter:tt)*] ) => { simple_derive!( __I $opt { $($rest)* } [ $($done)* [ st_name = $s, bind_style = Move, body = { $($body)* }, result = result, expanded = { fn $fn_name(self $($params)*) $(-> $t)* { match self { #result } } }, ] ] [$($filter)*] ); }; // XXX: Static methods? // codegen after data collection ( __I [$iname:ident, $path:path] {} [$( [ st_name = $st_name:ident, bind_style = $bind_style:ident, body = $body:tt, result = $result:ident, expanded = { $($expanded:tt)* }, ] )*] [$( [ st_name = $filter_st_name:ident, body = $filter_body:tt, ] )*] ) => { fn $iname(mut st: $crate::Structure) -> $crate::macros::TokenStream2 { let _ = &mut st; // Silence the unused mut warning // Filter/transform the `Structure` object before cloning it for // individual methods. $( { let $filter_st_name = &mut st; $filter_body } )* // Clone the `Structure` object and set the correct binding style, // then perform method specific expansion. $( let $result = { let mut $st_name = st.clone(); $st_name.bind_with(|_| ::synstructure::BindStyle::$bind_style); let $result = { $body }; quote!{ $($expanded)* } }; )* st.bound_impl(quote!($path), quote!{ $(#$result)* }) } } }