congen-derive 0.2.1

congen helps you build configuration systems that support partial updates from structured changes and CLI input
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
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
use std::collections::HashSet;

use proc_macro2::TokenStream;
use quote::{format_ident, quote};
use syn::{
    Expr, Field, GenericArgument, Ident, ItemStruct, Meta, PathArguments, Token, Type, Visibility,
    parse::Parse, parse2, punctuated::Punctuated,
};

use crate::{AttributeParam, CongenItemAttribute};

pub fn struct_configuration(input: ItemStruct) -> TokenStream {
    let mut errors = Vec::new();

    if matches!(input.fields, syn::Fields::Unnamed(_)) {
        return quote! { compile_error!("Configuration does not support Tupple structs") }.into();
    }

    let congen_attr = CongenItemAttribute::from_attrs(input.attrs.iter(), &mut errors);

    let fields: Vec<_> = input
        .fields
        .into_iter()
        .map(|field| CongenField::from_field(&mut errors, field))
        .map(|mut field| {
            if congen_attr.default && field.attr.default.is_none() {
                field.attr.default = Some(CongenDefault::UseDefault);
            }
            field
        })
        .collect();

    let vis = &input.vis;
    let change_type = format_ident!("{}Change", input.ident);

    let change_type_impl =
        derive_change_type(&input.ident, &change_type, vis, &fields, &congen_attr);
    let configuration_impl = derive_configuration_impl(&input.ident, &change_type, &fields);
    let congen_change_impl = derive_congen_change(&input.ident, &change_type, &fields);

    let errors = errors.iter().map(|e| e.to_compile_error());

    quote! {

        #(#errors)*

        #change_type_impl

        #configuration_impl

        #congen_change_impl
    }
}

fn derive_configuration_impl(
    ty: &Ident,
    change_type: &Ident,
    fields: &[CongenField],
) -> TokenStream {
    let type_name = ty.to_string();

    let apply_change = fields.iter().map(|field| {
        let ident = field.field.ident.as_ref().expect("tuple structs are not supported");
        let ty = &field.field.ty;
        let default_constructor = field.derive_default_constructor();
        quote! {
            <#ty as congen::internal::CongenInternal>::apply_change_with_inner_default(&mut self.#ident, change.#ident, #default_constructor);
        }
    });
    let field_desc = fields.iter().map(|field| {
        let field_name = if let Some(ident) = &field.field.ident {
            let name = ident.to_string();
            quote! { #name }
        } else {
            quote! { compile_error!("Configuration not supported for tupple structs") }
        };
        let ty = &field.field.ty;

        let with_default = if field.attr.default.is_some() {
            quote! { .with_default() }
        } else {
            quote! {}
        };

        quote! {
            children.push(<#ty as congen::internal::CongenInternal>::description(#field_name) #with_default);
        }
    });

    let mut has_default = true;

    let field_defaults = fields
        .iter()
        .map(|field| {
            let ident = &field
                .field
                .ident
                .as_ref()
                .expect("Tuple structs not supported");
            let ty = &field.field.ty;

            let Some(default) = field.attr.default.as_ref() else {
                has_default = false;
                return quote! {
                    #ident: { return Err(congen::internal::NotSupported) }
                };
            };

            match default {
                CongenDefault::UseDefault => quote! {
                    #ident: <#ty as congen::internal::CongenInternal>::default()?
                },
                CongenDefault::Expr(expr) => quote! {
                    #ident: #expr
                },
                CongenDefault::UseRust => quote! {
                    #ident: <#ty as std::default::Default>::default()
                },
            }
        })
        .collect::<Vec<_>>();

    let congen_default_impl = if has_default {
        quote! {
            impl congen::internal::CongenDefault for #ty {
            }
        }
    } else {
        quote! {}
    };

    let field_types_requiring_default = fields
        .iter()
        .filter_map(|field| {
            let ty = &field.field.ty;
            match field.attr.default.as_ref() {
                Some(CongenDefault::UseDefault) => Some(ty),
                _ => None,
            }
            .cloned()
        })
        .collect::<HashSet<_>>();
    let field_types_requiring_default = field_types_requiring_default.iter();

    quote! {
        impl congen::Configuration for #ty {
        }
        impl congen::internal::CongenInternal for #ty {
            type CongenChange  = #change_type;

            fn apply_change_with_inner_default(
                &mut self,
                change: #change_type,
                default: Option<fn() -> Box<dyn core::any::Any>>
            ) {
                #(#apply_change)*
            }

            fn description(field_name: &'static str) -> congen::internal::Description {
                let mut children = std::vec::Vec::new();

                #(#field_desc)*

                congen::internal::Description::Composit(
                    congen::internal::CompositDescription {
                        field_name,
                        type_name: Self::type_name(),
                        fields: children,
                        has_default: #has_default,
                        allow_unset: false,
                    }
                )
            }

            fn default() -> Result<Self, congen::internal::NotSupported> {
                #[allow(unreachable_code)]
                Ok(Self {
                    #(#field_defaults),*
                })
            }

            fn type_name() -> std::borrow::Cow<'static, str> {
                #type_name.into()
            }
        }

        #congen_default_impl

        #(const _: bool = congen::internal::assert_impl_default::<#field_types_requiring_default>();)*
    }
}

