Rewrite the core of the binding generator.

TL;DR: The binding generator is a mess as of right now. At first it was funny
(in a "this is challenging" sense) to improve on it, but this is not
sustainable.

The truth is that the current architecture of the binding generator is a huge
pile of hacks, so these few days I've been working on rewriting it with a few
goals.

 1) Have the hacks as contained and identified as possible. They're sometimes
    needed because how clang exposes the AST, but ideally those hacks are well
    identified and don't interact randomly with each others.

    As an example, in the current bindgen when scanning the parameters of a
    function that references a struct clones all the struct information, then if
    the struct name changes (because we mangle it), everything breaks.

 2) Support extending the bindgen output without having to deal with clang. The
    way I'm aiming to do this is separating completely the parsing stage from
    the code generation one, and providing a single id for each item the binding
    generator provides.

 3) No more random mutation of the internal representation from anywhere. That
    means no more Rc<RefCell<T>>, no more random circular references, no more
    borrow_state... nothing.

 4) No more deduplication of declarations before code generation.

    Current bindgen has a stage, called `tag_dup_decl`[1], that takes care of
    deduplicating declarations. That's completely buggy, and for C++ it's a
    complete mess, since we YOLO modify the world.

    I've managed to take rid of this using the clang canonical declaration, and
    the definition, to avoid scanning any type/item twice.

 5) Code generation should not modify any internal data structure. It can lookup
    things, traverse whatever it needs, but not modifying randomly.

 6) Each item should have a canonical name, and a single source of mangling
    logic, and that should be computed from the inmutable state, at code
    generation.

    I've put a few canonical_name stuff in the code generation phase, but it's
    still not complete, and should change if I implement namespaces.

