diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index dc7f708..e99e1fc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -96,6 +96,11 @@ jobs: run: > cargo ndk -t arm64-v8a doc --no-deps + - name: Tests (host build-testing) + run: | + cargo test -F native-activity -F test + cargo test -F game-activity -F test + format: runs-on: ubuntu-latest steps: diff --git a/android-activity/Cargo.toml b/android-activity/Cargo.toml index 4ea8435..06df02c 100644 --- a/android-activity/Cargo.toml +++ b/android-activity/Cargo.toml @@ -30,6 +30,10 @@ native-activity = [] api-level-30 = ["ndk/api-level-30"] api-level-33 = ["api-level-30", "ndk/api-level-33"] +# "Internal" feature to allow build-testing this crate for the host +# architecture, needed to make doctests actually compile sample code. +test = ["ndk/test", "ndk-sys/test"] + [dependencies] log = "0.4" jni-sys = "0.3" diff --git a/android-activity/src/input/sdk.rs b/android-activity/src/input/sdk.rs index 70a2c2c..978ad5a 100644 --- a/android-activity/src/input/sdk.rs +++ b/android-activity/src/input/sdk.rs @@ -284,13 +284,12 @@ impl KeyCharacterMap { /// Get the character that is produced by combining the dead key producing accent with the key producing character c. /// - /// For example, ```get_dead_char('`', 'e')``` returns 'è'. `get_dead_char('^', ' ')` returns '^' and `get_dead_char('^', '^')` returns '^'. + /// For example, ``get_dead_char('`', 'e')`` returns `'è'`. `get_dead_char('^', ' ')` returns `'^'` and `get_dead_char('^', '^')` returns `'^'`. /// /// # Errors /// - /// Since this API needs to use JNI internally to call into the Android JVM it may return - /// a [`AppError::JavaError`] in case there is a spurious JNI error or an exception - /// is caught. + /// Since this API needs to use JNI internally to call into the Android JVM it may return a + /// [`AppError::JavaError`] in case there is a spurious JNI error or an exception is caught. pub fn get_dead_char( &self, accent_char: char, diff --git a/android-activity/src/lib.rs b/android-activity/src/lib.rs index 45cc887..f98ffbe 100644 --- a/android-activity/src/lib.rs +++ b/android-activity/src/lib.rs @@ -13,15 +13,15 @@ //! a wider range of devices. //! //! Standalone applications based on this crate need to be built as `cdylib` libraries, like: -//! ``` +//! ```toml //! [lib] //! crate_type=["cdylib"] //! ``` //! //! and implement a `#[no_mangle]` `android_main` entry point like this: -//! ```rust +//! ``` //! #[no_mangle] -//! fn android_main(app: AndroidApp) { +//! fn android_main(app: android_activity::AndroidApp) { //! //! } //! ``` @@ -64,6 +64,7 @@ //! These are undone after `android_main()` returns //! //! # Android Extensible Enums +// TODO: Move this to the NDK crate, which now implements this for most of the code? //! //! There are numerous enums in the `android-activity` API which are effectively //! bindings to enums declared in the Android SDK which need to be considered @@ -95,7 +96,7 @@ //! For example, here is how you could ensure forwards compatibility with both //! compile-time and runtime extensions of a `SomeEnum` enum: //! -//! ```rust +//! ```ignore //! match some_enum { //! SomeEnum::Foo => {}, //! SomeEnum::Bar => {}, @@ -126,7 +127,7 @@ use ndk::native_window::NativeWindow; use bitflags::bitflags; -#[cfg(not(target_os = "android"))] +#[cfg(all(not(target_os = "android"), not(feature = "test")))] compile_error!("android-activity only supports compiling for Android"); #[cfg(all(feature = "game-activity", feature = "native-activity"))] @@ -550,10 +551,10 @@ impl AndroidApp { /// between native Rust code and Java/Kotlin code running within the JVM. /// /// If you use the [`jni`] crate you can wrap this as a [`JavaVM`] via: - /// ```ignore + /// ```no_run /// # use jni::JavaVM; - /// # let app: AndroidApp = todo!(); - /// let vm = unsafe { JavaVM::from_raw(app.vm_as_ptr()) }; + /// # let app: android_activity::AndroidApp = todo!(); + /// let vm = unsafe { JavaVM::from_raw(app.vm_as_ptr().ast()) }; /// ``` /// /// [`jni`]: https://crates.io/crates/jni @@ -565,10 +566,10 @@ impl AndroidApp { /// Returns a JNI object reference for this application's JVM `Activity` as a pointer /// /// If you use the [`jni`] crate you can wrap this as an object reference via: - /// ```ignore + /// ```no_run /// # use jni::objects::JObject; - /// # let app: AndroidApp = todo!(); - /// let activity = unsafe { JObject::from_raw(app.activity_as_ptr()) }; + /// # let app: android_activity::AndroidApp = todo!(); + /// let activity = unsafe { JObject::from_raw(app.activity_as_ptr().cast()) }; /// ``` /// /// # JNI Safety @@ -725,7 +726,7 @@ impl AndroidApp { /// # Example /// Code to iterate all pending input events would look something like this: /// - /// ```rust + /// ``` /// match app.input_events_iter() { /// Ok(mut iter) => { /// loop { @@ -780,7 +781,7 @@ impl AndroidApp { /// /// Code to handle unicode character mapping as well as combining dead keys could look some thing like: /// - /// ```rust + /// ``` /// let mut combining_accent = None; /// // Snip ///