composure_macros 0.1.1

Procedural macros for Composure Discord bots: #[command], #[app], #[view] and rsx! markup
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
//! `#[app(handlers(..), theme = .., events = ..)]`: makes a unit struct an App routing to the
//! Commands, Groups, Component and Modal Handlers, Views and Apps it lists (ADR 0013). Also the
//! `Route` impls the other attributes add to what they define.

use proc_macro2::{Ident, TokenStream};
use quote::{quote, quote_spanned};
use syn::spanned::Spanned;
use syn::{Expr, Fields, ItemStruct, Path};

pub fn expand(args: TokenStream, item: TokenStream) -> syn::Result<TokenStream> {
    let mut handlers: Option<Vec<Path>> = None;
    let mut theme: Option<Expr> = None;
    let mut events: Option<Path> = None;
    let parser = syn::meta::parser(|meta| {
        if meta.path.is_ident("handlers") {
            if handlers.is_some() {
                return Err(meta.error("`handlers` is set twice"));
            }
            let mut paths = Vec::new();
            meta.parse_nested_meta(|item| {
                paths.push(item.path.clone());
                Ok(())
            })?;
            handlers = Some(paths);
        } else if meta.path.is_ident("theme") {
            if theme.is_some() {
                return Err(meta.error("`theme` is set twice"));
            }
            theme = Some(meta.value()?.parse()?);
        } else if meta.path.is_ident("events") {
            if events.is_some() {
                return Err(meta.error("`events` is set twice"));
            }
            events = Some(meta.value()?.parse()?);
        } else {
            return Err(meta.error("unknown setting; expected one of handlers, theme, events"));
        }
        Ok(())
    });
    syn::parse::Parser::parse2(parser, args)?;
    let handlers = handlers.unwrap_or_default();

    let item: ItemStruct = syn::parse2(item)?;
    let ident = &item.ident;
    if !matches!(item.fields, Fields::Unit) || !item.generics.params.is_empty() {
        return Err(syn::Error::new(
            ident.span(),
            "apps must be unit structs: `struct Bot;`",
        ));
    }
    let attrs = &item.attrs;
    let vis = &item.vis;

    let c = quote!(::composure::command);
    let t = quote!(::composure::types);
    let routed = quote!(#c::__Routed);
    let theme_ty = quote!(::core::option::Option<&'static #c::Theme>);

    let routes = handlers
        .iter()
        .map(|h| quote_spanned!(h.span()=> <#h as #c::RouteDefinition>::ROUTE));
    let bounds = handlers
        .iter()
        .map(|h| quote_spanned!(h.span()=> #h: #c::Route<__S>,));
    let events_bound = events
        .as_ref()
        .map(|e| quote_spanned!(e.span()=> #e: #c::EventHandler<__S>,));
    let definitions = handlers
        .iter()
        .map(|h| quote_spanned!(h.span()=> <#h as #c::RouteDefinition>::definitions(into);));
    let has_events = events.is_some();
    let own_theme = theme.as_ref().map(|theme| {
        quote! {
            const THEME: #theme_ty = ::core::option::Option::Some(&#theme);
        }
    });
    // Without its own theme, an App passes the outer one through and leaves responses alone
    let (inherit, themed) = if theme.is_some() {
        (
            quote!(let theme = <Self as #c::RouteDefinition>::THEME.or(theme);),
            quote!(#c::__themed(routed, <Self as #c::RouteDefinition>::THEME)),
        )
    } else {
        (quote!(), quote!(routed))
    };
    // Children that cannot answer this kind of Interaction are skipped at compile time, so their
    // (always `None`) futures are not part of the App's
    let method = |name: TokenStream, interaction: TokenStream, answers: TokenStream| {
        let calls = handlers.iter().map(|h| {
            quote_spanned! {h.span()=>
                if const { <#h as #c::RouteDefinition>::ROUTE.#answers() }
                    && let ::core::option::Option::Some(result) =
                        <#h as #c::Route<__S>>::#name(interaction, state, theme).await
                {
                    break 'routed ::core::option::Option::Some(result);
                }
            }
        });
        quote! {
            async fn #name(
                interaction: &::std::sync::Arc<#t::#interaction>,
                state: &__S,
                theme: #theme_ty,
            ) -> #routed {
                #inherit
                #[allow(unused_labels)]
                let routed = 'routed: {
                    #(#calls)*
                    ::core::option::Option::None
                };
                #themed
            }
        }
    };
    let dispatch = method(
        quote!(dispatch),
        quote!(ApplicationCommandInteraction),
        quote!(has_commands),
    );
    let dispatch_autocomplete = method(
        quote!(dispatch_autocomplete),
        quote!(ApplicationCommandInteraction),
        quote!(has_commands),
    );
    let dispatch_component = method(
        quote!(dispatch_component),
        quote!(MessageComponentInteraction),
        quote!(has_components),
    );
    let dispatch_modal = method(
        quote!(dispatch_modal),
        quote!(ModalSubmitInteraction),
        quote!(has_modals),
    );
    // At most one App in the tree sets `events` (checked below), so the first that has it wins
    let dispatch_event = match &events {
        Some(events) => quote! {
            #c::EventHandler::<__S>::handle(&#events, ctx, event).await
        },
        None => {
            let calls = handlers.iter().map(|h| {
                quote_spanned! {h.span()=>
                    if const { <#h as #c::RouteDefinition>::ROUTE.has_events() } {
                        return <#h as #c::Route<__S>>::dispatch_event(ctx, event).await;
                    }
                }
            });
            quote! {
            #(#calls)*
            let _ = (ctx, event);
            ::core::result::Result::Ok(())
            }
        }
    };

    let check = quote_spanned! {ident.span()=>
        const _: () = #c::check_app(&<#ident as #c::RouteDefinition>::ROUTE);
    };

    Ok(quote! {
        #(#attrs)*
        #[derive(Debug, Clone, Copy, Default)]
        #vis struct #ident;

        #check

        impl #ident {
            /// Sends components, modals, autocomplete, and commands this App does not handle to
            /// `fallback`
            pub fn with_fallback<F>(self, fallback: F) -> #c::WithFallback<Self, F> {
                #c::WithFallback::new(self, fallback)
            }
        }

        impl #c::RouteDefinition for #ident {
            const ROUTE: #c::RouteInfo = #c::RouteInfo::App {
                routes: &[#(#routes),*],
                events: #has_events,
            };

            #own_theme

            fn definitions(into: &mut ::std::vec::Vec<#c::ScopedDefinition>) {
                let _ = &into;
                #(#definitions)*
            }
        }

        impl<__S: ::core::marker::Sync> #c::Route<__S> for #ident
        where
            #(#bounds)*
            #events_bound
        {
            #dispatch
            #dispatch_autocomplete
            #dispatch_component
            #dispatch_modal

            async fn dispatch_event(
                ctx: #c::EventCtx<'_, __S>,
                event: #t::Event,
            ) -> ::core::result::Result<(), #c::HandlerError> {
                #dispatch_event
            }
        }

        impl<__S: ::core::marker::Sync> #c::InteractionHandler<__S> for #ident
        where
            #ident: #c::Route<__S>,
        {
            fn theme(&self) -> #theme_ty {
                <Self as #c::RouteDefinition>::THEME
            }

            async fn command(
                &self,
                command: #t::ApplicationCommandInteraction,
                state: &__S,
            ) -> ::core::result::Result<#t::InteractionResponse, #c::HandlerError> {
                let command = ::std::sync::Arc::new(command);
                match <Self as #c::Route<__S>>::dispatch(&command, state, ::core::option::Option::None).await {
                    ::core::option::Option::Some(result) => result,
                    ::core::option::Option::None => ::core::result::Result::Err(
                        #c::HandlerError::unknown_command(&command.data.name),
                    ),
                }
            }

            async fn autocomplete(
                &self,
                autocomplete: #t::ApplicationCommandInteraction,
                state: &__S,
            ) -> ::core::result::Result<#t::InteractionResponse, #c::HandlerError> {
                let autocomplete = ::std::sync::Arc::new(autocomplete);
                match <Self as #c::Route<__S>>::dispatch_autocomplete(&autocomplete, state, ::core::option::Option::None).await {
                    ::core::option::Option::Some(result) => result,
                    ::core::option::Option::None => {
                        #c::InteractionHandler::<__S>::autocomplete(
                            &#c::NoHandler, #c::__unshare(autocomplete), state,
                        )
                        .await
                    }
                }
            }

            async fn component(
                &self,
                component: #t::MessageComponentInteraction,
                state: &__S,
            ) -> ::core::result::Result<#t::InteractionResponse, #c::HandlerError> {
                let component = ::std::sync::Arc::new(component);
                match <Self as #c::Route<__S>>::dispatch_component(&component, state, ::core::option::Option::None).await {
                    ::core::option::Option::Some(result) => result,
                    ::core::option::Option::None => {
                        #c::InteractionHandler::<__S>::component(
                            &#c::NoHandler, #c::__unshare(component), state,
                        )
                        .await
                    }
                }
            }

            async fn modal_submit(
                &self,
                modal: #t::ModalSubmitInteraction,
                state: &__S,
            ) -> ::core::result::Result<#t::InteractionResponse, #c::HandlerError> {
                let modal = ::std::sync::Arc::new(modal);
                match <Self as #c::Route<__S>>::dispatch_modal(&modal, state, ::core::option::Option::None).await {
                    ::core::option::Option::Some(result) => result,
                    ::core::option::Option::None => {
                        #c::InteractionHandler::<__S>::modal_submit(
                            &#c::NoHandler, #c::__unshare(modal), state,
                        )
                        .await
                    }
                }
            }
        }

        impl<__S: ::core::marker::Sync> #c::EventHandler<__S> for #ident
        where
            #ident: #c::Route<__S>,
        {
            async fn handle(
                &self,
                ctx: #c::EventCtx<'_, __S>,
                event: #t::Event,
            ) -> ::core::result::Result<(), #c::HandlerError> {
                <Self as #c::Route<__S>>::dispatch_event(ctx, event).await
            }
        }

        impl #c::CommandSetDefinition for #ident {
            fn definitions() -> ::std::vec::Vec<#c::ScopedDefinition> {
                let mut definitions = ::std::vec::Vec::new();
                <Self as #c::RouteDefinition>::definitions(&mut definitions);
                definitions
            }
        }
    })
}