Improvements pending until this can land:

 1) Add support for missing core stuff, mainly generating functions (note that
    we parse the signatures for types correctly though), bitfields, generating
    C++ methods.

 2) Add support for the necessary features that were added to work around some
    C++ pitfalls, like opaque types, etc...

 3) Add support for the sugar that Manish added recently.

 4) Optionally (and I guess this can land without it, because basically nobody
    uses it since it's so buggy), bring back namespace support.

These are not completely trivial, but I think I can do them quite easily with
the current architecture.

I'm putting the current state of affairs here as a request for comments... Any
thoughts? Note that there are still a few smells I want to eventually
re-redesign, like the ParseError::Recurse thing, but until that happens I'm
way happier with this kind of architecture.

I'm keeping the old `parser.rs` and `gen.rs` in tree just for reference while I
code, but they will go away.

[1]: https://github.com/Yamakaky/rust-bindgen/blob/master/src/gen.rs#L448

1 files changed, 38 insertions, 51 deletions

diff --git a/tests/expectations/union_with_anon_struct_bitfield.rs b/tests/expectations/union_with_anon_struct_bitfield.rs
index ce59836e..80be0e55 100644
--- a/tests/expectations/union_with_anon_struct_bitfield.rs
+++ b/tests/expectations/union_with_anon_struct_bitfield.rs
@@ -4,7 +4,7 @@
 #![allow(non_snake_case)]
 
 
-#[derive(Copy, Debug)]
+#[derive(Debug)]
 #[repr(C)]
 pub struct __BindgenUnionField<T>(::std::marker::PhantomData<T>);
 impl <T> __BindgenUnionField<T> {
@@ -23,75 +23,62 @@ impl <T> ::std::clone::Clone for __BindgenUnionField<T> {
     #[inline]
     fn clone(&self) -> Self { Self::new() }
 }
+impl <T> ::std::marker::Copy for __BindgenUnionField<T> { }
 #[repr(C)]
 #[derive(Debug, Copy)]
-pub struct Union_foo {
+pub struct foo {
     pub a: __BindgenUnionField<::std::os::raw::c_int>,
-    pub foo_union_with_anon_struct_bitfield_h_unnamed_1: __BindgenUnionField<Struct_foo_union_with_anon_struct_bitfield_h_unnamed_1>,
-    pub _bindgen_data_: u32,
+    pub __bindgen_anon_1: __BindgenUnionField<foo__bindgen_ty_bindgen_id_3>,
+    pub bindgen_union_field: u32,
 }
-impl Union_foo {
-    pub unsafe fn a(&mut self) -> *mut ::std::os::raw::c_int {
-        let raw: *mut u8 = ::std::mem::transmute(&self._bindgen_data_);
-        ::std::mem::transmute(raw.offset(0))
-    }
-    pub unsafe fn foo_union_with_anon_struct_bitfield_h_unnamed_1(&mut self)
-     -> *mut Struct_foo_union_with_anon_struct_bitfield_h_unnamed_1 {
-        let raw: *mut u8 = ::std::mem::transmute(&self._bindgen_data_);
-        ::std::mem::transmute(raw.offset(0))
-    }
-}
-impl ::std::clone::Clone for Union_foo {
-    fn clone(&self) -> Self { *self }
+#[repr(C)]
+#[derive(Debug, Copy)]
+pub struct foo__bindgen_ty_bindgen_id_3 {
+    pub _bitfield_1: u32,
 }
 #[test]
-fn bindgen_test_layout_Union_foo() {
-    assert_eq!(::std::mem::size_of::<Union_foo>() , 4usize);
-    assert_eq!(::std::mem::align_of::<Union_foo>() , 4usize);
+fn bindgen_test_layout_foo__bindgen_ty_bindgen_id_3() {
+    assert_eq!(::std::mem::size_of::<foo__bindgen_ty_bindgen_id_3>() ,
+               4usize);
+    assert_eq!(::std::mem::align_of::<foo__bindgen_ty_bindgen_id_3>() ,
+               4usize);
 }
-#[repr(C)]
-#[derive(Debug, Copy)]
-pub struct Struct_foo_union_with_anon_struct_bitfield_h_unnamed_1 {
-    pub _bitfield_1: ::std::os::raw::c_int,
+impl Clone for foo__bindgen_ty_bindgen_id_3 {
+    fn clone(&self) -> Self { *self }
 }
-impl Struct_foo_union_with_anon_struct_bitfield_h_unnamed_1 {
+impl foo__bindgen_ty_bindgen_id_3 {
     #[inline]
     pub fn b(&self) -> ::std::os::raw::c_int {
-        (self._bitfield_1 & (127usize as ::std::os::raw::c_int)) >> 0usize
+        unsafe {
+            ::std::mem::transmute(((self._bitfield_1 & (127usize as u32)) >>
+                                       0u32) as u32)
+        }
     }
     #[inline]
-    pub fn set_b(&mut self, val: u8) {
-        self._bitfield_1 &= !(127usize as ::std::os::raw::c_int);
-        self._bitfield_1 |=
-            ((val as ::std::os::raw::c_int) << 0usize) &
-                (127usize as ::std::os::raw::c_int);
+    pub fn set_b(&mut self, val: ::std::os::raw::c_int) {
+        self._bitfield_1 &= !(127usize as u32);
+        self._bitfield_1 |= ((val as u32 as u32) << 0u32) & (127usize as u32);
     }
     #[inline]
     pub fn c(&self) -> ::std::os::raw::c_int {
-        (self._bitfield_1 & (4294967168usize as ::std::os::raw::c_int)) >>
-            7usize
+        unsafe {
+            ::std::mem::transmute(((self._bitfield_1 &
+                                        (4294967168usize as u32)) >> 7u32) as
+                                      u32)
+        }
     }
     #[inline]
-    pub fn set_c(&mut self, val: u32) {
-        self._bitfield_1 &= !(4294967168usize as ::std::os::raw::c_int);
+    pub fn set_c(&mut self, val: ::std::os::raw::c_int) {
+        self._bitfield_1 &= !(4294967168usize as u32);
         self._bitfield_1 |=
-            ((val as ::std::os::raw::c_int) << 7usize) &
-                (4294967168usize as ::std::os::raw::c_int);
-    }
-    #[inline]
-    pub fn new_bitfield_1(b: u8, c: u32) -> ::std::os::raw::c_int {
-        0 | ((b as ::std::os::raw::c_int) << 0u32) |
-            ((c as ::std::os::raw::c_int) << 7u32)
+            ((val as u32 as u32) << 7u32) & (4294967168usize as u32);
     }
 }
-impl ::std::clone::Clone for
- Struct_foo_union_with_anon_struct_bitfield_h_unnamed_1 {
-    fn clone(&self) -> Self { *self }
-}
 #[test]
-fn bindgen_test_layout_Struct_foo_union_with_anon_struct_bitfield_h_unnamed_1() {
-    assert_eq!(::std::mem::size_of::<Struct_foo_union_with_anon_struct_bitfield_h_unnamed_1>()
-               , 4usize);
-    assert_eq!(::std::mem::align_of::<Struct_foo_union_with_anon_struct_bitfield_h_unnamed_1>()
-               , 4usize);
+fn bindgen_test_layout_foo() {
+    assert_eq!(::std::mem::size_of::<foo>() , 4usize);
+    assert_eq!(::std::mem::align_of::<foo>() , 4usize);
+}
+impl Clone for foo {
+    fn clone(&self) -> Self { *self }
 }