brk_traversable_derive 0.2.5

Derive for brk_vec's used in BRK
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
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
use proc_macro::TokenStream;
use quote::quote;
use syn::{Data, DeriveInput, Fields, Type, parse_macro_input};

// ===========================================================================
// Struct & field attribute parsing
// ===========================================================================

#[derive(Default)]
struct StructAttr {
    merge: bool,
    transparent: bool,
    hidden: bool,
    wrap: Option<String>,
}

fn get_struct_attr(attrs: &[syn::Attribute]) -> StructAttr {
    let mut result = StructAttr::default();
    for attr in attrs {
        if !attr.path().is_ident("traversable") {
            continue;
        }

        if let Ok(ident) = attr.parse_args::<syn::Ident>() {
            match ident.to_string().as_str() {
                "merge" => result.merge = true,
                "transparent" => result.transparent = true,
                "hidden" => result.hidden = true,
                _ => {}
            }
            continue;
        }

        if let Ok(meta) = attr.parse_args::<syn::MetaNameValue>()
            && meta.path.is_ident("wrap")
            && let syn::Expr::Lit(syn::ExprLit {
                lit: syn::Lit::Str(lit_str),
                ..
            }) = &meta.value
        {
            result.wrap = Some(lit_str.value());
        }
    }
    result
}

enum FieldAttr {
    Normal,
    Flatten,
}

struct FieldInfo<'a> {
    name: &'a syn::Ident,
    is_option: bool,
    attr: FieldAttr,
    rename: Option<String>,
    wrap: Option<String>,
    hidden: bool,
}

/// Returns None for skip, Some((attr, rename, wrap, hidden)) for normal/flatten/hidden.
fn get_field_attr(field: &syn::Field) -> Option<(FieldAttr, Option<String>, Option<String>, bool)> {
    let mut attr_type = FieldAttr::Normal;
    let mut rename = None;
    let mut wrap = None;
    let mut hidden = false;

    for attr in &field.attrs {
        if !attr.path().is_ident("traversable") {
            continue;
        }

        if let Ok(ident) = attr.parse_args::<syn::Ident>() {
            match ident.to_string().as_str() {
                "skip" => return None,
                "flatten" => attr_type = FieldAttr::Flatten,
                "hidden" => hidden = true,
                _ => {}
            }
            continue;
        }

        if let Ok(metas) = attr.parse_args_with(
            syn::punctuated::Punctuated::<syn::MetaNameValue, syn::Token![,]>::parse_terminated,
        ) {
            for meta in metas {
                if let syn::Expr::Lit(syn::ExprLit {
                    lit: syn::Lit::Str(lit_str),
                    ..
                }) = &meta.value
                {
                    if meta.path.is_ident("rename") {
                        rename = Some(lit_str.value());
                    } else if meta.path.is_ident("wrap") {
                        wrap = Some(lit_str.value());
                    }
                }
            }
        }
    }

    Some((attr_type, rename, wrap, hidden))
}

fn is_field_skipped(field: &syn::Field) -> bool {
    field.attrs.iter().any(|attr| {
        attr.path().is_ident("traversable")
            && attr.parse_args::<syn::Ident>().is_ok_and(|id| id == "skip")
    })
}

// ===========================================================================
// Type helpers
// ===========================================================================

fn is_option_type(ty: &Type) -> bool {
    matches!(
        ty,
        Type::Path(type_path)
        if type_path.path.segments.last()
            .is_some_and(|seg| seg.ident == "Option")
    )
}

fn is_box_type(ty: &Type) -> bool {
    matches!(
        ty,
        Type::Path(type_path)
        if type_path.path.segments.last()
            .is_some_and(|seg| seg.ident == "Box")
    )
}

/// Extract the inner type from `Option<T>`, returning `Some(&T)`.
fn extract_option_inner(ty: &Type) -> Option<&Type> {
    if let Type::Path(type_path) = ty
        && let Some(seg) = type_path.path.segments.last()
        && seg.ident == "Option"
        && let syn::PathArguments::AngleBracketed(args) = &seg.arguments
        && let Some(syn::GenericArgument::Type(inner)) = args.args.first()
    {
        Some(inner)
    } else {
        None
    }
}

