structural-typing-macros 0.1.8

Procedural macros for structural-typing 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
use proc_macro2::TokenStream;
use quote::quote;
use syn::{Expr, GenericArgument, Ident, PathArguments, Type};

use crate::codegen::generics_utils;
use crate::parsing::StructInfo;

fn generate_fields_trait_parts(field_names: &[&Ident]) -> Vec<TokenStream> {
    field_names
        .iter()
        .map(|name| {
            quote! { type #name: Presence; }
        })
        .collect()
}

fn generate_fieldset_parts(
    field_names: &[&Ident],
) -> (Vec<TokenStream>, Vec<TokenStream>, Vec<TokenStream>) {
    let phantom_types = field_names
        .iter()
        .map(|name| {
            quote! { #name }
        })
        .collect();

    let params = field_names
        .iter()
        .map(|name| {
            quote! { #name: Presence }
        })
        .collect();

    let assocs = field_names
        .iter()
        .map(|name| {
            quote! { type #name = #name; }
        })
        .collect();

    (phantom_types, params, assocs)
}

fn generate_merge_fields(field_names: &[&Ident]) -> Vec<TokenStream> {
    field_names
        .iter()
        .map(|name| {
            quote! {
                <<F2 as Fields>::#name as Presence>::Or<<F1 as Fields>::#name>
            }
        })
        .collect()
}

fn generate_remainder_fields(field_names: &[&Ident], field_types: &[&Type]) -> Vec<TokenStream> {
    field_names
        .iter()
        .zip(field_types.iter())
        .map(|(name, ty)| {
            quote! {
                <<<<F2 as Fields>::#name as ::structural_typing::presence::Presence>::Output<#ty> as ::structural_typing::access::Access<#ty>>::RemainderFrom<<<F1 as Fields>::#name as ::structural_typing::presence::Presence>::Output<#ty>> as ::structural_typing::presence::InferPresence<#ty>>::Presence
            }
        })
        .collect()
}

fn generate_empty_constructor(info: &StructInfo) -> TokenStream {
    let struct_name = &info.name;
    let field_names: Vec<_> = info.fields.iter().map(|f| &f.name).collect();

    let non_defaulted_params = generics_utils::non_defaulted_params(&info.generics);
    let non_defaulted_params_with_bounds: Vec<_> = non_defaulted_params.iter().collect();

    // Build a generics object with only non-defaulted params for type_args_with_f
    let mut non_defaulted_generics = info.generics.clone();
    non_defaulted_generics.params = non_defaulted_params.iter().cloned().collect();

    let user_type_args_for_return: Vec<_> =
        generics_utils::extract_type_param_idents(&non_defaulted_generics.params);

    let f_value = quote! { with::all<::structural_typing::presence::Absent> };
    let type_args = generics_utils::type_args_with_f(
        &non_defaulted_generics,
        &user_type_args_for_return,
        f_value,
    );

    let where_clause = &info.generics.where_clause;

    let generic_params = if non_defaulted_params.is_empty() {
        quote! {}
    } else {
        quote! { <#(#non_defaulted_params_with_bounds),*> }
    };

    quote! {
        /// Creates an empty instance with all fields absent.
        pub fn empty #generic_params () -> #struct_name #type_args #where_clause {
            #struct_name {
                #(#field_names: ::core::marker::PhantomData),*
            }
        }
    }
}

fn extract_generic_idents_from_type(
    ty: &Type,
    user_generics: &[String],
    generic_params: &syn::punctuated::Punctuated<syn::GenericParam, syn::token::Comma>,
) -> Vec<TokenStream> {
    let mut found_idents = Vec::new();
    visit_type_for_generics(ty, user_generics, &mut found_idents);

    // Map found identifiers back to their full GenericParam declarations
    // Preserve declaration order by iterating through generic_params in order
    let mut result = Vec::new();
    let found_strs: std::collections::HashSet<String> =
        found_idents.iter().map(|t| t.to_string()).collect();

    for param in generic_params {
        let (param_str, token) = match param {
            syn::GenericParam::Type(tp) => {
                let ident = &tp.ident;
                (ident.to_string(), quote! { #ident })
            }
            syn::GenericParam::Lifetime(lp) => {
                let lifetime = &lp.lifetime;
                (lifetime.to_string(), quote! { #lifetime })
            }
            syn::GenericParam::Const(cp) => {
                let ident = &cp.ident;
                let ty = &cp.ty;
                (ident.to_string(), quote! { const #ident: #ty })
            }
        };

        // Use exact match instead of substring match to avoid false positives
        if found_strs.contains(&param_str) {
            result.push(token);
        }
    }
    result
}

fn visit_type_for_generics(
    ty: &Type,
    user_generics: &[String],
    generics: &mut Vec<TokenStream>,
) {
    match ty {
        Type::Path(type_path) => {
            if let Some(ident) = type_path.path.get_ident() {
                let ident_str = ident.to_string();
                if user_generics.contains(&ident_str) {
                    let token = quote! { #ident };
                    if !generics.iter().any(|g| g.to_string() == token.to_string()) {
                        generics.push(token);
                    }
                }
            }

            for segment in &type_path.path.segments {
                if let PathArguments::AngleBracketed(args) = &segment.arguments {
                    for arg in &args.args {
                        match arg {
                            GenericArgument::Type(ty) => {
                                visit_type_for_generics(ty, user_generics, generics);
                            }
                            GenericArgument::Lifetime(lifetime) => {
                                let lifetime_str = lifetime.ident.to_string();
                                if user_generics.contains(&lifetime_str) {
                                    let token = quote! { #lifetime };
                                    if !generics
                                        .iter()
                                        .any(|g| g.to_string() == token.to_string())
                                    {
                                        generics.push(token);
                                    }
                                }
                            }
                            GenericArgument::Const(expr) => {
                                visit_expr_for_generics(expr, user_generics, generics);
                            }
                            _ => {}
                        }
                    }
                }
            }
        }
        Type::Reference(type_ref) => {
            // Check for explicit lifetime in reference
            if let Some(lifetime) = &type_ref.lifetime {
                let lifetime_str = lifetime.ident.to_string();
                if user_generics.contains(&lifetime_str) {
                    let token = quote! { #lifetime };
                    if !generics.iter().any(|g| g.to_string() == token.to_string()) {
                        generics.push(token);
                    }
                }
            }
            visit_type_for_generics(&type_ref.elem, user_generics, generics);
        }
        Type::Ptr(type_ptr) => {
            visit_type_for_generics(&type_ptr.elem, user_generics, generics);
        }
        Type::Array(type_array) => {
            visit_type_for_generics(&type_array.elem, user_generics, generics);
            // Check if the array length uses a const generic
            visit_expr_for_generics(&type_array.len, user_generics, generics);
        }
        Type::Slice(type_slice) => {
            visit_type_for_generics(&type_slice.elem, user_generics, generics);
        }
        Type::Tuple(type_tuple) => {
            for elem in &type_tuple.elems {
                visit_type_for_generics(elem, user_generics, generics);
            }
        }
        Type::Paren(type_paren) => {
            visit_type_for_generics(&type_paren.elem, user_generics, generics);
        }
        _ => {}
    }
}

fn visit_expr_for_generics(
    expr: &Expr,
    user_generics: &[String],
    generics: &mut Vec<TokenStream>,
) {
    match expr {
        Expr::Path(expr_path) => {
            if let Some(ident) = expr_path.path.get_ident() {
                let ident_str = ident.to_string();
                if user_generics.contains(&ident_str) {
                    // Store just the identifier token for const generics
                    let token = quote! { #ident };
                    if !generics.iter().any(|g| g.to_string() == token.to_string()) {
                        generics.push(token);
                    }
                }
            }
        }
        Expr::Binary(binary) => {
            // Handle binary expressions like N + M, N * 2
            visit_expr_for_generics(&binary.left, user_generics, generics);
            visit_expr_for_generics(&binary.right, user_generics, generics);
        }
        Expr::Block(block) => {
            // Handle const blocks like { N * 2 }
            if let Some(syn::Stmt::Expr(expr, _)) = block.block.stmts.last() {
                visit_expr_for_generics(expr, user_generics, generics);
            }
        }
        _ => {
            // For other expression types, we don't extract generics
            // This is conservative but avoids false positives
        }
    }
}

fn generate_type_of_module(info: &StructInfo) -> TokenStream {
    let user_generics: Vec<String> = info
        .generics
        .params
        .iter()
        .map(|param| match param {
            syn::GenericParam::Type(type_param) => type_param.ident.to_string(),
            syn::GenericParam::Lifetime(lifetime_param) => {
                lifetime_param.lifetime.ident.to_string()
            }
            syn::GenericParam::Const(const_param) => const_param.ident.to_string(),
        })
        .collect();

    let field_type_aliases: Vec<_> = info
        .fields
        .iter()
        .map(|field| {
            let field_name = &field.name;
            let field_ty = &field.ty;
            let generics_in_field =
                extract_generic_idents_from_type(field_ty, &user_generics, &info.generics.params);

            if generics_in_field.is_empty() {
                quote! {
                    #[allow(non_camel_case_types)]
                    pub type #field_name = #field_ty;
                }
            } else {
                quote! {
                    #[allow(non_camel_case_types)]
                    pub type #field_name<#(#generics_in_field),*> = #field_ty;
                }
            }
        })
        .collect();

    quote! {
        /// Type aliases for field types.
        pub mod type_of {
            use super::*;

            #(#field_type_aliases)*
        }
    }
}

fn generate_with_modules(field_names: &[&Ident]) -> TokenStream {
    let has_multiple_fields = field_names.len() > 1;

    let all_absent_default: Vec<_> = std::iter::repeat_n(
        quote! { ::structural_typing::presence::Absent },
        field_names.len(),
    )
    .collect();

    let field_type_aliases: Vec<_> = field_names
        .iter()
        .enumerate()
        .map(|(current_idx, field_name)| {
            let field_types: Vec<_> = field_names
                .iter()
                .enumerate()
                .map(|(idx, name)| {
                    if idx == current_idx {
                        quote! { P }
                    } else {
                        quote! { F::#name }
                    }
                })
                .collect();

            if has_multiple_fields {
                quote! {
                    /// Parameterized field presence type alias.
                    #[allow(non_camel_case_types)]
                    pub type #field_name<
                        P: Presence = ::structural_typing::presence::Present,
                        F: Fields = FieldSet<#(#all_absent_default),*>
                    > = FieldSet<#(#field_types),*>;
                }
            } else {
                // Single-field structs don't get F parameter since there are no other fields to spread.
                // Attempting to use nested setters with single-field structs will fail at compile time
                // with "type parameter F is never used" error when the select! macro tries to use
                // with::field<P, F> - this is intentional and documents the limitation clearly.
                quote! {
                    /// Parameterized field presence type alias.
                    #[allow(non_camel_case_types)]
                    pub type #field_name<P: Presence = ::structural_typing::presence::Present> = FieldSet<P>;
                }
            }
        })
        .collect();

    let all_fields: Vec<_> = std::iter::repeat_n(quote! { P }, field_names.len()).collect();

    quote! {
        /// Type aliases for field presence combinations.
        pub mod with {
            use super::*;

            #(#field_type_aliases)*

            /// All fields with the same presence state.
            #[allow(non_camel_case_types)]
            pub type all<P: Presence = ::structural_typing::presence::Present> = FieldSet<#(#all_fields),*>;
        }
    }
}

pub fn generate(info: &StructInfo, serde_helper: Option<TokenStream>) -> TokenStream {
    let module_name = &info.module_name;
    let vis = &info.vis;
    let field_names: Vec<_> = info.fields.iter().map(|f| &f.name).collect();
    let field_types: Vec<_> = info.fields.iter().map(|f| &f.ty).collect();

    let field_type_assocs = generate_fields_trait_parts(&field_names);
    let (fieldset_phantom_types, fieldset_params, fieldset_assocs) =
        generate_fieldset_parts(&field_names);
    let merge_fields = generate_merge_fields(&field_names);
    let remainder_fields = generate_remainder_fields(&field_names, &field_types);
    let type_of_module = generate_type_of_module(info);
    let with_modules = generate_with_modules(&field_names);
    let empty_constructor = generate_empty_constructor(info);

    let remainder_params = if info.generics.params.is_empty() {
        quote! { F1, F2 }
    } else {
        let (lifetimes, others): (Vec<_>, Vec<_>) = info
            .generics
            .params
            .iter()
            .partition(|p| matches!(p, syn::GenericParam::Lifetime(_)));
        quote! { #(#lifetimes,)* F1, F2, #(#others),* }
    };

    let remainder_type = quote! {
        /// Remainder after extracting F2 from F1.
        #[allow(type_alias_bounds)]
        pub type Remainder<#remainder_params> = FieldSet<
            #(#remainder_fields),*
        >;
    };

    let canonical_fields: Vec<_> = field_names.iter().map(|name| quote! { F::#name }).collect();

    let canonical_type = quote! {
        /// Convert a Fields trait bound to its canonical FieldSet representation.
        pub type Canonical<F: Fields> = FieldSet<
            #(#canonical_fields),*
        >;
    };

    quote! {
        #vis mod #module_name {
            use super::*;
            use ::core::marker::PhantomData;
            use ::structural_typing::presence::{Presence, Present, Optional, Absent};

            #serde_helper

            mod sealed {
                pub trait Sealed {}
            }

            /// Trait representing field presence states.
            #[allow(non_camel_case_types)]
            pub trait Fields: sealed::Sealed {
                #(#field_type_assocs)*
            }

            /// Type-level representation of field presence states.
            #[allow(non_camel_case_types)]
            pub struct FieldSet<#(#fieldset_params),*>(
                PhantomData<(#(#fieldset_phantom_types),*)>,
            );

            #[allow(non_camel_case_types)]
            impl<#(#fieldset_params),*> sealed::Sealed for FieldSet<#(#field_names),*> {}

            #[allow(non_camel_case_types)]
            impl<#(#fieldset_params),*> Fields for FieldSet<#(#field_names),*> {
                #(#fieldset_assocs)*
            }

            /// Merge two field sets (F2 takes precedence over F1).
            pub type Merge<F1, F2> = FieldSet<
                #(#merge_fields),*
            >;

            #remainder_type

            #canonical_type

            #type_of_module

            #with_modules

            #empty_constructor
        }
    }
}