Skip to content

Feature 699 constified enum module #741

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

Merged
merged 9 commits into from
Jun 21, 2017
+776 −17
Merged

Feature 699 constified enum module #741

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5762339
Adds `--constified-enum-module` option per #699
tmfink Jun 11, 2017
0826846
Convert comment to a doc comment
tmfink Jun 11, 2017
fb9959a
Add typedef/namespace tests for module const enum
tmfink Jun 14, 2017
977ec6f
Add more constified module enum tests
tmfink Jun 16, 2017
de155b9
Add constified module enum template test
tmfink Jun 16, 2017
5f4b730
Refactor namespace code and test
tmfink Jun 17, 2017
4b10529
Fix recursive aliases to const module enum
tmfink Jun 19, 2017
465e242
Test const mod enum variants shadowing "Type"
tmfink Jun 19, 2017
814d28e
Simplify is_constified_enum_module
tmfink Jun 21, 2017
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
74 changes: 67 additions & 7 deletions src/codegen/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,12 @@ use std::mem;
use std::ops;
use syntax::abi;
use syntax::ast;
use syntax::codemap::{Span, respan};
use syntax::codemap::{DUMMY_SP, Span, respan};
use syntax::ptr::P;

// Name of type defined in constified enum module
pub static CONSTIFIED_ENUM_MODULE_REPR_NAME: &'static str = "Type";

