orga-macros 0.2.0

Macros for the orga crate
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
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
use heck::{CamelCase, SnakeCase};
use proc_macro::TokenStream;
use proc_macro2::{Literal, Span, TokenStream as TokenStream2};
use quote::quote;
use syn::*;

use super::utils::*;

pub fn derive(item: TokenStream) -> TokenStream {
    let item = parse_macro_input!(item as DeriveInput);
    let source = parse_parent();

    let name = &item.ident;
    let modname = Ident::new(
        format!("{}_client", name).to_snake_case().as_str(),
        Span::call_site(),
    );

    let field_adapters = create_field_adapters(&item);
    let client_impl = create_client_impl(&item, &modname);
    let client_struct = create_client_struct(&item, field_adapters.1, &source);

    let field_adapters = field_adapters.0;

    let output = quote! {
        pub mod #modname {
            use super::*;
            #client_struct
            #field_adapters
        }

        #client_impl
    };

    output.into()
}

fn create_client_impl(item: &DeriveInput, modname: &Ident) -> TokenStream2 {
    let name = &item.ident;
    let generics = &item.generics;

    let mut generics_sanitized = generics.clone();
    generics_sanitized.params.iter_mut().for_each(|g| {
        if let GenericParam::Type(ref mut t) = g {
            t.default = None;
        }
    });
    let parent_ty: GenericParam = syn::parse2(quote!(__Parent)).unwrap();
    generics_sanitized.params.push(parent_ty.clone());

    let generic_params = gen_param_input(generics, false);
    let generic_params_bracketed = gen_param_input(generics, true);
    let where_preds = item.generics.where_clause.as_ref().map(|w| &w.predicates);

    quote! {
        impl#generics_sanitized ::orga::client::Client<#parent_ty> for #name#generic_params_bracketed
        where
            #parent_ty: Clone + Send,
            #where_preds
        {
            type Client = #modname::Client<#generic_params #parent_ty>;

            fn create_client(parent: #parent_ty) -> Self::Client {
                #modname::Client::new(parent)
            }
        }
    }
}

