easily write JNI extern functions with native Rust types
Find a file
2024-09-21 17:37:13 +02:00
src feat: return compiler errors, throw java err 2024-09-21 17:37:13 +02:00
.editorconfig chore: setup project 2024-09-21 17:00:54 +02:00
.gitignore chore: setup project 2024-09-21 17:00:54 +02:00
.rustfmt.toml chore: setup project 2024-09-21 17:00:54 +02:00
Cargo.lock chore: setup project 2024-09-21 17:00:54 +02:00
Cargo.toml chore: setup project 2024-09-21 17:00:54 +02:00
README.md feat: return compiler errors, throw java err 2024-09-21 17:37:13 +02:00

jni-macro

this is a simple procedural macro crate to automatically generate JNI-compatible extern functions

it also wraps functions returning Result<>, making short-circuiting easy

usage

just annotate your functions with

#[jni_macro::jni(package = "your.package.path", class = "ContainerClass")]
fn your_function_name(arg: i32) -> Result<(), String> {
	// your code here
}

by specifying package and class, this crate will write an appropriate wrapper with the right function name. If inner function returns a Result<>, wrapper will also handle it. (currently just panics, soon will throw exceptions!)

note that input/output arguments must be natively FFI safe: there will be no hidden translations! you will have to un-marshal strings yourself

examples

the following function:

#[jni_macro::jni(package = "mp.code", class = "Client")]
fn connect(env: JNIEnv, cacca: JString) -> Result<(), ConnectionError> {
  let config = codemp::api::Config::new("asd".into(), "dsa".into());
  tokio().block_on(codemp::Client::connect(config))?;
  Ok(())
}

gets turned into this couple of functions:

fn connect(env: JNIEnv, host: JString) -> Result<(), ConnectionError> {
  let config = codemp::api::Config::new("mail@example.net".into(), "dont-use-this-password".into());
  tokio::runtime::current().block_on(codemp::Client::connect(config))?;
  Ok(())
}

#[no_mangle]
pub extern "system" fn Java_mp_code_Client_connect<'local>(env: JNIEnv, host: JString) -> () {
  match connect(env, cacca) {
    Ok(x) => x,
    Err(e) => {
      $crate::panicking::panic_fmt($crate::const_format_args!("error in JNI!"));
    }
  }
}

status

this crate is rather early and intended mostly to maintain codemp java bindings, however it's also quite small and only runs at comptime, so should be rather safe to use