rust: enable bindings to be built without existing cmake build dir

Author: NickeZ

.gitattributes

@@ -1 +1,2 @@
-/py/bitbox02/bitbox02/generated/* linguist-generated=true
+/py/bitbox02/bitbox02/generated/** linguist-generated=true
+/src/rust/vendor/** linguist-generated=true

src/CMakeLists.txt

@@ -306,6 +306,14 @@ add_custom_target(rust-bindgen
   )
 add_dependencies(rust-bindgen generate-protobufs)
 
+# A custom target to export the list of includes for rust tooling (RA, clippy)
+add_custom_command(OUTPUT rust-bindgen.flags
+  COMMAND
+    ${CMAKE_COMMAND} -E echo ${RUST_INCLUDES} > rust-bindgen.flags
+)
+add_custom_target(rust-bindgen-includes DEPENDS rust-bindgen.flags)
+add_dependencies(rust-bindgen-includes generate-protobufs)
+
 
 # Test rust crates that contain business logic. Avoid testing crates that depend on hardware.
 if(NOT CMAKE_CROSSCOMPILING)

src/rust/README.md

@@ -35,3 +35,15 @@ The bottom-most layer are bindings generated from C header files:
 
 We generate one header file `rust.h` and ever product specific function is `#ifdeffed` with
 `RUST_PRODUCT_*` macro.
+
+
+# rust-analyzer / clippy
+
+If you can run the following on your dev machine you should be able to use rust analyzer and cargo
+clippy in the rust projects.
+
+```
+cmake build-build && cd build-build && make rust-bindgen-includes
+```
+
+See the Dockerfile for necessary dependencies.

src/rust/bitbox02-sys/build.rs

@@ -0,0 +1,44 @@
+use std::process::Command;
+use std::fs::File;
+use std::io::prelude::*;
+
+fn main() {
+    let path_to_bindings = if let Ok(cmake_dir) = std::env::var("CMAKE_CURRENT_BINARY_DIR") {
+        // if we are being invoked from CMAKE, the bindings are here:
+        format!("{}/rust", cmake_dir)
+    } else {
+        let bitbox02_sys_dir = std::env::var("CARGO_MANIFEST_DIR").unwrap();
+        let cmake_dir = format!("{}/../../../", bitbox02_sys_dir);
+        let outdir = std::env::var("OUT_DIR").unwrap();
+
+        // generate list of includes using CMake
+        let cmake_builddir = format!("{}/_cmake_build_dir", outdir);
+        std::fs::create_dir_all(&cmake_builddir).expect("failed to create a directory");
+        let out = Command::new("cmake").arg(&cmake_dir).current_dir(&cmake_builddir).output().unwrap();
+        assert!(out.status.success());
+        let out = Command::new("make").arg("rust-bindgen-includes").current_dir(&cmake_builddir).output().unwrap();
+        println!("{}", std::str::from_utf8(&out.stdout).unwrap());
+        println!("{}", std::str::from_utf8(&out.stderr).unwrap());
+        assert!(out.status.success());
+        let mut includes_file = File::open(format!("{}/src/rust-bindgen.flags", cmake_builddir)).unwrap();
+        let mut includes = String::new();
+        includes_file.read_to_string(&mut includes).unwrap();
+        let includes:Vec<&str> = includes.trim().split_ascii_whitespace().collect();
+        let target = std::env::var("TARGET").unwrap();
+        let mut flags = vec!["-target", &target, "-DTESTING=1"];
+        flags.extend(&includes);
+
+        // generate bindings
+        let generate_bindings = format!("{}/scripts/generate-bindings.sh", cmake_dir);
+        let bindings = format!("{}/bindings.rs", outdir);
+        let wrapper = format!("{}/wrapper.h", bitbox02_sys_dir);
+        let _ = Command::new(&generate_bindings)
+            .args(&[&bindings, &wrapper])
+            .args(&flags)
+            .output()
+            .unwrap();
+
+        outdir
+    };
+    println!("cargo:rustc-env=BINDINGS={}/bindings.rs", path_to_bindings);
+}

src/rust/bitbox02-sys/src/lib.rs

@@ -19,9 +19,7 @@
 #![allow(non_snake_case)]
 // Can be removed once https://github.com/rust-lang/rust-bindgen/issues/1651 is resolved.
 #![allow(deref_nullptr)]
+#![allow(clippy::all)]
+
 // include our generated bindings
-include!(concat!(
-    env!("CMAKE_CURRENT_BINARY_DIR"),
-    "/rust",
-    "/bindings.rs"
-));
+include!(env!("BINDINGS"));

src/rust/bitbox02/build.rs

@@ -1,24 +1,26 @@
 fn main() {
     #[cfg(feature = "testing")]
     {
-        let cmake_dir = std::env::var("CMAKE_CURRENT_BINARY_DIR").unwrap();
-        println!("cargo:rustc-link-search={}/../lib", cmake_dir);
-        // c and rust code merged :O
-        println!("cargo:rustc-link-lib=bitbox_merged");
-        println!(
-            "cargo:rerun-if-changed={}/../lib/libbitbox_merged.a",
-            cmake_dir
-        );
+        // CMAKE_CURRENT_BINARY_DIR is required for building tests
+        if let Ok(cmake_dir) = std::env::var("CMAKE_CURRENT_BINARY_DIR") {
+            println!("cargo:rustc-link-search={}/../lib", cmake_dir);
+            // c and rust code merged :O
+            println!("cargo:rustc-link-lib=bitbox_merged");
+            println!(
+                "cargo:rerun-if-changed={}/../lib/libbitbox_merged.a",
+                cmake_dir
+            );
 
-        // external libs
-        println!("cargo:rustc-link-lib=wallycore");
-        println!("cargo:rustc-link-lib=secp256k1");
-        println!("cargo:rustc-link-lib=base32");
-        println!("cargo:rustc-link-lib=ctaes");
-        println!("cargo:rustc-link-lib=fatfs");
-        println!("cargo:rustc-link-lib=sd-mock");
+            // external libs
+            println!("cargo:rustc-link-lib=wallycore");
+            println!("cargo:rustc-link-lib=secp256k1");
+            println!("cargo:rustc-link-lib=base32");
+            println!("cargo:rustc-link-lib=ctaes");
+            println!("cargo:rustc-link-lib=fatfs");
+            println!("cargo:rustc-link-lib=sd-mock");
 
-        // system libs
-        println!("cargo:rustc-link-lib=cmocka");
+            // system libs
+            println!("cargo:rustc-link-lib=cmocka");
+        }
     }
 }