Remove llvm_stable, prevent generating bindings for top-level inlined functions, and add an option to override this behavior.

Author: emilio

.travis.yml

@@ -2,13 +2,13 @@ language: rust
 addons:
     apt:
       sources:
-        - llvm-toolchain-precise-3.8
+        - llvm-toolchain-precise-3.9
         - ubuntu-toolchain-r-test
       packages:
-        - libclang-3.8-dev
-        - llvm-3.8-dev
+        - libclang-3.9-dev
+        - llvm-3.9-dev
 env:
-  - LLVM_VERSION=3.8
+  - LLVM_VERSION=3.9
 rust:
   - stable
   - nightly
@@ -39,7 +39,7 @@ before_script:
   - echo $LIBCLANG_PATH
 
 script:
-  - cargo build --verbose --features llvm_stable
+  - cargo build --verbose
   - make test
   - git add -A
   - git diff @

Cargo.toml

@@ -43,7 +43,6 @@ features = ["with-syntex"]
 version = "0.20"
 
 [features]
-llvm_stable = []
 static = []
 
 [lib]

Makefile

@@ -9,7 +9,7 @@ BINDGEN := ./target/debug/bindgen
 
 .PHONY: $(BINDGEN)
 $(BINDGEN):
-	[ -f $@ ] || cargo build --features llvm_stable
+	[ -f $@ ] || cargo build
 
 .PHONY: test
 test: regen-tests

README.md

@@ -64,11 +64,14 @@ Those instructions list optional steps. For bindgen:
 
 ## Building
 
+Just run:
+
 ```
-$ cargo build --features llvm_stable
+cargo build
 ```
 