fn derive_change_type(
    config_type: &Ident,
    change_type: &Ident,
    vis: &Visibility,
    fields: &[CongenField],
    opts: &CongenItemAttribute,
) -> TokenStream {
    let change_fields_decls = fields.iter().map(|field| {
        let ident = &field.field.ident;
        let ty = &field.field.ty;
        quote! { #ident: <#ty as congen::internal::CongenInternal>::CongenChange }
    });

    let derive_debug = if opts.debug {
        quote! { #[derive(Debug)] }
    } else {
        quote! {}
    };

    let clone_impl = if opts.clone {
        let clone_field = fields.iter().map(|field| {
            let ident = &field.field.ident;
            quote! {
                #ident: self.#ident.clone()
            }
        });
        quote! {
            impl core::clone::Clone for #change_type {
                fn clone(&self) -> Self {
                    Self {
                        #(#clone_field),*
                    }
                }
            }
        }
    } else {
        quote! {}
    };

    quote! {
        #[doc = concat!("Change type for [`", stringify!(#config_type), "`] in use with [`congen::Configuration`]")]
        #[derive(Default)]
        #derive_debug
        #vis struct #change_type {
            #(#change_fields_decls),*
        }

        #clone_impl
    }
}

fn derive_congen_change(
    config_type: &Ident,
    change_type: &Ident,
    fields: &[CongenField],
) -> TokenStream {
    let field_idents: Vec<_> = fields.iter().map(|field| &field.field.ident).collect();

    let fields_from_path = fields.iter().map(|field| {
        let ident = &field.field.ident.clone().expect("tuples are not supported");
        let ident_str = ident.to_string();
        let field_ty = field.field.ty.clone();

        let special_case_default_verb = match &field.attr.default {
            Some(CongenDefault::Expr(default_expr)) => {
                quote! {
                    let mut path = path.peekable();
                    let verb = if path.peek().is_none() && matches!(verb, congen::internal::ChangeVerb::UseDefault) {
                        let value: #field_ty = #default_expr;
                        congen::internal::ChangeVerb::SetAny(Box::new(value))
                    } else {
                        verb
                    };
                }
            },
            _ => quote! {}
        };

        quote! {
            Some(#ident_str) => {
                #special_case_default_verb
                congen::internal::CongenChange::apply_change(
                    &mut change.#ident,
                    <#field_ty as congen::internal::CongenInternal>::CongenChange::from_path_and_verb(path, verb)?,
                );
            }
        }
    });

    let field_path_names = fields.iter().map(|field| {
        field
            .field
            .ident
            .as_ref()
            .expect("Tuple structs not supported")
            .to_string()
    });

    quote! {
        impl congen::internal::CongenChange for #change_type {
            type Configuration = #config_type;

            fn empty() -> Self {
                #change_type {
                    #(#field_idents: congen::internal::CongenChange::empty()),*
                }
            }

            fn default() -> Result<Self, congen::internal::NotSupported> {
                fn map_err(err: congen::internal::VerbError) -> congen::internal::NotSupported {
                    match err {
                        congen::internal::VerbError::InvalidPath | congen::internal::VerbError::ParseError(_) | congen::internal::VerbError::DowncastFailed | congen::internal::VerbError::InvalidDescription =>
                            panic!("unexpected error while creating default CongenChange: {err}"),
                        congen::internal::VerbError::NotSupported(_) | congen::internal::VerbError::UnsupportedVerb(_) => congen::internal::NotSupported,
                        err => panic!("unknown error while creating default CongenChange: {err}"),
                    }
                }

                let mut default = Self::empty();

                #(
                    eprintln!("create default for: {}", #field_path_names);

                    default.apply_change(
                        #change_type::from_path_and_verb([#field_path_names].into_iter(), congen::internal::ChangeVerb::UseDefault)
                            .map_err(map_err)?
                    );
                )*
                eprintln!("done!");

                Ok(default)
            }

            fn apply_change(&mut self, change: Self) {
                #(congen::internal::CongenChange::apply_change(&mut self.#field_idents, change.#field_idents));*
            }

            fn from_path_and_verb<'a, P>(
                mut path: P,
                verb: congen::internal::ChangeVerb)
            -> Result<Self, congen::internal::VerbError>
            where P: Iterator<Item = &'a str> {
                let field_name = path.next();
                let mut change = Self::empty();
                match field_name {
                    #(#fields_from_path,)*
                    Some(_) => return Err(congen::internal::VerbError::InvalidPath),
                    None => {
                        return match verb {
                            congen::internal::ChangeVerb::Set(_) | congen::internal::ChangeVerb::SetAny(_) | congen::internal::ChangeVerb::List(_)
                                => Err(congen::internal::VerbError::UnsupportedVerb(verb)),
                            congen::internal::ChangeVerb::SetFlag | congen::internal::ChangeVerb::Unset => {
                                eprintln!("set-flag and unset are not supported by derived congens");
                                Err(congen::internal::VerbError::UnsupportedVerb(verb))
                            },
                            congen::internal::ChangeVerb::UseDefault => Ok(<Self as congen::internal::CongenChange>::default()?),
                            unknown => {
                                eprintln!("unkown ChangeVerb {unknown:?}");
                                Err(congen::internal::VerbError::UnsupportedVerb(unknown))
                            }
                        }
                    },
                };
                Ok(change)
            }
        }
    }
}

