Merge pull request #110 from Techie-Pi/docs/improve-docs-v3

Add `bindgen-ctru-sys` package and update bindings

Cargo.toml

@@ -1,5 +1,6 @@
 [workspace]
-members = ["ctru-rs", "ctru-sys", "ctru-sys/docstring-to-rustdoc"]
+members = ["ctru-rs", "ctru-sys", "ctru-sys/bindgen-ctru-sys"]
+default-members = ["ctru-rs", "ctru-sys"]
 
 [patch.'https://github.com/rust3ds/ctru-rs']
 # Make sure all dependencies use the local ctru-sys package

ctru-rs/Cargo.toml

@@ -13,7 +13,7 @@ name = "ctru"
 
 [dependencies]
 cfg-if = "1.0"
-ctru-sys = { path = "../ctru-sys", version = "21.2" }
+ctru-sys = { path = "../ctru-sys", version = "22.0" }
 const-zero = "0.1.0"
 shim-3ds = { git = "https://github.com/rust3ds/shim-3ds.git" }
 pthread-3ds = { git = "https://github.com/rust3ds/pthread-3ds.git" }

ctru-sys/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ctru-sys"
-version = "21.2.0+2.1.2-1"
+version = "22.0.0+2.2.0"
 authors = [ "Rust3DS Org", "Ronald Kinard <furyhunter600@gmail.com>" ]
 license = "Zlib"
 links = "ctru"

ctru-sys/bindgen-ctru-sys/Cargo.toml

@@ -1,7 +1,8 @@
 [package]
-name = "docstring-to-rustdoc"
+name = "bindgen-ctru-sys"
 version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-doxygen-rs = "0.3.1"
+bindgen = "0.64"
+doxygen-rs = "0.4"

ctru-sys/bindgen-ctru-sys/src/main.rs

@@ -0,0 +1,60 @@
+use bindgen::callbacks::ParseCallbacks;
+use bindgen::{Builder, RustTarget};
+use std::path::PathBuf;
+
+#[derive(Debug)]
+struct CustomCallbacks;
+
+impl ParseCallbacks for CustomCallbacks {
+    fn process_comment(&self, comment: &str) -> Option<String> {
+        Some(doxygen_rs::transform(comment))
+    }
+}
+
+fn main() {
+    let devkitpro = std::env::var("DEVKITPRO").expect("DEVKITPRO not set in environment");
+    let devkitarm = std::env::var("DEVKITARM").expect("DEVKITARM not set in environment");
+
+    let include_path = PathBuf::from_iter([devkitpro.as_str(), "libctru", "include"]);
+    let header = include_path.join("3ds.h");
+
+    let sysroot = PathBuf::from(devkitarm).join("arm-none-eabi");
+    let system_include = sysroot.join("include");
+
+    let bindings = Builder::default()
+        .header(header.to_str().unwrap())
+        .rust_target(RustTarget::Nightly)
+        .use_core()
+        .trust_clang_mangling(false)
+        .must_use_type("Result")
+        .layout_tests(false)
+        .ctypes_prefix("::libc")
+        .prepend_enum_name(false)
+        .blocklist_type("u(8|16|32|64)")
+        .blocklist_type("__builtin_va_list")
+        .blocklist_type("__va_list")
+        .opaque_type("MiiData")
+        .derive_default(true)
+        .clang_args([
+            "--target=arm-none-eabi",
+            "--sysroot",
+            sysroot.to_str().unwrap(),
+            "-isystem",
+            system_include.to_str().unwrap(),
+            "-I",
+            include_path.to_str().unwrap(),
+            "-mfloat-abi=hard",
+            "-march=armv6k",
+            "-mtune=mpcore",
+            "-mfpu=vfp",
+            "-DARM11",
+            "-D__3DS__",
+        ])
+        .parse_callbacks(Box::new(CustomCallbacks))
+        .generate()
+        .expect("unable to generate bindings");
+
+    bindings
+        .write(Box::new(std::io::stdout()))
+        .expect("failed to write bindings");
+}

ctru-sys/bindgen.sh

@@ -21,35 +21,7 @@ CTRU_SYS_VERSION="$(
 )"
 
 echo "Generating bindings.rs..."
-bindgen "$DEVKITPRO/libctru/include/3ds.h" \
-    --rust-target nightly \
-    --use-core \
-    --distrust-clang-mangling \
-    --must-use-type 'Result' \
-    --no-layout-tests \
-    --ctypes-prefix "::libc" \
-    --no-prepend-enum-name \
-    --generate "functions,types,vars" \
-    --blocklist-type "u(8|16|32|64)" \
-    --blocklist-type "__builtin_va_list" \
-    --blocklist-type "__va_list" \
-    --opaque-type "MiiData" \
-    --with-derive-default \
-    -- \
-    --target=arm-none-eabi \
-    --sysroot="$DEVKITARM/arm-none-eabi" \
-    -isystem"$DEVKITARM/arm-none-eabi/include" \
-    -I"$DEVKITPRO/libctru/include" \
-    -mfloat-abi=hard \
-    -march=armv6k \
-    -mtune=mpcore \
-    -mfpu=vfp \
-    -DARM11 \
-    -D__3DS__ \
-> src/bindings.rs
-
-echo "Updating docstrings in bindings.rs..."
-cargo run --quiet --package docstring-to-rustdoc -- src/bindings.rs
+cargo run --package bindgen-ctru-sys > src/bindings.rs
 
 echo "Formatting generated files..."
 cargo fmt --all

ctru-sys/docstring-to-rustdoc/src/main.rs

@@ -1,31 +0,0 @@
-//! This script transforms _some_ Boxygen comments to Rustdoc format
-//!
-//! # Usage
-//!
-//! `cargo run --package docstring-to-rustdoc -- [location of the bindings.rs]`
-//! Example: `cargo run --package docstring-to-rustdoc -- src/bindings.rs`
-//!
-//! # Transformations
-//!
-//! Check [doxygen-rs docs](https://techie-pi.github.io/doxygen-rs/doxygen_rs/)
-
-use std::path::Path;
-use std::{env, fs, io};
-
-fn main() -> io::Result<()> {
-    let args: Vec<String> = env::args().collect();
-
-    let bindings_path = Path::new(args.get(1).expect("bindings.rs not provided in the args"));
-    let bindings = fs::read_to_string(bindings_path)?;
-
-    let parsed = doxygen_rs::transform_bindgen(bindings.as_str());
-
-    let old_bindings_path = bindings_path.to_str().unwrap().to_owned() + ".old";
-
-    // If something fails, the original bindings are available at ``bindings.rs.old``
-    fs::rename(bindings_path, &old_bindings_path)?;
-    fs::write(bindings_path, parsed)?;
-    fs::remove_file(&old_bindings_path)?;
-
-    Ok(())
-}