/// One `Route` dispatch method forwarding to a `command::__dispatch_*` helper
fn forward(name: &str, interaction: &str, helper: &str) -> TokenStream {
    let c = quote!(::composure::command);
    let name = Ident::new(name, proc_macro2::Span::call_site());
    let interaction = Ident::new(interaction, proc_macro2::Span::call_site());
    let helper = Ident::new(helper, proc_macro2::Span::call_site());
    quote! {
        fn #name(
            interaction: &::std::sync::Arc<::composure::types::#interaction>,
            state: &__S,
            theme: ::core::option::Option<&'static #c::Theme>,
        ) -> impl ::core::future::Future<Output = #c::__Routed> + ::core::marker::Send {
            #c::#helper::<Self, __S>(interaction, state, theme)
        }
    }
}

/// `RouteDefinition` and `Route` for a `#[command]` or `#[group]`
pub fn command_route(ident: &Ident) -> TokenStream {
    let c = quote!(::composure::command);
    let dispatch = forward(
        "dispatch",
        "ApplicationCommandInteraction",
        "__dispatch_command",
    );
    let autocomplete = forward(
        "dispatch_autocomplete",
        "ApplicationCommandInteraction",
        "__dispatch_autocomplete",
    );
    quote! {
        impl #c::RouteDefinition for #ident {
            const ROUTE: #c::RouteInfo = #c::RouteInfo::command::<Self>();

            fn definitions(into: &mut ::std::vec::Vec<#c::ScopedDefinition>) {
                into.push(#c::ScopedDefinition::of::<Self>());
            }
        }

        impl<__S: ::core::marker::Sync> #c::Route<__S> for #ident
        where
            #ident: #c::Command<__S>,
        {
            #dispatch
            #autocomplete
        }
    }
}

