icydb-model-macros 0.293.0

Procedural macros for IcyDB application models
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
//! Module: imp::normalize
//! Responsibility: generated implementation tokens.
//! Does not own: runtime trait semantics.
//! Boundary: parsed nodes to impl tokens.

use crate::{
    imp::field_walk::{cardinality_wrapper, field_walk_bindings},
    prelude::*,
};

/// ---------------------------------------------------------------------------
/// NormalizeAuto
/// ---------------------------------------------------------------------------

pub struct NormalizeAutoTrait;

/// Each node type can emit normalizer code for its *own value only*.
/// Traversal into children is handled by the visitor.

pub trait NormalizeAutoFn {
    fn self_tokens(_: &Self, __paths: &CratePaths) -> TokenStream {
        quote!()
    }
}

macro_rules! impl_normalize_auto {
    ($($ty:ty),* $(,)?) => {
        $(impl Imp<$ty> for NormalizeAutoTrait {
            fn strategy(node: &$ty) -> Option<TraitStrategy> {
        let paths = node.def().paths();
                let self_tokens = NormalizeAutoFn::self_tokens(node, paths);

                let tokens = Implementor::new(node.def(), TraitKind::NormalizeAuto)
                    .add_tokens(self_tokens)
                    .impl_tokens(paths);

                Some(TraitStrategy::from_impl(tokens))
            }
        })*
    };
}

impl_normalize_auto!(Enum, List, Map, Newtype, Set, Tuple);

/// ---------------------------------------------------------------------------
/// Entity / Record
/// ---------------------------------------------------------------------------
/// Apply field-item normalizers using the declared cardinality.
/// Do NOT recurse.
impl Imp<Entity> for NormalizeAutoTrait {
    fn strategy(node: &Entity) -> Option<TraitStrategy> {
        let paths = node.def().paths();
        Some(field_list_normalize_strategy(
            node.def(),
            &node.ty,
            &node.fields,
            paths,
        ))
    }
}

impl Imp<Record> for NormalizeAutoTrait {
    fn strategy(node: &Record) -> Option<TraitStrategy> {
        let paths = node.def().paths();
        Some(field_list_normalize_strategy(
            node.def(),
            &node.ty,
            &node.fields,
            paths,
        ))
    }
}

