enum_index_repr_derive/
lib.rs

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
use proc_macro::TokenStream;
use quote::quote;
use syn::{parse_macro_input, spanned::Spanned, DeriveInput, Error, Meta, NestedMeta};

#[proc_macro_derive(EnumIndex)]
pub fn my_macro(input: TokenStream) -> TokenStream {
    let input = parse_macro_input!(input as DeriveInput);

    let enum_name = input.ident.clone();

    match validate_repr(&input) {
        Err(error) => {
            let message = match error {
                ReprError::NoRepr => {
                    "Missing repr on enum. EnumIndex requires enum to be repr(u16)"
                }
                ReprError::WrongRepr => {
                    "Incorrect repr on enum. EnumIndex requires enum to be repr(u16)"
                }
                ReprError::MultipleRepr => {
                    "Multiple repr on enum. EnumIndex requires enum to be repr(u16)"
                }
            };
            return Error::new(input.span(), message).to_compile_error().into();
        }
        _ => (),
    }

    let expanded = quote! {
        impl EnumIndexGet for #enum_name {
            fn index(&self) -> u16 {
                //
                // SAFETY: This is implemented through a macro which ensures the enum is repr(u16)
                //
                unsafe { *((self as *const _) as *const u16) }
            }
        }
    };

    TokenStream::from(expanded)
}

fn validate_repr(input: &DeriveInput) -> Result<(), ReprError> {
    for attribute in &input.attrs {
        let Some(Meta::List(meta)) = attribute.parse_meta().ok() else {
            continue;
        };

        if !meta.path.is_ident("repr") {
            continue;
        }

        if meta.nested.len() > 1 {
            return Err(ReprError::MultipleRepr);
        }

        let repr = match meta.nested.first() {
            Some(repr) => repr,
            None => continue,
        };

        let repr_name = match repr {
            NestedMeta::Meta(Meta::Path(path)) => path
                .get_ident()
                .and_then(|ident| Some(ident.clone().to_string())),
            _ => None,
        };

        let Some(repr_name) = repr_name else {
            return Err(ReprError::WrongRepr);
        };

        if repr_name != String::from("u16") {
            return Err(ReprError::WrongRepr);
        }

        return Ok(());
    }
    Err(ReprError::NoRepr)
}

#[derive(Debug)]
enum ReprError {
    NoRepr,
    WrongRepr,
    MultipleRepr,
}