mod.rs

mod helpers;

use self::helpers::{attributes, ArrayTyBuilder, BlobTyBuilder};

use ir::context::BindgenContext;
use ir::item::{Item, ItemId, ItemCanonicalName, ItemCanonicalPath};
use ir::ty::{Type, TypeKind};
use ir::int::IntKind;
use ir::module::Module;
use ir::var::Var;
use ir::enum_ty::Enum;
use ir::function::{Function, FunctionSig};
use ir::item_kind::ItemKind;
use ir::comp::{CompKind, CompInfo, Field, Method};
use ir::layout::Layout;
use ir::annotations::FieldAccessorKind;

use std::ops;
use std::mem;
use std::collections::BTreeSet;
use std::collections::HashSet;
use std::collections::hash_map::{HashMap, Entry};

use syntax::abi::Abi;
use syntax::ast;
use syntax::codemap::{Span, respan};
use syntax::ptr::P;
use aster;

fn root_import(ctx: &BindgenContext) -> P<ast::Item> {
    assert!(ctx.options().enable_cxx_namespaces, "Somebody messed it up");
    let root = ctx.root_module().canonical_name(ctx);
    let root_ident = ctx.rust_ident(&root);
    quote_item!(ctx.ext_cx(), use $root_ident;).unwrap()
}

struct CodegenResult {
    items: Vec<P<ast::Item>>,
    saw_union: bool,
    items_seen: HashSet<ItemId>,
    /// The set of generated function names, needed because in C/C++ is legal to
    /// do something like:
    ///
    /// ```
    /// extern "C" {
    ///   void foo();
    /// }
    ///
    /// extern "C" {
    ///   void foo();
    /// }
    /// ```
    ///
    /// Being these two different declarations.
    functions_seen: HashSet<String>,
}

impl CodegenResult {
    fn new() -> Self {
        CodegenResult {
            items: vec![],
            saw_union: false,
            items_seen: Default::default(),
            functions_seen: Default::default(),
        }
    }

    fn saw_union(&mut self) {
        self.saw_union = true;
    }

    fn seen(&self, item: ItemId) -> bool {
        self.items_seen.contains(&item)
    }

    fn set_seen(&mut self, item: ItemId) {
        self.items_seen.insert(item);
    }

    fn seen_function(&self, name: &str) -> bool {
        self.functions_seen.contains(name)
    }

    fn saw_function(&mut self, name: &str) {
        self.functions_seen.insert(name.into());
    }

    fn inner<F>(&mut self, cb: F) -> Vec<P<ast::Item>>
        where F: FnOnce(&mut Self)
    {
        let mut new = Self::new();

        cb(&mut new);

        self.saw_union |= new.saw_union;

        new.items
    }
}

impl ops::Deref for CodegenResult {
    type Target = Vec<P<ast::Item>>;

    fn deref(&self) -> &Self::Target {
        &self.items
    }
}

impl ops::DerefMut for CodegenResult {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.items
    }
}

struct ForeignModBuilder {
    inner: ast::ForeignMod,
}

impl ForeignModBuilder {
    fn new(abi: Abi) -> Self {
        ForeignModBuilder {
            inner: ast::ForeignMod {
                abi: abi,
                items: vec![],
            }
        }
    }

    fn with_foreign_item(mut self, item: ast::ForeignItem) -> Self {
        self.inner.items.push(item);
        self
    }

    #[allow(dead_code)]
    fn with_foreign_items<I>(mut self, items: I) -> Self
        where I: IntoIterator<Item=ast::ForeignItem>
    {
        self.inner.items.extend(items.into_iter());
        self
    }

    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,
            node: ast::ItemKind::ForeignMod(self.inner),
            vis: ast::Visibility::Public,
            attrs: vec![],
            span: DUMMY_SP,
        })
    }
}

/// A trait to convert a rust type into a pointer, optionally const, to the same
/// type.
///
/// This is done due to aster's lack of pointer builder, I guess I should PR
/// there.
trait ToPtr {
    fn to_ptr(self, is_const: bool, span: Span) -> P<ast::Ty>;
}

impl ToPtr for P<ast::Ty> {
    fn to_ptr(self, is_const: bool, span: Span) -> Self {
        let ty = ast::TyKind::Ptr(ast::MutTy {
            ty: self,
            mutbl: if is_const {
                ast::Mutability::Immutable
            } else {
                ast::Mutability::Mutable
            }
        });
        P(ast::Ty {
            id: ast::DUMMY_NODE_ID,
            node: ty,
            span: span,
        })
    }
}

trait CodeGenerator {
    /// Extra information from the caller.
    type Extra;

    fn codegen(&self,
               ctx: &BindgenContext,
               result: &mut CodegenResult,
               extra: &Self::Extra);
}

impl CodeGenerator for Item {
    type Extra = ();

    fn codegen(&self,
               ctx: &BindgenContext,
               result: &mut CodegenResult,
               _extra: &()) {
        if self.is_hidden(ctx) || result.seen(self.id()) {
            return;
        }

        result.set_seen(self.id());

        match *self.kind() {
            ItemKind::Module(ref module) => {
                if !ctx.options().enable_cxx_namespaces && self.id() == ctx.root_module() {
                    return;
                }

                module.codegen(ctx, result, self);
            },
            ItemKind::Function(ref fun) => {
                if !ctx.options().ignore_functions {
                    fun.codegen(ctx, result, self);
                }
            },
            ItemKind::Var(ref var) => {
                var.codegen(ctx, result, self);
            },
            ItemKind::Type(ref ty) => {
                ty.codegen(ctx, result, self);
            }
        }
    }
}

impl CodeGenerator for Module {
    type Extra = Item;

    fn codegen(&self,
               ctx: &BindgenContext,
               result: &mut CodegenResult,
               item: &Item) {
        if !ctx.options().enable_cxx_namespaces {
            for child in self.children() {
                ctx.resolve_item(*child).codegen(ctx, result, &());
            }
            return;
        }

        let inner_items = result.inner(|result| {
            result.push(root_import(ctx));
            for child in self.children() {
                ctx.resolve_item(*child).codegen(ctx, result, &());
            }
        });

        let module = ast::ItemKind::Mod(ast::Mod {
            inner: ctx.span(),
            items: inner_items,
        });

        let name = item.canonical_name(ctx);
        let item = aster::AstBuilder::new().item().pub_()
                         .build_item_kind(name, module);

        result.push(item);
    }
}

impl CodeGenerator for Var {
    type Extra = Item;
    fn codegen(&self,
               ctx: &BindgenContext,
               result: &mut CodegenResult,
               item: &Item) {
        let name = item.canonical_name(ctx);
        let ty = self.ty().to_rust_ty(ctx);

        if let Some(val) = self.val() {
            let const_item = aster::AstBuilder::new().item().pub_().const_(name)
                                                .expr().int(val).build(ty);
            result.push(const_item)
        } else {
            let mut attrs = vec![];
            if let Some(mangled) = self.mangled_name() {
                attrs.push(attributes::link_name(mangled));
            } else if name != self.name() {
                attrs.push(attributes::link_name(self.name()));
            }

            let item = ast::ForeignItem {
                ident: ctx.rust_ident_raw(&name),
                attrs: attrs,
                node: ast::ForeignItemKind::Static(ty, !self.is_const()),
                id: ast::DUMMY_NODE_ID,
                span: ctx.span(),
                vis: ast::Visibility::Public,
            };

            let item = ForeignModBuilder::new(Abi::C)
                            .with_foreign_item(item)
                            .build(ctx);
            result.push(item);
        }
    }
}

