Skip to content

Add support for constructors, and integration tests. #332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 13, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ script:
- cd ../../../bindgen
- cargo test --features "$BINDGEN_FEATURES"
- cargo test --release --features "$BINDGEN_FEATURES"
- cd ../bindgen-integration
- cargo test --features "$BINDGEN_FEATURES"
- cargo test --release --features "$BINDGEN_FEATURES"
Copy link
Member

Choose a reason for hiding this comment

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

I think this is getting big enough that we should pull it out into a ./ci/test script. In a follow up, of course.


notifications:
webhooks: http://build.servo.org:54856/travis
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[workspace]
members = [
"bindgen",
"bindgen-integration",
"libbindgen",
"libbindgen/tests/expectations",
]
15 changes: 15 additions & 0 deletions bindgen-integration/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[package]
name = "bindgen-integration"
description = "A package to test various bindgen features"
version = "0.1.0"
authors = ["Emilio Cobos Álvarez <[email protected]>"]
workspace = ".."
publish = false
build = "build.rs"

[build-dependencies]
libbindgen = { path = "../libbindgen" }
gcc = "0.3"

[features]
llvm_stable = ["libbindgen/llvm_stable"]
28 changes: 28 additions & 0 deletions bindgen-integration/build.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
extern crate libbindgen;
extern crate gcc;

use std::env;
use std::path::PathBuf;
use libbindgen::Builder;

fn main() {
gcc::Config::new()
.cpp(true)
.file("cpp/Test.cc")
.compile("libtest.a");

let bindings = Builder::default()
.no_unstable_rust()
.header("cpp/Test.h")
.clang_arg("-x")
.clang_arg("c++")
.clang_arg("-std=c++11")
.generate()
.expect("Unable to generate bindings");


let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
bindings
.write_to_file(out_path.join("test.rs"))
.expect("Couldn't write bindings!");
}
15 changes: 15 additions & 0 deletions bindgen-integration/cpp/Test.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#include "Test.h"

const char* Test::name() {
return "Test";
}

Test::Test(int foo)
: m_int(foo)
, m_double(0.0)
{}

Test::Test(double foo)
: m_int(0)
, m_double(foo)
{}
10 changes: 10 additions & 0 deletions bindgen-integration/cpp/Test.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#pragma once

class Test {
int m_int;
double m_double;
public:
static const char* name();
Test(int foo);
Test(double foo);
};
28 changes: 28 additions & 0 deletions bindgen-integration/src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
mod bindings {
include!(concat!(env!("OUT_DIR"), "/test.rs"));
}

use std::ffi::CStr;

#[test]
fn test_static_method() {
let c_str = unsafe { bindings::Test::name() };
let name = unsafe {
CStr::from_ptr(c_str).to_string_lossy().into_owned()
};
assert_eq!(name, "Test", "Calling a static C++ method works!");
}

#[test]
fn test_constructor() {
let test = unsafe { bindings::Test::new(5) };
assert_eq!(test.m_int, 5);
assert_eq!(test.m_double, 0.0);
}

#[test]
fn test_overload() {
let test = unsafe { bindings::Test::new1(5.0) };
assert_eq!(test.m_int, 0);
assert_eq!(test.m_double, 5.0);
}
22 changes: 22 additions & 0 deletions libbindgen/src/codegen/helpers.rs
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ impl BlobTyBuilder {
pub mod ast_ty {
use aster;
use ir::context::BindgenContext;
use ir::function::FunctionSig;
use ir::ty::FloatKind;
use syntax::ast;
use syntax::ptr::P;
Expand Down Expand Up @@ -164,4 +165,25 @@ pub mod ast_ty {
let kind = ast::LitKind::FloatUnsuffixed(interned_str);
aster::AstBuilder::new().expr().lit().build_lit(kind)
}

pub fn arguments_from_signature(signature: &FunctionSig,
ctx: &BindgenContext)
-> Vec<P<ast::Expr>> {
// 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;
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<_>>()
}
}
97 changes: 62 additions & 35 deletions libbindgen/src/codegen/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ mod helpers;
use aster;

use ir::annotations::FieldAccessorKind;
use ir::comp::{CompInfo, CompKind, Field, Method};
use ir::comp::{CompInfo, CompKind, Field, Method, MethodKind};
use ir::context::{BindgenContext, ItemId};
use ir::enum_ty::{Enum, EnumVariant, EnumVariantValue};
use ir::function::{Function, FunctionSig};
Expand Down Expand Up @@ -1181,15 +1181,28 @@ impl CodeGenerator for CompInfo {
result.push(item);
}

let mut method_names = Default::default();
if ctx.options().codegen_config.methods {
let mut method_names = Default::default();
for method in self.methods() {
assert!(method.kind() != MethodKind::Constructor);
method.codegen_method(ctx,
&mut methods,
&mut method_names,
result,
whitelisted_items,
item);
self);
}
}

