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

Add --no-hash <regex> flag #1105

Merged
merged 1 commit into from Oct 27, 2017
Merged
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
4 changes: 4 additions & 0 deletions src/ir/analysis/derive_hash.rs
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,10 @@ impl<'ctx> MonotoneFramework for CannotDeriveHash<'ctx> {
}
};

if self.ctx.no_hash_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_hash()
Expand Down
6 changes: 6 additions & 0 deletions src/ir/context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2495,6 +2495,12 @@ impl BindgenContext {
let name = item.canonical_path(self)[1..].join("::");
self.options().no_copy_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("::");
self.options().no_hash_types.matches(&name)
}
}

/// A builder struct for configuring item resolution options.
Expand Down
26 changes: 26 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -536,6 +536,20 @@ impl Builder {
})
.count();

self.options
.no_hash_types
.get_items()
.iter()
.map(|item| {
output_vector.push("--no-hash".into());
output_vector.push(
item.trim_left_matches("^")
.trim_right_matches("$")
.into(),
);
})
.count();

output_vector
}

Expand Down Expand Up @@ -1179,6 +1193,13 @@ impl Builder {
self.options.no_copy_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 {
self.options.no_hash_types.insert(arg);
self
}
}

/// Configuration options for generated bindings.
Expand Down Expand Up @@ -1369,6 +1390,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 `Hash` for.
no_hash_types: RegexSet,
}

/// TODO(emilio): This is sort of a lie (see the error message that results from
Expand All @@ -1388,6 +1412,7 @@ impl BindgenOptions {
self.rustified_enums.build();
self.no_partialeq_types.build();
self.no_copy_types.build();
self.no_hash_types.build();
}

/// Update rust target version
Expand Down Expand Up @@ -1460,6 +1485,7 @@ impl Default for BindgenOptions {
rustfmt_configuration_file: None,
no_partialeq_types: Default::default(),
no_copy_types: Default::default(),
no_hash_types: Default::default(),
}
}
}
Expand Down
13 changes: 13 additions & 0 deletions src/options.rs
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,13 @@ where
.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>.")
.value_name("regex")
.takes_value(true)
.multiple(true)
.number_of_values(1),
]) // .args()
.get_matches_from(args);

Expand Down Expand Up @@ -592,6 +599,12 @@ where
}
}

if let Some(no_hash) = matches.values_of("no-hash") {
for regex in no_hash {
builder = builder.no_hash(String::from(regex));
}
}

let verbose = matches.is_present("verbose");

Ok((builder, output, verbose))
Expand Down
24 changes: 24 additions & 0 deletions tests/expectations/tests/no-hash-opaque.rs
Original file line number Diff line number Diff line change
@@ -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(Debug, Default, Copy, Clone)]
pub struct NoHash {
pub _bindgen_opaque_blob: u32,
}
#[test]
fn bindgen_test_layout_NoHash() {
assert_eq!(
::std::mem::size_of::<NoHash>(),
4usize,
concat!("Size of: ", stringify!(NoHash))
);
assert_eq!(
::std::mem::align_of::<NoHash>(),
4usize,
concat!("Alignment of ", stringify!(NoHash))
);
}
34 changes: 34 additions & 0 deletions tests/expectations/tests/no-hash-whitelisted.rs
Original file line number Diff line number Diff line change
@@ -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(Debug, Default, Copy, Clone)]
pub struct NoHash {
pub i: ::std::os::raw::c_int,
}
#[test]
fn bindgen_test_layout_NoHash() {
assert_eq!(
::std::mem::size_of::<NoHash>(),
4usize,
concat!("Size of: ", stringify!(NoHash))
);
assert_eq!(
::std::mem::align_of::<NoHash>(),
4usize,
concat!("Alignment of ", stringify!(NoHash))
);
assert_eq!(
unsafe { &(*(0 as *const NoHash)).i as *const _ as usize },
0usize,
concat!(
"Alignment of field: ",
stringify!(NoHash),
"::",
stringify!(i)
)
);
}
52 changes: 52 additions & 0 deletions tests/expectations/tests/whitelisted-item-references-no-hash.rs
Original file line number Diff line number Diff line change
@@ -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(Debug, Default, Copy, Clone)]
pub struct NoHash {
pub _address: u8,
}
#[test]
fn bindgen_test_layout_NoHash() {
assert_eq!(
::std::mem::size_of::<NoHash>(),
1usize,
concat!("Size of: ", stringify!(NoHash))
);
assert_eq!(
::std::mem::align_of::<NoHash>(),
1usize,
concat!("Alignment of ", stringify!(NoHash))
);
}
#[repr(C)]
#[derive(Debug, Default, Copy, Clone)]
pub struct WhitelistMe {
pub a: NoHash,
}
#[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 { &(*(0 as *const WhitelistMe)).a as *const _ as usize },
0usize,
concat!(
"Alignment of field: ",
stringify!(WhitelistMe),
"::",
stringify!(a)
)
);
}
5 changes: 5 additions & 0 deletions tests/headers/no-hash-opaque.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// bindgen-flags: --with-derive-hash --opaque-type "NoHash" --no-hash "NoHash"

class NoHash {
int i;
};
5 changes: 5 additions & 0 deletions tests/headers/no-hash-whitelisted.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// bindgen-flags: --with-derive-hash --whitelist-type "NoHash" --no-hash "NoHash"

class NoHash {
int i;
};
7 changes: 7 additions & 0 deletions tests/headers/whitelisted-item-references-no-hash.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
// bindgen-flags: --with-derive-hash --whitelist-type "WhitelistMe" --no-hash "NoHash"

struct NoHash {};

class WhitelistMe {
NoHash a;
};