fn create_client_struct(
    item: &DeriveInput,
    field_adapters: Vec<(&Field, ItemStruct)>,
    source: &File,
) -> TokenStream2 {
    let name = &item.ident;
    let generics = &item.generics;

    let parent_ty: GenericParam = syn::parse2(quote!(__Parent)).unwrap();

    let mut generics_sanitized = generics.clone();
    generics_sanitized.params.iter_mut().for_each(|g| {
        if let GenericParam::Type(ref mut t) = g {
            t.default = None;
        }
    });
    generics_sanitized.params.push(parent_ty.clone());

    let mut generics_sanitized_with_return = generics_sanitized.clone();
    generics_sanitized_with_return
        .params
        .push(syn::parse_quote!(__Return));

    let generic_params = gen_param_input(generics, false);
    let generic_params_bracketed = gen_param_input(generics, true);
    let where_preds = item.generics.where_clause.as_ref().map(|w| &w.predicates);

    let field_fields = field_adapters
        .iter()
        .enumerate()
        .map(|(i, (field, adapter))| {
            let field_name = field.ident.as_ref().map_or_else(
                || {
                    let i = Literal::usize_unsuffixed(i);
                    quote!(#i)
                },
                |f| quote!(#f),
            );
            let field_ty = &field.ty;

            let adapter_name = &adapter.ident;
            let mut adapter_generics = adapter.generics.clone();
            adapter_generics.params.iter_mut().for_each(|g| {
                if let GenericParam::Type(ref mut t) = g {
                    t.default = None;
                    t.bounds = Default::default();
                }
            });

            quote!(pub #field_name: <#field_ty as ::orga::client::Client<#adapter_name#adapter_generics>>::Client)
        });

    let field_clones = field_adapters
        .iter()
        .enumerate()
        .map(|(i, (field, adapter))| {
            let field_name = field.ident.as_ref().map_or_else(
                || {
                    let i = Literal::usize_unsuffixed(i);
                    quote!(#i)
                },
                |f| quote!(#f),
            );

            let mut adapter_generics = adapter.generics.clone();
            adapter_generics.params.iter_mut().for_each(|g| {
                if let GenericParam::Type(ref mut t) = g {
                    t.default = None;
                    t.bounds = Default::default();
                }
            });

            quote!(#field_name: self.#field_name.clone())
        });

    let field_constructors = field_adapters
        .iter()
        .enumerate()
        .map(|(i, (field, adapter))| {
            let field_name = field.ident.as_ref().map_or_else(
                || {
                    let i = Literal::usize_unsuffixed(i);
                    quote!(#i)
                },
                |f| quote!(#f),
            );
            let field_ty = &field.ty;
            let field_ty = if let Type::Path(ref ty) = field_ty {
                let mut without_params = ty.clone();
                let params = without_params
                    .path
                    .segments
                    .last()
                    .unwrap()
                    .arguments
                    .clone();
                if let PathArguments::AngleBracketed(ref params) = params {
                    without_params.path.segments.last_mut().unwrap().arguments =
                        PathArguments::None;
                    quote!(#without_params::#params)
                } else {
                    quote!(#field_ty)
                }
            } else {
                quote!(#field_ty)
            };

            let adapter_name = &adapter.ident;

            quote!(#field_name: #field_ty::create_client(#adapter_name::new(parent.clone())))
        });

    let call_method_impls_and_adapters =
        relevant_methods(name, "call", source)
            .into_iter()
            .map(|(method, impl_item)| {
                let method_name = &method.sig.ident;

                let method_inputs = &method.sig.inputs;
                let arg_types: Vec<_> = method_inputs
                    .iter()
                    .filter_map(|arg| match arg {
                        FnArg::Typed(arg) => Some(arg.ty.clone()),
                        _ => None,
                    })
                    .map(|ty| quote!(#ty))
                    .collect();
                let unrolled_args: Vec<_> = (0..arg_types.len()).map(|i| {
                    let i = Literal::usize_unsuffixed(i);
                    quote!(self.args.#i)
                }).collect();
                let method_input_names = method_inputs
                    .iter()
                    .filter_map(|arg| match arg {
                        FnArg::Typed(arg) => Some(arg.pat.clone()),
                        _ => None,
                    })
                    .map(|pat| quote!(#pat));

                let adapter_name = Ident::new(
                    format!("Method{}Adapter", method_name.to_string().to_camel_case()).as_str(),
                    Span::call_site(),
                );
                let call_variant_name = Ident::new(
                    format!("Method{}", method_name.to_string().to_camel_case()).as_str(),
                    Span::call_site(),
                );

                let output_ty = match method.sig.output.clone() {
                    ReturnType::Default => quote!(()),
                    ReturnType::Type(_, mut ty) => {
                        add_static_lifetimes(&mut ty);
                        quote!(#ty)
                    },
                };
                let method_output = quote!(
                    ::orga::client::CallChain<
                        <#output_ty as ::orga::client::Client<#adapter_name<#generic_params #output_ty, #parent_ty>>>::Client,
                        #adapter_name<#generic_params #output_ty, #parent_ty>,
                    >
                );

                let impl_preds = impl_item
                    .generics
                    .where_clause
                    .as_ref()
                    .map(|w| &w.predicates);

                let source = parse_parent();
                let call_enum = super::call::create_call_enum(&item, &source).1;
                let call_impl = super::call::create_call_impl(&item, &source, &call_enum).1;
                let call_preds = call_impl.generics.where_clause.as_ref().map(|w| &w.predicates);

                quote! {
                    pub struct #adapter_name<#generic_params __Return, #parent_ty>
                    where
                        #parent_ty: Clone + Send,
                        #parent_ty: ::orga::client::AsyncCall<Call = <#name#generic_params_bracketed as ::orga::call::Call>::Call>,
                    {
                        pub(super) parent: #parent_ty,
                        args: (#(#arg_types,)*),
                        _marker: std::marker::PhantomData<(#name#generic_params_bracketed, __Return)>,
                    }

                    unsafe impl#generics_sanitized_with_return Send for #adapter_name<#generic_params __Return, #parent_ty>
                    where
                        #parent_ty: Clone + Send,
                        #parent_ty: ::orga::client::AsyncCall<Call = <#name#generic_params_bracketed as ::orga::call::Call>::Call>,
                        #call_preds
                    {}

                    impl#generics_sanitized_with_return Clone for #adapter_name<#generic_params __Return, #parent_ty>
                    where
                        #parent_ty: Clone + Send,
                        #parent_ty: ::orga::client::AsyncCall<Call = <#name#generic_params_bracketed as ::orga::call::Call>::Call>,
                        #call_preds
                    {
                        fn clone(&self) -> Self {
                            let encoded_args = ::orga::encoding::Encode::encode(&self.args).unwrap();
                            let cloned_args = ::orga::encoding::Decode::decode(encoded_args.as_slice()).unwrap();
                            Self {
                                parent: self.parent.clone(),
                                args: cloned_args,
                                _marker: std::marker::PhantomData,
                            }
                        }
                    }

                    #[::orga::async_trait]
                    impl#generics_sanitized_with_return ::orga::client::AsyncCall for #adapter_name<#generic_params __Return, #parent_ty>
                    where
                        #parent_ty: Clone + Send,
                        #parent_ty: ::orga::client::AsyncCall<Call = <#name#generic_params_bracketed as ::orga::call::Call>::Call>,
                        __Return: ::orga::call::Call,
                        __Return::Call: Send + Sync,
                        #call_preds
                    {
                        type Call = <__Return as ::orga::call::Call>::Call;

                        async fn call(&mut self, call: Self::Call) -> Result<()> {
                            let call_bytes = ::orga::encoding::Encode::encode(&call)?;
                            let parent_call = <#name as ::orga::call::Call>::Call::#call_variant_name(
                                #(#unrolled_args,)*
                                call_bytes
                            );
                            self.parent.call(parent_call).await
                        }
                    }

                    impl#generics_sanitized Client<#generic_params #parent_ty>
                    where
                        #parent_ty: Clone + Send,
                        #parent_ty: ::orga::client::AsyncCall<Call = <#name#generic_params_bracketed as ::orga::call::Call>::Call>,
                        #where_preds
                        #impl_preds
                        #call_preds
                    {
                        pub fn #method_name(#method_inputs) -> #method_output {
                            let adapter = #adapter_name {
                                parent: self.parent.clone(),
                                args: (#(#method_input_names,)*),
                                _marker: std::marker::PhantomData,
                            };
                            let client = <#output_ty as ::orga::client::Client<#adapter_name<#generic_params _, #parent_ty>>>::create_client(adapter.clone());
                            ::orga::client::CallChain::new(client, adapter)
                        }
                    }
                }
            });

    quote! {
        #[must_use]
        pub struct Client<#generic_params #parent_ty>
        where
            #parent_ty: Clone + Send,
            #where_preds
        {
            pub(super) parent: #parent_ty,
            #(#field_fields,)*
        }

        impl<#generic_params #parent_ty> Clone for Client<#generic_params #parent_ty>
        where
            #parent_ty: Clone + Send,
            #where_preds
        {
            fn clone(&self) -> Self {
                Self {
                    parent: self.parent.clone(),
                    #(#field_clones,)*
                }
            }
        }

        impl#generics_sanitized Client<#generic_params #parent_ty>
        where
            #parent_ty: Clone + Send,
            #where_preds
        {
            pub fn new(parent: #parent_ty) -> Self {
                use ::orga::client::Client as _;
                Client {
                    #(#field_constructors,)*
                    parent,
                }
            }
        }

        #(#call_method_impls_and_adapters)*
    }
}

fn create_field_adapters(item: &DeriveInput) -> (TokenStream2, Vec<(&Field, ItemStruct)>) {
    let fields: Vec<_> = struct_fields(&item)
        .filter(|field| matches!(field.vis, Visibility::Public(_)))
        .collect();

    let item_name = &item.ident;
    let item_generics = &item.generics;
    let item_ty = quote!(#item_name#item_generics);

    let adapters: Vec<_> = fields
        .iter()
        .enumerate()
        .map(|(i, f)| create_field_adapter(&item_ty, f, i))
        .collect();
    let adapter_outputs = adapters.clone().into_iter().map(|a| a.0);
    let adapter_items: Vec<_> = fields
        .iter()
        .map(|f| *f)
        .zip(adapters.into_iter().map(|a| a.1))
        .collect();

    let output = quote!(#(#adapter_outputs)*);

    (output, adapter_items)
}

fn create_field_adapter(
    parent_ty: &TokenStream2,
    field: &Field,
    i: usize,
) -> (TokenStream2, ItemStruct) {
    let struct_name = field.ident.as_ref().map_or(
        Ident::new(format!("Field{}Adapter", i).as_str(), Span::call_site()),
        |f| {
            Ident::new(
                format!("Field{}Adapter", f.to_string().to_camel_case()).as_str(),
                Span::call_site(),
            )
        },
    );
    let variant_name = field.ident.as_ref().map_or(
        Ident::new(format!("Field{}", i).as_str(), Span::call_site()),
        |f| {
            Ident::new(
                format!("Field{}", f.to_string().to_camel_case()).as_str(),
                Span::call_site(),
            )
        },
    );
    let field_ty = &field.ty;
    let parent_client_ty: GenericParam = syn::parse2(quote!(__Parent)).unwrap();

    let struct_def = quote! {
        #[derive(Clone)]
        pub struct #struct_name<#parent_client_ty>
        where
            #parent_client_ty: Clone + Send,
        {
            pub(super) parent: #parent_client_ty,
        }
    };

    let adapter_struct: ItemStruct = syn::parse2(struct_def.clone()).unwrap();
    let mut adapter_generics = adapter_struct.generics.clone();
    adapter_generics.params.iter_mut().for_each(|g| {
        if let GenericParam::Type(ref mut t) = g {
            t.default = None;
        }
    });

    let output = quote! {
        #struct_def
        impl#adapter_generics #struct_name<#parent_client_ty>
        where
            #parent_client_ty: Clone + Send,
        {
            pub fn new(parent: #parent_client_ty) -> Self {
                Self { parent }
            }
        }

        #[::orga::async_trait]
        impl#adapter_generics ::orga::client::AsyncCall for #struct_name<#parent_client_ty>
        where
            #parent_client_ty: Clone + Send,
            #parent_client_ty: ::orga::client::AsyncCall<Call = <#parent_ty as ::orga::call::Call>::Call>,
        {
            type Call = <#field_ty as ::orga::call::Call>::Call;

            async fn call(&mut self, call: Self::Call) -> Result<()> {
                // assumes that the call has a tuple variant called "Field" +
                // the camel-cased name as the field
                let subcall_bytes = ::orga::encoding::Encode::encode(&call)?; // TODO: error handling
                let subcall = <#parent_ty as ::orga::call::Call>::Call::#variant_name(subcall_bytes);
                self.parent.call(subcall).await
            }
        }
    };

    (output, adapter_struct)
}

fn gen_param_input(generics: &Generics, bracketed: bool) -> TokenStream2 {
    let gen_params = generics.params.iter().map(|p| match p {
        GenericParam::Type(p) => {
            let ident = &p.ident;
            quote!(#ident)
        }
        GenericParam::Lifetime(p) => {
            let ident = &p.lifetime.ident;
            quote!(#ident)
        }
        GenericParam::Const(p) => {
            let ident = &p.ident;
            quote!(#ident)
        }
    });

    if gen_params.len() == 0 {
        quote!()
    } else if bracketed {
        quote!(<#(#gen_params),*>)
    } else {
        quote!(#(#gen_params,)*)
    }
}

fn struct_fields(item: &DeriveInput) -> impl Iterator<Item = &Field> {
    let data = match item.data {
        Data::Struct(ref data) => data,
        Data::Enum(ref _data) => todo!("#[derive(Client)] does not yet support enums"),
        Data::Union(_) => panic!("Unions are not supported"),
    };

    match data.fields {
        Fields::Named(ref fields) => fields.named.iter(),
        Fields::Unnamed(ref fields) => fields.unnamed.iter(),
        Fields::Unit => panic!("Unit structs are not supported"),
    }
}

fn add_static_lifetimes(ty: &mut Type) {
    match ty {
        Type::Path(path) => {
            if let Some(last_segment) = path.path.segments.last_mut() {
                if let PathArguments::AngleBracketed(args) = &mut last_segment.arguments {
                    args.args.iter_mut().for_each(|arg| {
                        if let GenericArgument::Type(ty) = arg {
                            add_static_lifetimes(ty);
                        }
                    });
                }
            }
        }
        Type::Reference(ref mut ref_) => {
            ref_.lifetime = Some(Lifetime::new("'static", Span::call_site()));
            add_static_lifetimes(&mut ref_.elem);
        }
        _ => {}
    }
}