impl CodeGenerator for Type {
    type Extra = Item;

    fn codegen(&self,
               ctx: &BindgenContext,
               result: &mut CodegenResult,
               item: &Item) {
        match *self.kind() {
            TypeKind::Void |
            TypeKind::NullPtr |
            TypeKind::Int(..) |
            TypeKind::Float(..) |
            TypeKind::Array(..) |
            TypeKind::Pointer(..) |
            TypeKind::Reference(..) |
            TypeKind::TemplateRef(..) |
            TypeKind::Function(..) |
            TypeKind::ResolvedTypeRef(..) |
            TypeKind::Named(..) => {
                // These items don't need code generation, they only need to be
                // converted to rust types in fields, arguments, and such.
                return;
            }
            TypeKind::Comp(ref ci) => ci.codegen(ctx, result, item),
            TypeKind::Alias(ref spelling, inner) => {
                let inner_item = ctx.resolve_item(inner);
                let name = item.canonical_name(ctx);

                // Try to catch the common pattern:
                //
                // typedef struct foo { ... } foo;
                //
                // here.
                //
                if inner_item.canonical_name(ctx) == name {
                    return;
                }

                // If this is a known named type, disallow generating anything
                // for it too.
                if utils::type_from_named(ctx, spelling, inner).is_some() {
                    return;
                }

                let mut applicable_template_args = item.applicable_template_args(ctx);
                let inner_rust_type = if item.is_opaque(ctx) {
                    applicable_template_args.clear();
                    // Pray if there's no layout.
                    let layout = self.layout(ctx).unwrap_or_else(Layout::zero);
                    BlobTyBuilder::new(layout).build()
                } else {
                    inner_item.to_rust_ty(ctx)
                };

                let rust_name = ctx.rust_ident(&name);
                let mut typedef = aster::AstBuilder::new().item().pub_();

                if let Some(comment) = item.comment() {
                    typedef = typedef.attr().doc(comment);
                }

                let mut generics = typedef.type_(rust_name).generics();
                for template_arg in applicable_template_args.iter() {
                    let template_arg = ctx.resolve_type(*template_arg);
                    if template_arg.is_named() {
                        let name = template_arg.name().unwrap();
                        if name.contains("typename ") {
                            error!("Item contained `typename`'d template param: {:?}", item);
                            return;
                        }
                        generics = generics.ty_param_id(template_arg.name().unwrap());
                    }
                }

                let typedef = generics.build().build_ty(inner_rust_type);
                result.push(typedef)
            }
            TypeKind::Enum(ref ei) => ei.codegen(ctx, result, item),
            ref u @ TypeKind::UnresolvedTypeRef(..)
                => unreachable!("Should have been resolved after parsing {:?}!", u),
        }
    }
}

struct Vtable<'a> {
    item_id: ItemId,
    #[allow(dead_code)]
    methods: &'a [Method],
    #[allow(dead_code)]
    base_classes: &'a [ItemId],
}

impl<'a> Vtable<'a> {
    fn new(item_id: ItemId, methods: &'a [Method], base_classes: &'a [ItemId]) -> Self {
        Vtable {
            item_id: item_id,
            methods: methods,
            base_classes: base_classes,
        }
    }
}

impl<'a> CodeGenerator for Vtable<'a> {
    type Extra = Item;

    fn codegen(&self,
               ctx: &BindgenContext,
               result: &mut CodegenResult,
               item: &Item) {
        assert_eq!(item.id(), self.item_id);
        // For now, generate an empty struct, later we should generate function
        // pointers and whatnot.
        let vtable = aster::AstBuilder::new().item().pub_()
                            .with_attr(attributes::repr("C"))
                            .struct_(self.canonical_name(ctx))
                            .build();
        result.push(vtable);
    }
}

impl<'a> ItemCanonicalName for Vtable<'a> {
    fn canonical_name(&self, _ctx: &BindgenContext) -> String {
        format!("bindgen_vtable_{}", self.item_id)
    }
}

impl<'a> ItemToRustTy for Vtable<'a> {
    fn to_rust_ty(&self, ctx: &BindgenContext) -> P<ast::Ty> {
        aster::ty::TyBuilder::new().id(self.canonical_name(ctx))
    }
}

struct Bitfield<'a> {
    index: usize,
    fields: Vec<&'a Field>,
}

impl<'a> Bitfield<'a> {
    fn new(index: usize, fields: Vec<&'a Field>) -> Self {
        Bitfield {
            index: index,
            fields: fields,
        }
    }

    fn codegen_fields(self,
                      ctx: &BindgenContext,
                      fields: &mut Vec<ast::StructField>,
                      methods: &mut Vec<ast::ImplItem>) {
        use aster::struct_field::StructFieldBuilder;
        use std::cmp;
        let mut total_width = self.fields.iter()
                                     .fold(0u32, |acc, f| acc + f.bitfield().unwrap());

        if !total_width.is_power_of_two() || total_width < 8 {
            total_width = cmp::max(8, total_width.next_power_of_two());
        }
        debug_assert_eq!(total_width % 8, 0);
        let total_width_in_bytes = total_width as usize / 8;

        let bitfield_type =
            BlobTyBuilder::new(Layout::new(total_width_in_bytes, total_width_in_bytes)).build();
        let field_name = format!("_bitfield_{}", self.index);
        let field_ident = ctx.ext_cx().ident_of(&field_name);
        let field = StructFieldBuilder::named(&field_name).pub_()
                        .build_ty(bitfield_type.clone());
        fields.push(field);


        let mut offset = 0;
        for field in self.fields {
            let width = field.bitfield().unwrap();
            let field_name = field.name()
                                  .map(ToOwned::to_owned)
                                  .unwrap_or_else(|| format!("at_offset_{}", offset));

            let field_item = ctx.resolve_item(field.ty());
            let field_ty_layout = field_item.kind().expect_type()
                                            .layout(ctx)
                                            .expect("Bitfield without layout? Gah!");

            let field_type = field_item.to_rust_ty(ctx);
            let int_type = BlobTyBuilder::new(field_ty_layout).build();

            let getter_name = ctx.ext_cx().ident_of(&field_name);
            let setter_name = ctx.ext_cx().ident_of(&format!("set_{}", &field_name));
            let mask = ((1usize << width) - 1) << offset;
            // The transmute is unfortunate, but it's needed for enums in
            // bitfields.
            let item = quote_item!(ctx.ext_cx(),
                impl X {
                    #[inline]
                    pub fn $getter_name(&self) -> $field_type {
                        unsafe {
                            ::std::mem::transmute(
                                ((self.$field_ident & ($mask as $bitfield_type)) >> $offset)
                                as $int_type)
                        }
                    }

                    #[inline]
                    pub fn $setter_name(&mut self, val: $field_type) {
                        self.$field_ident &= !($mask as $bitfield_type);
                        self.$field_ident |= (val as $int_type as $bitfield_type << $offset) & ($mask as $bitfield_type);
                    }
                }
            ).unwrap();

            let items = match item.unwrap().node {
                ast::ItemKind::Impl(_, _, _, _, _, items) => items,
                _ => unreachable!(),
            };

            methods.extend(items.into_iter());
            offset += width;
        }
    }
}

