macro_tools 0.85.0

Tools for writing procedural macroses.
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
//!
//! Tests for new generic parameter utilities in `macro_tools`
//!

use macro_tools ::generic_params :: *;
use quote ::quote;
use syn ::parse_quote;

// Test Matrix for classify_generics
// | ID    | Input                                      | Expected Classification                           |
// |-------|--------------------------------------------|-------------------------------------------------|
// | C1.1  | Empty generics                             | is_empty: true, all others false                |
// | C1.2  | Only lifetimes: < 'a >                       | has_only_lifetimes: true                        |
// | C1.3  | Only lifetimes: < 'a, 'b, 'c >               | has_only_lifetimes: true                        |
// | C1.4  | Only types: < T >                            | has_only_types: true                            |
// | C1.5  | Only types: < T, U, V >                      | has_only_types: true                            |
// | C1.6  | Only consts: < const N: usize >              | has_only_consts: true                           |
// | C1.7  | Only consts: < const N: usize, const M: i32 >| has_only_consts: true                           |
// | C1.8  | Mixed: < 'a, T >                             | has_mixed: true                                 |
// | C1.9  | Mixed: < T, const N: usize >                 | has_mixed: true                                 |
// | C1.10 | Mixed: < 'a, T, const N: usize >             | has_mixed: true                                 |

#[ test ]
fn test_classify_generics_empty() 
{
  let generics: syn ::Generics = parse_quote! {};
  let classification = classify_generics(&generics);
  
  assert!(classification.is_empty);
  assert!(!classification.has_only_lifetimes);
  assert!(!classification.has_only_types);
  assert!(!classification.has_only_consts);
  assert!(!classification.has_mixed);
  assert_eq!(classification.lifetimes.len(), 0);
  assert_eq!(classification.types.len(), 0);
  assert_eq!(classification.consts.len(), 0);
}