#[derive(Default)]
pub struct CongenFieldAttribute {
    pub default: Option<CongenDefault>,
    pub inner_default: Option<Expr>,
}

pub enum CongenDefault {
    UseDefault,
    UseRust,
    Expr(Expr),
}

impl Parse for CongenFieldAttribute {
    fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {
        let args = Punctuated::<AttributeParam, Token![,]>::parse_terminated(input)?;

        let mut default = None;
        let mut inner_default = None;

        for arg in args {
            match arg.ident().to_string().as_str() {
                "rust_default" => {
                    if default.is_some() {
                        return Err(syn::Error::new_spanned(
                            arg,
                            "\"default\" should only be specified once in `congen` attribute",
                        ));
                    }

                    if !matches!(arg, AttributeParam::Flag(_)) {
                        return Err(syn::Error::new_spanned(
                            arg,
                            "\"rust_default\" takes no arguments",
                        ));
                    }

                    default = Some(CongenDefault::UseRust);
                }
                "default" => {
                    if default.is_some() {
                        return Err(syn::Error::new_spanned(
                            arg,
                            "\"default\" should only be specified once in `congen` attribute",
                        ));
                    }

                    default = Some(match arg {
                        AttributeParam::Flag(_ident) => CongenDefault::UseDefault,
                        AttributeParam::NameValue { value, .. } => CongenDefault::Expr(value),
                    });
                }
                "inner_default" => {
                    if inner_default.is_some() {
                        return Err(syn::Error::new_spanned(
                            arg,
                            "\"inner_default\" should only be specified once in `congen` attribute",
                        ));
                    }

                    let AttributeParam::NameValue { value: expr, .. } = arg else {
                        return Err(syn::Error::new_spanned(
                            arg,
                            "\"inner_default\" requires expression as argument",
                        ));
                    };

                    inner_default = Some(expr);
                }

                _ => {
                    return Err(syn::Error::new_spanned(
                        arg,
                        "unknown argument to `congen` attribute",
                    ));
                }
            }
        }

        Ok(CongenFieldAttribute {
            default,
            inner_default,
        })
    }
}

pub struct CongenField {
    pub attr: CongenFieldAttribute,
    pub field: Field,
    pub inner_type: Option<InnerType>,
    pub is_option: bool,
}

#[allow(clippy::large_enum_variant)]
pub enum InnerType {
    /// used for Lists and Option
    Single(Type),
    /// used for map types (key, value)
    #[expect(unused)]
    Double(Type, Type),
}

impl InnerType {
    pub fn field_type(&self) -> &Type {
        match self {
            InnerType::Single(typ) => typ,
            InnerType::Double(_, typ) => typ,
        }
    }
}