impl CodeGenerator for CompInfo {
    type Extra = Item;

    fn codegen(&self,
               ctx: &BindgenContext,
               result: &mut CodegenResult,
               item: &Item) {
        use aster::struct_field::StructFieldBuilder;
        // Don't output classes with template parameters that aren't types, and
        // also don't output template specializations, neither total or partial.
        //
        // TODO: Generate layout tests for template specializations, yay!
        if self.has_non_type_template_params() || self.is_template_specialization() {
            return;
        }

        let applicable_template_args = item.applicable_template_args(ctx);

        let mut attributes = vec![];
        let mut needs_clone_impl = false;
        if let Some(comment) = item.comment() {
            attributes.push(attributes::doc(comment));
        }
        if self.packed() {
            attributes.push(attributes::repr_list(&["C", "packed"]));
        } else {
            attributes.push(attributes::repr("C"));
        }

        let mut derives = vec![];
        let ty = item.expect_type();
        if ty.can_derive_debug(ctx) {
            derives.push("Debug");
        }

        if ty.can_derive_copy(ctx) && !item.annotations().disallow_copy() {
            derives.push("Copy");
            if !applicable_template_args.is_empty() {
                // FIXME: This requires extra logic if you have a big array in a
                // templated struct. The reason for this is that the magic:
                //     fn clone(&self) -> Self { *self }
                // doesn't work for templates.
                //
                // It's not hard to fix though.
                derives.push("Clone");
            } else {
                needs_clone_impl = true;
            }
        }

        if !derives.is_empty() {
            attributes.push(attributes::derives(&derives))
        }

        let mut template_args_used = vec![false; applicable_template_args.len()];
        let canonical_name = item.canonical_name(ctx);
        let builder = aster::AstBuilder::new().item().pub_()
                                .with_attrs(attributes)
                                .struct_(&canonical_name);

        // Generate the vtable from the method list if appropriate.
        // TODO: I don't know how this could play with virtual methods that are
        // not in the list of methods found by us, we'll see. Also, could the
        // order of the vtable pointers vary?
        //
        // FIXME: Once we generate proper vtables, we need to codegen the
        // vtable, but *not* generate a field for it in the case that
        // needs_explicit_vtable is false but has_vtable is true.
        //
        // Also, we need to generate the vtable in such a way it "inherits" from
        // the parent too.
        let mut fields = vec![];
        if self.needs_explicit_vtable(ctx) {
            let vtable = Vtable::new(item.id(),
                                     self.methods(),
                                     self.base_members());
            vtable.codegen(ctx, result, item);

            let vtable_type = vtable.to_rust_ty(ctx).to_ptr(true, ctx.span());

            let vtable_field = StructFieldBuilder::named("vtable_").pub_()
                                    .build_ty(vtable_type);

            fields.push(vtable_field);
        }

        for (i, base) in self.base_members().iter().enumerate() {
            let base_ty = ctx.resolve_type(*base);
            // NB: We won't include unsized types in our base chain because they
            // would contribute to our size given the dummy field we insert for
            // unsized types.
            //
            // NB: Canonical type is here because it could be inheriting from a
            // typedef, for example, and the lack of `unwrap()` is because we
            // can inherit from a template parameter, yes.
            if base_ty.is_unsized(ctx) {
                continue;
            }

            for (i, ty) in applicable_template_args.iter().enumerate() {
                if base_ty.signature_contains_named_type(ctx, ctx.resolve_type(*ty)) {
                    template_args_used[i] = true;
                }
            }

            let inner = base.to_rust_ty(ctx);
            let field_name = if i == 0 {
                "_base".into()
            } else {
                format!("_base_{}", i)
            };

            let field = StructFieldBuilder::named(field_name)
                                    .pub_().build_ty(inner);
            fields.push(field);
        }

        let is_union = self.kind() == CompKind::Union;
        if is_union {
            result.saw_union();
        }

        let layout = item.kind().expect_type().layout(ctx);

        let mut current_bitfield_width = None;
        let mut current_bitfield_layout: Option<Layout> = None;
        let mut current_bitfield_fields = vec![];
        let mut bitfield_count = 0;
        let struct_fields = self.fields();
        let fields_should_be_private = item.annotations()
                                           .private_fields()
                                           .unwrap_or(false);
        let struct_accessor_kind = item.annotations()
                                       .accessor_kind()
                                       .unwrap_or(FieldAccessorKind::None);

        let mut methods = vec![];
        let mut anonymous_field_count = 0;
        for field in struct_fields {
            debug_assert_eq!(current_bitfield_width.is_some(),
                             current_bitfield_layout.is_some());
            debug_assert_eq!(current_bitfield_width.is_some(),
                             !current_bitfield_fields.is_empty());

            let field_ty = ctx.resolve_type(field.ty());

            // Try to catch a bitfield contination early.
            if let (Some(ref mut bitfield_width), Some(width)) = (current_bitfield_width, field.bitfield()) {
                let layout = current_bitfield_layout.unwrap();
                debug!("Testing bitfield continuation {} {} {:?}",
                       *bitfield_width, width, layout);
                 if *bitfield_width + width <= (layout.size * 8) as u32 {
                     *bitfield_width += width;
                     current_bitfield_fields.push(field);
                     continue;
                 }
            }

            // Flush the current bitfield.
            if current_bitfield_width.is_some() {
                debug_assert!(!current_bitfield_fields.is_empty());
                let bitfield_fields =
                    mem::replace(&mut current_bitfield_fields, vec![]);
                bitfield_count += 1;
                Bitfield::new(bitfield_count, bitfield_fields)
                    .codegen_fields(ctx, &mut fields, &mut methods);
                current_bitfield_width = None;
                current_bitfield_layout = None;
            }
            debug_assert!(current_bitfield_fields.is_empty());

            if let Some(width) = field.bitfield() {
                let layout = field_ty.layout(ctx)
                                     .expect("Bitfield type without layout?");
                current_bitfield_width = Some(width);
                current_bitfield_layout = Some(layout);
                current_bitfield_fields.push(field);
                continue;
            }

            for (i, ty) in applicable_template_args.iter().enumerate() {
                if field_ty.signature_contains_named_type(ctx, ctx.resolve_type(*ty)) {
                    template_args_used[i] = true;
                }
            }

            let ty = field.ty().to_rust_ty(ctx);

            let ty = if is_union {
                quote_ty!(ctx.ext_cx(), __BindgenUnionField<$ty>)
            } else {
                ty
            };

            let mut attrs = vec![];
            if let Some(comment) = field.comment() {
                attrs.push(attributes::doc(comment));
            }
            let field_name = match field.name() {
                Some(name) => ctx.rust_mangle(name).into_owned(),
                None => {
                    anonymous_field_count += 1;
                    format!("__bindgen_anon_{}", anonymous_field_count)
                }
            };

            let is_private = field.annotations()
                                  .private_fields()
                                  .unwrap_or(fields_should_be_private);

            let accessor_kind = field.annotations()
                                     .accessor_kind()
                                     .unwrap_or(struct_accessor_kind);

            let mut field = StructFieldBuilder::named(&field_name);

            if !is_private {
                field = field.pub_();
            }

            let field = field.with_attrs(attrs)
                             .build_ty(ty.clone());

            fields.push(field);

            // TODO: Factor the following code out, please!
            if accessor_kind == FieldAccessorKind::None {
                continue;
            }

            let getter_name =
                ctx.rust_ident_raw(&format!("get_{}", field_name));
            let mutable_getter_name =
                ctx.rust_ident_raw(&format!("get_{}_mut", field_name));
            let field_name = ctx.rust_ident_raw(&field_name);

            let accessor_methods_impl = match accessor_kind {
                FieldAccessorKind::None => unreachable!(),
                FieldAccessorKind::Regular => {
                    quote_item!(ctx.ext_cx(),
                        impl X {
                            #[inline]
                            pub fn $getter_name(&self) -> &$ty {
                                &self.$field_name
                            }

                            #[inline]
                            pub fn $mutable_getter_name(&mut self) -> &mut $ty {
                                &mut self.$field_name
                            }
                        }
                    )
                }
                FieldAccessorKind::Unsafe => {
                    quote_item!(ctx.ext_cx(),
                        impl X {
                            #[inline]
                            pub unsafe fn $getter_name(&self) -> &$ty {
                                &self.$field_name
                            }

                            #[inline]
                            pub unsafe fn $mutable_getter_name(&mut self) -> &mut $ty {
                                &mut self.$field_name
                            }
                        }
                    )
                }
                FieldAccessorKind::Immutable => {
                    quote_item!(ctx.ext_cx(),
                        impl X {
                            #[inline]
                            pub fn $getter_name(&self) -> &$ty {
                                &self.$field_name
                            }
                        }
                    )
                }
            };

            match accessor_methods_impl.unwrap().node {
                ast::ItemKind::Impl(_, _, _, _, _, ref items)
                    => methods.extend(items.clone()),
                _   => unreachable!()
            }
        }

        // Flush the last bitfield if any.
        //
        // FIXME: Reduce duplication with the loop above.
        // FIXME: May need to pass current_bitfield_layout too.
        if current_bitfield_width.is_some() {
            debug_assert!(!current_bitfield_fields.is_empty());
            let bitfield_fields = mem::replace(&mut current_bitfield_fields, vec![]);
            bitfield_count += 1;
            Bitfield::new(bitfield_count, bitfield_fields)
                .codegen_fields(ctx, &mut fields, &mut methods);
        }
        debug_assert!(current_bitfield_fields.is_empty());

        if is_union {
            let layout = layout.expect("Unable to get layout information?");
            let ty = BlobTyBuilder::new(layout).build();
            let field = StructFieldBuilder::named("bindgen_union_field").pub_()
                             .build_ty(ty);
            fields.push(field);
        }

        // Yeah, sorry about that.
        if item.is_opaque(ctx) {
            fields.clear();
            methods.clear();
            for i in 0..template_args_used.len() {
                template_args_used[i] = false;
            }

            match layout {
                Some(l) => {
                    let ty = BlobTyBuilder::new(l).build();
                    let field = StructFieldBuilder::named("_bindgen_opaque_blob").pub_()
                                     .build_ty(ty);
                    fields.push(field);
                }
                None => {
                    warn!("Opaque type without layout! Expect dragons!");
                }
            }
        }

        // C requires every struct to be addressable, so what C compilers do is
        // making the struct 1-byte sized.
        //
        // NOTE: This check is conveniently here to avoid the dummy fields we
        // may add for unused template parameters.
        if self.is_unsized(ctx) {
            let ty = BlobTyBuilder::new(Layout::new(1, 1)).build();
            let field = StructFieldBuilder::named("_address").pub_()
                            .build_ty(ty);
            fields.push(field);
        }

        // Append any extra template arguments that nobody has used so far.
        for (i, ty) in applicable_template_args.iter().enumerate() {
            if !template_args_used[i] {
                let name = ctx.resolve_type(*ty).name().unwrap();
                let ident = ctx.rust_ident(name);
                let field =
                    StructFieldBuilder::named(format!("_phantom_{}", i)).pub_()
                            .build_ty(quote_ty!(ctx.ext_cx(), ::std::marker::PhantomData<$ident>));
                fields.push(field)
            }
        }


        let mut generics = aster::AstBuilder::new().generics();
        for template_arg in applicable_template_args.iter() {
            // Take into account that here only arrive named types, not
            // template specialisations that would need to be
            // instantiated.
            //
            // TODO: Add template args from the parent, here and in
            // `to_rust_ty`!!
            let template_arg = ctx.resolve_type(*template_arg);
            generics = generics.ty_param_id(template_arg.name().unwrap());
        }

        let generics = generics.build();

        let rust_struct = builder.with_generics(generics.clone())
                                 .with_fields(fields).build();
        result.push(rust_struct);

        // Generate the inner types and all that stuff.
        //
        // TODO: In the future we might want to be smart, and use nested
        // modules, and whatnot.
        for ty in self.inner_types() {
            let child_item = ctx.resolve_item(*ty);
            // assert_eq!(child_item.parent_id(), item.id());
            child_item.codegen(ctx, result, &());
        }

        // NOTE: Some unexposed attributes (like alignment attributes) may
        // affect layout, so we're bad and pray to the gods for avoid sending
        // all the tests to shit when parsing things like max_align_t.
        if self.found_unknown_attr() {
            warn!("Type {} has an unkown attribute that may affect layout", canonical_name);
        }
        if applicable_template_args.is_empty() && !self.found_unknown_attr() {
            for var in self.inner_vars() {
                ctx.resolve_item(*var).codegen(ctx, result, &());
            }

            if let Some(layout) = layout {
                let fn_name =
                    ctx.rust_ident_raw(&format!("bindgen_test_layout_{}", canonical_name));
                let ident = ctx.rust_ident_raw(&canonical_name);
                let size_of_expr =
                    quote_expr!(ctx.ext_cx(), ::std::mem::size_of::<$ident>());
                let align_of_expr =
                    quote_expr!(ctx.ext_cx(), ::std::mem::align_of::<$ident>());
                let size = layout.size;
                let align = layout.align;
                let item = quote_item!(ctx.ext_cx(),
                    #[test]
                    fn $fn_name() {
                        assert_eq!($size_of_expr, $size);
                        assert_eq!($align_of_expr, $align);
                    }).unwrap();
                result.push(item);
            }

            let mut method_names = Default::default();
            for method in self.methods() {
                method.codegen_method(ctx, &mut methods, &mut method_names, result, item);
            }
        }

        // NB: We can't use to_rust_ty here since for opaque types this tries to
        // use the specialization knowledge to generate a blob field.
        let ty_for_impl = aster::AstBuilder::new().ty().path().id(&canonical_name).build();
        if needs_clone_impl {
            let impl_ = quote_item!(ctx.ext_cx(),
                impl X {
                    fn clone(&self) -> Self { *self }
                }
            );

            let impl_ = match impl_.unwrap().node {
                ast::ItemKind::Impl(_, _, _, _, _, ref items) => items.clone(),
                _ => unreachable!(),
            };

            let clone_impl =
                aster::AstBuilder::new().item().impl_()
                                .trait_().id("Clone").build()
                                .with_generics(generics.clone())
                                .with_items(impl_)
                                .build_ty(ty_for_impl.clone());

            result.push(clone_impl);
        }

        if !methods.is_empty() {
            let methods =
                aster::AstBuilder::new().item().impl_()
                                .with_generics(generics)
                                .with_items(methods)
                                .build_ty(ty_for_impl);
            result.push(methods);
        }
    }
}