fn root_import_depth(ctx: &BindgenContext, item: &Item) -> usize {
if !ctx.options().enable_cxx_namespaces {
return 0;
Expand Down Expand Up @@ -244,7 +247,6 @@ impl ForeignModBuilder {
}

fn build(self, ctx: &BindgenContext) -> P<ast::Item> {
use syntax::codemap::DUMMY_SP;
P(ast::Item {
ident: ctx.rust_ident(""),
id: ast::DUMMY_NODE_ID,
Expand Down Expand Up @@ -2001,6 +2003,10 @@ enum EnumBuilder<'a> {
aster: P<ast::Item>,
},
Consts { aster: P<ast::Item> },
ModuleConsts {
module_name: &'a str,
module_items: Vec<P<ast::Item>>,
},
}

impl<'a> EnumBuilder<'a> {
Expand All @@ -2010,7 +2016,8 @@ impl<'a> EnumBuilder<'a> {
name: &'a str,
repr: P<ast::Ty>,
bitfield_like: bool,
constify: bool)
constify: bool,
constify_module: bool)
-> Self {
if bitfield_like {
EnumBuilder::Bitfield {
Expand All @@ -2022,8 +2029,20 @@ impl<'a> EnumBuilder<'a> {
.build(),
}
} else if constify {
EnumBuilder::Consts {
aster: aster.type_(name).build_ty(repr),
if constify_module {
let type_definition = aster::item::ItemBuilder::new()
.pub_()
.type_(CONSTIFIED_ENUM_MODULE_REPR_NAME)
.build_ty(repr);

EnumBuilder::ModuleConsts {
module_name: name,
module_items: vec![type_definition],
}
} else {
EnumBuilder::Consts {
aster: aster.type_(name).build_ty(repr),
}
}
} else {
EnumBuilder::Rust(aster.enum_(name))
Expand Down Expand Up @@ -2095,6 +2114,27 @@ impl<'a> EnumBuilder<'a> {
result.push(constant);
self
}
EnumBuilder::ModuleConsts { module_name, module_items, .. } => {
// Variant type
let inside_module_type =
aster::AstBuilder::new().ty().id(CONSTIFIED_ENUM_MODULE_REPR_NAME);

let constant = aster::AstBuilder::new()
.item()
.pub_()
.const_(&*variant_name)
.expr()
.build(expr)
.build(inside_module_type.clone());

let mut module_items = module_items.clone();
module_items.push(constant);

EnumBuilder::ModuleConsts {
module_name,
module_items,
}
}
}
}

Expand Down Expand Up @@ -2160,6 +2200,22 @@ impl<'a> EnumBuilder<'a> {
aster
}
EnumBuilder::Consts { aster, .. } => aster,
EnumBuilder::ModuleConsts { module_items, module_name, .. } => {
// Create module item with type and variant definitions
let module_item = P(ast::Item {
ident: ast::Ident::from_str(module_name),
attrs: vec![],
id: ast::DUMMY_NODE_ID,
node: ast::ItemKind::Mod(ast::Mod {
inner: DUMMY_SP,
items: module_items,
}),
vis: ast::Visibility::Public,
span: DUMMY_SP,
});

module_item
}
}
}
}
Expand Down Expand Up @@ -2225,7 +2281,10 @@ impl CodeGenerator for Enum {
.any(|v| ctx.options().bitfield_enums.matches(&v.name())))
};

let is_constified_enum = {
let is_constified_enum_module = self.is_constified_enum_module(ctx, item);

let is_constified_enum = {
is_constified_enum_module ||
ctx.options().constified_enums.matches(&name) ||
(enum_ty.name().is_none() &&
self.variants()
Expand Down Expand Up @@ -2300,7 +2359,8 @@ impl CodeGenerator for Enum {
&name,
repr,
is_bitfield,
is_constified_enum);
is_constified_enum,
is_constified_enum_module);

// A map where we keep a value -> variant relation.
let mut seen_values = HashMap::<_, String>::new();
Expand Down
15 changes: 15 additions & 0 deletions src/ir/enum_ty.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,14 @@ use super::item::Item;
use super::ty::TypeKind;
use clang;
use ir::annotations::Annotations;
use ir::item::ItemCanonicalName;
use parse::{ClangItemParser, ParseError};

/// An enum representing custom handling that can be given to a variant.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum EnumVariantCustomBehavior {
/// This variant will be a module containing constants.
ModuleConstify,
/// This variant will be constified, that is, forced to generate a constant.
Constify,
/// This variant will be hidden entirely from the resulting enum.
Expand Down Expand Up @@ -121,6 +124,18 @@ impl Enum {
});
Ok(Enum::new(repr, variants))
}

/// Whether the enum should be an constified enum module
pub fn is_constified_enum_module(&self, ctx: &BindgenContext, item: &Item) -> bool {
let name = item.canonical_name(ctx);
let enum_ty = item.expect_type();

ctx.options().constified_enum_modules.matches(&name) ||
(enum_ty.name().is_none() &&
self.variants()
.iter()
.any(|v| ctx.options().constified_enum_modules.matches(&v.name())))
}
}

/// A single enum variant, to be contained only in an enum.
Expand Down
68 changes: 62 additions & 6 deletions src/ir/item.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
//! Bindgen's core intermediate representation type.

use super::super::codegen::CONSTIFIED_ENUM_MODULE_REPR_NAME;
use super::annotations::Annotations;
use super::context::{BindgenContext, ItemId, PartialType};
use super::derive::{CanDeriveCopy, CanDeriveDebug, CanDeriveDefault};
Expand Down Expand Up @@ -825,6 +826,50 @@ impl Item {
_ => None,
}
}

