Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial pass of libctru version checking in ctru-sys #101

Merged
merged 5 commits into from
Apr 1, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ctru-rs/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
authors = ["Ronald Kinard <[email protected]>"]
description = "A safe wrapper around smealum's ctrulib."
license = "https://en.wikipedia.org/wiki/Zlib_License"
license = "Zlib"
name = "ctru-rs"
version = "0.7.1"
edition = "2021"
Expand All @@ -13,7 +13,7 @@ name = "ctru"

[dependencies]
cfg-if = "1.0"
ctru-sys = { path = "../ctru-sys", version = "0.4" }
ctru-sys = { path = "../ctru-sys", version = "21.2" }
const-zero = "0.1.0"
linker-fix-3ds = { git = "https://github.com/rust3ds/rust-linker-fix-3ds.git" }
pthread-3ds = { git = "https://github.com/rust3ds/pthread-3ds.git" }
Expand Down
7 changes: 5 additions & 2 deletions ctru-sys/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
[package]
name = "ctru-sys"
version = "0.4.1"
version = "21.2.0+2.1.2-1"
authors = ["Ronald Kinard <[email protected]>"]
license = "https://en.wikipedia.org/wiki/Zlib_License"
license = "Zlib"
links = "ctru"
edition = "2021"

[dependencies]
libc = { version = "0.2.121", default-features = false }

[build-dependencies]
which = "4.4.0"
67 changes: 67 additions & 0 deletions ctru-sys/build.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
use std::env;
use std::error::Error;
use std::process::{Command, Output, Stdio};

fn main() {
let dkp_path = env::var("DEVKITPRO").unwrap();
Expand All @@ -14,4 +16,69 @@ fn main() {
_ => "ctru",
}
);

match check_libctru_version() {
Ok((maj, min, patch)) => {
eprintln!("using libctru version {maj}.{min}.{patch}");

// These are accessible by the crate during build with `env!()`.
// We might consider exporting some public constants or something.
println!("cargo:rustc-env=LIBCTRU_VERSION={maj}.{min}.{patch}");
println!("cargo:rustc-env=LIBCTRU_MAJOR={maj}");
println!("cargo:rustc-env=LIBCTRU_MINOR={min}");
println!("cargo:rustc-env=LIBCTRU_PATCH={patch}");

// It would be nice if we could rerun-if-changed on libctru itself,
// maybe we can write a file to OUT_DIR and check that file?
ian-h-chamberlain marked this conversation as resolved.
Show resolved Hide resolved
}
Err(err) => println!("cargo:warning=failed to check libctru version: {err}"),
}
}

fn parse_version(version: &str) -> Result<(String, String, String), &str> {
let versions: Vec<_> = version
.split(|c| c == '.' || c == '-')
.map(String::from)
.collect();

match &versions[..] {
[major, minor, patch, _build] => Ok((major.clone(), minor.clone(), patch.clone())),
_ => Err("unexpected number of version segments"),
}
}

fn check_libctru_version() -> Result<(String, String, String), Box<dyn Error>> {
let pacman = which::which("dkp-pacman").or_else(|_| which::which("pacman"))?;

let Output { stdout, .. } = Command::new(pacman)
.args(["--query", "libctru"])
.stderr(Stdio::inherit())
.output()?;

let output_str = String::from_utf8_lossy(&stdout);

let (_pkg, lib_version) = output_str
.split_once(char::is_whitespace)
.ok_or("unexpected output format")?;

let cargo_pkg_version = env::var("CARGO_PKG_VERSION").unwrap();
let (_, crate_built_version) = cargo_pkg_version
.split_once('+')
.expect("crate version should have '+' delimeter");

let (lib_major, lib_minor, lib_patch) = parse_version(lib_version)?;
let (crate_supported_major, crate_supported_minor, _crate_supported_patch) =
parse_version(crate_built_version)?;

// TODO: does == comparison make sense, or should we use >= or something?
if crate_supported_major != lib_major || crate_supported_minor != lib_minor {
// TODO: should this be a panic (i.e. induce build failure)? Maybe only for major version?

return Err(format!(
"libctru version is {lib_major}.{lib_minor}.{lib_patch}, \
but this crate only supports {crate_supported_major}.{crate_supported_minor}.x"
))?;
}

Ok((lib_major, lib_minor, lib_patch))
}