trait MethodCodegen {
    fn codegen_method(&self,
                      ctx: &BindgenContext,
                      methods: &mut Vec<ast::ImplItem>,
                      method_names: &mut HashMap<String, usize>,
                      result: &mut CodegenResult,
                      parent: &Item);
}

impl MethodCodegen for Method {
    fn codegen_method(&self,
                      ctx: &BindgenContext,
                      methods: &mut Vec<ast::ImplItem>,
                      method_names: &mut HashMap<String, usize>,
                      result: &mut CodegenResult,
                      _parent: &Item) {
        if ctx.options().ignore_methods {
            return;
        }

        if self.is_virtual() {
            return; // FIXME
        }
        // First of all, output the actual function.
        ctx.resolve_item(self.signature()).codegen(ctx, result, &());

        let function_item = ctx.resolve_item(self.signature());
        let function = function_item.expect_function();
        let mut name = function.name().to_owned();
        let signature_item = ctx.resolve_item(function.signature());
        let signature = match *signature_item.expect_type().kind() {
            TypeKind::Function(ref sig) => sig,
            _ => panic!("How in the world?"),
        };

        let count = {
            let mut count = method_names.entry(name.clone())
                                        .or_insert(0);
            *count += 1;
            *count - 1
        };

        if count != 0 {
            name.push_str(&count.to_string());
        }

        let function_name = function_item.canonical_name(ctx);
        let mut fndecl = utils::rust_fndecl_from_signature(ctx, signature_item).unwrap();
        if !self.is_static() {
            let mutability = if self.is_const() {
                ast::Mutability::Immutable
            } else {
                ast::Mutability::Mutable
            };

            assert!(!fndecl.inputs.is_empty());
            // FIXME: use aster here.
            fndecl.inputs[0] = ast::Arg {
                ty: P(ast::Ty {
                    id: ast::DUMMY_NODE_ID,
                    node: ast::TyKind::Rptr(None, ast::MutTy {
                        ty: P(ast::Ty {
                            id: ast::DUMMY_NODE_ID,
                            node: ast::TyKind::ImplicitSelf,
                            span: ctx.span()
                        }),
                        mutbl: mutability,
                    }),
                    span: ctx.span(),
                }),
                pat: P(ast::Pat {
                    id: ast::DUMMY_NODE_ID,
                    node: ast::PatKind::Ident(ast::BindingMode::ByValue(ast::Mutability::Immutable),
                                              respan(ctx.span(), ctx.ext_cx().ident_of("self")),
                                              None),
                    span: ctx.span(),
                }),
                id: ast::DUMMY_NODE_ID,
            };
        }

        let sig = ast::MethodSig {
            unsafety: ast::Unsafety::Unsafe,
            abi: Abi::Rust,
            decl: P(fndecl.clone()),
            generics: ast::Generics::default(),
            constness: respan(ctx.span(), ast::Constness::NotConst),
        };

        // TODO: We need to keep in sync the argument names, so we should unify
        // this with the other loop that decides them.
        let mut unnamed_arguments = 0;
        let mut exprs = signature.argument_types().iter().map(|&(ref name, _ty)| {
            let arg_name = match *name {
                Some(ref name) => ctx.rust_mangle(name).into_owned(),
                None => {
                    unnamed_arguments += 1;
                    format!("arg{}", unnamed_arguments)
                }
            };
            aster::expr::ExprBuilder::new().id(arg_name)
        }).collect::<Vec<_>>();

        if !self.is_static() {
            assert!(!exprs.is_empty());
            exprs[0] = if self.is_const() {
                quote_expr!(ctx.ext_cx(), &*self)
            } else {
                quote_expr!(ctx.ext_cx(), &mut *self)
            };
        };

        let call = aster::expr::ExprBuilder::new().call()
                        .id(function_name)
                        .with_args(exprs)
                        .build();

        let block = ast::Block {
            stmts: vec![
                ast::Stmt {
                    id: ast::DUMMY_NODE_ID,
                    node: ast::StmtKind::Expr(call),
                    span: ctx.span(),
                }
            ],
            id: ast::DUMMY_NODE_ID,
            rules: ast::BlockCheckMode::Default,
            span: ctx.span(),
        };

        let mut attrs = vec![];
        attrs.push(attributes::inline());

        let item = ast::ImplItem {
            id: ast::DUMMY_NODE_ID,
            ident: ctx.ext_cx().ident_of(&name),
            vis: ast::Visibility::Public,
            attrs: attrs,
            node: ast::ImplItemKind::Method(sig, P(block)),
            defaultness: ast::Defaultness::Final,
            span: ctx.span(),
        };

        methods.push(item);
    }
}