/// `RouteDefinition` and `Route` for a `#[component]` (`modal: false`) or `#[modal]`
pub fn handler_route(ident: &Ident, modal: bool) -> TokenStream {
    let c = quote!(::composure::command);
    let (variant, definition, handler, method) = if modal {
        (
            quote!(Modal),
            quote!(ModalDefinition),
            quote!(ModalHandler),
            forward(
                "dispatch_modal",
                "ModalSubmitInteraction",
                "__dispatch_modal",
            ),
        )
    } else {
        (
            quote!(Component),
            quote!(ComponentDefinition),
            quote!(ComponentHandler),
            forward(
                "dispatch_component",
                "MessageComponentInteraction",
                "__dispatch_component",
            ),
        )
    };
    quote! {
        impl #c::RouteDefinition for #ident {
            const ROUTE: #c::RouteInfo = #c::RouteInfo::#variant {
                prefix: <Self as #c::#definition>::PREFIX,
            };
        }

        impl<__S: ::core::marker::Sync> #c::Route<__S> for #ident
        where
            #ident: #c::#handler<__S>,
        {
            #method
        }
    }
}

/// `RouteDefinition` and `Route` for a `#[view]`
pub fn view_route(ident: &Ident) -> TokenStream {
    let c = quote!(::composure::command);
    let component = forward(
        "dispatch_component",
        "MessageComponentInteraction",
        "__dispatch_view_component",
    );
    let modal = forward(
        "dispatch_modal",
        "ModalSubmitInteraction",
        "__dispatch_view_modal",
    );
    quote! {
        impl #c::RouteDefinition for #ident {
            const ROUTE: #c::RouteInfo =
                #c::RouteInfo::View(<Self as #c::ViewDefinition>::INFO);
        }

        impl<__S: ::core::marker::Sync> #c::Route<__S> for #ident
        where
            #ident: #c::ViewHandler<__S>,
        {
            #component
            #modal
        }
    }
}