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
// Rust language amplification derive library providing multiple generic trait // implementations, type wrappers, derive macros and other language enhancements // // Written in 2019-2020 by // Dr. Maxim Orlovsky <orlovsky@pandoracore.com> // Elichai Turkel <elichai.turkel@gmail.com> // // To the extent possible under law, the author(s) have dedicated all // copyright and related and neighboring rights to this software to // the public domain worldwide. This software is distributed without // any warranty. // // You should have received a copy of the MIT License // along with this software. // If not, see <https://opensource.org/licenses/MIT>. //! Amplifying Rust language capabilities: multiple generic trait //! implementations, type wrappers, derive macros. #![recursion_limit = "256"] #![deny( non_upper_case_globals, non_camel_case_types, non_snake_case, unused_mut, unused_imports, missing_docs, dead_code, warnings )] #[macro_use] extern crate quote; #[macro_use] extern crate syn; extern crate amplify; /// Macro producing [`Result::Err`] with [`syn::Error`] containing span /// information from `$attr` (first) argument and formatted string describing /// concrete error (description is taken from `$msg` second macro argument) and /// providing an example `$example` (third macro argument) of how the macro /// should be used. macro_rules! attr_err { ($attr:expr, $msg:tt) => { attr_err!($attr.span(), NAME, $msg, EXAMPLE); }; ($name:expr, $msg:tt, $example:tt) => { attr_err!(::syn::export::Span::call_site(), $name, $msg, $example); }; ($attr:expr, $name:expr, $msg:tt, $example:tt) => { ::syn::Error::new( $attr.span(), format!( "Attribute `#[{}]`: {}\nExample use: {}", $name, $msg, $example ), ); }; } mod as_any; mod display; mod error; mod from; mod getters; mod wrapper; use syn::export::TokenStream; use syn::DeriveInput; /// # Usage /// /// 1. Generate [`Display`] descriptions using other formatting trait: /// ``` /// # #[macro_use] extern crate amplify_derive; /// #[derive(Display, Debug)] /// #[display(Debug)] /// struct Some { /* ... */ } /// ``` /// 2. Use existing function for displaying descriptions: /// ``` /// # #[macro_use] extern crate amplify_derive; /// #[macro_use] extern crate amplify; /// /// #[derive(Display)] /// #[display(Int::print)] /// union Int { uint: u32, int: i32 }; /// impl Int { /// pub fn print(&self) -> String { /// s!("Integer representation") /// } /// } /// ``` /// Formatting function must return [`String`] and take a single `self` /// argument (if you need formatting with streamed output, use one of /// existing formatting traits as shown in pt. 1). /// 3. Custom format string: /// ``` /// # #[macro_use] extern crate amplify_derive; /// #[derive(Display)] /// #[display("({x}, {y})")] /// struct Point { x: u32, y: u32 } /// ``` /// 4. Use of doc comments for descrition representation. In this case doc /// comments may also contain formatting like in the case 3: /// ``` /// # #[macro_use] extern crate amplify_derive; /// #[macro_use] extern crate amplify; /// /// #[derive(Display)] /// #[display(doc_comments)] /// enum Variants { /// /// Letter A /// /// Multiline comments are also working /// A, /// /// Letter B /// B, /// /// This comment is ignored /// #[display("Letter C")] /// C, /// /// Letter {_0} /// Letter(String), /// /// You can omit parameters and just have a normal doc comment /// Number(u8), /// /// ... for variants with named fields as well /// Named { some: String } /// }; /// /// assert_eq!(format!("{}", Variants::C), "Letter C"); /// assert_eq!(format!("{}", Variants::Letter(s!("K"))), " Letter K"); /// ``` /// You can also mix in this mode with other fors of display tags on a /// specific options; in this case doc comments are ignored /// /// # Example /// /// Advanced use with enums: /// ``` /// # #[macro_use] extern crate amplify_derive; /// #[derive(Display)] /// enum Test { /// Some, /// /// #[display = "OtherName"] /// Other, /// /// /// Document comment working as display string /// Commented, /// /// Named { /// x: u8, /// }, /// /// #[display = "Custom{x}"] /// NamedCustom { /// x: u8, /// }, /// /// Unnamed(u16), /// /// // NB: Use `_`-prefixed indexes for tuple values /// #[display = "Custom{_0}"] /// UnnamedCustom(String), /// } /// /// assert_eq!(format!("{}", Test::Some), "Some"); /// assert_eq!(format!("{}", Test::Other), "OtherName"); /// assert_eq!(format!("{}", Test::Named { x: 1 }), "Named { .. }"); /// assert_eq!(format!("{}", Test::Unnamed(5)), "Unnamed(..)"); /// assert_eq!(format!("{}", Test::NamedCustom { x: 8 }), "Custom8"); /// assert_eq!( /// format!("{}", Test::UnnamedCustom("Test".to_string())), /// "CustomTest" /// ); /// ``` #[proc_macro_derive(Display, attributes(display))] pub fn derive_display(input: TokenStream) -> TokenStream { let derive_input = parse_macro_input!(input as DeriveInput); display::inner(derive_input) .unwrap_or_else(|e| e.to_compile_error()) .into() } /// Error derive macro works to the full extend only when other derive macros /// are used. With `#[derive(Display)]` and `[display(doc_comments)]` it uses /// doc comments for generating error descriptions; with `#[derive(From)]` it /// may automatically implement transofrations from other error types. /// /// ``` /// # #[macro_use] extern crate amplify_derive; /// #[derive(Debug, Display, Error)] /// #[display(doc_comments)] /// enum Error { /// /// I/O operation error /// Io, /// /// Math overflow /// Overflow, /// /// Zero division with {_0} /// ZeroDivision(u16), /// } /// /// assert_eq!(format!("{}", Error::Io), " I/O operation error"); /// assert_eq!(format!("{}", Error::Overflow), " Math overflow"); /// assert_eq!( /// format!("{}", Error::ZeroDivision(2)), /// " Zero division with 2" /// ); /// ``` #[proc_macro_derive(Error)] pub fn derive_error(input: TokenStream) -> TokenStream { let derive_input = parse_macro_input!(input as DeriveInput); error::inner(derive_input) .unwrap_or_else(|e| e.to_compile_error()) .into() } /// Implements [`From`] trait for the whole entity and/or its separate fields. /// Works well with `#[derive(Error)]` and, in many cases may require /// [`Default`] implementation (for details, pls see Examples below) /// /// # Examples /// /// ``` /// # #[macro_use] extern crate amplify_derive; /// # /// #[derive(From, Default)] /// #[from(::std::io::Error)] /// // Structure may contain no parameters /// pub struct IoErrorUnit; /// /// #[derive(From, Default)] /// #[from(::std::io::Error)] // When no explicit binding is given, structure must implement `Default` /// pub struct IoError { /// details: String, /// /// #[from] /// kind: IoErrorUnit, /// } /// /// #[derive(From)] /// pub enum Error { /// // You can specify multiple conversions with separate attributes /// #[from(::std::io::Error)] /// #[from(IoError)] /// Io, /// /// #[from] /// Format(::std::fmt::Error), /// /// #[from] /// WithFields { details: ::std::str::Utf8Error }, /// /// MultipleFields { /// // ...and you can also covert error type /// #[from(IoErrorUnit)] /// // rest of parameters must implement `Default` /// io: IoError, /// details: String, /// }, /// } /// /// #[derive(From)] /// pub struct Wrapper(u32, i16); /// ``` /// /// If you use rust nightly and `#![feature(never_type)]` for [`!`], you can /// even do the following: /// ```ignore /// #![feature(never_type)] /// /// #[macro_use] /// extern crate amplify_derive; /// /// #[derive(From)] /// pub enum Error { /// // ... other error types /// #[from(!)] /// NeverType, /// } /// /// # fn main () { /// # } /// ``` #[proc_macro_derive(From, attributes(from))] pub fn derive_from(input: TokenStream) -> TokenStream { let derive_input = parse_macro_input!(input as DeriveInput); from::inner(derive_input) .unwrap_or_else(|e| e.to_compile_error()) .into() } /// Trait [`amplify::AsAny`] allows simple conversion of any type into a generic /// "thick" pointer `&dyn Any` (see [`::core::any::Any`]), that can be later /// converted back to the original type with a graceful failing for all other /// conversions. `AsAny` derive macro allows to implement this trait for /// arbitrary time without much hussle: /// /// # Example /// /// ``` /// # #[macro_use] extern crate amplify_derive; /// extern crate amplify; /// use amplify::AsAny; /// /// #[derive(AsAny, Copy, Clone, PartialEq, Eq, Debug)] /// struct Point { /// pub x: u64, /// pub y: u64, /// } /// /// #[derive(AsAny, PartialEq, Debug)] /// struct Circle { /// pub radius: f64, /// pub center: Point, /// } /// /// let mut point = Point { x: 1, y: 2 }; /// let point_ptr = point.as_any(); /// /// let mut circle = Circle { /// radius: 18., /// center: point, /// }; /// let circle_ptr = circle.as_any(); /// /// assert_eq!(point_ptr.downcast_ref(), Some(&point)); /// assert_eq!(circle_ptr.downcast_ref(), Some(&circle)); /// assert_eq!(circle_ptr.downcast_ref::<Point>(), None); /// /// let p = point_ptr.downcast_ref::<Point>().unwrap(); /// assert_eq!(p.x, 1) /// ``` #[proc_macro_derive(AsAny)] pub fn derive_as_any(input: TokenStream) -> TokenStream { let derive_input = parse_macro_input!(input as DeriveInput); as_any::inner(derive_input) .unwrap_or_else(|e| e.to_compile_error()) .into() } /// ``` /// # #[macro_use] extern crate amplify_derive; /// #[derive(Getters)] /// struct One { /// a: Vec<u8>, /// b: bool, /// } /// ``` #[proc_macro_derive(Getters)] pub fn derive_getters(input: TokenStream) -> TokenStream { let derive_input = parse_macro_input!(input as DeriveInput); getters::inner(derive_input) .unwrap_or_else(|e| e.to_compile_error()) .into() } /// ```ignore /// # #[macro_use] extern crate amplify_derive; /// # use std::collections::HashMap; /// use std::marker::PhantomData; /// /// #[derive(Clone, Wrapper)] /// #[wrap(Debug, Default, Hash, PartialEq, Eq)] /// struct Wrapped<T, U>(HashMap<usize, Vec<U>>, PhantomData<T>) /// where /// U: Sized + Eq; /// ``` #[proc_macro_derive(Wrapper)] pub fn derive_wrapper(input: TokenStream) -> TokenStream { let derive_input = parse_macro_input!(input as DeriveInput); wrapper::inner(derive_input) .unwrap_or_else(|e| e.to_compile_error()) .into() }