impl CodeGenerator for Enum {
    type Extra = Item;

    fn codegen(&self,
               ctx: &BindgenContext,
               result: &mut CodegenResult,
               item: &Item) {
        use ir::enum_ty::EnumVariantValue;

        let name = item.canonical_name(ctx);
        let layout = item.expect_type().layout(ctx);

        let repr = self.repr().map(|repr| ctx.resolve_type(repr));
        let repr = match repr {
            Some(repr) => match *repr.canonical_type(ctx).kind() {
                TypeKind::Int(int_kind) => int_kind,
                _ => panic!("Unexpected type as enum repr"),
            },
            None => {
                warn!("Guessing type of enum! Forward declarations of enums shouldn't be legal!");
                IntKind::Int
            }
        };

        let signed = repr.is_signed();
        let size = layout.map(|l| l.size).unwrap_or(0);
        let repr_name = match (signed, size) {
            (true, 1) => "i8",
            (false, 1) => "u8",
            (true, 2) => "i16",
            (false, 2) => "u16",
            (true, 4) => "i32",
            (false, 4) => "u32",
            (true, 8) => "i64",
            (false, 8) => "u64",
            _ => {
                warn!("invalid enum decl: signed: {}, size: {}", signed, size);
                "i32"
            }
        };

        let mut builder = aster::AstBuilder::new().item().pub_();

        // FIXME: Rust forbids repr with empty enums. Remove this condition when
        // this is allowed.
        if !self.variants().is_empty() {
            builder = builder.with_attr(attributes::repr(repr_name));
        }

        if let Some(comment) = item.comment() {
            builder = builder.with_attr(attributes::doc(comment));
        }

        let derives =
            attributes::derives(&["Debug", "Copy", "Clone", "PartialEq", "Eq", "Hash"]);

        builder = builder.with_attr(derives);

        let mut builder = builder.enum_(&name);

        fn add_constant(enum_: &Type,
                        // Only to avoid recomputing every time.
                        enum_canonical_name: &str,
                        // May be the same as "variant" if it's because the enum
                        // is unnamed and we still haven't seen the value.
                        variant_name: &str,
                        referenced_name: &str,
                        enum_rust_ty: P<ast::Ty>,
                        result: &mut CodegenResult) {
            let constant_name = if enum_.name().is_some() {
                format!("{}_{}", enum_canonical_name, variant_name)
            } else {
                variant_name.into()
            };

            let constant = aster::AstBuilder::new().item().pub_()
                                                   .const_(constant_name)
                                                   .expr().path()
                                                   .ids(&[&*enum_canonical_name, referenced_name])
                                                   .build().build(enum_rust_ty);
            result.push(constant);
        }

        // A map where we keep a value -> variant relation.
        let mut seen_values = HashMap::<_, String>::new();
        let enum_ty = item.expect_type();
        let enum_rust_ty = item.to_rust_ty(ctx);
        for variant in self.variants().iter() {
            match seen_values.entry(variant.val()) {
                Entry::Occupied(ref entry) => {
                    let existing_variant_name = entry.get();
                    let variant_name = ctx.rust_mangle(variant.name());
                    add_constant(enum_ty, &name, &*variant_name,
                                 existing_variant_name, enum_rust_ty.clone(),
                                 result);
                }
                Entry::Vacant(entry) => {
                    let expr = aster::AstBuilder::new().expr();
                    let expr = match variant.val() {
                        EnumVariantValue::Signed(val) => expr.int(val),
                        EnumVariantValue::Unsigned(val) => expr.uint(val),
                    };
                    let variant_name = ctx.rust_mangle(variant.name());
                    builder = builder.with_variant_(ast::Variant_ {
                        name: ctx.rust_ident(&*variant_name),
                        attrs: vec![],
                        data: ast::VariantData::Unit(ast::DUMMY_NODE_ID),
                        disr_expr: Some(expr),
                    });

                    // If it's an unnamed enum, we also generate a constant so
                    // it can be properly accessed.
                    if enum_ty.name().is_none() {
                        // NB: if we want to do this for other kind of nested
                        // enums we can probably mangle the name.
                        if item.is_toplevel(ctx) {
                            add_constant(enum_ty, &name, &variant_name,
                                         &variant_name, enum_rust_ty.clone(),
                                         result);
                        }
                    }

                    entry.insert(variant_name.into_owned());
                }
            }
        }


        result.push(builder.build());
    }
}

