diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..344a534 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,64 @@ +name: CI + +on: + push: + branches: + - master + pull_request: + branches: + - master + workflow_dispatch: + +env: + # https://blog.rust-lang.org/2022/06/22/sparse-registry-testing.html + CARGO_UNSTABLE_SPARSE_REGISTRY: "true" + +jobs: + lint: + strategy: + matrix: + toolchain: + # Run against a "known good" nightly + - nightly-2022-07-18 + # Check for breakage on latest nightly + - nightly + # But if latest nightly fails, allow the workflow to continue + continue-on-error: ${{ matrix.toolchain == 'nightly' }} + runs-on: ubuntu-latest + container: devkitpro/devkitarm + steps: + - name: Checkout branch + uses: actions/checkout@v2 + + - name: Setup default Rust toolchain + uses: actions-rs/toolchain@v1 + with: + components: clippy, rustfmt, rust-src + profile: minimal + toolchain: ${{ matrix.toolchain }} + default: true + + - name: Install build tools for host + run: sudo apt-get install -y build-essential + + - name: Install cargo-3ds + uses: actions-rs/cargo@v1 + with: + command: install + # TODO: this should probably just be a released version from crates.io + # once cargo-3ds gets published somewhere... + args: >- + --git https://github.com/rust3ds/cargo-3ds + --rev 7b70b6b26c4740b9a10ab85b832ee73c41142bbb + + - name: Check formatting + run: cargo fmt --all --verbose -- --check + + - name: Cargo check + run: cargo 3ds clippy --color=always --workspace --verbose --all-targets + env: + RUSTFLAGS: + --deny=warnings + + # TODO: it would be nice to actually build 3dsx for examples/tests, etc. + # and run it somehow, but exactly how remains to be seen. diff --git a/ctru-rs/Cargo.toml b/ctru-rs/Cargo.toml index 1016198..3c90be8 100644 --- a/ctru-rs/Cargo.toml +++ b/ctru-rs/Cargo.toml @@ -36,5 +36,29 @@ default = ["romfs", "big-stack"] romfs = [] big-stack = [] +# Temporary feature to disable some examples by default, +# until thread support is upstreamed +std-threads = [] + [package.metadata.cargo-3ds] romfs_dir = "examples/romfs" + +[[example]] +name = "thread-basic" +required-features = ["std-threads"] + +[[example]] +name = "thread-info" +required-features = ["std-threads"] + +[[example]] +name = "thread-locals" +required-features = ["std-threads"] + +[[example]] +name = "futures-basic" +required-features = ["std-threads"] + +[[example]] +name = "futures-tokio" +required-features = ["std-threads"] diff --git a/ctru-rs/examples/network-sockets.rs b/ctru-rs/examples/network-sockets.rs index ac8953d..6526d41 100644 --- a/ctru-rs/examples/network-sockets.rs +++ b/ctru-rs/examples/network-sockets.rs @@ -43,7 +43,7 @@ fn main() { } else { println!("Unable to read stream: {}", e) } - }, + } } let response = b"HTTP/1.1 200 OK\r\nContent-Type: text/html; charset=UTF-8\r\n\r\nHello world\r\n"; diff --git a/ctru-rs/src/services/reference.rs b/ctru-rs/src/services/reference.rs index 7fac227..41319a7 100644 --- a/ctru-rs/src/services/reference.rs +++ b/ctru-rs/src/services/reference.rs @@ -16,7 +16,9 @@ impl ServiceReference { S: FnOnce() -> crate::Result<()>, E: Fn() + Send + Sync + 'static, { - let mut value = counter.lock().expect("Mutex Counter for ServiceReference is poisoned"); // todo: handle poisoning + let mut value = counter + .lock() + .expect("Mutex Counter for ServiceReference is poisoned"); // todo: handle poisoning if *value == 0 { start()?; @@ -35,7 +37,10 @@ impl ServiceReference { impl Drop for ServiceReference { fn drop(&mut self) { - let mut value = self.counter.lock().expect("Mutex Counter for ServiceReference is poisoned"); // todo: handle poisoning + let mut value = self + .counter + .lock() + .expect("Mutex Counter for ServiceReference is poisoned"); // todo: handle poisoning *value -= 1; if *value == 0 { (self.close)(); diff --git a/ctru-sys/src/bin/docstring-to-rustdoc.rs b/ctru-sys/src/bin/docstring-to-rustdoc.rs index b7c7cb9..21b1185 100644 --- a/ctru-sys/src/bin/docstring-to-rustdoc.rs +++ b/ctru-sys/src/bin/docstring-to-rustdoc.rs @@ -19,8 +19,8 @@ //! The followings are _partially_ transformed to Rustdoc format: //! * `@param` -use std::{env, fs, io}; use std::path::Path; +use std::{env, fs, io}; fn main() -> io::Result<()> { let args: Vec = env::args().collect(); @@ -32,9 +32,8 @@ fn main() -> io::Result<()> { .lines() .map(|v| { // Only modify lines with the following structure: `` #[doc ... ] `` - if v.trim_start().starts_with("#[doc") && v.trim_end().ends_with("]") { - v - .replace("@brief", "") + if v.trim_start().starts_with("#[doc") && v.trim_end().ends_with(']') { + v.replace("@brief", "") // Example: ``@param offset Offset of the RomFS...`` -> ``- offset Offset of the RomFS...`` // Will improve in the future .replace("@param", "* ") @@ -54,9 +53,7 @@ fn main() -> io::Result<()> { String::from(v) } }) - .map(|v| { - v + "\n" - }) + .map(|v| v + "\n") .collect::(); let old_bindings_path = bindings_path.to_str().unwrap().to_owned() + ".old"; @@ -67,4 +64,4 @@ fn main() -> io::Result<()> { fs::remove_file(&old_bindings_path)?; Ok(()) -} \ No newline at end of file +}