/// Returns whether the item is a constified module enum
fn is_constified_enum_module(&self, ctx: &BindgenContext) -> bool {
Copy link
Contributor

Choose a reason for hiding this comment

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

So what you're trying to do here is resolving through ResolvedTypeRefs, but not through Alias, right?

If so, instead of reinventing the wheel, you can do something like:

self.id.into_resolver()
    .through_type_refs()
    .resolve(ctx)

And keep the comment on why not through type alias.

We should arguably unify that and the canonical_type business, but that also handles some template stuff that may be nontrivial, so it's worth doing on a followup.

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 check needs to "peel back" one layer of Aliases. The issue with the resolve() function is that it resolves through all of the Aliases.

I think that implementation should remain as is.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm... I see. I guess I'm not sure why would making an alias claim it's a constified enum module be necessary.

I guess I'll poke a bit at the code this evening when I have the chance and see which tests break with that.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm... Ok, so what breaks in that case is the typedef enum case... fun. I still think we should be able to do better, though...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What about modifying ItemResolver to optionally disable recursive resolving? More generally, ItemResolver could even take a positive integer indicating through how many layers to resolve.

This way, is_constified_enum_module() could be simplified to use ItemResolver.

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this is about the number of layers to resolve. I think the logic in is_constified_enum_module is wrong, and the "alias to resolved type ref to alias" logic is just masking it.

Copy link
Contributor

Choose a reason for hiding this comment

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

Here's what I came up with, I think this is what you're really trying to do with that function:

    /// Returns whether the item is a constified module enum.
    fn is_constified_enum_module(&self, ctx: &BindgenContext) -> bool {
        // Do not jump through aliases, except for aliases that point to a type
        // with the same name, since we don't generate code for them.
        let item = self.id.into_resolver().through_type_refs().resolve(ctx);
        let type_ = match *item.kind() {
            ItemKind::Type(ref type_) => type_,
            _ => return false,
        };

        match *type_.kind() {
            TypeKind::Enum(ref enum_) => {
                enum_.is_constified_enum_module(ctx, self)
            }
            TypeKind::Alias(inner) => {
                // TODO(emilio): Make this "hop through type aliases that aren't
                // really generated" an option in `ItemResolver`?
                let inner_item = ctx.resolve_item(inner);
                let name = item.canonical_name(ctx);

                if inner_item.canonical_name(ctx) != name {
                    return false;
                }

                return inner_item.is_constified_enum_module(ctx)
            }
            _ => false,
        }
    }

Copy link
Contributor

Choose a reason for hiding this comment

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

Feel free to address the TODO if you want, btw :)

if let ItemKind::Type(ref type_) = self.kind {
// Do not count an "alias of an alias" as a constified module enum;
// otherwise, we will get:
// pub mod foo {
// pub type Type = ::std::os::raw::c_uint;
// ...
// }
// pub use foo::Type as foo_alias1;
// pub use foo_alias1::Type as foo_alias2;
// pub use foo_alias2::Type as foo_alias3;
// ...
//
// (We do not want the '::Type' appended to the alias types; only the base type)
if let TypeKind::Alias(inner_id) = *type_.kind() {
let inner_item = ctx.resolve_item(inner_id);
if let ItemKind::Type(ref inner_type) = *inner_item.kind() {
match *inner_type.kind() {
TypeKind::Alias(..) => { return false; }
TypeKind::ResolvedTypeRef(resolved_id) => {
// We need to handle:
// Alias -> ResolvedTypeRef -> Alias
let resolved_item = ctx.resolve_item(resolved_id);
if let ItemKind::Type(ref resolved_type) = *resolved_item.kind() {
if let TypeKind::Alias(..) = *resolved_type.kind() {
return false;
}
}
}
_ => (),
}
}
}
if let Some(ref type_) = type_.safe_canonical_type(ctx) {
if let TypeKind::Enum(ref enum_) = *type_.kind() {
return enum_.is_constified_enum_module(ctx, self);
}
}
}

return false;
}
}