if ctx.options().codegen_config.constructors {
for sig in self.constructors() {
Method::new(MethodKind::Constructor, *sig, /* const */ false)
.codegen_method(ctx,
&mut methods,
&mut method_names,
result,
whitelisted_items,
self);
}
}
}
Expand Down Expand Up @@ -1242,7 +1255,7 @@ trait MethodCodegen {
method_names: &mut HashMap<String, usize>,
result: &mut CodegenResult<'a>,
whitelisted_items: &ItemSet,
parent: &Item);
parent: &CompInfo);
}

impl MethodCodegen for Method {
Expand All @@ -1252,18 +1265,21 @@ impl MethodCodegen for Method {
method_names: &mut HashMap<String, usize>,
result: &mut CodegenResult<'a>,
whitelisted_items: &ItemSet,
_parent: &Item) {
_parent: &CompInfo) {
if self.is_virtual() {
return; // FIXME
}
// First of all, output the actual function.
ctx.resolve_item(self.signature())
.codegen(ctx, result, whitelisted_items, &());

let function_item = ctx.resolve_item(self.signature());
function_item.codegen(ctx, result, whitelisted_items, &());

let function = function_item.expect_function();
let mut name = function.name().to_owned();
let signature_item = ctx.resolve_item(function.signature());
let mut name = match self.kind() {
MethodKind::Constructor => "new".into(),
_ => function.name().to_owned(),
};

let signature = match *signature_item.expect_type().kind() {
TypeKind::Function(ref sig) => sig,
_ => panic!("How in the world?"),
Expand All @@ -1283,7 +1299,7 @@ impl MethodCodegen for Method {
let function_name = function_item.canonical_name(ctx);
let mut fndecl = utils::rust_fndecl_from_signature(ctx, signature_item)
.unwrap();
if !self.is_static() {
if !self.is_static() && !self.is_constructor() {
let mutability = if self.is_const() {
ast::Mutability::Immutable
} else {
Expand Down Expand Up @@ -1319,32 +1335,39 @@ impl MethodCodegen for Method {
};
}

// If it's a constructor, we always return `Self`, and we inject the
// "this" parameter, so there's no need to ask the user for it.
//
// Note that constructors in Clang are represented as functions with
// return-type = void.
if self.is_constructor() {
fndecl.inputs.remove(0);
fndecl.output = ast::FunctionRetTy::Ty(quote_ty!(ctx.ext_cx(), Self));
}

let sig = ast::MethodSig {
unsafety: ast::Unsafety::Unsafe,
abi: Abi::Rust,
decl: P(fndecl.clone()),
decl: P(fndecl),
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<_>>();
let mut exprs =
helpers::ast_ty::arguments_from_signature(&signature, ctx);

let mut stmts = vec![];

if !self.is_static() {
// If it's a constructor, we need to insert an extra parameter with a
// variable called `__bindgen_tmp` we're going to create.
Copy link
Member

Choose a reason for hiding this comment

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

Great :)

if self.is_constructor() {
let tmp_variable_decl =
quote_stmt!(ctx.ext_cx(),
let mut __bindgen_tmp = ::std::mem::uninitialized())
.unwrap();
stmts.push(tmp_variable_decl);
exprs[0] = quote_expr!(ctx.ext_cx(), &mut __bindgen_tmp);
} else if !self.is_static() {
assert!(!exprs.is_empty());
exprs[0] = if self.is_const() {
quote_expr!(ctx.ext_cx(), &*self)
Expand All @@ -1359,14 +1382,18 @@ impl MethodCodegen for Method {
.with_args(exprs)
.build();

stmts.push(ast::Stmt {
id: ast::DUMMY_NODE_ID,
node: ast::StmtKind::Expr(call),
span: ctx.span(),
});

if self.is_constructor() {
stmts.push(quote_stmt!(ctx.ext_cx(), __bindgen_tmp).unwrap());
}

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