Support bool literal as enum id

wcampbell0x2a · wcampbell0x2a · commit eb5b6689e346 · 2024-09-04T08:48:51.000-04:00
diff --git a/deku-derive/src/lib.rs b/deku-derive/src/lib.rs
@@ -25,6 +25,7 @@ enum Id {
     TokenStream(TokenStream),
     LitByteStr(syn::LitByteStr),
     Int(syn::LitInt),
+    Bool(syn::LitBool),
 }
 
 impl Display for Id {
@@ -39,6 +40,7 @@ impl ToTokens for Id {
             Id::TokenStream(v) => v.to_tokens(tokens),
             Id::LitByteStr(v) => v.to_tokens(tokens),
             Id::Int(v) => v.to_tokens(tokens),
+            Id::Bool(v) => v.to_tokens(tokens),
         }
     }
 }
@@ -53,6 +55,7 @@ impl FromMeta for Id {
                     .expect("could not parse token stream"),
             )),
             syn::Lit::Int(ref s) => Ok(Id::Int(s.clone())),
+            syn::Lit::Bool(ref s) => Ok(Id::Bool(s.clone())),
             syn::Lit::ByteStr(ref s) => Ok(Id::LitByteStr(s.clone())),
             _ => Err(darling::Error::unexpected_lit_type(value)),
         })
diff --git a/deku-derive/src/macros/deku_read.rs b/deku-derive/src/macros/deku_read.rs
@@ -232,6 +232,7 @@ fn emit_enum(input: &DekuData) -> Result<TokenStream, syn::Error> {
                 Id::TokenStream(v) => (false, quote! {&#v}.into_token_stream()),
                 Id::LitByteStr(v) => (false, v.into_token_stream()),
                 Id::Int(v) => (false, v.into_token_stream()),
+                Id::Bool(v) => (false, v.into_token_stream()),
             }
         } else if let Some(variant_id_pat) = &variant.id_pat {
             // If user has supplied an id, then we have an id_pat that and the id variant doesn't
@@ -284,6 +285,7 @@ fn emit_enum(input: &DekuData) -> Result<TokenStream, syn::Error> {
                 let deref = match variant_id {
                     Id::TokenStream(_) => quote! {},
                     Id::Int(_) => quote! {},
+                    Id::Bool(_) => quote! {},
                     Id::LitByteStr(_) => quote! {*},
                 };
 
diff --git a/deku-derive/src/macros/deku_write.rs b/deku-derive/src/macros/deku_write.rs
@@ -231,6 +231,12 @@ fn emit_enum(input: &DekuData) -> Result<TokenStream, syn::Error> {
                             __deku_variant_id.to_writer(__deku_writer, (#id_args))?;
                         }
                     }
+                    Id::Bool(v) => {
+                        quote! {
+                            let mut __deku_variant_id: #id_type = #v;
+                            __deku_variant_id.to_writer(__deku_writer, (#id_args))?;
+                        }
+                    }
                     Id::LitByteStr(v) => {
                         quote! {
                             let mut __deku_variant_id: #id_type = *#v;
diff --git a/tests/test_enum.rs b/tests/test_enum.rs
@@ -155,3 +155,47 @@ fn test_id_pat_with_id() {
     );
     assert_eq!(input, &*v.to_bytes().unwrap());
 }
+
+#[test]
+fn test_litbool_as_id() {
+    use deku::prelude::*;
+
+    #[derive(DekuRead, DekuWrite, Debug, PartialEq, Eq)]
+    pub struct A {
+        #[deku(bits = 1)]
+        bit: bool,
+        #[deku(ctx = "*bit")]
+        var: Var,
+    }
+
+    #[derive(DekuRead, DekuWrite, Debug, PartialEq, Eq)]
+    #[deku(id = "bit", ctx = "bit: bool")]
+    pub enum Var {
+        #[deku(id = false)]
+        False(#[deku(bits = 15)] u16),
+        #[deku(id = true)]
+        True(#[deku(bits = 15)] u16),
+    }
+    let input = [0b1000_0000, 0xff];
+    let mut cursor = Cursor::new(input);
+    let (_, v) = A::from_reader((&mut cursor, 0)).unwrap();
+    assert_eq!(
+        v,
+        A {
+            bit: true,
+            var: Var::True(0x7f01),
+        }
+    );
+    assert_eq!(input, &*v.to_bytes().unwrap());
+    let input = [0b0000_0000, 0xff];
+    let mut cursor = Cursor::new(input);
+    let (_, v) = A::from_reader((&mut cursor, 0)).unwrap();
+    assert_eq!(
+        v,
+        A {
+            bit: false,
+            var: Var::False(0x7f01),
+        }
+    );
+    assert_eq!(input, &*v.to_bytes().unwrap());
+}

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ enum Id {`
`25`	`25`	`TokenStream(TokenStream),`
`26`	`26`	`LitByteStr(syn::LitByteStr),`
`27`	`27`	`Int(syn::LitInt),`
	`28`	`+ Bool(syn::LitBool),`
`28`	`29`	`}`
`29`	`30`
`30`	`31`	`impl Display for Id {`
`@@ -39,6 +40,7 @@ impl ToTokens for Id {`
`39`	`40`	`Id::TokenStream(v) => v.to_tokens(tokens),`
`40`	`41`	`Id::LitByteStr(v) => v.to_tokens(tokens),`
`41`	`42`	`Id::Int(v) => v.to_tokens(tokens),`
	`43`	`+ Id::Bool(v) => v.to_tokens(tokens),`
`42`	`44`	`}`
`43`	`45`	`}`
`44`	`46`	`}`
`@@ -53,6 +55,7 @@ impl FromMeta for Id {`
`53`	`55`	`.expect("could not parse token stream"),`
`54`	`56`	`)),`
`55`	`57`	`syn::Lit::Int(ref s) => Ok(Id::Int(s.clone())),`
	`58`	`+ syn::Lit::Bool(ref s) => Ok(Id::Bool(s.clone())),`
`56`	`59`	`syn::Lit::ByteStr(ref s) => Ok(Id::LitByteStr(s.clone())),`
`57`	`60`	`_ => Err(darling::Error::unexpected_lit_type(value)),`
`58`	`61`	`})`
Original file line number	Diff line number	Diff line change
`@@ -231,6 +231,12 @@ fn emit_enum(input: &DekuData) -> Result<TokenStream, syn::Error> {`
`231`	`231`	`__deku_variant_id.to_writer(__deku_writer, (#id_args))?;`
`232`	`232`	`}`
`233`	`233`	`}`
	`234`	`+ Id::Bool(v) => {`
	`235`	`+ quote! {`
	`236`	`+ let mut __deku_variant_id: #id_type = #v;`
	`237`	`+ __deku_variant_id.to_writer(__deku_writer, (#id_args))?;`
	`238`	`+ }`
	`239`	`+ }`
`234`	`240`	`Id::LitByteStr(v) => {`
`235`	`241`	`quote! {`
`236`	`242`	`let mut __deku_variant_id: #id_type = *#v;`