impl CongenField {
    pub fn from_field(errors: &mut Vec<syn::Error>, field: Field) -> CongenField {
        let attr = field
            .attrs
            .iter()
            .find_map(|attr| match &attr.meta {
                Meta::List(meta_list) if meta_list.path.is_ident(&format_ident!("congen")) => {
                    Some(parse2(meta_list.tokens.clone()))
                }
                _ => None,
            })
            .unwrap_or(Ok(CongenFieldAttribute::default()))
            .unwrap_or_else(|err| {
                errors.push(err);
                CongenFieldAttribute::default()
            });

        let inner_type = get_inner_type(&field.ty).unwrap_or_else(|err| {
            errors.push(err);
            None
        });
        let is_option = is_option(&field.ty).unwrap_or_else(|err| {
            errors.push(err);
            false
        });

        CongenField {
            attr,
            field,
            inner_type,
            is_option,
        }
    }

    pub fn derive_default_constructor(&self) -> TokenStream {
        let Some(inner_type) = self.inner_type.as_ref() else {
            return quote! { None };
        };
        let inner_type = inner_type.field_type();

        if let Some(inner_default) = self.attr.inner_default.as_ref() {
            quote! {
                Some(|| {
                    let inner_default: #inner_type = #inner_default;
                    Box::new(inner_default)
                })
            }
        } else if let Some(CongenDefault::Expr(expr)) = self.attr.default.as_ref()
            && self.is_option
        {
            // Special case Option with default expr. If expr is `Some(inner)` we can reuse
            // `inner` as the default for the inner type
            quote! {
                Some(|| {
                    let outer_default: core::option::Option<#inner_type> = #expr;
                    let inner_default: #inner_type = core::option::Option::expect(outer_default,
                        concat!("In order to use default of Option<",
                            stringify!(#inner_type),
                            "> for inner type default the default must be Some(_)."));
                    Box::new(inner_default)
                })
            }
        } else {
            quote! {
                Some(|| {
                    let inner_default = <#inner_type as congen::internal::CongenInternal>::default();
                    let inner_default: #inner_type = core::result::Result::expect(inner_default,
                        concat!(stringify!(#inner_type), " does not implement Configuration::default")
                    );
                    Box::new(inner_default)
                })
            }
        }
    }
}

fn get_inner_type(ty: &Type) -> Result<Option<InnerType>, syn::Error> {
    let Type::Path(path) = ty else {
        return Ok(None);
    };

    if path.qself.is_some() {
        return Err(syn::Error::new_spanned(
            ty,
            "Qself path type not supported in option for congen",
        ));
    }

    let path = &path.path;

    let Some(last_segment) = path.segments.iter().last() else {
        return Err(syn::Error::new_spanned(
            ty,
            "Empty path. Is this even possible?",
        ));
    };

    let PathArguments::AngleBracketed(opt_inner_type_args) = &last_segment.arguments else {
        // no type arguments
        return Ok(None);
    };

    let mut args = opt_inner_type_args.args.iter().cloned();

    // we only support generic types. Const, lifetimes, etc means that this is a type we don't
    // support so we don't need to record the inner type.
    let Some(GenericArgument::Type(first_inner)) = args.next() else {
        return Ok(None);
    };
    let Some(GenericArgument::Type(second_inner)) = args.next() else {
        return Ok(Some(InnerType::Single(first_inner)));
    };
    Ok(Some(InnerType::Double(first_inner, second_inner)))
}

fn is_option(ty: &Type) -> Result<bool, syn::Error> {
    let Type::Path(path) = ty else {
        return Ok(false);
    };
    if path.qself.is_some() {
        return Err(syn::Error::new_spanned(
            ty,
            "Qself path type not supported in option for congen",
        ));
    }

    let path = &path.path;

    if path.leading_colon.is_some() {
        return Ok(false);
    }

    let mut segments = path.segments.iter();
    let Some(first) = segments.next() else {
        return Err(syn::Error::new_spanned(
            ty,
            "Empty path. Is this even possible?",
        ));
    };
    match first.ident.to_string().as_str() {
        "Option" => Ok(true),
        "std" | "core" => {
            let Some(opt) = segments.next() else {
                return Ok(false);
            };
            if opt.ident != "option" {
                return Ok(false);
            };
            let Some(opt) = segments.next() else {
                return Ok(false);
            };
            if opt.ident != "Option" {
                return Ok(false);
            };
            Ok(true)
        }
        _ => Ok(false),
    }
}