/// A set of items.
Expand Down Expand Up @@ -1443,14 +1488,25 @@ impl ItemCanonicalPath for Item {
fn namespace_aware_canonical_path(&self,
ctx: &BindgenContext)
-> Vec<String> {
let path = self.canonical_path(ctx);
if ctx.options().enable_cxx_namespaces {
return path;
}
let mut path = self.canonical_path(ctx);

// ASSUMPTION: (disable_name_namespacing && cxx_namespaces)
// is equivalent to
// disable_name_namespacing
if ctx.options().disable_name_namespacing {
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this branch is correct.

return vec![path.last().unwrap().clone()];
// Only keep the last item in path
let split_idx = path.len() - 1;
path = path.split_off(split_idx);
} else if !ctx.options().enable_cxx_namespaces {
// Ignore first item "root"
path = vec![path[1..].join("_")];
}
return vec![path[1..].join("_")];

if self.is_constified_enum_module(ctx) {
path.push(CONSTIFIED_ENUM_MODULE_REPR_NAME.into());
}

return path;
}

fn canonical_path(&self, ctx: &BindgenContext) -> Vec<String> {
Expand Down
29 changes: 27 additions & 2 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,16 @@ impl Builder {
})
.count();

self.options
.constified_enum_modules
.get_items()
.iter()
.map(|item| {
output_vector.push("--constified-enum-module".into());
output_vector.push(item.trim_left_matches("^").trim_right_matches("$").into());
})
.count();

self.options
.hidden_types
.get_items()
Expand Down Expand Up @@ -562,8 +572,8 @@ impl Builder {
self
}

/// Mark the given enum (or set of enums, if using a pattern) as being
/// constant.
/// Mark the given enum (or set of enums, if using a pattern) as a set of
/// constants.
///
/// This makes bindgen generate constants instead of enums. Regular
/// expressions are supported.
Expand All @@ -572,6 +582,16 @@ impl Builder {
self
}

/// Mark the given enum (or set of enums, if using a pattern) as a set of
/// constants that should be put into a module.
///
/// This makes bindgen generate a modules containing constants instead of
/// enums. Regular expressions are supported.
pub fn constified_enum_module<T: AsRef<str>>(mut self, arg: T) -> Builder {
self.options.constified_enum_modules.insert(arg);
self
}

/// Add a string to prepend to the generated bindings. The string is passed
/// through without any modification.
pub fn raw_line<T: Into<String>>(mut self, arg: T) -> Builder {
Expand Down Expand Up @@ -813,6 +833,9 @@ pub struct BindgenOptions {
/// The enum patterns to mark an enum as constant.
pub constified_enums: RegexSet,

/// The enum patterns to mark an enum as a module of constants.
pub constified_enum_modules: RegexSet,

/// Whether we should generate builtins or not.
pub builtins: bool,

Expand Down Expand Up @@ -935,6 +958,7 @@ impl BindgenOptions {
self.hidden_types.build();
self.opaque_types.build();
self.bitfield_enums.build();
self.constified_enum_modules.build();
self.constified_enums.build();
}
}
Expand All @@ -949,6 +973,7 @@ impl Default for BindgenOptions {
whitelisted_vars: Default::default(),
bitfield_enums: Default::default(),
constified_enums: Default::default(),
constified_enum_modules: Default::default(),
builtins: false,
links: vec![],
emit_ast: false,
Expand Down
18 changes: 16 additions & 2 deletions src/options.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,15 @@ pub fn builder_from_flags<I>
.takes_value(true)
.multiple(true)
.number_of_values(1),
Arg::with_name("constified-enum-module")
.long("constified-enum-module")
.help("Mark any enum whose name matches <regex> as a module of \
constants instead of an enumeration. This option \
implies \"--constified-enum.\"")
.value_name("regex")
.takes_value(true)
.multiple(true)
.number_of_values(1),
Arg::with_name("blacklist-type")
.long("blacklist-type")
.help("Mark <type> as hidden.")
Expand Down Expand Up @@ -222,12 +231,17 @@ pub fn builder_from_flags<I>
}
}

if let Some(bitfields) = matches.values_of("constified-enum") {
for regex in bitfields {
if let Some(constifieds) = matches.values_of("constified-enum") {
for regex in constifieds {
builder = builder.constified_enum(regex);
}
}

if let Some(constified_mods) = matches.values_of("constified-enum-module") {
for regex in constified_mods {
builder = builder.constified_enum_module(regex);
}
}
if let Some(hidden_types) = matches.values_of("blacklist-type") {
for ty in hidden_types {
builder = builder.hide_type(ty);
Expand Down
Loading