bondrewd-derive 0.3.18

Bit-Level field packing with proc_macros
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
use proc_macro2::{Literal, Span};
use quote::format_ident;
use syn::parse::Error;
use syn::spanned::Spanned;
use syn::{Attribute, DeriveInput, Expr, Ident, Lit, Meta, NestedMeta, Variant};

#[derive(Eq, Debug, Clone)]
pub enum EnumVariantBuilderType {
    UnsignedValue,
    CatchAll,
    CatchPrimitive(Option<Ident>),
    Skip,
}

impl PartialEq for EnumVariantBuilderType {
    fn eq(&self, other: &Self) -> bool {
        match self {
            Self::UnsignedValue => false,
            Self::CatchAll => true,
            Self::CatchPrimitive(_) => {
                matches!(other, Self::CatchPrimitive(_))
            }
            Self::Skip => {
                matches!(other, Self::Skip)
            }
        }
    }
}
#[derive(Debug, Clone)]
pub struct EnumVariantBuilder {
    pub name: Ident,
    pub value: EnumVariantBuilderType,
}

#[derive(Debug)]
pub enum EnumVariantType {
    UnsignedValue(proc_macro2::Literal),
    CatchAll(proc_macro2::Literal),
    CatchPrimitive(Option<Ident>),
    Skip(proc_macro2::Literal),
}
#[derive(Debug)]
pub struct EnumVariant {
    pub name: Ident,
    pub value: EnumVariantType,
}

pub struct EnumInfo {
    pub name: Ident,
    pub variants: Vec<EnumVariant>,
    pub primitive: Ident,
    pub partial_eq: bool,
}

enum ParseMetaResult {
    FoundInvalid,
    None,
    InvalidConflict(proc_macro2::Span, Ident),
}