#[ test ]
fn test_classify_generics_only_lifetimes() 
{
  // Single lifetime
  let generics: syn ::Generics = parse_quote! { < 'a > };
  let classification = classify_generics(&generics);
  
  assert!(!classification.is_empty);
  assert!(classification.has_only_lifetimes);
  assert!(!classification.has_only_types);
  assert!(!classification.has_only_consts);
  assert!(!classification.has_mixed);
  assert_eq!(classification.lifetimes.len(), 1);
  
  // Multiple lifetimes
  let generics: syn ::Generics = parse_quote! { < 'a, 'b, 'c > };
  let classification = classify_generics(&generics);
  
  assert!(classification.has_only_lifetimes);
  assert_eq!(classification.lifetimes.len(), 3);
}

#[ test ]
fn test_classify_generics_only_types() 
{
  // Single type
  let generics: syn ::Generics = parse_quote! { < T > };
  let classification = classify_generics(&generics);
  
  assert!(!classification.is_empty);
  assert!(!classification.has_only_lifetimes);
  assert!(classification.has_only_types);
  assert!(!classification.has_only_consts);
  assert!(!classification.has_mixed);
  assert_eq!(classification.types.len(), 1);
  
  // Multiple types with bounds
  let generics: syn ::Generics = parse_quote! { < T: Clone, U: Default, V > };
  let classification = classify_generics(&generics);
  
  assert!(classification.has_only_types);
  assert_eq!(classification.types.len(), 3);
}

#[ test ]
fn test_classify_generics_only_consts() 
{
  // Single const
  let generics: syn ::Generics = parse_quote! { < const N: usize > };
  let classification = classify_generics(&generics);
  
  assert!(!classification.is_empty);
  assert!(!classification.has_only_lifetimes);
  assert!(!classification.has_only_types);
  assert!(classification.has_only_consts);
  assert!(!classification.has_mixed);
  assert_eq!(classification.consts.len(), 1);
  
  // Multiple consts
  let generics: syn ::Generics = parse_quote! { < const N: usize, const M: i32 > };
  let classification = classify_generics(&generics);
  
  assert!(classification.has_only_consts);
  assert_eq!(classification.consts.len(), 2);
}

#[ test ]
fn test_classify_generics_mixed() 
{
  // Lifetime + Type
  let generics: syn ::Generics = parse_quote! { < 'a, T > };
  let classification = classify_generics(&generics);
  
  assert!(classification.has_mixed);
  assert!(!classification.has_only_lifetimes);
  assert!(!classification.has_only_types);
  assert!(!classification.has_only_consts);
  
  // Type + Const
  let generics: syn ::Generics = parse_quote! { < T, const N: usize > };
  let classification = classify_generics(&generics);
  
  assert!(classification.has_mixed);
  
  // All three types
  let generics: syn ::Generics = parse_quote! { < 'a, T: Clone, const N: usize > };
  let classification = classify_generics(&generics);
  
  assert!(classification.has_mixed);
  assert_eq!(classification.lifetimes.len(), 1);
  assert_eq!(classification.types.len(), 1);
  assert_eq!(classification.consts.len(), 1);
}

// Test filter_params
#[ test ]
fn test_filter_params_lifetimes() 
{
  let generics: syn ::Generics = parse_quote! { < 'a, 'b, T, U, const N: usize > };
  let filtered = filter_params(&generics.params, filter_lifetimes);
  
  assert_eq!(filtered.len(), 2);
  assert!(!filtered.trailing_punct());
  
  // Verify all items are lifetimes
  for param in &filtered 
  {
  assert!(matches!(param, syn ::GenericParam ::Lifetime(_)));
 }
}

#[ test ]
fn test_filter_params_types() 
{
  let generics: syn ::Generics = parse_quote! { < 'a, T: Clone, U, const N: usize > };
  let filtered = filter_params(&generics.params, filter_types);
  
  assert_eq!(filtered.len(), 2);
  assert!(!filtered.trailing_punct());
  
  // Verify all items are types
  for param in &filtered 
  {
  assert!(matches!(param, syn ::GenericParam ::Type(_)));
 }
}

#[ test ]
fn test_filter_params_consts() 
{
  let generics: syn ::Generics = parse_quote! { < 'a, T, const N: usize, const M: i32 > };
  let filtered = filter_params(&generics.params, filter_consts);
  
  assert_eq!(filtered.len(), 2);
  assert!(!filtered.trailing_punct());
  
  // Verify all items are consts
  for param in &filtered 
  {
  assert!(matches!(param, syn ::GenericParam ::Const(_)));
 }
}

#[ test ]
fn test_filter_params_non_lifetimes() 
{
  let generics: syn ::Generics = parse_quote! { < 'a, 'b, T, const N: usize > };
  let filtered = filter_params(&generics.params, filter_non_lifetimes);
  
  assert_eq!(filtered.len(), 2); // T and const N
  assert!(!filtered.trailing_punct());
  
  // Verify no lifetimes
  for param in &filtered 
  {
  assert!(!matches!(param, syn ::GenericParam ::Lifetime(_)));
 }
}

#[ test ]
fn test_filter_params_custom_predicate()
{
  let generics : syn ::Generics = parse_quote! { < T : Clone, U : Default, V > };

  // Filter types with bounds
  let with_bounds = filter_params( &generics.params, | p |
  {
    if let syn ::GenericParam ::Type( ty ) = p
    {
      !ty.bounds.is_empty()
    }
    else
    {
      false
    }
  } );

  assert_eq!( with_bounds.len(), 2 ); // T and U have bounds
}

// Test decompose_classified
#[ test ]
fn test_decompose_classified_basic() 
{
  let generics: syn ::Generics = parse_quote! { < 'a, T: Clone, const N: usize > };
  let decomposed = decompose_classified(&generics);
  
  // Check classification
  assert!(decomposed.classification.has_mixed);
  assert_eq!(decomposed.classification.lifetimes.len(), 1);
  assert_eq!(decomposed.classification.types.len(), 1);
  assert_eq!(decomposed.classification.consts.len(), 1);
  
  // Check pre-filtered lists
  assert_eq!(decomposed.generics_impl_only_types.len(), 1);
  assert_eq!(decomposed.generics_impl_no_lifetimes.len(), 2); // T and const N
  assert_eq!(decomposed.generics_ty_only_types.len(), 1);
  assert_eq!(decomposed.generics_ty_no_lifetimes.len(), 2);
  
  // Check that original decomposition still works
  assert!(decomposed.generics_with_defaults.trailing_punct());
  assert!(!decomposed.generics_impl.trailing_punct());
  assert!(!decomposed.generics_ty.trailing_punct());
}

#[ test ]
fn test_decompose_classified_lifetime_only() 
{
  let generics: syn ::Generics = parse_quote! { < 'a, 'b > };
  let decomposed = decompose_classified(&generics);
  
  assert!(decomposed.classification.has_only_lifetimes);
  assert!(decomposed.generics_impl_only_types.is_empty());
  assert!(decomposed.generics_impl_no_lifetimes.is_empty());
}

// Test merge_params_ordered
#[ test ]
fn test_merge_params_ordered_basic() 
{
  let list1: syn ::punctuated ::Punctuated< syn ::GenericParam, syn ::token ::Comma > = 
  parse_quote! { T, const N: usize };
  let list2: syn ::punctuated ::Punctuated< syn ::GenericParam, syn ::token ::Comma > = 
  parse_quote! { 'a, U };
  
  let merged = merge_params_ordered(&[ &list1, &list2]);
  
  // Should be ordered: lifetimes, types, consts
  assert_eq!(merged.len(), 4);
  assert!(!merged.trailing_punct());
  
  // Check order
  let params: Vec< _ > = merged.iter().collect();
  assert!(matches!(params[0], syn ::GenericParam ::Lifetime(_))); // 'a
  assert!(matches!(params[1], syn ::GenericParam ::Type(_)));     // T
  assert!(matches!(params[2], syn ::GenericParam ::Type(_)));     // U
  assert!(matches!(params[3], syn ::GenericParam ::Const(_)));    // const N
}

#[ test ]
fn test_merge_params_ordered_empty() 
{
  let list1: syn ::punctuated ::Punctuated< syn ::GenericParam, syn ::token ::Comma > = 
  syn ::punctuated ::Punctuated ::new();
  let list2: syn ::punctuated ::Punctuated< syn ::GenericParam, syn ::token ::Comma > = 
  parse_quote! { T };
  
  let merged = merge_params_ordered(&[ &list1, &list2]);
  assert_eq!(merged.len(), 1);
  
  let merged_empty = merge_params_ordered(&[ &list1, &list1]);
  assert!(merged_empty.is_empty());
}

#[ test ]
fn test_merge_params_ordered_complex() 
{
  let list1: syn ::punctuated ::Punctuated< syn ::GenericParam, syn ::token ::Comma > = 
  parse_quote! { 'b, T: Clone, const N: usize };
  let list2: syn ::punctuated ::Punctuated< syn ::GenericParam, syn ::token ::Comma > = 
  parse_quote! { 'a, U: Default };
  let list3: syn ::punctuated ::Punctuated< syn ::GenericParam, syn ::token ::Comma > = 
  parse_quote! { const M: i32, V };
  
  let merged = merge_params_ordered(&[ &list1, &list2, &list3]);
  
  // Should have: 'b, 'a (lifetimes), T, U, V (types), const N, const M (consts)
  assert_eq!(merged.len(), 7);
  
  let params: Vec< _ > = merged.iter().collect();
  // First two should be lifetimes
  assert!(matches!(params[0], syn ::GenericParam ::Lifetime(_)));
  assert!(matches!(params[1], syn ::GenericParam ::Lifetime(_)));
  // Next three should be types
  assert!(matches!(params[2], syn ::GenericParam ::Type(_)));
  assert!(matches!(params[3], syn ::GenericParam ::Type(_)));
  assert!(matches!(params[4], syn ::GenericParam ::Type(_)));
  // Last two should be consts
  assert!(matches!(params[5], syn ::GenericParam ::Const(_)));
  assert!(matches!(params[6], syn ::GenericParam ::Const(_)));
}

// Test params_with_additional
#[ test ]
fn test_params_with_additional_basic() 
{
  let base: syn ::punctuated ::Punctuated< syn ::GenericParam, syn ::token ::Comma > = 
  parse_quote! { T, U };
  let additional = vec![parse_quote! { V }, parse_quote! { const N: usize }];
  
  let extended = params_with_additional(&base, &additional);
  
  assert_eq!(extended.len(), 4);
  assert!(!extended.trailing_punct());
  
  // Verify order is preserved
  let params: Vec< _ > = extended.iter().collect();
  if let syn ::GenericParam ::Type(ty) = params[0] 
  {
  assert_eq!(ty.ident.to_string(), "T");
 }
  if let syn ::GenericParam ::Type(ty) = params[2] 
  {
  assert_eq!(ty.ident.to_string(), "V");
 }
}

#[ test ]
fn test_params_with_additional_empty_base() 
{
  let base: syn ::punctuated ::Punctuated< syn ::GenericParam, syn ::token ::Comma > = 
  syn ::punctuated ::Punctuated ::new();
  let additional = vec![parse_quote! { T }];
  
  let extended = params_with_additional(&base, &additional);
  
  assert_eq!(extended.len(), 1);
  assert!(!extended.trailing_punct());
}

#[ test ]
fn test_params_with_additional_with_trailing_comma() 
{
  let mut base: syn ::punctuated ::Punctuated< syn ::GenericParam, syn ::token ::Comma > = 
  parse_quote! { T };
  base.push_punct(syn ::token ::Comma ::default()); // Test edge case where base params already have trailing punctuation
  
  let additional = vec![parse_quote! { U }];
  let extended = params_with_additional(&base, &additional);
  
  assert_eq!(extended.len(), 2);
  assert!(!extended.trailing_punct()); // Should not have trailing comma
}

// Test params_from_components
#[ test ]
fn test_params_from_components_basic() 
{
  let lifetimes = vec![parse_quote! { 'a }, parse_quote! { 'b }];
  let types = vec![parse_quote! { T: Clone }];
  let consts = vec![parse_quote! { const N: usize }];
  
  let params = params_from_components(&lifetimes, &types, &consts);
  
  assert_eq!(params.len(), 4);
  assert!(!params.trailing_punct());
  
  // Check order
  let param_vec: Vec< _ > = params.iter().collect();
  assert!(matches!(param_vec[0], syn ::GenericParam ::Lifetime(_)));
  assert!(matches!(param_vec[1], syn ::GenericParam ::Lifetime(_)));
  assert!(matches!(param_vec[2], syn ::GenericParam ::Type(_)));
  assert!(matches!(param_vec[3], syn ::GenericParam ::Const(_)));
}

#[ test ]
fn test_params_from_components_empty() 
{
  let params = params_from_components(&[ ], &[ ], &[ ]);
  assert!(params.is_empty());
  assert!(!params.trailing_punct());
}

#[ test ]
fn test_params_from_components_partial() 
{
  // Only types
  let types = vec![parse_quote! { T }, parse_quote! { U }];
  let params = params_from_components(&[ ], &types, &[ ]);
  
  assert_eq!(params.len(), 2);
  for param in &params 
  {
  assert!(matches!(param, syn ::GenericParam ::Type(_)));
 }
}

// Test GenericsRef extensions
#[ test ]
fn test_generics_ref_classification() 
{
  let generics: syn ::Generics = parse_quote! { < 'a, T, const N: usize > };
  let generics_ref = GenericsRef ::new(&generics);
  let classification = generics_ref.classification();
  
  assert!(classification.has_mixed);
  assert_eq!(classification.lifetimes.len(), 1);
  assert_eq!(classification.types.len(), 1);
  assert_eq!(classification.consts.len(), 1);
}

#[ test ]
fn test_generics_ref_has_only_methods() 
{
  // Only lifetimes
  let generics: syn ::Generics = parse_quote! { < 'a, 'b > };
  let generics_ref = GenericsRef ::new(&generics);
  assert!(generics_ref.has_only_lifetimes());
  assert!(!generics_ref.has_only_types());
  assert!(!generics_ref.has_only_consts());
  
  // Only types
  let generics: syn ::Generics = parse_quote! { < T, U > };
  let generics_ref = GenericsRef ::new(&generics);
  assert!(!generics_ref.has_only_lifetimes());
  assert!(generics_ref.has_only_types());
  assert!(!generics_ref.has_only_consts());
  
  // Only consts
  let generics: syn ::Generics = parse_quote! { < const N: usize, const M: i32 > };
  let generics_ref = GenericsRef ::new(&generics);
  assert!(!generics_ref.has_only_lifetimes());
  assert!(!generics_ref.has_only_types());
  assert!(generics_ref.has_only_consts());
}

#[ test ]
fn test_generics_ref_impl_no_lifetimes() 
{
  let generics: syn ::Generics = parse_quote! { < 'a, T: Clone, const N: usize > };
  let generics_ref = GenericsRef ::new(&generics);
  let impl_no_lifetimes = generics_ref.impl_generics_no_lifetimes();
  
  let expected = quote! { < T: Clone , const N: usize > };
  assert_eq!(impl_no_lifetimes.to_string(), expected.to_string());
}

#[ test ]
fn test_generics_ref_ty_no_lifetimes() 
{
  let generics: syn ::Generics = parse_quote! { < 'a, T, const N: usize > };
  let generics_ref = GenericsRef ::new(&generics);
  let ty_no_lifetimes = generics_ref.ty_generics_no_lifetimes();
  
  let expected = quote! { < T , const N: usize > };
  assert_eq!(ty_no_lifetimes.to_string(), expected.to_string());
}

#[ test ]
fn test_generics_ref_type_path_no_lifetimes() 
{
  use quote ::format_ident;
  
  let generics: syn ::Generics = parse_quote! { < 'a, T, const N: usize > };
  let generics_ref = GenericsRef ::new(&generics);
  let base = format_ident!("MyType");
  let path = generics_ref.type_path_no_lifetimes(&base);
  
  let expected = quote! { MyType < T , const N: usize > };
  assert_eq!(path.to_string(), expected.to_string());
  
  // Test with only lifetimes
  let generics2: syn ::Generics = parse_quote! { < 'a, 'b > };
  let generics_ref2 = GenericsRef ::new(&generics2);
  let path2 = generics_ref2.type_path_no_lifetimes(&base);
  
  let expected2 = quote! { MyType };
  assert_eq!(path2.to_string(), expected2.to_string());
}

// Integration tests
#[ test ]
fn test_integration_former_meta_pattern() 
{
  // Simulate the former_meta use case
  let struct_generics: syn ::Generics = parse_quote! { < 'a, T: Clone, const N: usize > };
  
  // Old way (manual check)
  let has_only_lifetimes_old = struct_generics.params.iter()
  .all(|param| matches!(param, syn ::GenericParam ::Lifetime(_)));
  
  // New way
  let decomposed = decompose_classified(&struct_generics);
  let has_only_lifetimes_new = decomposed.classification.has_only_lifetimes;
  
  assert_eq!(has_only_lifetimes_old, has_only_lifetimes_new);
  assert!(!has_only_lifetimes_new); // Should be false for mixed generics
  
  // Building generics with additional param
  let additional_param: syn ::GenericParam = parse_quote! { Definition };
  let entity_generics = params_with_additional(&decomposed.generics_impl, &[ additional_param]);
  
  // Should have original 3 params + 1 new one
  assert_eq!(entity_generics.len(), 4);
}

#[ test ]
fn test_edge_cases() 
{
  // Empty filter result
  let generics: syn ::Generics = parse_quote! { < 'a, 'b > };
  let filtered = filter_params(&generics.params, filter_types);
  assert!(filtered.is_empty());
  assert!(!filtered.trailing_punct());
  
  // Single param filter
  let generics: syn ::Generics = parse_quote! { < T > };
  let filtered = filter_params(&generics.params, filter_types);
  assert_eq!(filtered.len(), 1);
  assert!(!filtered.trailing_punct());
  
  // Merge with all empty
  let empty = syn ::punctuated ::Punctuated ::new();
  let merged = merge_params_ordered(&[ &empty, &empty, &empty]);
  assert!(merged.is_empty());
}