/// Check if a type AST references the given identifier anywhere.
fn type_contains_ident(ty: &Type, ident: &syn::Ident) -> bool {
    match ty {
        Type::Path(type_path) => {
            if let Some(qself) = &type_path.qself
                && type_contains_ident(&qself.ty, ident)
            {
                return true;
            }
            type_path.path.segments.iter().any(|seg| {
                if seg.ident == *ident {
                    return true;
                }
                match &seg.arguments {
                    syn::PathArguments::AngleBracketed(args) => args.args.iter().any(|arg| {
                        matches!(arg, syn::GenericArgument::Type(inner) if type_contains_ident(inner, ident))
                    }),
                    syn::PathArguments::Parenthesized(args) => {
                        args.inputs.iter().any(|inner| type_contains_ident(inner, ident))
                            || matches!(&args.output, syn::ReturnType::Type(_, inner) if type_contains_ident(inner, ident))
                    }
                    syn::PathArguments::None => false,
                }
            })
        }
        Type::Reference(r) => type_contains_ident(&r.elem, ident),
        Type::Tuple(t) => t.elems.iter().any(|e| type_contains_ident(e, ident)),
        Type::Array(a) => type_contains_ident(&a.elem, ident),
        Type::Slice(s) => type_contains_ident(&s.elem, ident),
        Type::Paren(p) => type_contains_ident(&p.elem, ident),
        _ => false,
    }
}

/// Find the generic type parameter bounded by `StorageMode`, if any.
fn find_storage_mode_param(generics: &syn::Generics) -> Option<&syn::Ident> {
    generics.type_params().find_map(|p| {
        p.bounds
            .iter()
            .any(|b| {
                matches!(b, syn::TypeParamBound::Trait(t)
                    if t.path.segments.last().is_some_and(|s| s.ident == "StorageMode"))
            })
            .then_some(&p.ident)
    })
}

// ===========================================================================
// Entry point
// ===========================================================================

#[proc_macro_derive(Traversable, attributes(traversable))]
pub fn derive_traversable(input: TokenStream) -> TokenStream {
    let input = parse_macro_input!(input as DeriveInput);

    let mut output = gen_traversable(&input);
    output.extend(gen_read_only_clone(&input));
    TokenStream::from(output)
}

// ===========================================================================
// Traversable generation
// ===========================================================================

