Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft: Support arbitrary enum discriminant #452

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 52 additions & 6 deletions deku-derive/src/macros/deku_read.rs
Original file line number Diff line number Diff line change
Expand Up @@ -181,8 +181,15 @@ fn emit_enum(input: &DekuData) -> Result<TokenStream, syn::Error> {
.first()
.and_then(|v| v.ident.as_ref())
.is_some();
let disc = &variant.discriminant;

let (use_id, variant_id) = if let Some(variant_id) = &variant.id {
if disc.is_some() {
return Err(syn::Error::new(
variant.ident.span(),
"DekuRead: `id` cannot be used with arbitrary_enum_discriminant",
));
}
match variant_id {
Id::TokenStream(v) => (false, quote! {&#v}.into_token_stream()),
Id::LitByteStr(v) => (false, v.into_token_stream()),
Expand All @@ -199,12 +206,51 @@ fn emit_enum(input: &DekuData) -> Result<TokenStream, syn::Error> {
(false, variant_id_pat.clone())
}
} else if has_discriminant {
let ident = &variant.ident;
let internal_ident = gen_internal_field_ident(&quote!(#ident));
pre_match_tokens.push(quote! {
let #internal_ident = <#id_type>::try_from(Self::#ident as isize)?;
});
(true, quote! { _ if __deku_variant_id == #internal_ident })
// Regular enum
if variant.fields.fields.is_empty() {
let ident = &variant.ident;
let internal_ident = gen_internal_field_ident(&quote!(#ident));

// If we have the discriminant, we can use that directly into the id_type
if let Some(disc) = disc {
// the discriminant is just an ident, we use the ident here
pre_match_tokens.push(quote! {
#[allow(non_upper_case_globals)]
const #internal_ident: #id_type = #disc;
});
} else {
// if not, we need to convert this into the type expressed by a cast
// enum Discriminant {
// Cats = 0x01,
// Dogs,
// }
pre_match_tokens.push(quote! {
let #internal_ident = <#id_type>::try_from(Self::#ident as isize)?;
});
}
(true, quote! { _ if __deku_variant_id == #internal_ident })
} else {
// arbitrary_enum_discriminant, such as:
//
// #[repr(u8)]
// #[derive(DekuRead, Debug)]
// #[deku(id_type = "u8")]
// enum Foo {
// A(u8) = 0,
// B(i8) = 1,
// C(bool) = 42,
// }
let ident = &variant.ident;
let disc = &variant.discriminant;
let internal_ident = gen_internal_field_ident(&quote!(#ident));
pre_match_tokens.push(quote! {
#[allow(non_upper_case_globals)]
const #internal_ident: #id_type = #disc;
});

// In this case, we send back false for use_id as we still need to read fields
(false, quote! { _ if __deku_variant_id == #internal_ident })
}
} else {
return Err(syn::Error::new(
variant.ident.span(),
Expand Down
23 changes: 20 additions & 3 deletions deku-derive/src/macros/deku_write.rs
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@ fn emit_enum(input: &DekuData) -> Result<TokenStream, syn::Error> {
.first()
.and_then(|v| v.ident.as_ref())
.is_some();
let disc = &variant.discriminant;

let variant_ident = &variant.ident;
let variant_writer = &variant.writer;
Expand All @@ -174,6 +175,12 @@ fn emit_enum(input: &DekuData) -> Result<TokenStream, syn::Error> {
}
} else if id_type.is_some() {
if let Some(variant_id) = &variant.id {
if disc.is_some() {
return Err(syn::Error::new(
variant.ident.span(),
"DekuWrite: `id` cannot be used with arbitrary_enum_discriminant",
));
}
match variant_id {
Id::TokenStream(v) => {
quote! {
Expand All @@ -197,9 +204,19 @@ fn emit_enum(input: &DekuData) -> Result<TokenStream, syn::Error> {
} else if variant.id_pat.is_some() {
quote! {}
} else if has_discriminant {
quote! {
let mut __deku_variant_id: #id_type = Self::#variant_ident as #id_type;
__deku_variant_id.to_writer(__deku_writer, (#id_args))?;
// Discriminant is provided, use it
if let Some(disc) = disc {
quote! {
#[allow(non_upper_case_globals)]
const __deku_variant_id: #id_type = #disc;
__deku_variant_id.to_writer(__deku_writer, (#id_args))?;
}
// Regular enum
} else {
quote! {
let mut __deku_variant_id: #id_type = Self::#variant_ident as #id_type;
__deku_variant_id.to_writer(__deku_writer, (#id_args))?;
}
}
} else {
return Err(syn::Error::new(
Expand Down
6 changes: 3 additions & 3 deletions examples/enums_catch_all.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ use hexlit::hex;
pub enum DekuTest {
/// A
#[deku(id = "1")]
A = 0,
A,
/// B
#[deku(id = "2")]
B = 1,
B,
/// C
#[deku(id = "3", default)]
C = 2,
C,
}

fn main() {
Expand Down
6 changes: 3 additions & 3 deletions tests/test_catch_all.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ mod test {
pub enum AdvancedRemapping {
/// A
#[deku(id = "1")]
A = 0,
A,
/// B
#[deku(id = "2")]
B = 1,
B,
/// C
#[deku(id = "3", default)]
C = 2,
C,
}

#[test]
Expand Down
10 changes: 5 additions & 5 deletions tests/test_compile/cases/attribute_token_stream.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ error[E0277]: can't compare `{integer}` with `bool`
|
= help: the trait `PartialEq<bool>` is not implemented for `{integer}`
= help: the following other types implement trait `PartialEq<Rhs>`:
isize
i8
f128
f16
f32
f64
i128
i16
i32
i64
i128
usize
u8
and $N others
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
error: DekuRead: `id` cannot be used with arbitrary_enum_discriminant
--> tests/test_compile/cases/id_arbitrary_enum_discriminant.rs:8:5
|
8 | A(u8) = 0,
| ^
40 changes: 40 additions & 0 deletions tests/test_enum.rs
Original file line number Diff line number Diff line change
Expand Up @@ -152,3 +152,43 @@ fn test_id_pat_with_id() {
);
assert_eq!(input, &*v.to_bytes().unwrap());
}

#[test]
fn test_arbitrary() {
#[repr(u8)]
#[derive(DekuRead, DekuWrite, Debug, PartialEq)]
#[deku(id_type = "u8")]
enum Foo {
A(u8) = 0,
B(bool) = 42,
I(Inner) = 12,
N = 10,
}

#[repr(u8)]
#[derive(DekuRead, DekuWrite, Debug, PartialEq)]
#[deku(id_type = "u8")]
enum Inner {
One(u8) = 0,
}

let bytes = [0, 1];
let (_, foo) = Foo::from_bytes((&bytes, 0)).unwrap();
assert_eq!(foo, Foo::A(1));
assert_eq!(bytes, &*foo.to_bytes().unwrap());

let bytes = [42, 1];
let (_, foo) = Foo::from_bytes((&bytes, 0)).unwrap();
assert_eq!(foo, Foo::B(true));
assert_eq!(bytes, &*foo.to_bytes().unwrap());

let bytes = [12, 0, 1];
let (_, foo) = Foo::from_bytes((&bytes, 0)).unwrap();
assert_eq!(foo, Foo::I(Inner::One(1)));
assert_eq!(bytes, &*foo.to_bytes().unwrap());

let bytes = [10];
let (_, foo) = Foo::from_bytes((&bytes, 0)).unwrap();
assert_eq!(foo, Foo::N);
assert_eq!(bytes, &*foo.to_bytes().unwrap());
}
Loading