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 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
//! Macros for [Medea] media server project. //! //! This crate is indented for inner use only by [Medea] media server. //! //! [Medea]: https://github.com/instrumentisto/medea #![deny(broken_intra_doc_links)] mod dispatchable; mod enum_delegate; mod js_caused; mod watchers; use proc_macro::TokenStream; use synstructure::decl_derive; /// Delegates function calls to enum variants field. /// Variants are expected to have only one field. /// /// # How to use /// /// ``` /// use medea_macro::enum_delegate; /// /// #[enum_delegate(pub fn as_str(&self) -> &str)] /// #[enum_delegate(pub fn push_str(&mut self, arg: &str))] /// enum MyEnum { /// Foo(String), /// Bar(String), /// } /// /// let mut foo = MyEnum::Foo(String::from("foo")); /// foo.push_str("_bar"); /// assert_eq!(foo.as_str(), "foo_bar") /// ``` /// /// # Extended example /// /// ``` /// use medea_macro::enum_delegate; /// /// struct SomeState; /// struct AnotherState; /// /// struct Context { /// some_value: i32, /// } /// /// struct Peer<S> { /// context: Context, /// state: S, /// } /// /// impl<T> Peer<T> { /// pub fn some_value(&self) -> i32 { /// self.context.some_value /// } /// /// pub fn function_with_additional_args(&self, some_arg: i32) -> i32 { /// some_arg /// } /// /// pub fn mutable_function(&mut self) -> i32 { /// let old_value = self.context.some_value; /// self.context.some_value = 1000; /// old_value /// } /// } /// /// #[enum_delegate(pub fn some_value(&self) -> i32)] /// #[enum_delegate( /// pub fn function_with_additional_args(&self, some_arg: i32) -> i32 /// )] /// #[enum_delegate(pub fn mutable_function(&mut self) -> i32)] /// enum PeerStateMachine { /// SomeState(Peer<SomeState>), /// AnotherState(Peer<AnotherState>), /// } /// /// let mut peer = PeerStateMachine::SomeState(Peer { /// context: Context { some_value: 10 }, /// state: SomeState, /// }); /// /// assert_eq!(peer.some_value(), 10); /// /// assert_eq!(peer.function_with_additional_args(100), 100); /// /// assert_eq!(peer.mutable_function(), 10); /// assert_eq!(peer.some_value(), 1000); /// ``` #[allow(clippy::needless_pass_by_value)] #[proc_macro_attribute] pub fn enum_delegate(args: TokenStream, input: TokenStream) -> TokenStream { enum_delegate::derive(&args, input) .unwrap_or_else(|e| e.to_compile_error().into()) } /// Generates `*Handler` trait and displatching function for some event, /// represented as `enum`. /// /// # How to use /// /// ### 1. Declare `enum` for event variants and a `struct` to handle them. /// ``` /// use medea_macro::dispatchable; /// /// #[dispatchable] /// enum Event { /// Some { new_bar: i32 }, /// Another, /// UnnamedVariant(i32, i32), /// } /// /// struct Foo { /// bar: i32, /// baz: i32, /// } /// ``` /// /// ### 2. Implement handler for your `struct`. /// /// For the given `enum` macro generates a unique trait by adding `Handler` /// to the end of its name. Each method of trait is created by `snake_case`'ing /// `enum` variants and adding `on_` prefix. /// /// `type Output` is a type which will be returned from all functions of /// `EventHandler` trait. /// /// ``` /// # use medea_macro::dispatchable; /// # /// # #[dispatchable] /// # enum Event { /// # Some { new_bar: i32 }, /// # Another, /// # UnnamedVariant(i32, i32), /// # } /// # /// # struct Foo { /// # bar: i32, /// # baz: i32, /// # } /// # /// impl EventHandler for Foo { /// type Output = i32; /// /// fn on_some(&mut self, new_bar: i32) -> Self::Output { /// self.bar = new_bar; /// self.bar /// } /// /// fn on_another(&mut self) -> Self::Output { /// self.bar = 2; /// self.bar /// } /// /// fn on_unnamed_variant(&mut self, data: (i32, i32)) -> Self::Output { /// self.bar = data.0; /// self.baz = data.1; /// self.bar /// } /// } /// ``` /// /// ### 3. Dispatch event with handler /// /// For the given `enum` macro generates `dispatch_with()` method to dispatch /// `enum` with a given handler. /// /// ``` /// # use medea_macro::dispatchable; /// # /// # #[dispatchable] /// # enum Event { /// # Some { new_bar: i32 }, /// # Another, /// # UnnamedVariant(i32, i32), /// # } /// # /// # struct Foo { /// # bar: i32, /// # baz: i32, /// # } /// # /// # impl EventHandler for Foo { /// # type Output = i32; /// # /// # fn on_some(&mut self, new_bar: i32) -> Self::Output { /// # self.bar = new_bar; /// # self.bar /// # } /// # /// # fn on_another(&mut self) -> Self::Output { /// # self.bar = 2; /// # self.bar /// # } /// # /// # fn on_unnamed_variant(&mut self, data: (i32, i32)) -> Self::Output { /// # self.bar = data.0; /// # self.baz = data.1; /// # self.bar /// # } /// # } /// # /// # /// let mut foo = Foo { bar: 0, baz: 0 }; /// /// let bar = Event::Some { new_bar: 1 }.dispatch_with(&mut foo); /// assert_eq!(foo.bar, 1); /// assert_eq!(bar, 1); /// /// let bar = Event::Another.dispatch_with(&mut foo); /// assert_eq!(foo.bar, 2); /// assert_eq!(bar, 2); /// /// let bar = Event::UnnamedVariant(3, 3).dispatch_with(&mut foo); /// assert_eq!(foo.bar, 3); /// assert_eq!(foo.baz, 3); /// assert_eq!(bar, 3); /// ``` /// /// # Customize `self` type in handler functions (optional) /// /// By default, all handler functions take `&mut Self`, if this doesn't suit /// your case, then you can specify the method receiver manually: /// `#[dispatchable(self: Rc<Self>)]`, `#[dispatchable(self: &Self)]`. /// /// You can use any type that is a valid `self` receiver, e.g. `self`, `&self`, /// `&mut self`, `self: Box<Self>`, `self: Rc<Self>`, `self: Arc<Self>`, or /// `self: Pin<P>` (where P is one of the previous, except `Self`). /// /// ``` /// # use std::rc::Rc; /// use medea_macro::dispatchable; /// /// #[dispatchable(self: Rc<Self>)] /// enum Event { /// Variant, /// } /// /// struct Foo; /// impl EventHandler for Foo { /// type Output = (); /// /// fn on_variant(self: Rc<Self>) {} /// } /// /// let foo = Rc::new(Foo); /// /// Event::Variant.dispatch_with(foo); /// ``` /// /// # Async handlers (optional) /// /// It's possible to make handler methods `async`. Rust doesn't support `async` /// trait methods at the moment, that's why [`async_trait`] is used. /// /// ``` /// use async_trait::async_trait; /// use medea_macro::dispatchable; /// /// #[dispatchable(async_trait(?Send))] /// enum Event { /// Variant, /// } /// /// struct Foo; /// #[async_trait(?Send)] /// impl EventHandler for Foo { /// type Output = (); /// /// async fn on_variant(&mut self) {} /// } /// /// let mut foo = Foo; /// /// Event::Variant.dispatch_with(&mut foo); /// ``` /// /// [`async_trait`]: https://docs.rs/async-trait #[proc_macro_attribute] pub fn dispatchable(args: TokenStream, input: TokenStream) -> TokenStream { let enum_item = syn::parse_macro_input!(input as dispatchable::Item); let args = syn::parse_macro_input!(args as dispatchable::Args); dispatchable::expand(enum_item, &args) } /// Generates `ComponentState` implementation on provided `impl`. /// /// # Usage /// /// ```ignore /// use std::rc::Rc; /// /// use medea_jason::utils::Component; /// use medea_macro::{watchers, watch}; /// /// struct SenderState { /// muted: ObservableCell<bool>, /// enabled: ObservableCell<bool>, /// } /// /// struct Sender; /// /// type SenderComponent = Component<SenderState, Sender>; /// /// #[watchers] /// impl SenderComponent { /// #[watch(self.muted.subscribe())] /// async fn muted_change_watcher( /// ctx: Rc<Sender>, /// state: Rc<SenderState>, /// new_muted_val: bool /// ) -> Result<(), ()> { /// Ok(()) /// } /// /// #[watch(self.enabled.subscribe())] /// async fn enabled_change_watcher( /// ctx: Rc<Sender>, /// state: Rc<SenderState>, /// new_enabled_val: bool, /// ) -> Result<(), ()> { /// Ok(()) /// } /// } /// ``` /// /// ## `SenderComponent` implementation after macro expansion /// /// ```ignore /// impl SenderComponent { /// async fn muted_change_watcher( /// sender: Rc<Sender>, /// state: Rc<SenderState>, /// new_muted_val: bool /// ) -> Result<(), ()> { /// Ok(()) /// } /// /// async fn enabled_change_watcher( /// sender: Rc<Sender>, /// state: Rc<SenderState>, /// new_enabled_val: bool, /// ) -> Result<(), ()> { /// Ok(()) /// } /// } /// /// impl ComponentState<Sender> for SenderState { /// fn spawn_watchers(&self, s: &mut WatchersSpawner<SenderState, Sender>) { /// s.spawn( /// self.muted.subscribe(), /// SenderComponent::muted_change_watcher, /// ); /// s.spawn( /// self.enabled.subscribe(), /// SenderComponent::enabled_change_watcher, /// ); /// } /// } /// ``` /// /// __Note__, that `ComponentState` implementation is simplified in this example /// for better readability. /// /// In reality object and state types will be obtained by casting /// `SenderComponent` to the `ComponentTypes` trait and getting types from it. #[proc_macro_attribute] pub fn watchers(_: TokenStream, input: TokenStream) -> TokenStream { watchers::expand(syn::parse_macro_input!(input)) .unwrap_or_else(|e| e.to_compile_error().into()) } decl_derive!([JsCaused, attributes(js)] => /// Generate implementation of `JsCaused` trait for errors represented as enum. /// /// # How to use /// /// ### 1. Declare wrapper for JS error and enum for error variants. /// /// The `js_cause()` method returns error if nested error has its type declared /// as an argument of the attribute `#[js(error = "path::to::Error")]` or /// the error type is assumed to be imported as `JsError`. /// /// ``` /// use medea_jason::utils::JsCaused; /// /// struct JsError; /// /// #[derive(JsCaused)] /// enum FooError { /// Internal, /// Js(JsError), /// } /// /// let err = FooError::Internal; /// assert_eq!(err.name(), "Internal"); /// assert!(err.js_cause().is_none()); /// /// let err = FooError::Js(JsError {}); /// assert_eq!(err.name(), "Js"); /// assert!(err.js_cause().is_some()); /// ``` /// /// If enum variant has attribute `#[js(cause)]` it will call the `js_cause()` /// method on nested error. /// /// ``` /// # use medea_jason::utils::JsCaused; /// # /// # struct JsError; /// # /// # #[derive(JsCaused)] /// # enum FooError { /// # Internal, /// # Js(JsError), /// # } /// # /// #[derive(JsCaused)] /// enum BarError { /// Foo(#[js(cause)] FooError), /// } /// /// let err = BarError::Foo(FooError::Internal); /// assert_eq!(err.name(), "Foo"); /// assert!(err.js_cause().is_none()); /// /// let err = BarError::Foo(FooError::Js(JsError {})); /// assert_eq!(err.name(), "Foo"); /// assert!(err.js_cause().is_some()); /// ``` js_caused::derive);