impl EnumInfo {
    fn parse_meta(
        meta: Meta,
        invalid_found: &mut Option<EnumVariantBuilder>,
        primitive_type: &mut Option<Ident>,
        var: &syn::Variant,
    ) -> syn::Result<ParseMetaResult> {
        match meta {
            Meta::NameValue(_) => Ok(ParseMetaResult::None),
            Meta::Path(name_value) => {
                if let Some(name) = name_value.get_ident() {
                    match name.to_string().as_str() {
                        "invalid" => {
                            if invalid_found.is_some() {
                                Ok(ParseMetaResult::InvalidConflict(
                                    var.ident.span(),
                                    var.ident.clone(),
                                ))
                            } else {
                                match var.fields {
                                    syn::Fields::Named(ref named) => match named.named.len() {
                                        1 => {
                                            if let syn::Type::Path(ref path) = named.named[0].ty {
                                                if let Some(prim_ident) = path.path.get_ident() {
                                                    if let Some(ref prim_ty) = primitive_type {
                                                        if prim_ty
                                                            != prim_ident
                                                        {
                                                            return Err(syn::Error::new(var.ident.span(), "primitive type does not match enums defined primitive type"));
                                                        }
                                                    } else {
                                                        let mut invalid = Some(EnumVariantBuilder{
                                                            name: var.ident.clone(),
                                                            value: EnumVariantBuilderType::CatchPrimitive(if let Some(ref name) = named.named.iter().collect::<Vec<&syn::Field>>()[0].ident{
                                                                Some(name.clone())
                                                            }else{
                                                                return Err(syn::Error::new(var.ident.span(), "named value didn't have name"));
                                                            }),
                                                        });
                                                        std::mem::swap(invalid_found, &mut invalid);
                                                    }
                                                }
                                            } else {
                                                return Err(syn::Error::new(var.ident.span(), "catch invalid variants with a field must contain a unsigned primitive"));
                                            }
                                            let mut invalid = Some(EnumVariantBuilder {
                                                name: var.ident.clone(),
                                                value: EnumVariantBuilderType::CatchPrimitive(
                                                    if let Some(ref name) = named
                                                        .named
                                                        .iter()
                                                        .collect::<Vec<&syn::Field>>()[0]
                                                        .ident
                                                    {
                                                        Some(name.clone())
                                                    } else {
                                                        return Err(syn::Error::new(
                                                            var.ident.span(),
                                                            "named value didn't have name",
                                                        ));
                                                    },
                                                ),
                                            });
                                            std::mem::swap(invalid_found, &mut invalid);

                                            Ok(ParseMetaResult::FoundInvalid)
                                        }
                                        _ => {
                                            Err(syn::Error::new(var.ident.span(), "Invalid Variants must have either no fields or 1 field containing the primitive type the enum will become"))
                                        }
                                    },
                                    syn::Fields::Unnamed(ref unnamed) => {
                                        match unnamed.unnamed.len() {
                                            1 => {
                                                if let syn::Type::Path(ref path) = unnamed.unnamed[0].ty {
                                                    if let Some(prim_ident) = path.path.get_ident(){
                                                        if let Some(ref prim_ty) = primitive_type {
                                                            if prim_ty != prim_ident {
                                                                return Err(syn::Error::new(var.ident.span(), "primitive type does not match enums defined primitive type"));
                                                            }
                                                        }else{
                                                            let mut invalid = Some(EnumVariantBuilder{
                                                                name: var.ident.clone(),
                                                                value: EnumVariantBuilderType::CatchPrimitive(None)
                                                            });
                                                            std::mem::swap(invalid_found,&mut invalid);
                                                        }
                                                    }
                                                }else{
                                                    return Err(syn::Error::new(var.ident.span(), "catch invalid variants with a field must contain a unsigned primitive"));
                                                }
                                                let mut invalid = Some(EnumVariantBuilder{
                                                    name: var.ident.clone(),
                                                    value: EnumVariantBuilderType::CatchPrimitive(None)
                                                });
                                                std::mem::swap(invalid_found,&mut invalid);
                                                Ok(ParseMetaResult::FoundInvalid)
                                            }
                                            _ => {
                                                Err(syn::Error::new(var.ident.span(), "Variants must have either no fields or 1 field containing the primitive type the enum will become"))
                                            }
                                        }
                                    }
                                    syn::Fields::Unit => {
                                        let mut invalid = Some(EnumVariantBuilder {
                                            name: var.ident.clone(),
                                            value: EnumVariantBuilderType::CatchAll,
                                        });
                                        std::mem::swap(invalid_found, &mut invalid);
                                        Ok(ParseMetaResult::FoundInvalid)
                                    }
                                }
                            }
                        }
                        _ => Ok(ParseMetaResult::None),
                    }
                } else {
                    Ok(ParseMetaResult::None)
                }
            }
            Meta::List(meta_list) => {
                if meta_list.path.is_ident("bondrewd_enum") {
                    for nested_meta in meta_list.nested {
                        match nested_meta {
                            NestedMeta::Meta(meta) => {
                                match Self::parse_meta(meta, invalid_found, primitive_type, var)? {
                                    ParseMetaResult::FoundInvalid => {
                                        return Ok(ParseMetaResult::FoundInvalid)
                                    }
                                    ParseMetaResult::None => {}
                                    ParseMetaResult::InvalidConflict(span, name) => {
                                        return Ok(ParseMetaResult::InvalidConflict(span, name))
                                    }
                                }
                            }
                            NestedMeta::Lit(_) => {}
                        }
                    }
                    Ok(ParseMetaResult::None)
                } else {
                    Ok(ParseMetaResult::None)
                }
            }
        }
    }

    // Parses the Expression, looking for a literal number expression
    fn parse_lit_discriminant_expr(input: &Expr) -> syn::Result<usize> {
        match input {
            Expr::Lit(ref lit) => match lit.lit {
                Lit::Int(ref i) => Ok(i.base10_parse()?),
                _ => Err(syn::Error::new(
                    input.span(),
                    "Non-integer literals for custom discriminant are illegal.",
                )),
            },
            _ => Err(syn::Error::new(
                input.span(),
                "non-literal expressions for custom discriminant are illegal.",
            )),
        }
    }

    fn parse_attrs(
        attrs: &Vec<Attribute>,
        var: &Variant,
        primitive_type: &mut Option<Ident>,
        invalid_found: &mut Option<EnumVariantBuilder>,
    ) -> syn::Result<bool> {
        let mut temp: Option<Ident> = None;
        let mut temp_invalid = invalid_found.clone();
        for attr in attrs {
            match Self::parse_meta(attr.parse_meta()?, &mut temp_invalid, &mut temp, var)? {
                ParseMetaResult::FoundInvalid => {
                    std::mem::swap(&mut temp, primitive_type);
                    std::mem::swap(&mut temp_invalid, invalid_found);
                    return Ok(true);
                }
                ParseMetaResult::None => {}
                ParseMetaResult::InvalidConflict(span, name) => {
                    return Err(syn::Error::new(
                        span,
                        format!("Invalid already found [{}]", name),
                    ));
                }
            }
        }
        Ok(false)
    }