trait ToRustTy {
    type Extra;

    fn to_rust_ty(&self, ctx: &BindgenContext, extra: &Self::Extra) -> P<ast::Ty>;
}

trait ItemToRustTy {
    fn to_rust_ty(&self, ctx: &BindgenContext) -> P<ast::Ty>;
}

// Convenience implementation.
impl ItemToRustTy for ItemId {
    fn to_rust_ty(&self, ctx: &BindgenContext) -> P<ast::Ty> {
        ctx.resolve_item(*self).to_rust_ty(ctx)
    }
}

impl ItemToRustTy for Item {
    fn to_rust_ty(&self, ctx: &BindgenContext) -> P<ast::Ty> {
        self.kind().expect_type().to_rust_ty(ctx, self)
    }
}

fn raw_type(ctx: &BindgenContext, name: &str) -> P<ast::Ty> {
    let ident = ctx.rust_ident_raw(&name);
    quote_ty!(ctx.ext_cx(), ::std::os::raw::$ident)
}

impl ToRustTy for Type {
    type Extra = Item;

    fn to_rust_ty(&self, ctx: &BindgenContext, item: &Item) -> P<ast::Ty> {
        macro_rules! raw {
            ($ty: ident) => {
                raw_type(ctx, stringify!($ty))
            }
        }
        match *self.kind() {
            TypeKind::Void => raw!(c_void),
            // TODO: we should do something smart with nullptr, or maybe *const
            // c_void is enough?
            TypeKind::NullPtr => quote_ty!(ctx.ext_cx(), *const ::std::os::raw::c_void),
            TypeKind::Int(ik) => {
                match ik {
                    IntKind::Bool => aster::ty::TyBuilder::new().bool(),
                    IntKind::Char => raw!(c_char),
                    IntKind::UChar => raw!(c_uchar),
                    IntKind::Short => raw!(c_short),
                    IntKind::UShort => raw!(c_ushort),
                    IntKind::Int => raw!(c_int),
                    IntKind::UInt => raw!(c_uint),
                    IntKind::Long => raw!(c_long),
                    IntKind::ULong => raw!(c_ulong),
                    IntKind::LongLong => raw!(c_longlong),
                    IntKind::ULongLong => raw!(c_ulonglong),
                    IntKind::U16 => aster::ty::TyBuilder::new().u16(),
                    IntKind::U32 => aster::ty::TyBuilder::new().u32(),
                }
            }
            TypeKind::Float(fk) => {
                use ir::ty::FloatKind;
                // TODO: we probably should just take the type layout into
                // account?
                match fk {
                    FloatKind::Float => aster::ty::TyBuilder::new().f32(),
                    FloatKind::Double |
                    FloatKind::LongDouble => aster::ty::TyBuilder::new().f64(),
                }
            }
            TypeKind::Function(ref fs) => {
                let ty = fs.to_rust_ty(ctx, item);
                aster::AstBuilder::new().ty().option().build(ty)
            }
            TypeKind::Array(item, len) => {
                let inner = item.to_rust_ty(ctx);
                ArrayTyBuilder::new().with_len(len).build(inner)
            }
            TypeKind::Enum(..) => {
                let path = item.canonical_path(ctx);
                aster::AstBuilder::new().ty().path().ids(path).build()
            }
            TypeKind::TemplateRef(inner, ref template_args) => {
                // PS: Sorry for the duplication here.
                let mut inner_ty = inner.to_rust_ty(ctx).unwrap();

                if let ast::TyKind::Path(_, ref mut path) = inner_ty.node {
                    path.segments.last_mut().unwrap().parameters =
                        ast::PathParameters::AngleBracketed(
                            ast::AngleBracketedParameterData {
                                lifetimes: vec![],
                                types: P::from_vec(template_args.iter().map(|arg| {
                                    arg.to_rust_ty(ctx)
                                }).collect()),
                                bindings: P::from_vec(vec![]),
                            }
                        );
                }

                P(inner_ty)
            }
            TypeKind::ResolvedTypeRef(inner) => inner.to_rust_ty(ctx),
            TypeKind::Alias(ref spelling, inner) => {
                if item.is_opaque(ctx) {
                    // Pray if there's no available layout.
                    let layout = self.layout(ctx).unwrap_or_else(Layout::zero);
                    BlobTyBuilder::new(layout).build()
                } else if let Some(ty) = utils::type_from_named(ctx, spelling, inner) {
                    ty
                } else {
                    utils::build_templated_path(item, ctx, true)
                }
            }
            TypeKind::Comp(ref info) => {
                if item.is_opaque(ctx) || info.has_non_type_template_params() {
                    return match self.layout(ctx) {
                        Some(layout) => {
                            BlobTyBuilder::new(layout).build()
                        }
                        None => {
                            warn!("Couldn't compute layout for a type with non \
                                  template params or opaque, expect dragons!");
                            aster::AstBuilder::new().ty().unit()
                        }
                    }
                }

                utils::build_templated_path(item, ctx, false)
            }
            TypeKind::Pointer(inner) |
            TypeKind::Reference(inner) => {
                let inner = ctx.resolve_item(inner);
                inner.to_rust_ty(ctx).to_ptr(inner.expect_type().is_const(), ctx.span())
            }
            TypeKind::Named(..) => {
                let name = item.canonical_name(ctx);
                let ident = ctx.rust_ident(&name);
                quote_ty!(ctx.ext_cx(), $ident)
            }
            ref u @ TypeKind::UnresolvedTypeRef(..)
                => unreachable!("Should have been resolved after parsing {:?}!", u),
        }
    }
}

impl ToRustTy for FunctionSig {
    type Extra = Item;

