Merge branch 'master' of github.com:rust-lang/rust-bindgen

Author: adetaylor

CHANGELOG.md

@@ -144,6 +144,16 @@
 
 ## Security
 
+# 0.58.1
+
+Released 2021/04/06
+
+## Added
+
+ * Re-introduced unintentionally removed
+   `bindgen::Builder::whitelist_recursively` (deprecated in favor of
+  `bindgen::Builder::allowlist_recursively`). [#2022][]
+
 # 0.58.0
 
 Released 2021/04/03

Cargo.lock

@@ -15,7 +15,7 @@ readme = "README.md"
 repository = "https://github.com/adetaylor/rust-bindgen"
 documentation = "https://docs.rs/bindgen"
 homepage = "https://rust-lang.github.io/rust-bindgen/"
-version = "0.58.0"
+version = "0.58.1"
 edition = "2018"
 build = "build.rs"
 
@@ -41,6 +41,7 @@ required-features = ["clap"]
 diff = "0.1"
 clap = "2"
 shlex = "1"
+tempfile = "3"
 
 [dependencies]
 bitflags = "1.0.3"

Cargo.toml

@@ -69,6 +69,10 @@ End-users should set these environment variables to modify `bindgen`'s behavior
     - Examples:
         - Specify alternate sysroot: `--sysroot=/path/to/sysroot`
         - Add include search path with spaces: `-I"/path/with spaces"`
+- `BINDGEN_EXTRA_CLANG_ARGS_<TARGET>`: similar to `BINDGEN_EXTRA_CLANG_ARGS`,
+   but used to set per-target arguments to pass to clang. Useful to set system include
+   directories in a target-specific way in cross-compilation environments with multiple targets.
+   Has precedence over `BINDGEN_EXTRA_CLANG_ARGS`.
 
 Additionally, `bindgen` uses `libclang` to parse C and C++ header files.
 To modify how `bindgen` searches for `libclang`, see the [`clang-sys` documentation][clang-sys-env].

README.md

@@ -140,10 +140,16 @@ fn main() {
     cc::Build::new()
         .cpp(true)
         .file("cpp/Test.cc")
+        .include("include")
         .compile("libtest.a");
 
     let macros = Arc::new(RwLock::new(HashSet::new()));
 
+    let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
+    let out_rust_file = out_path.join("test.rs");
+    let out_rust_file_relative = out_rust_file.strip_prefix(std::env::current_dir().unwrap()).unwrap();
+    let out_dep_file = out_path.join("test.d");
+
     let bindings = Builder::default()
         .rustfmt_bindings(false)
         .enable_cxx_namespaces()
@@ -154,7 +160,7 @@ fn main() {
         .raw_line("extern { fn my_prefixed_function_to_remove(i: i32); }")
         .module_raw_line("root::testing", "pub type Bar = i32;")
         .header("cpp/Test.h")
-        .clang_args(&["-x", "c++", "-std=c++11"])
+        .clang_args(&["-x", "c++", "-std=c++11", "-I", "include"])
         .parse_callbacks(Box::new(MacroCallback {
             macros: macros.clone(),
             seen_hellos: Mutex::new(0),
@@ -163,13 +169,18 @@ fn main() {
         .blocklist_function("my_prefixed_function_to_remove")
         .constified_enum("my_prefixed_enum_to_be_constified")
         .opaque_type("my_prefixed_templated_foo<my_prefixed_baz>")
+        .depfile(out_rust_file_relative.display().to_string(), &out_dep_file)
         .generate()
         .expect("Unable to generate bindings");
 
     assert!(macros.read().unwrap().contains("TESTMACRO"));
-
-    let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
-    bindings
-        .write_to_file(out_path.join("test.rs"))
-        .expect("Couldn't write bindings!");
+    bindings.write_to_file(&out_rust_file).expect("Couldn't write bindings!");
+
+    let observed_deps = std::fs::read_to_string(out_dep_file).expect("Couldn't read depfile!");
+    let expected_deps = format!("{}: cpp/Test.h include/stub.h", out_rust_file_relative.display());
+    assert_eq!(
+        observed_deps,
+        expected_deps,
+        "including stub via include dir must produce correct dep path",
+    );
 }

bindgen-integration/build.rs

@@ -1,3 +1,5 @@
+#include "stub.h" // this bad path is made valid by a `-I include` clang arg
+
 #pragma once
 
 #define TESTMACRO

bindgen-integration/cpp/Test.h

@@ -63,6 +63,12 @@ repos to get version 3.9. See http://apt.llvm.org/.
 # pacman -S clang
 ```
 
+#### Fedora
+
+```bash
+# dnf install clang-devel
+```
+
 #### OpenBSD
 
 ```bash

bindgen-integration/include/stub.h

@@ -79,4 +79,12 @@ fn main() {
     println!("cargo:rerun-if-env-changed=LIBCLANG_PATH");
     println!("cargo:rerun-if-env-changed=LIBCLANG_STATIC_PATH");
     println!("cargo:rerun-if-env-changed=BINDGEN_EXTRA_CLANG_ARGS");
+    println!(
+        "cargo:rerun-if-env-changed=BINDGEN_EXTRA_CLANG_ARGS_{}",
+        std::env::var("TARGET").unwrap()
+    );
+    println!(
+        "cargo:rerun-if-env-changed=BINDGEN_EXTRA_CLANG_ARGS_{}",
+        std::env::var("TARGET").unwrap().replace("-", "_")
+    );
 }

book/src/requirements.md

@@ -619,12 +619,18 @@ impl CodeGenerator for Var {
             return;
         }
 
+        let mut attrs = vec![];
+        if let Some(comment) = item.comment(ctx) {
+            attrs.push(attributes::doc(comment));
+        }
+
         let ty = self.ty().to_rust_ty_or_opaque(ctx, &()).ignore_annotations();
 
         if let Some(val) = self.val() {
             match *val {
                 VarType::Bool(val) => {
                     result.push(quote! {
+                        #(#attrs)*
                         pub const #canonical_ident : #ty = #val ;
                     });
                 }
@@ -644,6 +650,7 @@ impl CodeGenerator for Var {
                         helpers::ast_ty::uint_expr(val as _)
                     };
                     result.push(quote! {
+                        #(#attrs)*
                         pub const #canonical_ident : #ty = #val ;
                     });
                 }
@@ -661,12 +668,14 @@ impl CodeGenerator for Var {
                         Ok(string) => {
                             let cstr = helpers::ast_ty::cstr_expr(string);
                             result.push(quote! {
+                                #(#attrs)*
                                 pub const #canonical_ident : &'static #ty = #cstr ;
                             });
                         }
                         Err(..) => {
                             let bytes = helpers::ast_ty::byte_array_expr(bytes);
                             result.push(quote! {
+                                #(#attrs)*
                                 pub const #canonical_ident : #ty = #bytes ;
                             });
                         }
@@ -675,20 +684,20 @@ impl CodeGenerator for Var {
                 VarType::Float(f) => {
                     match helpers::ast_ty::float_expr(ctx, f) {
                         Ok(expr) => result.push(quote! {
+                            #(#attrs)*
                             pub const #canonical_ident : #ty = #expr ;
                         }),
                         Err(..) => return,
                     }
                 }
                 VarType::Char(c) => {
                     result.push(quote! {
+                        #(#attrs)*
                         pub const #canonical_ident : #ty = #c ;
                     });
                 }
             }
         } else {
-            let mut attrs = vec![];
-
             // If necessary, apply a `#[link_name]` attribute
             let link_name = self.mangled_name().unwrap_or(self.name());
             if !utils::names_will_be_identical_after_mangling(
@@ -4277,6 +4286,16 @@ pub(crate) fn codegen(
             }
         }
 
+        if let Some(spec) = context.options().depfile.as_ref() {
+            match spec.write(context.deps()) {
+                Ok(()) => info!(
+                    "Your depfile was generated successfully into: {}",
+                    spec.depfile_path.display()
+                ),
+                Err(e) => warn!("{}", e),
+            }
+        }
+
         context.resolve_item(context.root_module()).codegen(
             context,
             &mut result,

build.rs

@@ -0,0 +1,20 @@
+/// Generating build depfiles from parsed bindings.
+use std::{collections::BTreeSet, path::PathBuf};
+
+#[derive(Debug)]
+pub(crate) struct DepfileSpec {
+    pub output_module: String,
+    pub depfile_path: PathBuf,
+}
+
+impl DepfileSpec {
+    pub fn write(&self, deps: &BTreeSet<String>) -> std::io::Result<()> {
+        let mut buf = format!("{}:", self.output_module);
+
+        for file in deps {
+            buf = format!("{} {}", buf, file);
+        }
+
+        std::fs::write(&self.depfile_path, &buf)
+    }
+}