/// ---------------------------------------------------------------------------
/// Enum
/// ---------------------------------------------------------------------------
/// Whole-type hooks run before selecting the active payload's item hooks.
/// The visitor still owns traversal into the resulting payload's children.
impl NormalizeAutoFn for Enum {
    fn self_tokens(node: &Self, paths: &CratePaths) -> TokenStream {
        let mut statements = generate_normalizers(&node.ty.normalizers, quote!(*self), None, paths);
        if node.variants.iter().any(|variant| {
            variant
                .value
                .as_ref()
                .is_some_and(|value| !value.item.normalizers.is_empty())
        }) {
            let model = &paths.model;
            let arms = node.variants.iter().map(|variant| {
                let ident = &variant.name;
                let Some(value) = &variant.value else {
                    return quote! { Self::#ident => {} };
                };
                let name = ident.to_string();
                let rules = generate_normalizers(
                    &value.item.normalizers,
                    quote!(*v),
                    Some(quote!(#model::visitor::PathSegment::Field(#name))),
                    paths,
                );
                if let Some(rules) = cardinality_wrapper(value.cardinality(), rules, quote!(value))
                {
                    quote! { Self::#ident(value) => { #rules } }
                } else {
                    quote! { Self::#ident(_) => {} }
                }
            });
            statements.push(quote! { match self { #(#arms),* } });
        }
        fn_wrap_normalize_self(
            (!statements.is_empty()).then(|| quote! { #(#statements)* }),
            paths,
        )
    }
}

impl NormalizeAutoFn for Tuple {
    fn self_tokens(node: &Self, paths: &CratePaths) -> TokenStream {
        let model = &paths.model;
        let mut statements = generate_normalizers(&node.ty.normalizers, quote!(*self), None, paths);
        for (index, value) in node.values.iter().enumerate() {
            let name = index.to_string();
            let index = syn::Index::from(index);
            let rules = generate_normalizers(
                &value.item.normalizers,
                quote!(*v),
                Some(quote!(#model::visitor::PathSegment::Field(#name))),
                paths,
            );
            if let Some(rules) =
                cardinality_wrapper(value.cardinality(), rules, quote!(&mut self.#index))
            {
                statements.push(quote! { { #rules } });
            }
        }
        fn_wrap_normalize_self(
            (!statements.is_empty()).then(|| quote! { #(#statements)* }),
            paths,
        )
    }
}

/// ---------------------------------------------------------------------------
/// Newtype
/// ---------------------------------------------------------------------------
/// Apply normalizers attached to the newtype itself / its inner value.
impl NormalizeAutoFn for Newtype {
    fn self_tokens(node: &Self, paths: &CratePaths) -> TokenStream {
        fn_wrap_normalize_self(newtype_normalizers(node, paths), paths)
    }
}

/// ---------------------------------------------------------------------------
/// List / Set / Map
/// ---------------------------------------------------------------------------
/// Container-declared item hooks run here; the visitor separately visits each
/// child's own normalization implementation. Sorted keys are never mutated.
impl NormalizeAutoFn for List {
    fn self_tokens(node: &Self, paths: &CratePaths) -> TokenStream {
        let model = &paths.model;
        let mut statements =
            generate_normalizers(&node.ty.normalizers, quote!(self.0), None, paths);
        let items = generate_normalizers(
            &node.item.normalizers,
            quote!(*v),
            Some(quote!(#model::visitor::PathSegment::Index(i))),
            paths,
        );
        if !items.is_empty() {
            statements.push(quote! {
                for (i, v) in self.0.iter_mut().enumerate() {
                    #(#items)*
                }
            });
        }
        fn_wrap_normalize_self(
            (!statements.is_empty()).then(|| quote! { #(#statements)* }),
            paths,
        )
    }
}

impl NormalizeAutoFn for Set {
    fn self_tokens(node: &Self, paths: &CratePaths) -> TokenStream {
        container_self_tokens(&node.ty.normalizers, paths)
    }
}

impl NormalizeAutoFn for Map {
    fn self_tokens(node: &Self, paths: &CratePaths) -> TokenStream {
        let model = &paths.model;
        let mut statements =
            generate_normalizers(&node.ty.normalizers, quote!(self.0), None, paths);
        let values = generate_normalizers(
            &node.value.item.normalizers,
            quote!(*v),
            Some(quote!(#model::visitor::PathSegment::Index(i))),
            paths,
        );
        if let Some(values) = cardinality_wrapper(node.value.cardinality(), values, quote!(v)) {
            statements.push(quote! {
                for (i, v) in self.0.values_mut().enumerate() {
                    #values
                }
            });
        }
        fn_wrap_normalize_self(
            (!statements.is_empty()).then(|| quote! { #(#statements)* }),
            paths,
        )
    }
}

/// ---------------------------------------------------------------------------
/// Helpers
/// ---------------------------------------------------------------------------

/// Emit normalizer calls.
/// Errors are recorded via VisitorContext.
fn generate_normalizers(
    normalizers: &[TypeNormalizer],
    target: TokenStream,
    seg: Option<TokenStream>,
    paths: &CratePaths,
) -> Vec<TokenStream> {
    let model = &paths.model;
    normalizers
        .iter()
        .map(|normalizer| match &seg {
            None => normalizer_call(normalizer, &target, quote!(ctx), paths),
            Some(seg) => {
                let call = normalizer_call(normalizer, &target, quote!(&mut __field_ctx), paths);
                quote! {{
                    let mut __field_ctx = #model::visitor::ScopedContext::new(ctx, #seg);
                    #call
                }}
            }
        })
        .collect()
}

// Context selection does not change callback identity, invocation or issues.
fn normalizer_call(
    normalizer: &TypeNormalizer,
    target: &TokenStream,
    context: TokenStream,
    paths: &CratePaths,
) -> TokenStream {
    let model = &paths.model;
    let ctor = normalizer.quote_constructor();
    let callback_type = &normalizer.path;
    quote! {{
        let mut __callback_ctx = #model::visitor::CallbackContext::new(
            #context,
            #model::visitor::CallbackIdentity::new(
                #model::visitor::CallbackKind::Normalizer,
                ::core::any::type_name::<#callback_type>(),
            ),
        );
        if let ::core::result::Result::Err(msg) = #model::visitor::Normalizer::normalize_with_context(
            &(#ctor), &mut #target, &mut __callback_ctx,
        ) {
            #model::visitor::VisitorContext::add_issue(
                &mut __callback_ctx, #model::visitor::Issue::from(msg),
            );
        }
    }}
}

/// Normalizers attached to the container itself (not items).
fn container_normalizers(
    normalizers: &[TypeNormalizer],
    target: TokenStream,
    paths: &CratePaths,
) -> Option<TokenStream> {
    let stmts = generate_normalizers(normalizers, target, None, paths);
    if stmts.is_empty() {
        None
    } else {
        Some(quote! { #(#stmts)* })
    }
}

/// Emit container normalization without mutable item callbacks, as required by sets.
fn container_self_tokens(normalizers: &[TypeNormalizer], paths: &CratePaths) -> TokenStream {
    fn_wrap_normalize_self(
        container_normalizers(normalizers, quote!(self.0), paths),
        paths,
    )
}

/// Field-level normalizers for Entity / Record.
/// Applies item callbacks through each field's declared cardinality.
fn field_list(def: &Def, ty: &Type, fields: &FieldList, paths: &CratePaths) -> TokenStream {
    let model = &paths.model;
    let bindings = field_walk_bindings(fields);
    let field_table_ident = format_ident!("__NORMALIZE_FIELDS");

    let normalize_helpers = fields
        .iter()
        .zip(bindings.iter())
        .filter_map(|(field, binding)| {
            let stmts = generate_normalizers(
                &field.value.item.normalizers,
                quote!(*v),
                Some(binding.path_segment(paths)),
                paths,
            );
            let stmts = cardinality_wrapper(
                field.value.cardinality(),
                stmts,
                binding.member_mut_from(quote!(node)),
            )?;
            let fn_ident = binding.normalize_fn_ident();

            Some(quote! {
                fn #fn_ident(
                    node: &mut Self,
                    ctx: &mut dyn #model::visitor::VisitorContext,
                ) {
                    #stmts
                }
            })
        });

    let descriptors = bindings
        .iter()
        .zip(fields.iter())
        .filter_map(|(binding, field)| {
            if field.value.item.normalizers.is_empty() {
                None
            } else {
                let normalize_fn = binding.normalize_fn_ident();

                Some(quote! {
                    #model::visitor::NormalizeFieldDescriptor::new(Self::#normalize_fn)
                })
            }
        });

    let inherent_tokens = Implementor::inherent(def)
        .set_tokens(quote! {
            #(#normalize_helpers)*

            const #field_table_ident: &'static [#model::visitor::NormalizeFieldDescriptor<Self>] =
                &[#(#descriptors),*];
        })
        .impl_tokens(paths);

    let type_rules = generate_normalizers(&ty.normalizers, quote!(*self), None, paths);
    let trait_tokens = Implementor::new(def, TraitKind::NormalizeAuto)
        .add_tokens(fn_wrap_normalize_self(
            Some(quote! {
                #(#type_rules)*
                #model::visitor::drive_normalize_fields(self, ctx, Self::#field_table_ident);
            }),
            paths,
        ))
        .impl_tokens(paths);

    quote! {
        #inherent_tokens
        #trait_tokens
    }
}

/// Entity and record normalize generation share the same field-driven strategy.
fn field_list_normalize_strategy(
    def: &Def,
    ty: &Type,
    fields: &FieldList,
    paths: &CratePaths,
) -> TraitStrategy {
    TraitStrategy::from_impl(field_list(def, ty, fields, paths))
}

/// Normalizers for a newtype’s inner value (`self.0`).
fn newtype_normalizers(node: &Newtype, paths: &CratePaths) -> Option<TokenStream> {
    let target = quote!(self.0);

    let mut stmts = Vec::new();
    stmts.extend(generate_normalizers(
        &node.ty.normalizers,
        target.clone(),
        None,
        paths,
    ));
    stmts.extend(generate_normalizers(
        &node.item.normalizers,
        target,
        None,
        paths,
    ));

    if stmts.is_empty() {
        None
    } else {
        Some(quote! { #(#stmts)* })
    }
}

/// Emit `fn normalize_self(&mut self, ctx: &mut dyn VisitorContext)`
/// only if there is something to do.
fn fn_wrap_normalize_self(inner: Option<TokenStream>, paths: &CratePaths) -> TokenStream {
    let model = &paths.model;
    match inner {
        None => quote!(),
        Some(inner) => quote! {
            fn normalize_self(
                &mut self,
                ctx: &mut dyn #model::visitor::VisitorContext
            ) {
                #inner
            }
        },
    }
}