    fn to_rust_ty(&self, ctx: &BindgenContext, _item: &Item) -> P<ast::Ty> {
        // TODO: we might want to consider ignoring the reference return value.
        let return_item = ctx.resolve_item(self.return_type());
        let ret = if let TypeKind::Void = *return_item.kind().expect_type().kind() {
            ast::FunctionRetTy::Default(ctx.span())
        } else {
            ast::FunctionRetTy::Ty(return_item.to_rust_ty(ctx))
        };

        let mut unnamed_arguments = 0;
        let arguments = self.argument_types().iter().map(|&(ref name, ty)| {
            let arg_item = ctx.resolve_item(ty);
            let arg_ty = arg_item.kind().expect_type();

            // From the C90 standard (http://c0x.coding-guidelines.com/6.7.5.3.html)
            // 1598 - A declaration of a parameter as “array of type” shall be
            // adjusted to “qualified pointer to type”, where the type qualifiers
            // (if any) are those specified within the [ and ] of the array type
            // derivation.
            let arg_ty = if let TypeKind::Array(t, _) = *arg_ty.kind() {
                t.to_rust_ty(ctx).to_ptr(arg_ty.is_const(), ctx.span())
            } else {
                arg_item.to_rust_ty(ctx)
            };

            let arg_name = match *name {
                Some(ref name) => ctx.rust_mangle(name).into_owned(),
                None => {
                    unnamed_arguments += 1;
                    format!("arg{}", unnamed_arguments)
                }
            };

            assert!(!arg_name.is_empty());

            ast::Arg {
                ty: arg_ty,
                pat: aster::AstBuilder::new().pat().id(arg_name),
                id: ast::DUMMY_NODE_ID,
            }
        }).collect::<Vec<_>>();

        let decl = P(ast::FnDecl {
            inputs: arguments,
            output: ret,
            variadic: self.is_variadic(),
        });

        let fnty = ast::TyKind::BareFn(P(ast::BareFnTy {
            unsafety: ast::Unsafety::Unsafe,
            abi: self.abi(),
            lifetimes: vec![],
            decl: decl,
        }));

        P(ast::Ty {
            id: ast::DUMMY_NODE_ID,
            node: fnty,
            span: ctx.span(),
        })
    }
}

impl CodeGenerator for Function {
    type Extra = Item;

    fn codegen(&self,
               ctx: &BindgenContext,
               result: &mut CodegenResult,
               item: &Item) {
        let name = self.name();
        let canonical_name = item.canonical_name(ctx);

        // TODO: Maybe warn here if there's a type/argument mismatch, or
        // something?
        if result.seen_function(&canonical_name) {
            return;
        }
        result.saw_function(&canonical_name);

        let signature_item = ctx.resolve_item(self.signature());
        let signature = signature_item.kind().expect_type();
        let signature = match *signature.kind() {
            TypeKind::Function(ref sig) => sig,
            _ => panic!("How?"),
        };

        let fndecl = utils::rust_fndecl_from_signature(ctx, signature_item);

        let mut attributes = vec![];

        if let Some(comment) = item.comment() {
            attributes.push(attributes::doc(comment));
        }

        if let Some(mangled) = self.mangled_name() {
            attributes.push(attributes::link_name(mangled));
        } else if name != canonical_name {
            attributes.push(attributes::link_name(name));
        }

        let foreign_item_kind =
            ast::ForeignItemKind::Fn(fndecl, ast::Generics::default());

        let foreign_item =
            ast::ForeignItem {
                ident: ctx.rust_ident_raw(&canonical_name),
                attrs: attributes,
                node: foreign_item_kind,
                id: ast::DUMMY_NODE_ID,
                span: ctx.span(),
                vis: ast::Visibility::Public,
            };

        let item = ForeignModBuilder::new(signature.abi())
            .with_foreign_item(foreign_item)
            .build(ctx);

        result.push(item);
    }
}

type ItemSet = BTreeSet<ItemId>;

trait TypeCollector {
    type Extra;

    fn collect_types(&self,
                     context: &BindgenContext,
                     types: &mut ItemSet,
                     extra: &Self::Extra);
}

impl TypeCollector for ItemId {
    type Extra = ();

    fn collect_types(&self,
                     context: &BindgenContext,
                     types: &mut ItemSet,
                     extra: &()) {
        context.resolve_item(*self).collect_types(context, types, extra);
    }
}

impl TypeCollector for Item {
    type Extra = ();

    fn collect_types(&self,
                     context: &BindgenContext,
                     types: &mut ItemSet,
                     _extra: &()) {
        if self.is_hidden(context) || types.contains(&self.id()) {
            return;
        }

        match *self.kind() {
            ItemKind::Type(ref ty) => {
                types.insert(self.id());
                if !self.is_opaque(context) {
                    ty.collect_types(context, types, self);
                }
            }
            _ => {}, // FIXME.
        }
    }
}

impl TypeCollector for Type {
    type Extra = Item;

    fn collect_types(&self,
                     context: &BindgenContext,
                     types: &mut ItemSet,
                     item: &Item) {
        match *self.kind() {
            TypeKind::Pointer(inner) |
            TypeKind::Reference(inner) |
            TypeKind::Array(inner, _) |
            TypeKind::Alias(_, inner) |
            TypeKind::Named(_, Some(inner)) |
            TypeKind::ResolvedTypeRef(inner)
                => inner.collect_types(context, types, &()),

            TypeKind::TemplateRef(inner, ref template_args) => {
                inner.collect_types(context, types, &());
                for item in template_args {
                    item.collect_types(context, types, &());
                }
            }
            TypeKind::Comp(ref ci) => ci.collect_types(context, types, item),
            TypeKind::Function(ref sig) => {
                sig.collect_types(context, types, item)
            }
            // FIXME: Pending types!
            ref other @ _ => {
                debug!("Ignoring: {:?}", other);
            },
        }
    }
}

impl TypeCollector for FunctionSig {
    type Extra = Item;

    fn collect_types(&self,
                     context: &BindgenContext,
                     types: &mut ItemSet,
                     _item: &Item) {
        self.return_type().collect_types(context, types, &());

        for &(_, ty) in self.argument_types() {
            ty.collect_types(context, types, &());
        }
    }
}

impl TypeCollector for CompInfo {
    type Extra = Item;

    fn collect_types(&self,
                     context: &BindgenContext,
                     types: &mut ItemSet,
                     item: &Item) {
        if let Some(template) = self.specialized_template() {
            template.collect_types(context, types, &());
        }

        let applicable_template_args = item.applicable_template_args(context);
        for arg in applicable_template_args {
            arg.collect_types(context, types, &());
        }

        for base in self.base_members() {
            base.collect_types(context, types, &());
        }

        for field in self.fields() {
            field.ty().collect_types(context, types, &());
        }

        for ty in self.inner_types() {
            ty.collect_types(context, types, &());
        }

        // FIXME(emilio): Methods, VTable?
    }
}

