[Close rust-lang#961] Add --no-debug <regex> flag

Author: ivanovaleksey

src/ir/analysis/derive_debug.rs

@@ -144,6 +144,10 @@ impl<'ctx> MonotoneFramework for CannotDeriveDebug<'ctx> {
             }
         };
 
+        if self.ctx.no_debug_by_name(&item) {
+            return self.insert(id);
+        }
+
         if item.is_opaque(self.ctx, &()) {
             let layout_can_derive = ty.layout(self.ctx).map_or(true, |l| {
                 l.opaque().can_trivially_derive_debug()

src/ir/context.rs

@@ -2500,6 +2500,12 @@ impl BindgenContext {
         self.options().no_copy_types.matches(&name)
     }
 
+    /// Check if `--no-debug` flag is enabled for this item.
+    pub fn no_debug_by_name(&self, item: &Item) -> bool {
+        let name = item.canonical_path(self)[1..].join("::");
+        self.options().no_debug_types.matches(&name)
+    }
+
     /// Chech if `--no-hash` flag is enabled for this item.
     pub fn no_hash_by_name(&self, item: &Item) -> bool {
         let name = item.canonical_path(self)[1..].join("::");

src/lib.rs

@@ -538,6 +538,20 @@ impl Builder {
             })
             .count();
 
+        self.options
+            .no_debug_types
+            .get_items()
+            .iter()
+            .map(|item| {
+                output_vector.push("--no-debug".into());
+                output_vector.push(
+                    item.trim_left_matches("^")
+                        .trim_right_matches("$")
+                        .into(),
+                );
+            })
+            .count();
+
         self.options
             .no_hash_types
             .get_items()
@@ -1196,6 +1210,13 @@ impl Builder {
         self
     }
 
+    /// Don't derive `Debug` for a given type. Regular
+    /// expressions are supported.
+    pub fn no_debug(mut self, arg: String) -> Self {
+        self.options.no_debug_types.insert(arg);
+        self
+    }
+
     /// Don't derive `Hash` for a given type. Regular
     /// expressions are supported.
     pub fn no_hash(mut self, arg: String) -> Builder {
@@ -1384,7 +1405,6 @@ struct BindgenOptions {
 
     /// The absolute path to the rustfmt configuration file, if None, the standard rustfmt
     /// options are used.
-
     rustfmt_configuration_file: Option<PathBuf>,
 
     /// The set of types that we should not derive `PartialEq` for.
@@ -1393,6 +1413,9 @@ struct BindgenOptions {
     /// The set of types that we should not derive `Copy` for.
     no_copy_types: RegexSet,
 
+    /// The set of types that we should not derive `Debug` for.
+    no_debug_types: RegexSet,
+
     /// The set of types that we should not derive `Hash` for.
     no_hash_types: RegexSet,
 }
@@ -1414,6 +1437,7 @@ impl BindgenOptions {
         self.rustified_enums.build();
         self.no_partialeq_types.build();
         self.no_copy_types.build();
+        self.no_debug_types.build();
         self.no_hash_types.build();
     }
 
@@ -1487,6 +1511,7 @@ impl Default for BindgenOptions {
             rustfmt_configuration_file: None,
             no_partialeq_types: Default::default(),
             no_copy_types: Default::default(),
+            no_debug_types: Default::default(),
             no_hash_types: Default::default(),
         }
     }

src/options.rs

@@ -292,6 +292,13 @@ where
                 .takes_value(true)
                 .multiple(true)
                 .number_of_values(1),
+            Arg::with_name("no-debug")
+                .long("no-debug")
+                .help("Avoid deriving Debug for types matching <regex>.")
+                .value_name("regex")
+                .takes_value(true)
+                .multiple(true)
+                .number_of_values(1),
             Arg::with_name("no-hash")
                 .long("no-hash")
                 .help("Avoid deriving Hash for types matching <regex>.")
@@ -599,6 +606,12 @@ where
         }
     }
 
+    if let Some(no_debug) = matches.values_of("no-debug") {
+        for regex in no_debug {
+            builder = builder.no_debug(String::from(regex));
+        }
+    }
+
     if let Some(no_hash) = matches.values_of("no-hash") {
         for regex in no_hash {
             builder = builder.no_hash(String::from(regex));

tests/expectations/tests/no-debug-opaque.rs

@@ -0,0 +1,24 @@
+/* automatically generated by rust-bindgen */
+
+
+#![allow(dead_code, non_snake_case, non_camel_case_types, non_upper_case_globals)]
+
+
+#[repr(C)]
+#[derive(Default, Copy, Clone)]
+pub struct NoDebug {
+    pub _bindgen_opaque_blob: u32,
+}
+#[test]
+fn bindgen_test_layout_NoDebug() {
+    assert_eq!(
+        ::std::mem::size_of::<NoDebug>(),
+        4usize,
+        concat!("Size of: ", stringify!(NoDebug))
+    );
+    assert_eq!(
+        ::std::mem::align_of::<NoDebug>(),
+        4usize,
+        concat!("Alignment of ", stringify!(NoDebug))
+    );
+}

tests/expectations/tests/no-debug-whitelisted.rs

@@ -0,0 +1,34 @@
+/* automatically generated by rust-bindgen */
+
+
+#![allow(dead_code, non_snake_case, non_camel_case_types, non_upper_case_globals)]
+
+
+#[repr(C)]
+#[derive(Default, Copy, Clone)]
+pub struct NoDebug {
+    pub i: ::std::os::raw::c_int,
+}
+#[test]
+fn bindgen_test_layout_NoDebug() {
+    assert_eq!(
+        ::std::mem::size_of::<NoDebug>(),
+        4usize,
+        concat!("Size of: ", stringify!(NoDebug))
+    );
+    assert_eq!(
+        ::std::mem::align_of::<NoDebug>(),
+        4usize,
+        concat!("Alignment of ", stringify!(NoDebug))
+    );
+    assert_eq!(
+        unsafe { &(*(::std::ptr::null::<NoDebug>())).i as *const _ as usize },
+        0usize,
+        concat!(
+            "Offset of field: ",
+            stringify!(NoDebug),
+            "::",
+            stringify!(i)
+        )
+    );
+}

tests/expectations/tests/whitelisted-item-references-no-debug.rs

@@ -0,0 +1,52 @@
+/* automatically generated by rust-bindgen */
+
+
+#![allow(dead_code, non_snake_case, non_camel_case_types, non_upper_case_globals)]
+
+
+#[repr(C)]
+#[derive(Default, Copy, Clone)]
+pub struct NoDebug {
+    pub _address: u8,
+}
+#[test]
+fn bindgen_test_layout_NoDebug() {
+    assert_eq!(
+        ::std::mem::size_of::<NoDebug>(),
+        1usize,
+        concat!("Size of: ", stringify!(NoDebug))
+    );
+    assert_eq!(
+        ::std::mem::align_of::<NoDebug>(),
+        1usize,
+        concat!("Alignment of ", stringify!(NoDebug))
+    );
+}
+#[repr(C)]
+#[derive(Default, Copy, Clone)]
+pub struct WhitelistMe {
+    pub a: NoDebug,
+}
+#[test]
+fn bindgen_test_layout_WhitelistMe() {
+    assert_eq!(
+        ::std::mem::size_of::<WhitelistMe>(),
+        1usize,
+        concat!("Size of: ", stringify!(WhitelistMe))
+    );
+    assert_eq!(
+        ::std::mem::align_of::<WhitelistMe>(),
+        1usize,
+        concat!("Alignment of ", stringify!(WhitelistMe))
+    );
+    assert_eq!(
+        unsafe { &(*(::std::ptr::null::<WhitelistMe>())).a as *const _ as usize },
+        0usize,
+        concat!(
+            "Offset of field: ",
+            stringify!(WhitelistMe),
+            "::",
+            stringify!(a)
+        )
+    );
+}

tests/headers/no-debug-opaque.hpp

@@ -0,0 +1,5 @@
+// bindgen-flags: --opaque-type "NoDebug" --no-debug "NoDebug"
+
+class NoDebug {
+  int i;
+};

tests/headers/no-debug-whitelisted.hpp

@@ -0,0 +1,5 @@
+// bindgen-flags: --whitelist-type "NoDebug" --no-debug "NoDebug"
+
+class NoDebug {
+  int i;
+};

tests/headers/whitelisted-item-references-no-debug.hpp

@@ -0,0 +1,7 @@
+// bindgen-flags: --whitelist-type "WhitelistMe" --no-debug "NoDebug"
+
+struct NoDebug {};
+
+class WhitelistMe {
+  NoDebug a;
+};