Merge pull request #7 from Neotron-Compute/release/v0.2.0

Release/v0.2.0

Author: thejpster

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "neotron-api"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 authors = [
     "Jonathan 'theJPster' Pallant <github@thejpster.org.uk>",

README.md

@@ -15,6 +15,10 @@ Note that this API must be FFI-safe, because the [Neotron OS] and the Applicatio
 
 * None
 
+### v0.2.0
+
+* Introduce new type for application entry points (supports passing arguments)
+
 ### v0.1.0
 
 * First Version

src/lib.rs

@@ -154,6 +154,19 @@ pub struct Api {
     pub free: extern "C" fn(ptr: *mut core::ffi::c_void, size: usize, alignment: usize),
 }
 
+/// The type of the entry function for an application
+///
+/// * `api` is a pointer to the [`Api`] callback table
+/// * `argc` is the number of arguments passed. If this is non-zero, then `argv`
+///   must be non-null.
+/// * `argv` is a pointer to the start of an array of arguments to the program.
+///   Every item in that array is a [`FfiString`]. There are `argc` items in the
+///   array.
+///
+/// The function should return `0` on success, or anything else to indicate an
+/// error.
+pub type AppStartFn = extern "C" fn(api: *const Api, argc: usize, argv: *const FfiString) -> i32;
+
 /// Describes how something has failed
 #[repr(C)]
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]