diplomat-runtime 0.15.1

Common runtime utilities used by diplomat codegen
Documentation
#[cfg(feature = "jvm-callback-support")]
use alloc::boxed::Box;
use core::ffi::c_void;
#[cfg(feature = "jvm-callback-support")]
use jni::{
    errors::{Result, ThrowRuntimeExAndDefault},
    objects::{Global, JObject},
    sys::jlong,
    EnvUnowned,
};

/// Struct representing a callback from Rust into a foreign language
///
/// This is largely used internally by the Diplomat macro, and should not need to be constructed
/// manually outside of that context
#[repr(C)]
pub struct DiplomatCallback<ReturnType> {
    /// Any data required to run the callback; e.g. a pointer to the
    /// callback wrapper object in the foreign runtime + the runtime itself
    pub data: *mut c_void,
    /// Function to actually run the callback. Note the first param is mutable, but depending
    /// on if this is passed to a Fn or FnMut may not actually need to be.
    /// FFI-Callers of said functions should cast to mutable.
    ///
    /// Takes in `self.data` and any number of additional arguments.
    pub run_callback: unsafe extern "C" fn(*mut c_void, ...) -> ReturnType,
    /// Function to destroy this callback struct.
    ///
    /// Takes in `self.data`
    pub destructor: Option<unsafe extern "C" fn(*mut c_void)>,
}

impl<ReturnType> Drop for DiplomatCallback<ReturnType> {
    fn drop(&mut self) {
        if let Some(destructor) = self.destructor {
            unsafe {
                (destructor)(self.data);
            }
        }
    }
}

// return a pointer to a JNI Global, which is a JVM GC root to the object provided.
// this can then be stored as a field in a struct, so that the struct
// is not deallocated until the JVM calls a destructor that unwraps
// the Global so it can be dropped.
#[cfg(feature = "jvm-callback-support")]
#[no_mangle]
extern "system" fn create_rust_jvm_cookie<'local>(
    mut env: EnvUnowned<'local>,
    obj_to_ref: JObject<'local>,
) -> jlong {
    env.with_env(|env| -> Result<jlong> {
        let global_ref = env.new_global_ref(obj_to_ref).unwrap();
        Ok(Box::into_raw(Box::new(global_ref)) as jlong)
    })
    .resolve::<ThrowRuntimeExAndDefault>()
}

#[cfg(feature = "jvm-callback-support")]
#[no_mangle]
extern "system" fn destroy_rust_jvm_cookie(global_ref_boxed: jlong) {
    unsafe {
        drop(Box::from_raw(global_ref_boxed as *mut Global<JObject>));
    }
}