    pub fn parse(input: &DeriveInput) -> syn::Result<Self> {
        // get the struct, error out if not a struct
        let data = match input.data {
            syn::Data::Enum(ref data) => data,
            _ => {
                return Err(Error::new(Span::call_site(), "input must be an enum"));
            }
        };
        let mut primitive_type: Option<Ident> = None;
        let mut partial_eq = false;
        for attr in &input.attrs {
            match attr.parse_meta()? {
                Meta::NameValue(_) => {}
                Meta::Path(_) => {}
                Meta::List(meta_list) => {
                    if meta_list.path.is_ident("bondrewd_enum") {
                        for nested_meta in meta_list.nested {
                            match nested_meta {
                                NestedMeta::Meta(meta) => if let Meta::Path(path) = meta {
                                    // Add an additional check to implement `partial_eq` optionally.
                                    if path.is_ident("u8") {
                                        primitive_type = Some(quote::format_ident!("u8"));
                                    } else if path.is_ident("partial_eq") {
                                        partial_eq = true;
                                    } else {
                                        return Err(syn::Error::new(
                                            input.ident.span(),
                                            "the only supported enum attributes are u8, partial_eq currently",
                                        ));
                                    }

                                    // Have we found all of the relevant attributes?
                                    if primitive_type.is_some() && partial_eq {
                                        break;
                                    }
                                },
                                NestedMeta::Lit(_) => {}
                            }
                        }
                    }
                }
            }
        }
        // get the list of fields in syn form, error out if unit struct (because they have no data, and
        // data packing/analysis don't seem necessary)
        let mut literal_variants: std::collections::BTreeMap<usize, EnumVariant> =
            Default::default();
        let mut unknown_variants: std::collections::VecDeque<EnumVariantBuilder> =
            Default::default();
        let mut invalid_found: Option<EnumVariantBuilder> = None;
        let last_variant = data.variants.len() - 1;
        for (var, i) in data.variants.iter().zip(0..data.variants.len()) {
            let test_len = literal_variants.len() + unknown_variants.len();
            match var.fields {
                syn::Fields::Named(ref named) => {
                    match named.named.len() {
                        1 => {
                            if let syn::Type::Path(ref path) = named.named[0].ty {
                                if let Some(prim_ident) = path.path.get_ident(){
                                    if let Some(ref prim_ty) = primitive_type {
                                        if prim_ty != prim_ident {
                                            return Err(syn::Error::new(var.ident.span(), "primitive type does not match enums defined primitive type"));
                                        }
                                    }else{
                                        primitive_type = Some(prim_ident.clone());
                                    }
                                }
                            }else{
                                return Err(syn::Error::new(var.ident.span(), "catch invalid variants with a field must contain a unsigned primitive"));
                            }
                            if let Some(conflict) = invalid_found {
                                return Err(syn::Error::new(var.ident.span(), format!("conflicting Invalid Variant named [{}]", conflict.name)));
                            }
                            invalid_found = Some(EnumVariantBuilder{
                                name: var.ident.clone(),
                                value: EnumVariantBuilderType::CatchPrimitive(if let Some(ref name) = named.named.iter().collect::<Vec<&syn::Field>>()[0].ident{
                                    Some(name.clone())
                                }else{
                                    return Err(syn::Error::new(var.ident.span(), "named value didn't have name"));
                                })
                            });
                            unknown_variants.push_back(EnumVariantBuilder{
                                name: var.ident.clone(),
                                value: EnumVariantBuilderType::Skip,
                            });
                        }
                        _ => {
                            return Err(syn::Error::new(var.ident.span(), "Variants must have either no fields or 1 field containing the primitive type the enum will become"))
                        }
                    }
                }
                syn::Fields::Unnamed(ref unnamed) => {
                    match unnamed.unnamed.len() {
                        1 => {
                            if let syn::Type::Path(ref path) = unnamed.unnamed[0].ty {
                                if let Some(prim_ident) = path.path.get_ident(){
                                    if let Some(ref prim_ty) = primitive_type {
                                        if prim_ty != prim_ident {
                                            return Err(syn::Error::new(var.ident.span(), "primitive type does not match enums defined primitive type"));
                                        }
                                    }else{
                                        primitive_type = Some(prim_ident.clone());
                                    }
                                }
                            }else{
                                return Err(syn::Error::new(var.ident.span(), "catch invalid variants with a field must contain a unsigned primitive"));
                            }
                            if let Some(conflict) = invalid_found {
                                return Err(syn::Error::new(var.ident.span(), format!("conflicting Invalid Variant named [{}]", conflict.name)));
                            }
                            invalid_found = Some(EnumVariantBuilder{
                                name: var.ident.clone(),
                                value: EnumVariantBuilderType::CatchPrimitive(None)
                            });
                            unknown_variants.push_back(EnumVariantBuilder{
                                name: var.ident.clone(),
                                value: EnumVariantBuilderType::Skip,
                            });
                        }
                        _ => {
                            return Err(syn::Error::new(var.ident.span(), "Variants must have either no fields or 1 field containing the primitive type the enum will become"))
                        }
                    }
                }
                _ => {
                    // Check for an invalid already existing, and if this is the last variant in the variants
                    if invalid_found.is_none() && last_variant == i {
                        invalid_found = Some(EnumVariantBuilder{
                            name: var.ident.clone(),
                            value: EnumVariantBuilderType::CatchAll,
                        });
                        if let Some((_, ref discriminant)) = var.discriminant {
                            // Parse the discriminant and validate its able to be used
                            let discriminant_val = Self::parse_lit_discriminant_expr(discriminant)?;
                            if let Some(_oh_no) = literal_variants.insert(discriminant_val, EnumVariant{
                                value: EnumVariantType::Skip(Literal::usize_unsuffixed(discriminant_val)),
                                name: var.ident.clone(),
                            }) {
                                return Err(syn::Error::new(var.ident.span(), "Literal Values conflict"));
                            }
                        }else{
                            unknown_variants.push_back(EnumVariantBuilder{
                                name: var.ident.clone(),
                                value: EnumVariantBuilderType::Skip,
                            });
                        }
                    } else {
                        // This is one of the possible variants to use, check for a custom discriminant
                         if invalid_found.is_none() && Self::parse_attrs(&var.attrs, var, &mut primitive_type, &mut invalid_found)? {
                            if let Some((_, ref discriminant)) = var.discriminant {
                                // Parse the discriminant and validate its able to be used
                                let discriminant_val = Self::parse_lit_discriminant_expr(discriminant)?;
                                if let Some(_oh_no) = literal_variants.insert(discriminant_val, EnumVariant{
                                    value: EnumVariantType::Skip(Literal::usize_unsuffixed(discriminant_val)),
                                    name: var.ident.clone(),
                                }) {
                                    return Err(syn::Error::new(var.ident.span(), "Literal Values conflict"));
                                }
                            }else{
                                literal_variants.insert(i, EnumVariant{
                                    name: var.ident.clone(),
                                    value: EnumVariantType::Skip(Literal::usize_unsuffixed(i)),
                                });
                            }
                        } else if let Some((_, ref discriminant)) = var.discriminant {
                            // Parse the discriminant and validate its able to be used
                            let discriminant_val = Self::parse_lit_discriminant_expr(discriminant)?;
                            if let Some(_oh_no) = literal_variants.insert(discriminant_val, EnumVariant{
                                value: EnumVariantType::UnsignedValue(Literal::usize_unsuffixed(discriminant_val)),
                                name: var.ident.clone(),
                            }) {
                                return Err(syn::Error::new(var.ident.span(), "Literal Values conflict"));
                            }
                        } else {
                            // This is a simple usage of a bunch of unit variants in a row
                            unknown_variants.push_back(EnumVariantBuilder {
                                value: EnumVariantBuilderType::UnsignedValue,
                                name: var.ident.clone(),
                            });
                        }
                    }
                }
            }
            if unknown_variants.len() + literal_variants.len() == test_len {
                return Err(Error::new(var.span(), "field skipped, please open issue"));
            }
        }
        let mut skipped: Option<Literal> = None;
        let mut variants: Vec<EnumVariant> = Default::default();
        if unknown_variants.len() + literal_variants.len() != last_variant + 1 {
            return Err(Error::new(
                input.span(),
                format!(
                    "not all fields were parsed [({} + lits:{}) of {}]",
                    unknown_variants.len(),
                    literal_variants.len(),
                    last_variant + 1
                ),
            ));
        }
        for i in 0..=last_variant {
            if literal_variants.contains_key(&i) {
                if let Some(enum_var) = literal_variants.remove(&i) {
                    if let EnumVariantType::Skip(ref lit) = enum_var.value {
                        if skipped.is_some() {
                            // CHECK if error is needed
                            return Err(syn::Error::new(
                                enum_var.name.span(),
                                "two skips. please open issue for this",
                            ));
                        }
                        skipped = Some(lit.clone());
                    } else {
                        variants.push(enum_var);
                    }
                    continue;
                } else {
                    return Err(syn::Error::new(
                        input.span(),
                        "found key but removal failed. please open issue.",
                    ));
                }
            }
            if let Some(unknown_variant) = unknown_variants.pop_front() {
                match unknown_variant.value {
                    EnumVariantBuilderType::CatchAll => {
                        variants.push(EnumVariant {
                            name: unknown_variant.name,
                            value: EnumVariantType::CatchAll(Literal::usize_unsuffixed(i)),
                        });
                        continue;
                    }
                    EnumVariantBuilderType::CatchPrimitive(name) => {
                        variants.push(EnumVariant {
                            name: unknown_variant.name,
                            value: EnumVariantType::CatchPrimitive(name),
                        });
                        continue;
                    }
                    EnumVariantBuilderType::Skip => {
                        if skipped.is_some() {
                            // CHECK if needed
                            return Err(syn::Error::new(
                                unknown_variant.name.span(),
                                "two skips. please open issue for this",
                            ));
                        }
                        skipped = Some(Literal::usize_unsuffixed(i));
                        continue;
                    }
                    EnumVariantBuilderType::UnsignedValue => {
                        variants.push(EnumVariant {
                            name: unknown_variant.name,
                            value: EnumVariantType::UnsignedValue(Literal::usize_unsuffixed(i)),
                        });
                        continue;
                    }
                }
            }
            let key = { literal_variants.iter().next().as_ref().map(|size| *size.0) };
            if let Some(lit_index) = key {
                if let Some(enum_var) = literal_variants.remove(&lit_index) {
                    if let EnumVariantType::Skip(lit) = enum_var.value {
                        if skipped.is_some() {
                            // CHECK if needed
                            return Err(syn::Error::new(
                                enum_var.name.span(),
                                "two skips. please open issue for this",
                            ));
                        }
                        skipped = Some(lit.clone());
                        continue;
                    } else {
                        variants.push(enum_var);
                        continue;
                    }
                } else {
                    return Err(syn::Error::new(
                        input.span(),
                        format!("failed removing key cloned from its first key  [Key:{:?}], please open issue.", key),
                    ));
                }
            }
            if skipped.is_none() || i != last_variant {
                return Err(syn::Error::new(
                    input.span(),
                    format!(
                        "missing variant [{} of {}], please open issue.",
                        i,
                        last_variant + 1
                    ),
                ));
            }
        }

        if let Some(ref invalid) = invalid_found {
            if let Some(ref index) = skipped {
                if variants.len() == last_variant {
                    variants.push(EnumVariant {
                        value: match invalid.value {
                            EnumVariantBuilderType::CatchAll => {
                                EnumVariantType::CatchAll(index.clone())
                            }
                            EnumVariantBuilderType::CatchPrimitive(ref name) => {
                                EnumVariantType::CatchPrimitive(name.clone())
                            }
                            _ => {
                                return Err(syn::Error::new(
                                    invalid.name.span(),
                                    "Invalid found is not an invalid type, please open issue.",
                                ));
                            }
                        },
                        name: invalid.name.clone(),
                    });
                } else {
                    return Err(syn::Error::new(
                        input.span(),
                        format!(
                            "Invalid was not last variant [{} of {}], please open issue.",
                            variants.len(),
                            last_variant + 1
                        ),
                    ));
                }
            } else {
                return Err(syn::Error::new(
                    input.span(),
                    "Invalid found but skip never takes place, please open issue.",
                ));
            }
        }

        let info = EnumInfo {
            name: input.ident.clone(),
            partial_eq,
            primitive: if let Some(prim) = primitive_type {
                if prim.to_string().as_str() == "u8" {
                    prim
                } else {
                    return Err(syn::Error::new(
                        input.ident.span(),
                        "primitive_type must be u8 for now",
                    ));
                }
            } else {
                match variants.len() {
                    0_usize..=255_usize => {
                        format_ident!("u8")
                    }
                    256_usize..=65535 => {
                        format_ident!("u16")
                    }
                    65536..=4294967296 => {
                        format_ident!("u32")
                    }
                    _ => {
                        return Err(syn::Error::new(input.span(), "too many variants?"));
                    }
                }
            },
            variants,
        };

        Ok(info)
    }
}