fn gen_traversable(input: &DeriveInput) -> proc_macro2::TokenStream {
    let name = &input.ident;
    let generics = &input.generics;
    let (impl_generics, ty_generics, _) = generics.split_for_impl();

    let struct_attr = get_struct_attr(&input.attrs);

    let Data::Struct(data) = &input.data else {
        return syn::Error::new_spanned(
            &input.ident,
            "Traversable can only be derived for structs",
        )
        .to_compile_error();
    };

    // Single-field tuple struct: delegate (automatic transparent).
    if let Fields::Unnamed(fields) = &data.fields
        && fields.unnamed.len() == 1
    {
        let field_ty = &fields.unnamed.first().unwrap().ty;
        let where_clause = build_where_clause(generics, &[], &[field_ty]);
        let to_tree_node_body = if let Some(wrap_key) = &struct_attr.wrap {
            quote! { brk_traversable::TreeNode::wrap(#wrap_key, self.0.to_tree_node()) }
        } else {
            quote! { self.0.to_tree_node() }
        };
        return quote! {
            impl #impl_generics Traversable for #name #ty_generics #where_clause {
                fn to_tree_node(&self) -> brk_traversable::TreeNode {
                    #to_tree_node_body
                }

                fn iter_any_exportable(&self) -> impl Iterator<Item = &dyn vecdb::AnyExportableVec> {
                    self.0.iter_any_exportable()
                }

                fn iter_any_visible(&self) -> impl Iterator<Item = &dyn vecdb::AnyExportableVec> {
                    self.0.iter_any_visible()
                }
            }
        };
    }

    // Named fields required from here.
    let Fields::Named(named_fields) = &data.fields else {
        return quote! {
            impl #impl_generics Traversable for #name #ty_generics {
                fn to_tree_node(&self) -> brk_traversable::TreeNode {
                    brk_traversable::TreeNode::Branch(brk_traversable::IndexMap::new())
                }

                fn iter_any_exportable(&self) -> impl Iterator<Item = &dyn vecdb::AnyExportableVec> {
                    std::iter::empty()
                }
            }
        };
    };

    // Transparent delegation: forward everything to the first field.
    if struct_attr.transparent {
        let first_field = named_fields
            .named
            .first()
            .expect("transparent requires at least one field");
        let field_name = first_field
            .ident
            .as_ref()
            .expect("named field must have ident");
        let field_ty = &first_field.ty;
        let where_clause = build_where_clause(generics, &[], &[field_ty]);
        return quote! {
            impl #impl_generics Traversable for #name #ty_generics #where_clause {
                fn to_tree_node(&self) -> brk_traversable::TreeNode {
                    self.#field_name.to_tree_node()
                }

                fn iter_any_exportable(&self) -> impl Iterator<Item = &dyn vecdb::AnyExportableVec> {
                    self.#field_name.iter_any_exportable()
                }

                fn iter_any_visible(&self) -> impl Iterator<Item = &dyn vecdb::AnyExportableVec> {
                    self.#field_name.iter_any_visible()
                }
            }
        };
    }

    let generic_params: Vec<_> = generics.type_params().map(|p| &p.ident).collect();

    let (field_infos, generics_needing_traversable, field_traversable_types) =
        analyze_fields(named_fields, &generic_params);

    let field_traversals = generate_field_traversals(&field_infos, struct_attr.merge);
    let iterator_impl = generate_iterator_impl(&field_infos, struct_attr.hidden);
    let where_clause = build_where_clause(
        generics,
        &generics_needing_traversable,
        &field_traversable_types,
    );

    let to_tree_node_body = if struct_attr.hidden {
        quote! { brk_traversable::TreeNode::Branch(brk_traversable::IndexMap::new()) }
    } else {
        field_traversals
    };

    quote! {
        impl #impl_generics Traversable for #name #ty_generics #where_clause {
            fn to_tree_node(&self) -> brk_traversable::TreeNode {
                #to_tree_node_body
            }

            #iterator_impl
        }
    }
}

fn analyze_fields<'a>(
    fields: &'a syn::FieldsNamed,
    generic_params: &[&'a syn::Ident],
) -> (Vec<FieldInfo<'a>>, Vec<&'a syn::Ident>, Vec<&'a syn::Type>) {
    let mut field_infos = Vec::new();
    let mut generics_set = std::collections::BTreeSet::new();
    let mut field_traversable_types = Vec::new();

    for field in &fields.named {
        let Some((attr, rename, wrap, hidden)) = get_field_attr(field) else {
            continue;
        };

        if !matches!(field.vis, syn::Visibility::Public(_)) {
            continue;
        }

        let Some(field_name) = &field.ident else {
            continue;
        };

        let is_option = is_option_type(&field.ty);

        if let Type::Path(type_path) = &field.ty
            && type_path.path.segments.len() == 1
            && let Some(seg) = type_path.path.segments.first()
            && seg.arguments.is_empty()
            && let Some(&param) = generic_params.iter().find(|&&g| g == &seg.ident)
        {
            generics_set.insert(param);
        } else {
            let ty = if is_option {
                extract_option_inner(&field.ty).unwrap_or(&field.ty)
            } else {
                &field.ty
            };
            field_traversable_types.push(ty);
        }

        field_infos.push(FieldInfo {
            name: field_name,
            is_option,
            attr,
            rename,
            wrap,
            hidden,
        });
    }

    (
        field_infos,
        generics_set.into_iter().collect(),
        field_traversable_types,
    )
}

