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
//! [![github]](https://github.com/chesedo/despatma) [![crates-io]](https://crates.io/crates/despatma) [![docs-rs]](https://docs.rs/despatma) [![workflow]](https://github.com/chesedo/despatma/actions?query=workflow%3ARust) //! //! [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github //! [crates-io]: https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust //! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K //! [workflow]: https://img.shields.io/github/workflow/status/chesedo/despatma/Rust?color=green&label=&labelColor=555555&logo=github%20actions&logoColor=white&style=for-the-badge //! //! Despatma is a collection of `des`ign `pat`tern `ma`cros (`despatma`). //! It aims to provide the most common implementations for design patterns at run-time. //! //! This project is still a **work in progress**. //! The end goal is to be as [Loki](http://loki-lib.sourceforge.net/) is for C++ and more if possible. //! The following patterns are currently implemented: //! - [abstract_factory] - with the help of [interpolate_traits] macro //! - [visitor] //! //! [abstract_factory]: macro@self::abstract_factory //! [interpolate_traits]: macro@self::interpolate_traits //! [visitor]: macro@self::visitor mod abstract_factory; mod visitor; extern crate proc_macro; use proc_macro::TokenStream; use syn::punctuated::Punctuated; use syn::{parse_macro_input, ItemTrait, Token}; use tokenstream2_tmpl::Interpolate; use abstract_factory::AbstractFactoryAttribute; use despatma_lib::TraitSpecifier; use visitor::VisitorFunction; /// Turns a `trait` into an Abstract Factory. /// The trait can optionally have super-traits. /// /// This macro is generally used with the [interpolate_traits] macro. /// /// [interpolate_traits]: macro@self::interpolate_traits /// /// # Example input /// A factory method needs to be defined to use this macro. The factory method is passed as the first argument to the macro. The rest of the arguments passed to the macro are the elements the factory will create. /// ``` /// use despatma::abstract_factory; /// /// // A factory method /// // `Element` is a trait defined by you. /// pub trait Factory<T: Element + ?Sized> { /// fn create(&self, name: String) -> Box<T>; /// } /// /// // The abstract factory that also needs to implement `Display` and `Eq`. /// // The factory method above (`Factory`) is the first input. /// #[abstract_factory(Factory, dyn Button, dyn Scroller, dyn Window)] /// pub trait GuiFactory: Display + Eq {} /// ``` /// /// ## Output /// This will create the following code /// ``` /// use despatma::abstract_factory; /// /// // A factory method /// // `Element` is a trait defined by you. /// pub trait Factory<T: Element + ?Sized> { /// fn create(&self, name: String) -> Box<T>; /// } /// /// // The abstract factory that also needs to implement `Display` and `Eq`. /// // The factory method above (`Factory`) is the first input. /// #[abstract_factory(Factory, dyn Button, dyn Scroller, dyn Window)] /// pub trait GuiFactory: /// Display /// + Eq /// + Factory<dyn Button> /// + Factory<dyn Scroller> /// + Factory<dyn Window> /// { /// } /// ``` #[proc_macro_attribute] pub fn abstract_factory(tokens: TokenStream, trait_expr: TokenStream) -> TokenStream { let mut input = parse_macro_input!(trait_expr as ItemTrait); let attributes = parse_macro_input!(tokens as AbstractFactoryAttribute); attributes.expand(&mut input).into() } /// Expands a list of [despatma_lib::TraitSpecifier] elements over a template. /// The `TRAIT` and `CONCRETE` markers in the template will be replaced with each passed in element. /// The template is annotated with this attribute. /// /// This macro can be used to create concrete implementations for [abstract_factory]. /// /// # Example input /// ``` /// use despatma::interpolate_traits; /// /// // GuiFactory and Factory is defined in the abstract_factory example /// struct GnomeFactory{} /// impl GuiFactory for GnomeFactory{} /// /// // Implement the factory method for each GUI element /// #[interpolate_traits( /// Button => GnomeButton, /// Scroller => Gnome2Scroller, /// Window => Gnome3Window, /// )] /// impl Factory<dyn TRAIT> for GnomeFactory { /// fn create(&self, name: String) -> Box<dyn TRAIT> { /// Box::new(CONCRETE::new(name)) /// } /// } /// ``` /// /// ## Output /// This will implement the factory method (expand the template) for each element as follow. /// ``` /// use despatma::interpolate_traits; /// /// // GuiFactory and Factory is defined in the abstract_factory example /// struct GnomeFactory{} /// impl GuiFactory for GnomeFactory{} /// /// // Implement the factory method for each GUI element /// impl Factory<dyn Button> for GnomeFactory { /// fn create(&self, name: String) -> Box<dyn Button> { /// Box::new(GnomeButton::new(name)) /// } /// } /// impl Factory<dyn Scroller> for GnomeFactory { /// fn create(&self, name: String) -> Box<dyn Scroller> { /// Box::new(Gnome2Scroller::new(name)) /// } /// } /// impl Factory<dyn Window> for GnomeFactory { /// fn create(&self, name: String) -> Box<dyn Window> { /// Box::new(Gnome3Window::new(name)) /// } /// } /// ``` /// /// [abstract_factory]: macro@self::abstract_factory #[proc_macro_attribute] pub fn interpolate_traits(tokens: TokenStream, concrete_impl: TokenStream) -> TokenStream { let attributes = parse_macro_input!(tokens with Punctuated::<TraitSpecifier, Token![,]>::parse_terminated); attributes.interpolate(concrete_impl.into()).into() } /// Creates an abstract visitor for a list of elements. /// /// This macro does three things: /// 1. A `Visitor` trait is created with methods to visit each element. Each method calls a default helper function by default. /// 1. A helper function is created for each element. The idea is for this function to transverse into the elements children. /// 1. A `Visitable` trait is created that redirects / reflects each element back to its visitor /// /// # Example input /// ``` /// use despatma::visitor; /// /// visitor!( /// dyn Arc, /// Rectangle, /// dyn Point, /// ); /// ``` /// /// ## Output /// The three elements listed above will be created. /// ``` /// use despatma::visitor; /// /// pub trait Visitor { /// fn visit_arc(&mut self, arc: &dyn Arc) { /// visit_arc(self, arc) /// } /// fn visit_rectangle(&mut self, rectangle: &Rectangle) { /// visit_rectangle(self, rectangle) /// } /// fn visit_point(&mut self, point: &dyn Point) { /// visit_point(self, point) /// } /// } /// /// pub fn visit_arc<V>(visitor: &mut V, _arc: &dyn Arc) /// where /// V: Visitor + ?Sized, /// { /// } /// pub fn visit_rectangle<V>(visitor: &mut V, _rectangle: &Rectangle) /// where /// V: Visitor + ?Sized, /// { /// } /// pub fn visit_point<V>(_visitor: &mut V, _point: &dyn Point) /// where /// V: Visitor + ?Sized, /// { /// } /// /// trait Visitable { /// fn apply(&self, visitor: &mut dyn Visitor); /// } /// impl Visitable for dyn Arc { /// fn apply(&self, visitor: &mut dyn Visitor) { /// visitor.visit_arc(self); /// } /// } /// impl Visitable for Rectangle { /// fn apply(&self, visitor: &mut dyn Visitor) { /// visitor.visit_rectangle(self); /// } /// } /// impl Visitable for dyn Point { /// fn apply(&self, visitor: &mut dyn Visitor) { /// visitor.visit_point(self); /// } /// } /// ``` /// /// The input shows `Visitor` can be applied to structs (`Rectangle`) and traits (`Arc` and `Point`). /// /// ## Usage /// Any visitor can now just implement the `Visitor` trait and provide its own implementation for any of the visitor methods. /// ``` /// use my_lib::{Visitor, visit_point}; /// /// struct PointCounter { /// pub count: usize, /// } /// /// impl Visitor for PointCounter { /// fn visit_point(&mut self, point: &dyn Point) { /// self.count += 1; /// /// // Call helper function to keep transversal intact /// visit_point(self, point) /// } /// } /// ``` /// /// This visitor will now count all the points in a hierarchy. /// But there is a problem. The default helper implementations do not have any transversal code. This can be fixed with the `helper_tmpl` option. /// /// ## `helper_tmpl` option /// This option will fill the body of the helper method with the given code. /// ``` /// use despatma::visitor; /// /// visitor!( /// #[helper_tmpl = {visitor.visit_point(arc.center);} ] /// dyn Arc, /// /// #[ /// helper_tmpl = { /// visitor.visit_point(rectangle.top_left); /// visitor.visit_point(rectangle.bottom_right); /// }, /// ] /// Rectangle, /// /// dyn Point, /// ); /// ``` /// /// The helper functions will now look as follow: /// ``` /// // `Visitor` is same as earlier /// /// pub fn visit_arc<V>(visitor: &mut V, arc: &dyn Arc) /// where /// V: Visitor + ?Sized, /// { /// visitor.visit_point(arc.center); /// } /// pub fn visit_rectangle<V>(visitor: &mut V, rectangle: &Rectangle) /// where /// V: Visitor + ?Sized, /// { /// visitor.visit_point(rectangle.top_left); /// visitor.visit_point(rectangle.bottom_right); /// } /// pub fn visit_point<V>(_visitor: &mut V, _point: &dyn Point) /// where /// V: Visitor + ?Sized, /// { /// } /// /// // `Visitable` is same as earlier /// ``` /// /// `PointCounter` will now work as expected! /// /// ## `no_defualt` option /// You might want to force visitors to implement a visit method and not have a trait default. The default trait implementation can be removed using the `no_default` option. /// ``` /// use despatma::visitor; /// /// visitor!( /// #[ /// helper_tmpl = {visitor.visit_point(arc.center);}, /// no_default, /// ] /// dyn Arc, /// /// #[ /// helper_tmpl = { /// visitor.visit_point(rectangle.top_left); /// visitor.visit_point(rectangle.bottom_right); /// }, /// ] /// Rectangle, /// /// dyn Point, /// ); /// ``` /// /// The `Visitor` trait will now be as follow and `PointCounter` will have to implement the `visit_arc()` method too. /// ``` /// pub trait Visitor { /// fn visit_arc(&mut self, arc: &dyn Arc); /// fn visit_rectangle(&mut self, rectangle: &Rectangle) { /// visit_rectangle(self, rectangle) /// } /// fn visit_point(&mut self, point: &dyn Point) { /// visit_point(self, point) /// } /// } /// /// // Rest is same as earlier /// ``` /// /// # Calling a visitor /// Suppose the follow code exists /// ``` /// // Create a rectangle with bottom-left point (0, 0) and top-right point (10, 12) /// let rect = Rectangle::new(0, 0, 10, 12); /// let point_stats = PointCounter{}; /// /// // Invoke visitor on hierarchy options /// rect.apply(&mut dyn point_stats); // 1 - Preferred /// visit_rectangle(&mut point_stats, &rect); // 2 /// point_stats.visit_rectangle(&dyn rect); // 3 /// ``` /// /// The visitor (`PointCounter`) can be invoked in three ways /// 1. This is the preferred way as it will work with any visitor and there is no need to remember the visit method's name. /// 1. Needs to know the helper function name and is less generic. But it might work with any visitor. /// 1. Least generic and also needs to know the method name. #[proc_macro] pub fn visitor(tokens: TokenStream) -> TokenStream { let input = parse_macro_input!(tokens as VisitorFunction); input.expand().into() }