ioevent_macro 0.1.0-rc.3

Macro for ioevent
Documentation
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
//! Procedural macros for the I/O event system.
//!
//! This crate provides procedural macros for deriving event types and creating event subscribers.
//! It is part of the `ioevent` ecosystem and should be used as a dependency of `ioevent`.

use proc_macro::TokenStream;
use quote::{ToTokens, format_ident, quote};
use syn::{FnArg, ItemFn, ReturnType, Token, parse_macro_input, punctuated::Punctuated};

/// Derives the `Event` trait for a type.
///
/// This macro implements the `Event` trait for a type, allowing it to participate in the event system.
/// It provides serialization and deserialization capabilities for the type.
///
/// # Attributes
///
/// * `#[event(tag = "custom_tag")]` - Specifies a custom tag for the event type.
///   If not provided, the tag will be generated from the module path and type name.
///   
/// # Requires
///
/// * The type must implement the `Serialize` and `Deserialize` traits from the `serde` crate.
///
/// # Examples
///
/// ```rust
/// #[derive(Event)]
/// struct MyEvent {
///     field: String,
/// }
/// ```
#[proc_macro_derive(Event, attributes(event))]
pub fn derive_event(input: TokenStream) -> TokenStream {
    let input = parse_macro_input!(input as syn::DeriveInput);
    let name = input.ident;
    let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();

    let mut custom_tag = None;
    for attr in &input.attrs {
        if !attr.path().is_ident("event") {
            continue;
        }

        let meta_list =
            match attr.parse_args_with(Punctuated::<syn::Meta, Token![,]>::parse_terminated) {
                Ok(list) => list,
                Err(e) => return e.to_compile_error().into(),
            };

        for meta in meta_list {
            match meta {
                syn::Meta::NameValue(nv) if nv.path.is_ident("tag") => {
                    let lit_str =
                        match syn::parse2::<syn::LitStr>(nv.value.clone().into_token_stream()) {
                            Ok(lit) => lit,
                            Err(_) => {
                                let msg = "`tag` attribute must be a string literal";
                                return syn::Error::new_spanned(nv.value, msg)
                                    .to_compile_error()
                                    .into();
                            }
                        };

                    if custom_tag.is_some() {
                        let msg = "`tag` specified multiple times";
                        return syn::Error::new_spanned(nv, msg).to_compile_error().into();
                    }

                    custom_tag = Some(lit_str);
                }
                _ => {
                    let msg = "unknown attribute parameter, expected `tag = \"...\"`";
                    return syn::Error::new_spanned(meta, msg).to_compile_error().into();
                }
            }
        }
    }

    let tag_expr = if let Some(lit) = custom_tag {
        quote! { #lit }
    } else {
        quote! { concat!(module_path!(), "::", stringify!(#name)) }
    };

    let expanded = quote! {
        impl #impl_generics ::ioevent::event::Event for #name #ty_generics #where_clause {
            const TAG: &'static str = #tag_expr;
        }

        impl #impl_generics TryFrom<&::ioevent::event::EventData> for #name #ty_generics #where_clause {
            type Error = ::ioevent::error::TryFromEventError;
            fn try_from(value: &::ioevent::event::EventData) -> ::core::result::Result<Self, Self::Error> {
                ::core::result::Result::Ok(value.payload.deserialized()?)
            }
        }
    };

    TokenStream::from(expanded)
}

/// Creates an event subscriber from an async function.
///
/// This macro transforms an async function into an event subscriber that can be registered
/// with the event system. The function must take either one or two parameters:
/// * A state parameter (optional)
/// * An event parameter
/// * A return value of type `Result` (optional)
///
/// # Examples
///
/// ```rust
/// #[subscriber]
/// async fn handle_event(event: MyEvent) -> Result {
///     // Handle the event
///     Ok(())
/// }
/// ```
#[proc_macro_attribute]
pub fn subscriber(_attr: TokenStream, item: TokenStream) -> TokenStream {
    let original_fn = parse_macro_input!(item as ItemFn);

    if original_fn.sig.asyncness.is_none() {
        return quote! { compile_error!("subscriber macro can only be applied to async functions"); }.into();
    }

    let params = original_fn.sig.inputs.iter().collect::<Vec<_>>();
    let (state_param, event_param) = match params.len() {
        1 => (None, params[0]),
        2 => (Some(params[0]), params[1]),
        _ => panic!("Expected 1 or 2 parameters"),
    };

    let (event_ty, event_name) = match event_param {
        FnArg::Typed(pat_type) => (&pat_type.ty, &pat_type.pat),
        _ => panic!("Event parameter must be a typed parameter"),
    };

    let state_ty_name = state_param.map(|param| match param {
        FnArg::Typed(pat_type) => (&pat_type.ty, &pat_type.pat),
        _ => panic!("State parameter must be a typed parameter"),
    });
    
    let raw_generics = &original_fn.sig.generics.type_params().map(|v|v.clone()).collect::<Vec<_>>();

    let (generics, new_params) = if let Some((state_ty, state_name)) = state_ty_name {
        let params = quote! {
            #state_name: &#state_ty,
            #event_name: &::ioevent::event::EventData
        };
        (quote! { <#(#raw_generics),*> }, params)
    } else {
        let params = quote! {
            _state: &::ioevent::state::State<_STATE>,
            #event_name: &::ioevent::event::EventData
        };
        (quote! { <#(#raw_generics),* _STATE> }, params)
    };

    let event_try_into = quote! {
        let #event_name: ::core::result::Result<#event_ty, ::ioevent::error::TryFromEventError> = ::std::convert::TryInto::try_into(#event_name);
    };

    let state_clone = if let Some((_, state_name)) = state_ty_name {
        quote! {
            let #state_name = ::std::clone::Clone::clone(#state_name);
        }
    } else {
        quote! {}
    };

    let return_expr = if matches!(original_fn.sig.output, ReturnType::Default) {
        Some(quote! { Ok(()) })
    } else {
        None
    };

    let original_stmts = &original_fn.block.stmts;

    let async_block = quote! {
        async move {
            let #event_name = #event_name?;
            #(#original_stmts)*
            #return_expr
        }
    };

    let func_name = &original_fn.sig.ident;

    let mod_name = format_ident!("{}", func_name);

    let vis = &original_fn.vis;

    let mod_block = quote! {
        #[doc(hidden)]
        #vis mod #mod_name {
            use super::*;
            pub type _Event = #event_ty;
        }
    };

    let expanded = quote! {
        #vis fn #func_name #generics (#new_params) -> ::ioevent::future::SubscribeFutureRet {
            #event_try_into
            #state_clone
            ::std::boxed::Box::pin(#async_block)
        }
        #mod_block
    };

    TokenStream::from(expanded)
}

/// Derives the `ProcedureCall` trait for a type.
///
/// This macro implements the `ProcedureCall` trait for a type, allowing it to be used
/// in remote procedure calls. It provides serialization and deserialization capabilities
/// for the type.
///
/// # Attributes
///
/// * `#[procedure(path = "custom_path")]` - Specifies a custom path for the procedure.
///   If not provided, the path will be generated from the module path and type name.
///   
/// # Requires
///
/// * The type must implement the `Serialize` and `Deserialize` traits from the `serde` crate.
///
/// # Examples
///
/// ```rust
/// #[derive(ProcedureCall)]
/// struct MyProcedure {
///     field: String,
/// }
/// ```
#[proc_macro_derive(ProcedureCall, attributes(procedure))]
pub fn derive_procedure_call(input: TokenStream) -> TokenStream {
    let input = parse_macro_input!(input as syn::DeriveInput);
    let name = input.ident;
    let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();

    let mut custom_path = None;
    for attr in &input.attrs {
        if !attr.path().is_ident("procedure") {
            continue;
        }

        let meta_list = match attr.parse_args_with(Punctuated::<syn::Meta, Token![,]>::parse_terminated) {
            Ok(list) => list,
            Err(e) => return e.to_compile_error().into(),
        };

        for meta in meta_list {
            match meta {
                syn::Meta::NameValue(nv) if nv.path.is_ident("path") => {
                    let lit_str = match syn::parse2::<syn::LitStr>(nv.value.clone().into_token_stream()) {
                        Ok(lit) => lit,
                        Err(_) => {
                            let msg = "`path` attribute must be a string literal";
                            return syn::Error::new_spanned(nv.value, msg)
                                .to_compile_error()
                                .into();
                        }
                    };

                    if custom_path.is_some() {
                        let msg = "`path` specified multiple times";
                        return syn::Error::new_spanned(nv, msg).to_compile_error().into();
                    }

                    custom_path = Some(lit_str);
                }
                _ => {
                    let msg = "unknown attribute parameter, expected `path = \"...\"`";
                    return syn::Error::new_spanned(meta, msg).to_compile_error().into();
                }
            }
        }
    }

    let path_expr = if let Some(lit) = custom_path {
        quote! { #lit }
    } else {
        quote! { concat!(module_path!(), "::", stringify!(#name)) }
    };

    let expanded = quote! {
        impl #impl_generics ::ioevent::state::ProcedureCall for #name #ty_generics #where_clause {
            fn path() -> String {
                #path_expr.to_owned()
            }
        }

        impl #impl_generics TryFrom<::ioevent::state::ProcedureCallData> for #name #ty_generics #where_clause {
            type Error = ::ioevent::error::TryFromEventError;
            fn try_from(value: ::ioevent::state::ProcedureCallData) -> ::core::result::Result<Self, Self::Error> {
                ::core::result::Result::Ok(value.payload.deserialized()?)
            }
        }
    };

    TokenStream::from(expanded)
}

/// Creates a procedure handler from an async function.
///
/// This macro transforms an async function into a procedure handler that can be registered
/// with the procedure call system. The function must take either one or two parameters:
/// * A state parameter (optional)
/// * A procedure parameter
///
/// # Examples
///
/// ```rust
/// #[procedure]
/// async fn handle_procedure(proc: MyProcedureRequest) -> Result {
///     // Handle the procedure
///     Ok(MyProcedureResponse)
/// }
/// ```
#[proc_macro_attribute]
pub fn procedure(_attr: TokenStream, item: TokenStream) -> TokenStream {
    let original_fn = parse_macro_input!(item as ItemFn);

    if original_fn.sig.asyncness.is_none() {
        return quote! { compile_error!("procedure macro can only be applied to async functions"); }.into();
    }
    
    let params = original_fn.sig.inputs.iter().collect::<Vec<_>>();
    let (state_param, event_param) = match params.len() {
        1 => (None, params[0]),
        2 => (Some(params[0]), params[1]),
        _ => panic!("Expected 1 or 2 parameters"),
    };

    let (event_ty, event_name) = match event_param {
        FnArg::Typed(pat_type) => (&pat_type.ty, &pat_type.pat),
        _ => panic!("Event parameter must be a typed parameter"),
    };

    let state_ty_name = state_param.map(|param| match param {
        FnArg::Typed(pat_type) => (&pat_type.ty, &pat_type.pat),
        _ => panic!("State parameter must be a typed parameter"),
    });
    
    let raw_generics = &original_fn.sig.generics.type_params().map(|v|v.clone()).collect::<Vec<_>>();

    let (generics, new_params) = if let Some((state_ty, state_name)) = state_ty_name {
        let params = quote! {
            #state_name: &#state_ty,
            #event_name: &::ioevent::event::EventData
        };
        (quote! { <#(#raw_generics),*> }, params)
    } else {
        let params = quote! {
            _state: &::ioevent::state::State<_STATE>,
            #event_name: &::ioevent::event::EventData
        };
        (quote! { <#(#raw_generics),* _STATE: ::ioevent::state::ProcedureCallWright + ::std::clone::Clone + ::std::marker::Send + ::std::marker::Sync + 'static> }, params)
    };

    let event_try_into = quote! {
        let #event_name: ::core::result::Result<::ioevent::state::ProcedureCallData, ::ioevent::error::TryFromEventError> = ::std::convert::TryInto::try_into(#event_name);
    };

    let state_clone = if let Some((_, state_name)) = state_ty_name {
        quote! {
            let #state_name = ::std::clone::Clone::clone(#state_name);
        }
    } else {
        quote! {
            let _state = ::std::clone::Clone::clone(_state);
        }
    };

    let original_stmts = &original_fn.block.stmts;

    let async_block = if let Some((_, state_name)) = state_ty_name {
        quote! {
            async move {
                let #event_name = #event_name?;
                if <#event_ty as ::ioevent::state::ProcedureCallRequest>::match_self(&#event_name) {
                    let echo = #event_name.echo;
                    let #event_name = <#event_ty as ::std::convert::TryFrom<::ioevent::state::ProcedureCallData>>::try_from(#event_name)?;
                    let response: ::core::result::Result<_, ::ioevent::error::CallSubscribeError> = {
                        #(#original_stmts)*
                    };
                    ::ioevent::state::ProcedureCallExt::resolve::<#event_ty>(&#state_name, echo, &response?).await?;
                }
                Ok(())
            }
        }
    } else {
        quote! {
            async move {
                let #event_name = #event_name?;
                if <#event_ty as ::ioevent::state::ProcedureCallRequest>::match_self(&#event_name) {
                    let echo = #event_name.echo;
                    let #event_name = <#event_ty as ::std::convert::TryFrom<::ioevent::state::ProcedureCallData>>::try_from(#event_name)?;
                    let response: ::core::result::Result<_, ::ioevent::error::CallSubscribeError> = {
                        #(#original_stmts)*
                    };
                    ::ioevent::state::ProcedureCallExt::resolve::<#event_ty>(&_state, echo, &response?).await?;
                }
                Ok(())
            }
        }
    };

    let func_name = &original_fn.sig.ident;
    let mod_name = format_ident!("{}", func_name);

    let vis = &original_fn.vis;

    let mod_block = quote! {
        #[doc(hidden)]
        #vis mod #mod_name {
            use super::*;
            pub type _Event = ::ioevent::state::ProcedureCallData;
        }
    };

    let expanded = quote! {
        #vis fn #func_name #generics (#new_params) -> ::ioevent::future::SubscribeFutureRet {
            #event_try_into
            #state_clone
            ::std::boxed::Box::pin(#async_block)
        }
        #mod_block
    };

    TokenStream::from(expanded)
}