-If you want a build with extra features (llvm 3.9) then you can use:
+This version of bindgen requires LLVM 3.9, so if you don't have it installed in
+your `PATH`, you'll need to build it (see below) and do something like:
 
 ```
 $ LIBCLANG_PATH=path/to/clang-3.9/build/lib \

src/bin/bindgen.rs

@@ -56,6 +56,8 @@ Options:
 
     --ignore-methods              Avoid generating all kind of methods.
 
+    --keep-inline-functions       Generate code for inline functions anyway.
+
     --enable-cxx-namespaces       Enable support for C++ namespaces.
 
     --no-type-renaming            Don't rename types.
@@ -158,6 +160,9 @@ fn parse_args_or_exit(args: Vec<String>) -> (BindgenOptions, Box<io::Write>) {
             "--ignore-functions" => {
                 options.ignore_functions = true;
             }
+            "--keep-inline-functions" => {
+                options.keep_inline_functions = true;
+            }
             "--no-bitfield-methods" => {
                 options.gen_bitfield_methods = false;
             }

src/clang.rs

@@ -17,8 +17,9 @@ pub struct Cursor {
 
 impl fmt::Debug for Cursor {
     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
-        write!(fmt, "Cursor({} kind: {}, loc: {}, usr: {:?})",
-               self.spelling(), kind_to_str(self.kind()), self.location(), self.usr())
+        write!(fmt, "Cursor({} kind: {} ({}), loc: {}, usr: {:?})",
+               self.spelling(), kind_to_str(self.kind()), self.kind(),
+               self.location(), self.usr())
     }
 }
 
@@ -211,19 +212,10 @@ impl Cursor {
         }
     }
 
-    #[cfg(not(feature="llvm_stable"))]
     pub fn is_inlined_function(&self) -> bool {
         unsafe { clang_Cursor_isFunctionInlined(self.x) != 0 }
     }
 
-    // TODO: Remove this when LLVM 3.9 is released.
-    //
-    // This is currently used for CI purposes.
-    #[cfg(feature="llvm_stable")]
-    pub fn is_inlined_function(&self) -> bool {
-        false
-    }
-
     // bitfield
     pub fn bit_width(&self) -> Option<u32> {
         unsafe {
@@ -392,9 +384,9 @@ impl Eq for Type {}
 
 impl fmt::Debug for Type {
     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
-        write!(fmt, "Type({}, kind: {}, decl: {:?}, canon: {:?})",
-               self.spelling(), type_to_str(self.kind()), self.declaration(),
-               self.declaration().canonical())
+        write!(fmt, "Type({}, kind: {} ({}), decl: {:?}, canon: {:?})",
+               self.spelling(), type_to_str(self.kind()), self.kind(),
+               self.declaration(), self.declaration().canonical())
     }
 }
 
@@ -573,7 +565,6 @@ impl Type {
         }
     }
 
-    #[cfg(not(feature="llvm_stable"))]
     pub fn named(&self) -> Type {
         unsafe {
             Type { x: clang_Type_getNamedType(self.x) }
@@ -1093,9 +1084,7 @@ pub fn type_to_str(x: Enum_CXTypeKind) -> &'static str {
         CXType_VariableArray => "VariableArray",
         CXType_DependentSizedArray => "DependentSizedArray",
         CXType_MemberPointer => "MemberPointer",
-        #[cfg(not(feature="llvm_stable"))]
         CXType_Auto => "Auto",
-        #[cfg(not(feature="llvm_stable"))]
         CXType_Elaborated => "Elaborated",
         _ => "?"
     }

src/clangll.rs

@@ -408,9 +408,7 @@ pub const CXType_IncompleteArray: c_uint = 114;
 pub const CXType_VariableArray: c_uint = 115;
 pub const CXType_DependentSizedArray: c_uint = 116;
 pub const CXType_MemberPointer: c_uint = 117;
-#[cfg(not(feature="llvm_stable"))]
 pub const CXType_Auto: c_uint = 118;
-#[cfg(not(feature="llvm_stable"))]
 pub const CXType_Elaborated: c_uint = 119;
 pub type Enum_CXCallingConv = c_uint;
 pub const CXCallingConv_Default: c_uint = 0;
@@ -1113,10 +1111,8 @@ extern "C" {
     pub fn clang_Type_getNumTemplateArguments(T: CXType) -> c_int;
     pub fn clang_Type_getTemplateArgumentAsType(T: CXType, i: c_int) ->
      CXType;
-    #[cfg(not(feature="llvm_stable"))]
     pub fn clang_Type_getNamedType(CT: CXType) -> CXType;
     pub fn clang_Cursor_isBitField(C: CXCursor) -> c_uint;
-    #[cfg(not(feature="llvm_stable"))]
     pub fn clang_Cursor_isFunctionInlined(C: CXCursor) -> c_uint;
     pub fn clang_isVirtualBase(arg1: CXCursor) -> c_uint;
     pub fn clang_getCXXAccessSpecifier(arg1: CXCursor) ->

src/ir/comp.rs

@@ -583,7 +583,7 @@ impl CompInfo {
                         return CXChildVisit_Continue;
                     }
 
-                    if cur.is_inlined_function() {
+                    if cur.is_inlined_function() && !ctx.options().keep_inline_functions {
                         return CXChildVisit_Continue;
                     }
 

src/ir/function.rs

@@ -104,6 +104,10 @@ impl FunctionSig {
         use clangll::*;
         debug!("FunctionSig::from_ty {:?} {:?}", ty, cursor);
 
+        if cursor.is_inlined_function() && !ctx.options().keep_inline_functions {
+            return Err(ParseError::Continue);
+        }
+
         // Don't parse operatorxx functions in C++
         let spelling = cursor.spelling();
         if spelling.starts_with("operator") {
@@ -115,6 +119,7 @@ impl FunctionSig {
         } else {
             ty.declaration()
         };
+
         let mut args: Vec<_> = match cursor.kind() {
             CXCursor_FunctionDecl |
             CXCursor_CXXMethod => {

src/ir/ty.rs

@@ -543,7 +543,6 @@ impl Type {
                                 .expect("Not able to resolve array element?");
                 TypeKind::Array(inner, ty.array_size())
             }
-            #[cfg(not(feature="llvm_stable"))]
             CXType_Elaborated => {
                 return Self::from_clang_ty(potential_id, &ty.named(),
                                            location, parent_id, ctx);

src/lib.rs

@@ -173,6 +173,10 @@ pub struct BindgenOptions {
     pub emit_ast: bool,
     pub ignore_functions: bool,
     pub ignore_methods: bool,
+    /// Whether to generate code for inline functions. If you do this, you need
+    /// to make sure you compile the C++ code with a flag like
+    /// -fkeep-inline-functions
+    pub keep_inline_functions: bool,
     pub gen_bitfield_methods: bool,
     pub fail_on_unknown_type: bool,
     pub enable_cxx_namespaces: bool,
@@ -208,6 +212,7 @@ impl Default for BindgenOptions {
             emit_ast: false,
             ignore_functions: false,
             ignore_methods: false,
+            keep_inline_functions: false,
             gen_bitfield_methods: true,
             fail_on_unknown_type: true,
             rename_types: true,

tests/expectations/class_with_typedef.rs

@@ -22,38 +22,16 @@ fn bindgen_test_layout_C() {
     assert_eq!(::std::mem::align_of::<C>() , 8usize);
 }
 extern "C" {
-    #[link_name = "_ZN1C6methodEi"]
-    pub fn C_method(this: *mut C, c: C_MyInt);
-}
-extern "C" {
-    #[link_name = "_ZN1C9methodRefERi"]
-    pub fn C_methodRef(this: *mut C, c: *mut C_MyInt);
-}
-extern "C" {
-    #[link_name = "_ZN1C16complexMethodRefERPKc"]
-    pub fn C_complexMethodRef(this: *mut C, c: *mut C_Lookup);
-}
-extern "C" {
-    #[link_name = "_ZN1C13anotherMethodEi"]
-    pub fn C_anotherMethod(this: *mut C, c: AnotherInt);
+    #[link_name = "_ZN1C16notInlinedMethodEi"]
+    pub fn C_notInlinedMethod(this: *mut C, c: C_MyInt);
 }
 impl Clone for C {
     fn clone(&self) -> Self { *self }
 }
 impl C {
     #[inline]
-    pub unsafe fn method(&mut self, c: C_MyInt) { C_method(&mut *self, c) }
-    #[inline]
-    pub unsafe fn methodRef(&mut self, c: *mut C_MyInt) {
-        C_methodRef(&mut *self, c)
-    }
-    #[inline]
-    pub unsafe fn complexMethodRef(&mut self, c: *mut C_Lookup) {
-        C_complexMethodRef(&mut *self, c)
-    }
-    #[inline]
-    pub unsafe fn anotherMethod(&mut self, c: AnotherInt) {
-        C_anotherMethod(&mut *self, c)
+    pub unsafe fn notInlinedMethod(&mut self, c: C_MyInt) {
+        C_notInlinedMethod(&mut *self, c)
     }
 }
 #[repr(C)]

tests/expectations/inlined_functions.rs

@@ -0,0 +1,37 @@
+/* automatically generated by rust-bindgen */
+
+
+#![allow(non_snake_case)]
+
+
+extern "C" {
+    #[link_name = "_Z3foov"]
+    pub fn foo() -> bool;
+}
+#[repr(C)]
+#[derive(Debug, Copy)]
+pub struct C {
+    pub _address: u8,
+}
+#[test]
+fn bindgen_test_layout_C() {
+    assert_eq!(::std::mem::size_of::<C>() , 1usize);
+    assert_eq!(::std::mem::align_of::<C>() , 1usize);
+}
+extern "C" {
+    #[link_name = "_ZN1C3fooEv"]
+    pub fn C_foo();
+}
+extern "C" {
+    #[link_name = "_ZN1C3barEv"]
+    pub fn C_bar() -> bool;
+}
+impl Clone for C {
+    fn clone(&self) -> Self { *self }
+}
+impl C {
+    #[inline]
+    pub unsafe fn foo() { C_foo() }
+    #[inline]
+    pub unsafe fn bar() -> bool { C_bar() }
+}

tests/headers/class_with_typedef.hpp

@@ -16,6 +16,7 @@ class C {
     void methodRef(MyInt& c) {};
     void complexMethodRef(Lookup& c) {};
     void anotherMethod(AnotherInt c) {};
+    void notInlinedMethod(MyInt c);
 };
 
 class D: public C {

tests/headers/inlined_functions.hpp

@@ -0,0 +1,11 @@
+// bindgen-flags: --keep-inline-functions
+
+inline bool foo() {
+  return true;
+}
+
+class C {
+public:
+  static void foo() { }
+  static bool bar() { return false; }
+};

tests/tools/run-bindgen.py

@@ -40,6 +40,7 @@
 # https://forums.developer.apple.com/thread/9233
 if "DYLD_LIBRARY_PATH" not in env and "LIBCLANG_PATH" in env:
     env["DYLD_LIBRARY_PATH"] = env["LIBCLANG_PATH"]
+
 subprocess.check_call(base_command, cwd=os.getcwd(), env=env)