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
use std::collections::HashMap;
use proc_macro::TokenStream;
use quote::{format_ident, quote};
use syn::{DeriveInput, Fields, Variant};
use crate::utils::{
cbor_map, cbor_text, cbor_to_iter, default_gen_bounds, is_valid_method_name, make_method_ident,
pascal_to_snake, tuple_schema,
};
/// Extract all field types from a variant.
fn variant_field_types(variant: &Variant) -> Vec<&syn::Type> {
variant.fields.iter().map(|f| &f.ty).collect()
}
/// Derive Generator for an enum.
pub(crate) fn derive_enum_generator(input: &DeriveInput, data: &syn::DataEnum) -> TokenStream {
let enum_name = &input.ident;
let generator_name = format_ident!("{}Generator", enum_name);
let variants: Vec<_> = data.variants.iter().collect();
let data_variants: Vec<_> = variants
.iter()
.filter(|v| !matches!(v.fields, Fields::Unit))
.collect();
// Compute method names for each data variant.
//
// 1. Snake-case the variant's identifier (preserving any `r#` raw prefix
// that syn carries through in `to_string()`).
// 2. If the result would not be a valid Rust method-name token, append `_`.
// 3. If two variants now share a method name, fall back to the original
// identifier for all colliding members.
let field_names: Vec<syn::Ident> = {
let method_strs: Vec<String> = data_variants
.iter()
.map(|v| {
let snake = pascal_to_snake(&v.ident.to_string());
if is_valid_method_name(&snake) {
snake
} else {
format!("{}_", snake)
}
})
.collect();
let mut counts: HashMap<&str, usize> = HashMap::new();
for name in &method_strs {
*counts.entry(name.as_str()).or_insert(0) += 1;
}
data_variants
.iter()
.zip(method_strs.iter())
.map(|(v, name)| {
if counts[name.as_str()] > 1 {
v.ident.clone()
} else {
make_method_ident(name, v.ident.span())
}
})
.collect()
};
// Generate variant generator structs for data variants
let variant_generators: Vec<_> = data_variants
.iter()
.map(|variant| generate_variant_generator(enum_name, variant))
.collect();
// Generate field definitions for the main generator struct
let generator_fields: Vec<_> = field_names
.iter()
.map(|field_name| {
quote! {
pub #field_name: hegel::generators::BoxedGenerator<'a, #enum_name>
}
})
.collect();
// Generate new() field initializations (call variant generator directly)
let new_field_inits: Vec<_> = data_variants
.iter()
.zip(field_names.iter())
.map(|(variant, field_name)| {
let variant_name = &variant.ident;
let variant_generator_name = format_ident!("{}{}Generator", enum_name, variant_name);
quote! {
#field_name: #variant_generator_name::new().boxed()
}
})
.collect();
// Generator DefaultGenerate bounds for new()
let default_bounds: Vec<_> = data_variants
.iter()
.flat_map(|variant| default_gen_bounds(&variant_field_types(variant), quote! { 'a }))
.collect();
// builder methods
let with_methods: Vec<_> = data_variants
.iter()
.zip(field_names.iter())
.map(|(variant, field_name)| {
let variant_name = &variant.ident;
let variant_generator_name = format_ident!("{}{}Generator", enum_name, variant_name);
match &variant.fields {
Fields::Unit => unreachable!(),
Fields::Named(_) => {
let field_types = variant_field_types(variant);
let bounds = default_gen_bounds(&field_types, quote! { 'a });
quote! {
/// Set a custom generator for the #variant_name variant.
pub fn #field_name<F, G>(mut self, configure: F) -> Self
where
F: FnOnce(#variant_generator_name<'a>) -> G,
G: hegel::generators::Generator<#enum_name> + Send + Sync + 'a,
#(#bounds,)*
{
self.#field_name = configure(#variant_generator_name::new()).boxed();
self
}
}
}
Fields::Unnamed(_) => {
let field_types = variant_field_types(variant);
let gen_type_params: Vec<_> = (0..field_types.len())
.map(|i| format_ident!("G{}", i))
.collect();
let gen_param_names: Vec<_> = (0..field_types.len())
.map(|i| format_ident!("gen_{}", i))
.collect();
let field_indices: Vec<_> = (0..field_types.len())
.map(|i| format_ident!("_{}", i))
.collect();
let bounds: Vec<_> = gen_type_params
.iter()
.zip(field_types.iter())
.map(|(gtp, ft)| {
quote! {
#gtp: hegel::generators::Generator<#ft> + Send + Sync + 'a
}
})
.collect();
// Emit a `<name>_with` method for tuple variants.
// Takes a closure receiving the default variant generator
// and returning any generator for #enum_name.
let with_method_name = format_ident!("{}_with", field_name);
let with_bounds = default_gen_bounds(&field_types, quote! { 'a });
let with_method = quote! {
/// Configure the #variant_name variant via a closure.
///
/// The closure receives the default variant generator and
/// must return any generator producing #enum_name.
pub fn #with_method_name<F, G>(mut self, configure: F) -> Self
where
F: FnOnce(#variant_generator_name<'a>) -> G,
G: hegel::generators::Generator<#enum_name> + Send + Sync + 'a,
#(#with_bounds,)*
{
self.#field_name = configure(#variant_generator_name::new()).boxed();
self
}
};
quote! {
/// Set custom generators for the #variant_name variant.
pub fn #field_name<#(#gen_type_params),*>(
mut self,
#(#gen_param_names: #gen_type_params),*
) -> Self
where
#(#bounds,)*
{
self.#field_name = #variant_generator_name {
#(#field_indices: #gen_param_names.boxed(),)*
}.boxed();
self
}
#with_method
}
}
}
})
.collect();
// Build a `0..=N-1` integer schema for variant selection. This mirrors how
// `gs::sampled_from` lowers to an integer-index schema.
let max_variant_idx = variants.len() - 1;
let variant_index_schema = cbor_map(vec![
(cbor_text("type"), cbor_text("integer")),
(
cbor_text("min_value"),
quote! { hegel::ciborium::Value::Integer(hegel::ciborium::value::Integer::from(0u64)) },
),
(
cbor_text("max_value"),
quote! { hegel::ciborium::Value::Integer(hegel::ciborium::value::Integer::from(#max_variant_idx as u64)) },
),
]);
// Map from data variant name to its field ident
let variant_to_field: HashMap<String, &syn::Ident> = data_variants
.iter()
.zip(field_names.iter())
.map(|(v, f)| (v.ident.to_string(), f))
.collect();
// Generate match arms for generate() compositional fallback, keyed by
// declaration index.
let generate_match_arms: Vec<_> = variants
.iter()
.enumerate()
.map(|(i, variant)| {
let variant_name = &variant.ident;
match &variant.fields {
Fields::Unit => quote! { #i => #enum_name::#variant_name },
_ => {
let field_name = variant_to_field[&variant.ident.to_string()];
quote! { #i => self.#field_name.do_draw(__tc) }
}
}
})
.collect();
let generator_struct = quote! {
/// Generated generator for #enum_name.
pub struct #generator_name<'a> {
#(#generator_fields,)*
_phantom: std::marker::PhantomData<&'a ()>,
}
impl<'a> #generator_name<'a> {
/// Create a new generator with default generators for all variants.
pub fn new() -> Self
where
#(#default_bounds,)*
{
Self {
#(#new_field_inits,)*
_phantom: std::marker::PhantomData,
}
}
#(#with_methods)*
}
impl<'a> Default for #generator_name<'a>
where
#(#default_bounds,)*
{
fn default() -> Self {
Self::new()
}
}
};
// Unit variant match arms keyed by declaration index for the all-unit
// `as_basic` parse closure. Equivalent to `generate_match_arms` here
// (every variant is unit) but kept separate for clarity.
let unit_variant_match_arms: Vec<proc_macro2::TokenStream> = variants
.iter()
.enumerate()
.map(|(i, variant)| {
let variant_name = &variant.ident;
quote! { #i => #enum_name::#variant_name }
})
.collect();
let generate_trait_impl = if data_variants.is_empty() {
// All-unit enum: pick a variant by integer index.
quote! {
impl<'a> hegel::generators::Generator<#enum_name> for #generator_name<'a> {
fn do_draw(&self, __tc: &hegel::TestCase) -> #enum_name {
let basic = self.as_basic().unwrap();
basic.parse_raw(hegel::generate_raw(__tc, basic.schema()))
}
fn as_basic(&self) -> Option<hegel::generators::BasicGenerator<'_, #enum_name>> {
let schema = #variant_index_schema;
Some(hegel::generators::BasicGenerator::new(schema, |raw| {
let index: usize = hegel::generators::deserialize_value(raw);
match index {
#(#unit_variant_match_arms,)*
_ => unreachable!("Unknown variant index: {}", index),
}
}))
}
}
}
} else {
// Mixed enum: try schema-based, fall back to compositional.
//
// Schema is `{"type": "one_of", "generators": [s_0, s_1, ...]}` with one
// child per variant in declaration order. The server's response is
// `[index, value]` where `index` selects the variant; for unit variants
// the corresponding child schema is `{"type": "constant", "value": null}`
// and the value is discarded, for data variants it's the variant
// generator's schema.
// Bind data variant basic generators (must succeed for all data variants).
let data_variant_basic_bindings: Vec<proc_macro2::TokenStream> = field_names
.iter()
.map(|field_name| {
let basic_name = format_ident!("basic_{}", field_name);
quote! {
let #basic_name = self.#field_name.as_basic()?;
}
})
.collect();
// Build schema entries and parse arms in declaration order so the wire
// index matches the variant order.
let null_schema = cbor_map(vec![
(cbor_text("type"), cbor_text("constant")),
(cbor_text("value"), quote! { hegel::ciborium::Value::Null }),
]);
let one_of_schema_entries: Vec<proc_macro2::TokenStream> = variants
.iter()
.map(|variant| match &variant.fields {
Fields::Unit => null_schema.clone(),
_ => {
let field_name = variant_to_field[&variant.ident.to_string()];
let basic_name = format_ident!("basic_{}", field_name);
quote! { #basic_name.schema().clone() }
}
})
.collect();
let parse_arms: Vec<proc_macro2::TokenStream> = variants
.iter()
.enumerate()
.map(|(i, variant)| {
let variant_name = &variant.ident;
match &variant.fields {
Fields::Unit => quote! { #i => #enum_name::#variant_name },
_ => {
let field_name = variant_to_field[&variant.ident.to_string()];
let basic_name = format_ident!("basic_{}", field_name);
quote! { #i => #basic_name.parse_raw(value) }
}
}
})
.collect();
quote! {
impl<'a> hegel::generators::Generator<#enum_name> for #generator_name<'a> {
fn do_draw(&self, __tc: &hegel::TestCase) -> #enum_name {
if let Some(basic) = self.as_basic() {
basic.parse_raw(hegel::generate_raw(__tc, basic.schema()))
} else {
__tc.start_span(hegel::generators::labels::ENUM_VARIANT);
let index: usize = hegel::generate_from_schema(__tc,
&#variant_index_schema
);
let __result = match index {
#(#generate_match_arms,)*
_ => unreachable!("Unknown variant index: {}", index),
};
__tc.stop_span(false);
__result
}
}
fn as_basic(&self) -> Option<hegel::generators::BasicGenerator<'_, #enum_name>> {
#(#data_variant_basic_bindings)*
let one_of_schemas: Vec<hegel::ciborium::Value> = vec![
#(#one_of_schema_entries,)*
];
let schema = hegel::ciborium::Value::Map(vec![
(
hegel::ciborium::Value::Text("type".to_string()),
hegel::ciborium::Value::Text("one_of".to_string()),
),
(
hegel::ciborium::Value::Text("generators".to_string()),
hegel::ciborium::Value::Array(one_of_schemas),
),
]);
Some(hegel::generators::BasicGenerator::new(schema, move |raw| {
// The server returns `[index, value]` for one_of schemas.
let [idx, value]: [hegel::ciborium::Value; 2] =
raw.into_array().unwrap().try_into().unwrap();
let index = i128::from(idx.into_integer().unwrap()) as usize;
match index {
#(#parse_arms,)*
_ => panic!("Unknown variant index: {}", index),
}
}))
}
}
}
};
let default_generator_bounds: Vec<_> = data_variants
.iter()
.flat_map(|variant| default_gen_bounds(&variant_field_types(variant), quote! { 'static }))
.collect();
let default_generator_impl = quote! {
impl hegel::generators::DefaultGenerator for #enum_name
where
#(#default_generator_bounds,)*
{
type Generator = #generator_name<'static>;
fn default_generator() -> Self::Generator {
#generator_name::new()
}
}
};
let expanded = quote! {
// if a user has non-camel-case types that conflict, we will generate warning-emitting variable and type
// names here. We want to suppress these warnings, because the user already had to suppress these same warnings
// when they constructed their type, and they have no way to reach down into this block to locally-suppress them
// and would have to suppress on their entire module, which is onerous.
#[allow(non_camel_case_types, non_snake_case)]
const _: () = {
use hegel::generators::Generator as _;
#(#variant_generators)*
#generator_struct
#generate_trait_impl
#default_generator_impl
};
};
TokenStream::from(expanded)
}
/// Generate a variant generator struct for a data variant.
fn generate_variant_generator(
enum_name: &syn::Ident,
variant: &Variant,
) -> proc_macro2::TokenStream {
let variant_name = &variant.ident;
let variant_generator_name = format_ident!("{}{}Generator", enum_name, variant_name);
match &variant.fields {
Fields::Unit => {
// Unit variants don't get their own generator
quote! {}
}
Fields::Named(fields) => {
let field_names: Vec<_> = fields
.named
.iter()
.map(|f| f.ident.as_ref().unwrap())
.collect();
let field_types: Vec<_> = fields.named.iter().map(|f| &f.ty).collect();
// Generate field builder methods (same name as field, no prefix)
let builder_methods: Vec<_> = field_names
.iter()
.zip(field_types.iter())
.map(|(field_name, field_type)| {
quote! {
/// Set a custom generator for this field.
pub fn #field_name<G>(mut self, generator: G) -> Self
where
G: hegel::generators::Generator<#field_type> + Send + Sync + 'a,
{
self.#field_name = generator.boxed();
self
}
}
})
.collect();
// Generate field definitions
let generator_fields: Vec<_> = field_names
.iter()
.zip(field_types.iter())
.map(|(field_name, field_type)| {
quote! { #field_name: hegel::generators::BoxedGenerator<'a, #field_type> }
})
.collect();
// Generate new() initializers
let new_inits: Vec<_> = field_names
.iter()
.zip(field_types.iter())
.map(|(field_name, field_type)| {
quote! {
#field_name: <#field_type as hegel::generators::DefaultGenerator>::default_generator().boxed()
}
})
.collect();
// Generator Default bounds
let default_bounds = default_gen_bounds(&field_types, quote! { 'a });
// Generate field construction in generate()
let field_constructions: Vec<_> = field_names
.iter()
.map(|field_name| {
quote! { #field_name: self.#field_name.do_draw(__tc) }
})
.collect();
// Basic bindings
let basic_bindings: Vec<proc_macro2::TokenStream> = field_names
.iter()
.map(|name| {
let basic_name = format_ident!("basic_{}", name);
quote! { let #basic_name = self.#name.as_basic()?; }
})
.collect();
// Schema elements (positional, in field order)
let schema_elements: Vec<_> = field_names
.iter()
.map(|name| {
let basic_name = format_ident!("basic_{}", name);
quote! { #basic_name.schema().clone() }
})
.collect();
let schema_ts = tuple_schema(schema_elements);
let parse_iter_ts =
cbor_to_iter("iter", quote! { raw }, "Expected tuple for variant fields");
// parse closure field extractions (positional from tuple)
let field_parse_in_closure: Vec<proc_macro2::TokenStream> = field_names
.iter()
.map(|name| {
let basic_name = format_ident!("basic_{}", name);
quote! {
let #name = #basic_name.parse_raw(
iter.next().unwrap_or_else(|| panic!("Missing element in tuple"))
);
}
})
.collect();
quote! {
/// Generated generator for the #variant_name variant of #enum_name.
pub struct #variant_generator_name<'a> {
#(#generator_fields,)*
}
impl<'a> #variant_generator_name<'a> {
/// Create a new generator with default generators for all fields.
pub fn new() -> Self
where
#(#default_bounds,)*
{
Self {
#(#new_inits,)*
}
}
#(#builder_methods)*
}
impl<'a> Default for #variant_generator_name<'a>
where
#(#default_bounds,)*
{
fn default() -> Self {
Self::new()
}
}
impl<'a> hegel::generators::Generator<#enum_name> for #variant_generator_name<'a> {
fn do_draw(&self, __tc: &hegel::TestCase) -> #enum_name {
if let Some(basic) = self.as_basic() {
basic.parse_raw(hegel::generate_raw(__tc, basic.schema()))
} else {
#enum_name::#variant_name {
#(#field_constructions,)*
}
}
}
fn as_basic(&self) -> Option<hegel::generators::BasicGenerator<'_, #enum_name>> {
#(#basic_bindings)*
let schema = #schema_ts;
Some(hegel::generators::BasicGenerator::new(schema, move |raw| {
#parse_iter_ts
#(#field_parse_in_closure)*
#enum_name::#variant_name {
#(#field_names,)*
}
}))
}
}
}
}
Fields::Unnamed(fields) => {
let field_types: Vec<_> = fields.unnamed.iter().map(|f| &f.ty).collect();
// Generate field names _0, _1, _2, etc.
let field_indices: Vec<_> = (0..field_types.len())
.map(|i| format_ident!("_{}", i))
.collect();
let generator_fields: Vec<_> = field_indices
.iter()
.zip(field_types.iter())
.map(|(field_idx, field_type)| {
quote! { #field_idx: hegel::generators::BoxedGenerator<'a, #field_type> }
})
.collect();
let new_inits: Vec<_> = field_indices
.iter()
.zip(field_types.iter())
.map(|(field_idx, field_type)| {
quote! {
#field_idx: <#field_type as hegel::generators::DefaultGenerator>::default_generator().boxed()
}
})
.collect();
let default_bounds = default_gen_bounds(&field_types, quote! { 'a });
// Per-field builder methods on the variant generator (`g._0(gen)`,
// `g._1(gen)`, etc.). Reachable via the `<name>_with` closure:
// `.read_write_with(|g| g._0(gen0))`.
let builder_methods: Vec<_> = field_indices
.iter()
.zip(field_types.iter())
.map(|(field_idx, field_type)| {
quote! {
/// Set a custom generator for this field.
pub fn #field_idx<G>(mut self, generator: G) -> Self
where
G: hegel::generators::Generator<#field_type> + Send + Sync + 'a,
{
self.#field_idx = generator.boxed();
self
}
}
})
.collect();
let field_generates: Vec<_> = field_indices
.iter()
.map(|field_idx| {
quote! { self.#field_idx.do_draw(__tc) }
})
.collect();
// Basic bindings for tuple fields
let basic_bindings: Vec<proc_macro2::TokenStream> = field_indices
.iter()
.map(|idx| {
let basic_name = format_ident!("basic{}", idx);
quote! { let #basic_name = self.#idx.as_basic()?; }
})
.collect();
let schema_elements: Vec<proc_macro2::TokenStream> = field_indices
.iter()
.map(|idx| {
let basic_name = format_ident!("basic{}", idx);
quote! { #basic_name.schema().clone() }
})
.collect();
// parse closure extractions
let parse_raw_extractions: Vec<proc_macro2::TokenStream> = field_indices
.iter()
.map(|idx| {
let basic_name = format_ident!("basic{}", idx);
quote! {
let #idx = #basic_name.parse_raw(
iter.next().unwrap_or_else(|| panic!("Tuple variant missing element"))
);
}
})
.collect();
let schema_ts = tuple_schema(schema_elements);
let parse_iter_ts =
cbor_to_iter("iter", quote! { raw }, "Expected tuple for variant fields");
quote! {
/// Generated generator for the #variant_name variant of #enum_name.
pub struct #variant_generator_name<'a> {
#(#generator_fields,)*
}
impl<'a> #variant_generator_name<'a> {
/// Create a new generator with default generators for all fields.
pub fn new() -> Self
where
#(#default_bounds,)*
{
Self {
#(#new_inits,)*
}
}
#(#builder_methods)*
}
impl<'a> Default for #variant_generator_name<'a>
where
#(#default_bounds,)*
{
fn default() -> Self {
Self::new()
}
}
impl<'a> hegel::generators::Generator<#enum_name> for #variant_generator_name<'a> {
fn do_draw(&self, __tc: &hegel::TestCase) -> #enum_name {
if let Some(basic) = self.as_basic() {
basic.parse_raw(hegel::generate_raw(__tc, basic.schema()))
} else {
#enum_name::#variant_name(#(#field_generates,)*)
}
}
fn as_basic(&self) -> Option<hegel::generators::BasicGenerator<'_, #enum_name>> {
#(#basic_bindings)*
let schema = #schema_ts;
Some(hegel::generators::BasicGenerator::new(schema, move |raw| {
#parse_iter_ts
#(#parse_raw_extractions)*
#enum_name::#variant_name(#(#field_indices,)*)
}))
}
}
}
}
}
}