feat: generate rust-c bindings automatically

.github/workflows/cmake-debug.yml

@@ -26,6 +26,9 @@ jobs:
     - name: Install Ninja
       run: sudo apt-get install -y ninja-build
 
+    - name: Install cbindgen
+      run: cargo install --force cbindgen
+
     - name: Configure CMake
       run: cmake -G Ninja -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=Debug
 

.github/workflows/cmake-release.yml

@@ -26,6 +26,9 @@ jobs:
       - name: Install Ninja
         run: sudo apt-get install -y ninja-build
 
+      - name: Install cbindgen
+        run: cargo install --force cbindgen
+
       - name: Configure CMake
         run: cmake -G Ninja -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=Release
 

.vscode/settings.json

@@ -1,3 +1,12 @@
 {
-  "rust-analyzer.linkedProjects": ["src/crates/Cargo.toml"]
+  "rust-analyzer.linkedProjects": [
+    "src/crates/Cargo.toml"
+  ],
+  "files.associations": {
+    "quickjs-rs.h": "c",
+    "js-array.h": "c",
+    "types.h": "c",
+    "list.h": "c",
+    "js-function.h": "c"
+  }
 }

CMakeLists.txt

@@ -38,6 +38,7 @@ set(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)
 # include c headers
 include_directories(${PROJECT_SOURCE_DIR}/include)
 include_directories(${PROJECT_SOURCE_DIR}/vendor/mimalloc/include)
+include_directories(${PROJECT_SOURCE_DIR}/src/crates/include)
 add_subdirectory(src)
 add_subdirectory(vendor/mimalloc)
 

include/quickjs/quickjs.h

@@ -980,6 +980,9 @@ int JS_SetModuleExportList(JSContext* ctx, JSModuleDef* m, const JSCFunctionList
 } /* extern "C" { */
 #endif
 
+/* quickjs_rs c bindings */
+#include "quickjs-rs.h"
+
 /* Should use in `jsc` repl only */
 #ifdef CONFIG_DEBUG_ON_RELEASE
 void __internal_debug_log(const char* fmt, ...);

src/CMakeLists.txt

@@ -61,9 +61,15 @@ add_library(quickjs
     core/misc/debug.c
 )
 
-# link quickjs rust library
+# create a custom target for including headers
+add_custom_target(include_rust_c_bindings
+    COMMAND echo "include headers: ${PROJECT_SOURCE_DIR}/src/crates/target/include"
+    COMMAND include_directories(${PROJECT_SOURCE_DIR}/src/crates/target/include)
+)
+
+# build rust libraries
 corrosion_import_crate(MANIFEST_PATH ${CMAKE_SOURCE_DIR}/src/crates/Cargo.toml)
-target_link_libraries(quickjs quickjs_rust)
+target_link_libraries(quickjs quickjs_rs)
 
 set(QUICKJS_VERSION STRING "0.1.0")
 

src/core/runtime.c

@@ -2612,9 +2612,6 @@ void JS_SetRuntimeInfo(JSRuntime* rt, const char* s) {
     rt->rt_info = s;
 }
 
-// TODO remove it from `core`
-void print_gc_objects(struct list_head *head);
-
 void JS_FreeRuntime(JSRuntime* rt) {
   struct list_head *el, *el1;
   int i;

src/crates/.gitignore

@@ -1 +1,2 @@
-target/
+target/
+include/

src/crates/Cargo.toml

@@ -3,4 +3,4 @@ resolver = "2"
 members = [
     "quickjs",
     "quickjs_gc"
-]
+]

src/crates/README.md

@@ -2,4 +2,19 @@
 
 ## Prerequisites
 
-1. `rust >= 1.70.0`, make sure using `rustup` to update your rust toolchain.
+### `rust nightly`
+
+We rely on features that are only available in `rust nightly`. To install `rust nightly`:
+
+```bash
+rustup default nightly
+rustup update
+```
+
+### `cbindgen`
+
+We use `cbindgen` to generate the C header file for the Rust library. To install `cbindgen`:
+
+```bash
+cargo install --force cbindgen
+```

src/crates/cbindgen.toml

@@ -0,0 +1,10 @@
+# Whether cbindgen's default C/C++ standard imports should be suppressed. These
+# imports are included by default because our generated headers tend to require
+# them (e.g. for uint32_t). Currently, the generated imports are:
+#
+# * for C: <stdarg.h>, <stdbool.h>, <stdint.h>, <stdlib.h>, <uchar.h>
+#
+# * for C++: <cstdarg>, <cstdint>, <cstdlib>, <new>, <cassert> (depending on config)
+#
+# default: false
+no_includes = true

src/crates/quickjs/Cargo.toml

@@ -2,9 +2,10 @@
 name = "quickjs"
 version = "0.1.0"
 edition = "2021"
+build = "build.rs"
 
 [lib]
-name = "quickjs_rust"
+name = "quickjs_rs"
 crate-type = ["staticlib"]
 
 [dependencies]

src/crates/quickjs/build.rs

@@ -0,0 +1,28 @@
+use std::env;
+use std::path::PathBuf;
+use std::process::Command;
+
+fn main() {
+    env::set_var("RUST_BACKTRACE", "1");
+    let current_dir = env::current_dir().unwrap();
+    let working_dir = current_dir.parent().unwrap();
+
+    let home_dir = env::var("HOME").expect("HOME environment variable not found.");
+    let cbindgen_bin_path = PathBuf::from(&home_dir).join(".cargo/bin/cbindgen");
+
+    let output = Command::new(cbindgen_bin_path)
+        .current_dir(&working_dir)
+        .arg("--config")
+        .arg("cbindgen.toml")
+        .arg("--crate")
+        .arg("quickjs_gc") // quickjs_gc
+        .arg("--lang")
+        .arg("c")
+        .arg("--output")
+        .arg("include/quickjs-rs.h")
+        .output()
+        .expect("FAiled");
+
+    println!("{}", String::from_utf8_lossy(&output.stdout));
+    eprintln!("{}", String::from_utf8_lossy(&output.stderr));
+}

src/crates/quickjs/src/lib.rs

@@ -1 +1 @@
-pub use quickjs_gc::{print_gc_objects};
+pub use quickjs_gc::print_gc_objects;