Use annotations on enumerations: This enables users to add additional derives, or prevent deriving traits

Fixes #2076

Author: VeaaC

src/codegen/mod.rs

@@ -3010,16 +3010,26 @@ impl CodeGenerator for Enum {
 
         if !variation.is_const() {
             let mut derives = derives_of_item(item, ctx);
-            // For backwards compat, enums always derive Clone/Eq/PartialEq/Hash, even
+            // For backwards compat, enums always derive Debug/Clone/Eq/PartialEq/Hash, even
             // if we don't generate those by default.
+            if !item.annotations().disallow_debug() {
+                derives.insert(DerivableTraits::DEBUG);
+            }
+            if !item.annotations().disallow_copy() {
+                derives.insert(DerivableTraits::COPY);
+            }
             derives.insert(
                 DerivableTraits::CLONE |
-                    DerivableTraits::COPY |
                     DerivableTraits::HASH |
                     DerivableTraits::PARTIAL_EQ |
                     DerivableTraits::EQ,
             );
-            let derives: Vec<_> = derives.into();
+            let mut derives: Vec<_> = derives.into();
+            for derive in item.annotations().derives().iter() {
+                if !derives.contains(&derive.as_str()) {
+                    derives.push(&derive);
+                }
+            }
             attrs.push(attributes::derives(&derives));
         }
 

tests/expectations/tests/enum-default-bitfield.rs

@@ -149,3 +149,39 @@ impl ::std::ops::BitAndAssign for NoDebug {
 /// <div rustbindgen nodebug></div>
 #[derive(Copy, Clone, Hash, PartialEq, Eq)]
 pub struct NoDebug(pub ::std::os::raw::c_uint);
+impl Debug {
+    pub const Debug1: Debug = Debug(0);
+}
+impl Debug {
+    pub const Debug2: Debug = Debug(1);
+}
+impl ::std::ops::BitOr<Debug> for Debug {
+    type Output = Self;
+    #[inline]
+    fn bitor(self, other: Self) -> Self {
+        Debug(self.0 | other.0)
+    }
+}
+impl ::std::ops::BitOrAssign for Debug {
+    #[inline]
+    fn bitor_assign(&mut self, rhs: Debug) {
+        self.0 |= rhs.0;
+    }
+}
+impl ::std::ops::BitAnd<Debug> for Debug {
+    type Output = Self;
+    #[inline]
+    fn bitand(self, other: Self) -> Self {
+        Debug(self.0 & other.0)
+    }
+}
+impl ::std::ops::BitAndAssign for Debug {
+    #[inline]
+    fn bitand_assign(&mut self, rhs: Debug) {
+        self.0 &= rhs.0;
+    }
+}
+#[repr(transparent)]
+/// <div rustbindgen derive="Debug"></div>
+#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
+pub struct Debug(pub ::std::os::raw::c_uint);

tests/expectations/tests/enum-default-consts.rs

@@ -57,3 +57,7 @@ pub const NoDebug_NoDebug1: NoDebug = 0;
 pub const NoDebug_NoDebug2: NoDebug = 1;
 /// <div rustbindgen nodebug></div>
 pub type NoDebug = ::std::os::raw::c_uint;
+pub const Debug_Debug1: Debug = 0;
+pub const Debug_Debug2: Debug = 1;
+/// <div rustbindgen derive="Debug"></div>
+pub type Debug = ::std::os::raw::c_uint;

tests/expectations/tests/enum-default-module.rs

@@ -63,3 +63,9 @@ pub mod NoDebug {
     pub const NoDebug1: Type = 0;
     pub const NoDebug2: Type = 1;
 }
+pub mod Debug {
+    /// <div rustbindgen derive="Debug"></div>
+    pub type Type = ::std::os::raw::c_uint;
+    pub const Debug1: Type = 0;
+    pub const Debug2: Type = 1;
+}

tests/expectations/tests/enum-default-rust.rs

@@ -68,3 +68,10 @@ pub enum NoDebug {
     NoDebug1 = 0,
     NoDebug2 = 1,
 }
+#[repr(u32)]
+/// <div rustbindgen derive="Debug"></div>
+#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
+pub enum Debug {
+    Debug1 = 0,
+    Debug2 = 1,
+}

tests/expectations/tests/enum.rs

@@ -55,3 +55,7 @@ pub const NoDebug_NoDebug1: NoDebug = 0;
 pub const NoDebug_NoDebug2: NoDebug = 1;
 /// <div rustbindgen nodebug></div>
 pub type NoDebug = ::std::os::raw::c_uint;
+pub const Debug_Debug1: Debug = 0;
+pub const Debug_Debug2: Debug = 1;
+/// <div rustbindgen derive="Debug"></div>
+pub type Debug = ::std::os::raw::c_uint;

tests/headers/enum.h

@@ -23,3 +23,9 @@ enum NoDebug {
     NoDebug1,
     NoDebug2,
 };
+
+/** <div rustbindgen derive="Debug"></div> */
+enum Debug {
+    Debug1,
+    Debug2,
+};