pub fn codegen(context: &mut BindgenContext) -> Vec<P<ast::Item>> {
    context.gen(|context| {
        let mut result = CodegenResult::new();

        debug!("codegen: {:?}", context.options());

        // If the whitelisted types and functions sets are empty, just generate
        // everything.
        if context.options().whitelisted_types.is_empty() &&
           context.options().whitelisted_functions.is_empty() &&
           context.options().whitelisted_vars.is_empty() {
            for (_item_id, item) in context.items() {
                // Non-toplevel item parents are the responsible one for generating
                // them.
                if item.is_toplevel(context) {
                    item.codegen(context, &mut result, &());
                }
            }
        } else {
            // Recursively collect all the types dependent on the whitelisted
            // types, then generate them.
            //
            // FIXME(emilio): This pass is probably slow, but it can't be faster
            // than docopt anyway :)
            let mut items = ItemSet::new();
            for (_item_id, item) in context.items() {
                // FIXME(emilio): This probably should look only at whether the
                // parent is a module.
                if !item.is_toplevel(context) {
                    continue;
                }

                let name = item.canonical_name(context);
                match *item.kind() {
                    ItemKind::Type(ref ty) => {
                        if context.options().whitelisted_types.matches(&name) {
                            item.collect_types(context, &mut items, &());
                        }
                        // Unnamed top-level enums are special and we whitelist
                        // them via the whitelisted_vars filter, since they're
                        // effectively top-level constants, and there's no way
                        // for them to be referenced consistently.
                        if let TypeKind::Enum(ref enum_) = *ty.kind() {
                            if ty.name().is_none() {
                                if enum_.variants().iter().any(|variant| {
                                    context.options().whitelisted_vars.matches(&variant.name())
                                }) {
                                    item.collect_types(context, &mut items, &());
                                }
                            }
                        }
                    }
                    ItemKind::Function(ref fun) => {
                        if context.options().whitelisted_functions.matches(&name) {
                            items.insert(item.id());
                            fun.signature().collect_types(context, &mut items, &());
                        }
                    }
                    ItemKind::Var(ref var) => {
                        if context.options().whitelisted_vars.matches(&name) {
                            items.insert(item.id());
                            var.ty().collect_types(context, &mut items, &());
                        }
                    }
                    ItemKind::Module(..) => {}
                }
            }

            fn contains_parent(ctx: &BindgenContext, types: &ItemSet, id: ItemId) -> bool {
                let item = ctx.resolve_item(id);
                let mut last = id;
                let mut current = item.parent_id();

                while last != current {
                    if types.contains(&current) {
                        return true;
                    }
                    last = current;
                    current = ctx.resolve_item(current).parent_id();
                }

                false
            }

            for item_id in items.iter() {
                let item = context.resolve_item(*item_id);
                if item.is_toplevel(context) || !contains_parent(context, &items, *item_id) {
                    item.codegen(context, &mut result, &());
                }
            }
        }
        let saw_union = result.saw_union;
        let mut result = result.items;
        if saw_union {
            utils::prepend_union_types(context, &mut result);
        }
        result
    })
}

mod utils {
    use ir::context::BindgenContext;
    use ir::item::{Item, ItemCanonicalPath, ItemId};
    use ir::ty::TypeKind;
    use syntax::ast;
    use syntax::ptr::P;
    use std::mem;
    use super::ItemToRustTy;
    use aster;

    pub fn prepend_union_types(ctx: &BindgenContext, result: &mut Vec<P<ast::Item>>) {
        let union_field_decl = quote_item!(ctx.ext_cx(),
            #[derive(Debug)]
            #[repr(C)]
            pub struct __BindgenUnionField<T>(::std::marker::PhantomData<T>);
        ).unwrap();

        let union_field_impl = quote_item!(&ctx.ext_cx(),
            impl<T> __BindgenUnionField<T> {
                #[inline]
                pub fn new() -> Self {
                    __BindgenUnionField(::std::marker::PhantomData)
                }

                #[inline]
                pub unsafe fn as_ref(&self) -> &T {
                    ::std::mem::transmute(self)
                }

                #[inline]
                pub unsafe fn as_mut(&mut self) -> &mut T {
                    ::std::mem::transmute(self)
                }
            }
        ).unwrap();

        let union_field_default_impl = quote_item!(&ctx.ext_cx(),
            impl<T> ::std::default::Default for __BindgenUnionField<T> {
                #[inline]
                fn default() -> Self {
                    Self::new()
                }
            }
        ).unwrap();

        let union_field_clone_impl = quote_item!(&ctx.ext_cx(),
            impl<T> ::std::clone::Clone for __BindgenUnionField<T> {
                #[inline]
                fn clone(&self) -> Self {
                    Self::new()
                }
            }
        ).unwrap();

        let union_field_copy_impl = quote_item!(&ctx.ext_cx(),
            impl<T> ::std::marker::Copy for __BindgenUnionField<T> {}
        ).unwrap();

        let items = vec![
            union_field_decl, union_field_impl,
            union_field_default_impl,
            union_field_clone_impl,
            union_field_copy_impl,
        ];

        let old_items = mem::replace(result, items);
        result.extend(old_items.into_iter());
    }


    pub fn build_templated_path(item: &Item, ctx: &BindgenContext, only_named: bool) -> P<ast::Ty> {
        let path = item.canonical_path(ctx);

        let builder = aster::AstBuilder::new().ty().path();
        let template_args = if only_named {
            item.applicable_template_args(ctx).iter().filter(|arg| {
                ctx.resolve_type(**arg).is_named()
            }).map(|arg| {
                arg.to_rust_ty(ctx)
            }).collect::<Vec<_>>()
        } else {
            item.applicable_template_args(ctx).iter().map(|arg| {
                arg.to_rust_ty(ctx)
            }).collect::<Vec<_>>()
        };

        // XXX: I suck at aster.
        if path.len() == 1 {
            return builder.segment(&path[0])
                          .with_tys(template_args).build().build();
        }

        let mut builder = builder.id(&path[0]);
        for (i, segment) in path.iter().skip(1).enumerate() {
            // Take into account the skip(1)
            builder = if i == path.len() - 2 {
                // XXX Extra clone courtesy of the borrow checker.
                builder.segment(&segment)
                       .with_tys(template_args.clone()).build()
            } else {
                builder.segment(&segment).build()
            }
        }

        builder.build()
    }

    fn primitive_ty(ctx: &BindgenContext, name: &str) -> P<ast::Ty> {
        let ident = ctx.rust_ident_raw(&name);
        quote_ty!(ctx.ext_cx(), $ident)
    }

    pub fn type_from_named(ctx: &BindgenContext,
                           name: &str,
                           _inner: ItemId) -> Option<P<ast::Ty>> {
        // FIXME: We could use the inner item to check this is really a
        // primitive type but, who the heck overrides these anyway?
        macro_rules! ty {
            ($which:ident) => {{
                primitive_ty(ctx, stringify!($which))
            }}
        }
        Some(match name {
            "int8_t" => ty!(i8),
            "uint8_t" => ty!(u8),
            "int16_t" => ty!(i16),
            "uint16_t" => ty!(u16),
            "int32_t" => ty!(i32),
            "uint32_t" => ty!(u32),
            "int64_t" => ty!(i64),
            "uint64_t" => ty!(u64),

            "uintptr_t" |
            "size_t" => ty!(usize),

            "intptr_t" |
            "ptrdiff_t" |
            "ssize_t" => ty!(isize),
            _ => return None,
        })
    }

    pub fn rust_fndecl_from_signature(ctx: &BindgenContext, sig: &Item) -> P<ast::FnDecl> {
        use codegen::ToRustTy;

        let signature = sig.kind().expect_type();
        let signature = match *signature.kind() {
            TypeKind::Function(ref sig) => sig,
            _ => panic!("How?"),
        };

        let decl_ty = signature.to_rust_ty(ctx, sig);
        match decl_ty.unwrap().node {
            ast::TyKind::BareFn(bare_fn) => bare_fn.unwrap().decl,
            _ => panic!("How did this happen exactly?"),
        }
    }
}