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.

Sign up for GitHub

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

Allow blocklisting anonymous enums #3067

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Allow blocklisting anonymous enums #3067

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions bindgen-tests/tests/expectations/tests/blocklist-anon-enum.rs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions bindgen-tests/tests/headers/blocklist-anon-enum.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
// bindgen-flags: --blocklist-item 'SHOULD_BE_BLOCKED.*'

enum {
SHOULD_BE_BLOCKED_1,
SHOULD_BE_BLOCKED_2,
SHOULD_BE_BLOCKED_3
};
12 changes: 12 additions & 0 deletions bindgen/codegen/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3594,6 +3594,18 @@ impl CodeGenerator for Enum {
let layout = enum_ty.layout(ctx);
let variation = self.computed_enum_variation(ctx, item);

// blocklist anonymous enums based on variants.
if enum_ty.name().is_none() &&
self.is_matching_enum(
ctx,
&ctx.options().blocklisted_items,
item,
)
{
debug!("Blocklisting anonymous enum.");
return;
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this only block the enum if all variants, and not any are blocklisted? If not, can we document this behavior and why is it useful? thanks.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The behavior of using any variant matches for anonymous enums is not new, and already works when allowlisting anonymous enums, so there is a (probably small) risk that changing the way matching works could break users who are relying on the current behavior for allowlisting.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But you can individually hide variants (via annotations or callbacks), right...

I'd expect allowlisting to work with any and blocklisting to work with all, if that makes sense... But let me know if you disagree, maybe my expectation is flawed somehow?


let repr_translated;
let repr = match self.repr().map(|repr| ctx.resolve_type(repr)) {
Some(repr)
Expand Down
6 changes: 5 additions & 1 deletion bindgen/ir/enum_ty.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,11 @@ impl Enum {
Ok(Enum::new(repr, variants))
}

fn is_matching_enum(
/// Checks if the enum matches any of the regular expressions in `enums`
///
/// For anonymous enums, returns true if any of the enum variants matches
/// any of the regular expressions in `enums`.
pub(crate) fn is_matching_enum(
&self,
ctx: &BindgenContext,
enums: &RegexSet,
Expand Down