fn build_where_clause(
    generics: &syn::Generics,
    generics_needing_traversable: &[&syn::Ident],
    extra_traversable_types: &[&syn::Type],
) -> proc_macro2::TokenStream {
    let generic_params: Vec<_> = generics.type_params().map(|p| &p.ident).collect();
    let original_predicates = generics.where_clause.as_ref().map(|w| &w.predicates);

    if generics_needing_traversable.is_empty()
        && extra_traversable_types.is_empty()
        && generic_params.is_empty()
        && original_predicates.is_none()
    {
        return quote! {};
    }

    quote! {
        where
            #(#generics_needing_traversable: brk_traversable::Traversable,)*
            #(#extra_traversable_types: brk_traversable::Traversable,)*
            #(#generic_params: Send + Sync,)*
            #original_predicates
    }
}

fn generate_field_traversals(infos: &[FieldInfo], merge: bool) -> proc_macro2::TokenStream {
    // Process all fields in declaration order (interleaving normal and flatten)
    // so that struct field order determines tree key order.
    let field_operations: Vec<_> = infos
        .iter()
        .filter(|i| !i.hidden)
        .map(|info| {
            match info.attr {
                FieldAttr::Normal => {
                    let field_name = info.name;
                    let field_name_str = {
                        let s = field_name.to_string();
                        let s = s.strip_prefix("r#").unwrap_or(&s).to_string();
                        s.strip_prefix('_').map(String::from).unwrap_or(s)
                    };

                    // Determine the tree key and optional wrapping path.
                    // wrap = "a/b" means: outer_key = "a", wrap the node under "b" then under the rename/field name.
                    // wrap = "a" means: outer_key = "a", wrap under rename or field name.
                    // No wrap: outer_key = rename or field name, no wrapping.
                    let (outer_key, wrap_path): (String, Vec<&str>) =
                        match (info.wrap.as_deref(), info.rename.as_deref()) {
                            (Some(wrap), Some(rename)) => {
                                let parts: Vec<&str> = wrap.split('/').collect();
                                let outer = parts[0].to_string();
                                let mut path: Vec<&str> = parts[1..].to_vec();
                                path.push(rename);
                                (outer, path)
                            }
                            (Some(wrap), None) => {
                                let parts: Vec<&str> = wrap.split('/').collect();
                                let outer = parts[0].to_string();
                                let mut path: Vec<&str> = parts[1..].to_vec();
                                path.push(&field_name_str);
                                (outer, path)
                            }
                            (None, Some(rename)) => (rename.to_string(), vec![]),
                            (None, None) => (field_name_str.clone(), vec![]),
                        };

                    // Build nested wrapping: wrap(path[last], wrap(path[last-1], ... node))
                    let build_wrapped = |base: proc_macro2::TokenStream| -> proc_macro2::TokenStream {
                        wrap_path.iter().rev().fold(base, |inner, key| {
                            quote! { brk_traversable::TreeNode::wrap(#key, #inner) }
                        })
                    };

                    if info.is_option {
                        let node_expr = build_wrapped(quote! { nested.to_tree_node() });
                        quote! {
                            if let Some(entry) = self.#field_name.as_ref().map(|nested| (String::from(#outer_key), #node_expr)) {
                                brk_traversable::TreeNode::merge_node(&mut collected, entry.0, entry.1)
                                    .expect("Conflicting values for same key");
                            }
                        }
                    } else {
                        let node_expr_self = build_wrapped(quote! { self.#field_name.to_tree_node() });
                        quote! {
                            brk_traversable::TreeNode::merge_node(&mut collected, String::from(#outer_key), #node_expr_self)
                                .expect("Conflicting values for same key");
                        }
                    }
                }
                FieldAttr::Flatten => {
                    let field_name = info.name;
                    let merge_branch = quote! {
                        brk_traversable::TreeNode::Branch(map) => {
                            for (key, node) in map {
                                brk_traversable::TreeNode::merge_node(&mut collected, key, node)
                                    .expect("Conflicting values for same key during flatten");
                            }
                        }
                        leaf @ brk_traversable::TreeNode::Leaf(_) => {
                            brk_traversable::TreeNode::merge_node(&mut collected, String::from(stringify!(#field_name)), leaf)
                                .expect("Conflicting values for same key during flatten");
                        }
                    };

                    if info.is_option {
                        quote! {
                            if let Some(ref nested) = self.#field_name {
                                match nested.to_tree_node() { #merge_branch }
                            }
                        }
                    } else {
                        quote! {
                            match self.#field_name.to_tree_node() { #merge_branch }
                        }
                    }
                }
            }
        })
        .collect();

    let final_expr = if merge {
        quote! { brk_traversable::TreeNode::Branch(collected).merge_branches().unwrap() }
    } else {
        quote! { brk_traversable::TreeNode::Branch(collected) }
    };

    let init_collected = quote! {
        let mut collected: brk_traversable::IndexMap<String, brk_traversable::TreeNode> =
            brk_traversable::IndexMap::new();
    };

    quote! {
        #init_collected
        #(#field_operations)*
        #final_expr
    }
}

fn generate_iter_body(
    fields: &[&syn::Ident],
    option_fields: &[&syn::Ident],
    method: &str,
) -> proc_macro2::TokenStream {
    let method_ident = syn::Ident::new(method, proc_macro2::Span::call_site());

    if fields.is_empty() && option_fields.is_empty() {
        return quote! { std::iter::empty() };
    }

    let (init_part, chain_part) = if let Some((&first, rest)) = fields.split_first() {
        (
            quote! {
                let mut iter: Box<dyn Iterator<Item = &dyn vecdb::AnyExportableVec>> =
                    Box::new(self.#first.#method_ident());
            },
            quote! {
                #(iter = Box::new(iter.chain(self.#rest.#method_ident()));)*
            },
        )
    } else {
        (
            quote! {
                let mut iter: Box<dyn Iterator<Item = &dyn vecdb::AnyExportableVec>> =
                    Box::new(std::iter::empty());
            },
            quote! {},
        )
    };

    let option_part = if !option_fields.is_empty() {
        let chains = option_fields.iter().map(|f| {
            quote! {
                if let Some(ref x) = self.#f {
                    iter = Box::new(iter.chain(x.#method_ident()));
                }
            }
        });
        quote! { #(#chains)* }
    } else {
        quote! {}
    };

    quote! {
        #init_part
        #chain_part
        #option_part
        iter
    }
}

fn generate_iterator_impl(infos: &[FieldInfo], struct_hidden: bool) -> proc_macro2::TokenStream {
    let all_regular: Vec<_> = infos
        .iter()
        .filter(|i| !i.is_option)
        .map(|i| i.name)
        .collect();
    let all_option: Vec<_> = infos
        .iter()
        .filter(|i| i.is_option)
        .map(|i| i.name)
        .collect();

    let exportable_body = generate_iter_body(&all_regular, &all_option, "iter_any_exportable");

    let visible_impl = if struct_hidden {
        // Entire struct is hidden — iter_any_visible returns nothing
        quote! {
            fn iter_any_visible(&self) -> impl Iterator<Item = &dyn vecdb::AnyExportableVec> {
                std::iter::empty()
            }
        }
    } else {
        // Always generate iter_any_visible that calls iter_any_visible on children
        // (skipping hidden fields if any), so hidden propagates through the tree
        let visible_regular: Vec<_> = infos
            .iter()
            .filter(|i| !i.is_option && !i.hidden)
            .map(|i| i.name)
            .collect();
        let visible_option: Vec<_> = infos
            .iter()
            .filter(|i| i.is_option && !i.hidden)
            .map(|i| i.name)
            .collect();
        let visible_body =
            generate_iter_body(&visible_regular, &visible_option, "iter_any_visible");
        quote! {
            fn iter_any_visible(&self) -> impl Iterator<Item = &dyn vecdb::AnyExportableVec> {
                #visible_body
            }
        }
    };

    quote! {
        fn iter_any_exportable(&self) -> impl Iterator<Item = &dyn vecdb::AnyExportableVec> {
            #exportable_body
        }
        #visible_impl
    }
}

// ===========================================================================
// ReadOnlyClone generation
// ===========================================================================

/// Generate `ReadOnlyClone` for Traversable-derived types.
///
/// Three paths:
/// 1. `M: StorageMode` → concrete impl mapping `Self<Rw>` → `Self<Ro>`.
/// 2. Generic container params → propagates `ReadOnlyClone` through each param.
/// 3. No container params → nothing generated.
///
/// Container params are: unbounded type params, OR bounded params that appear
/// as a bare field type (e.g. `field: M` where M is the param itself).
fn gen_read_only_clone(input: &DeriveInput) -> proc_macro2::TokenStream {
    let generics = &input.generics;
    let name = &input.ident;

    let Data::Struct(data) = &input.data else {
        return quote! {};
    };

    // Path 1: StorageMode param → Rw/Ro substitution.
    if let Some(mode_param) = find_storage_mode_param(generics) {
        return gen_read_only_clone_storage_mode(name, generics, data, mode_param);
    }

    // Path 2/3: classify type params as containers or leaves.
    let type_params: Vec<&syn::TypeParam> = generics
        .params
        .iter()
        .filter_map(|p| match p {
            syn::GenericParam::Type(tp) => Some(tp),
            _ => None,
        })
        .collect();

    if type_params.is_empty() {
        return quote! {};
    }

    let is_bounded = |tp: &syn::TypeParam| -> bool {
        if !tp.bounds.is_empty() {
            return true;
        }
        if let Some(wc) = &generics.where_clause {
            return wc.predicates.iter().any(|pred| {
                matches!(pred, syn::WherePredicate::Type(pt)
                    if matches!(&pt.bounded_ty, Type::Path(p)
                        if p.path.segments.first().is_some_and(|s| s.ident == tp.ident)))
            });
        }
        false
    };

    let bare_field_params = find_bare_field_params(data, &type_params);

    let container_params: Vec<&syn::Ident> = type_params
        .iter()
        .filter(|tp| !is_bounded(tp) || bare_field_params.contains(&&tp.ident))
        .map(|tp| &tp.ident)
        .collect();

    if container_params.is_empty() {
        return quote! {};
    }

    gen_read_only_clone_generics(name, generics, data, &type_params, &container_params)
}

/// Find type params used as bare (direct) field types in non-skipped fields.
fn find_bare_field_params<'a>(
    data: &syn::DataStruct,
    type_params: &[&'a syn::TypeParam],
) -> Vec<&'a syn::Ident> {
    let fields: &syn::punctuated::Punctuated<syn::Field, _> = match &data.fields {
        Fields::Named(named) => &named.named,
        Fields::Unnamed(unnamed) => &unnamed.unnamed,
        Fields::Unit => return Vec::new(),
    };

    let mut bare = Vec::new();
    for field in fields {
        if is_field_skipped(field) {
            continue;
        }
        if let Type::Path(type_path) = &field.ty
            && type_path.path.segments.len() == 1
            && let Some(seg) = type_path.path.segments.first()
            && seg.arguments.is_empty()
            && let Some(tp) = type_params.iter().find(|tp| tp.ident == seg.ident)
        {
            bare.push(&tp.ident);
        }
    }
    bare
}

// ---------------------------------------------------------------------------
// Shared field-conversion helpers
// ---------------------------------------------------------------------------

/// Generate the value expression for a single field in a ReadOnlyClone impl.
///
/// - Skipped + Option → `None`
/// - Skipped + non-Option → `Default::default()`
/// - Contains relevant param + Box → `Box::new(read_only_clone(&*self.field))`
/// - Contains relevant param → `read_only_clone(&self.field)`
/// - Otherwise → `self.field.clone()`
fn gen_roc_field_value(
    field: &syn::Field,
    self_access: proc_macro2::TokenStream,
    is_relevant: impl Fn(&Type) -> bool,
) -> proc_macro2::TokenStream {
    if is_field_skipped(field) {
        if is_option_type(&field.ty) {
            return quote! { None };
        }
        return quote! { #self_access.clone() };
    }

    if is_relevant(&field.ty) {
        if is_box_type(&field.ty) {
            quote! { Box::new(vecdb::ReadOnlyClone::read_only_clone(&*#self_access)) }
        } else {
            quote! { vecdb::ReadOnlyClone::read_only_clone(&#self_access) }
        }
    } else {
        quote! { #self_access.clone() }
    }
}

/// Generate the struct body for a ReadOnlyClone impl.
fn gen_roc_body(
    name: &syn::Ident,
    data: &syn::DataStruct,
    is_relevant: impl Fn(&Type) -> bool,
) -> proc_macro2::TokenStream {
    match &data.fields {
        Fields::Named(named) => {
            let conversions: Vec<_> = named
                .named
                .iter()
                .map(|f| {
                    let field_name = f.ident.as_ref().unwrap();
                    let value = gen_roc_field_value(f, quote! { self.#field_name }, &is_relevant);
                    quote! { #field_name: #value }
                })
                .collect();
            quote! { #name { #(#conversions,)* } }
        }
        Fields::Unnamed(unnamed) => {
            let conversions: Vec<_> = unnamed
                .unnamed
                .iter()
                .enumerate()
                .map(|(i, f)| {
                    let idx = syn::Index::from(i);
                    gen_roc_field_value(f, quote! { self.#idx }, &is_relevant)
                })
                .collect();
            quote! { #name(#(#conversions,)*) }
        }
        Fields::Unit => quote! { #name },
    }
}

/// Collect type args from generics, applying a mapping function to each.
fn collect_ty_args(
    generics: &syn::Generics,
    map_type: impl Fn(&syn::TypeParam) -> proc_macro2::TokenStream,
) -> Vec<proc_macro2::TokenStream> {
    generics
        .params
        .iter()
        .map(|p| match p {
            syn::GenericParam::Type(tp) => map_type(tp),
            syn::GenericParam::Lifetime(lt) => {
                let lt = &lt.lifetime;
                quote! { #lt }
            }
            syn::GenericParam::Const(c) => {
                let id = &c.ident;
                quote! { #id }
            }
        })
        .collect()
}

// ---------------------------------------------------------------------------
// Path 1: StorageMode → Rw/Ro substitution
// ---------------------------------------------------------------------------

fn gen_read_only_clone_storage_mode(
    name: &syn::Ident,
    generics: &syn::Generics,
    data: &syn::DataStruct,
    mode_param: &syn::Ident,
) -> proc_macro2::TokenStream {
    let impl_params: Vec<proc_macro2::TokenStream> = generics
        .params
        .iter()
        .filter_map(|p| match p {
            syn::GenericParam::Type(tp) if tp.ident == *mode_param => None,
            syn::GenericParam::Type(tp) => {
                let ident = &tp.ident;
                let bounds = &tp.bounds;
                if bounds.is_empty() {
                    Some(quote! { #ident })
                } else {
                    Some(quote! { #ident: #bounds })
                }
            }
            syn::GenericParam::Lifetime(lt) => Some(quote! { #lt }),
            syn::GenericParam::Const(c) => {
                let ident = &c.ident;
                let ty = &c.ty;
                Some(quote! { const #ident: #ty })
            }
        })
        .collect();

    let make_ty_args = |replacement: proc_macro2::TokenStream| {
        collect_ty_args(generics, |tp| {
            if tp.ident == *mode_param {
                replacement.clone()
            } else {
                let id = &tp.ident;
                quote! { #id }
            }
        })
    };

    let ty_args_rw = make_ty_args(quote! { vecdb::Rw });
    let ty_args_ro = make_ty_args(quote! { vecdb::Ro });
    let where_clause = &generics.where_clause;

    let body = gen_roc_body(name, data, |ty| type_contains_ident(ty, mode_param));

    let impl_generics = if impl_params.is_empty() {
        quote! {}
    } else {
        quote! { <#(#impl_params),*> }
    };

    quote! {
        impl #impl_generics vecdb::ReadOnlyClone for #name<#(#ty_args_rw),*> #where_clause {
            type ReadOnly = #name<#(#ty_args_ro),*>;

            fn read_only_clone(&self) -> Self::ReadOnly {
                #body
            }
        }
    }
}

// ---------------------------------------------------------------------------
// Path 2: Generic container params → ReadOnlyClone propagation
// ---------------------------------------------------------------------------

fn gen_read_only_clone_generics(
    name: &syn::Ident,
    generics: &syn::Generics,
    data: &syn::DataStruct,
    type_params: &[&syn::TypeParam],
    container_params: &[&syn::Ident],
) -> proc_macro2::TokenStream {
    // Check if any non-skipped field actually uses a container param.
    let has_container_field = match &data.fields {
        Fields::Named(named) => named.named.iter().any(|f| {
            !is_field_skipped(f)
                && container_params
                    .iter()
                    .any(|tp| type_contains_ident(&f.ty, tp))
        }),
        Fields::Unnamed(unnamed) => unnamed.unnamed.iter().any(|f| {
            !is_field_skipped(f)
                && container_params
                    .iter()
                    .any(|tp| type_contains_ident(&f.ty, tp))
        }),
        Fields::Unit => false,
    };

    if !has_container_field {
        return quote! {};
    }

    let is_container = |ident: &syn::Ident| container_params.contains(&ident);

    // Impl params: containers get ReadOnlyClone (+ original bounds), others keep their bounds.
    let impl_params: Vec<proc_macro2::TokenStream> = generics
        .params
        .iter()
        .map(|p| match p {
            syn::GenericParam::Type(tp) => {
                let ident = &tp.ident;
                let bounds = &tp.bounds;
                if is_container(ident) {
                    if bounds.is_empty() {
                        quote! { #ident: vecdb::ReadOnlyClone }
                    } else {
                        quote! { #ident: #bounds + vecdb::ReadOnlyClone }
                    }
                } else if bounds.is_empty() {
                    quote! { #ident }
                } else {
                    quote! { #ident: #bounds }
                }
            }
            syn::GenericParam::Lifetime(lt) => quote! { #lt },
            syn::GenericParam::Const(c) => {
                let ident = &c.ident;
                let ty = &c.ty;
                quote! { const #ident: #ty }
            }
        })
        .collect();

    let self_ty_args = collect_ty_args(generics, |tp| {
        let id = &tp.ident;
        quote! { #id }
    });

    let ro_ty_args = collect_ty_args(generics, |tp| {
        let id = &tp.ident;
        if is_container(id) {
            quote! { <#id as vecdb::ReadOnlyClone>::ReadOnly }
        } else {
            quote! { #id }
        }
    });

    // Where clause: propagate bounds from bounded container params to their ReadOnly.
    let mut extra_where: Vec<proc_macro2::TokenStream> = Vec::new();

    for tp in type_params {
        if is_container(&tp.ident) && !tp.bounds.is_empty() {
            let ident = &tp.ident;
            let bounds = &tp.bounds;
            extra_where.push(quote! {
                <#ident as vecdb::ReadOnlyClone>::ReadOnly: #bounds
            });
        }
    }

    if let Some(wc) = &generics.where_clause {
        for pred in &wc.predicates {
            if let syn::WherePredicate::Type(pt) = pred
                && let Type::Path(tp) = &pt.bounded_ty
                && let Some(seg) = tp.path.segments.first()
                && container_params.iter().any(|cp| **cp == seg.ident)
            {
                let ident = &seg.ident;
                let bounds = &pt.bounds;
                extra_where.push(quote! {
                    <#ident as vecdb::ReadOnlyClone>::ReadOnly: #bounds
                });
            }
        }
    }

    let original_predicates = generics.where_clause.as_ref().map(|w| &w.predicates);
    let combined_where = if extra_where.is_empty() && original_predicates.is_none() {
        quote! {}
    } else {
        quote! { where #(#extra_where,)* #original_predicates }
    };

    let body = gen_roc_body(name, data, |ty| {
        container_params
            .iter()
            .any(|tp| type_contains_ident(ty, tp))
    });

    quote! {
        impl<#(#impl_params),*> vecdb::ReadOnlyClone for #name<#(#self_ty_args),*> #combined_where {
            type ReadOnly = #name<#(#ro_ty_args),*>;

            fn read_only_clone(&self) -> Self::ReadOnly {
                #body
            }
        }
    }
}