add scripting module with script! macro

Author: dr-frmr

src/lib.rs

@@ -49,6 +49,9 @@ pub mod timer;
 /// Interact with the virtual filesystem
 pub mod vfs;
 
+/// A set of types and macros for writing "script" processes.
+pub mod scripting;
+
 mod types;
 pub use types::{
     address::{Address, AddressParseError},
@@ -122,6 +125,14 @@ pub fn await_message() -> Result<Message, SendError> {
     }
 }
 
+/// Get the next message body from the message queue, or propagate the error.
+pub fn await_next_message_body() -> Result<Vec<u8>, SendError> {
+    match await_message() {
+        Ok(msg) => Ok(msg.body().to_vec()),
+        Err(e) => Err(e.into()),
+    }
+}
+
 /// Simple wrapper over spawn() in WIT to make use of our good types
 pub fn spawn(
     name: Option<&str>,
@@ -262,11 +273,3 @@ pub fn get_capability(our: &Address, params: &str) -> Option<Capability> {
         })
         .cloned()
 }
-
-/// Get the next message body from the message queue, or propagate the error
-pub fn await_next_message_body() -> Result<Vec<u8>, SendError> {
-    match await_message() {
-        Ok(msg) => Ok(msg.body().to_vec()),
-        Err(e) => Err(e.into()),
-    }
-}

src/scripting/mod.rs

@@ -0,0 +1,41 @@
+#[macro_export]
+/// A macro for writing a "script" process. Using this will create the initial
+/// entry point for your process, including the standard `init` function which
+/// is called by the system, and a set of calls that:
+/// 1. Parse the `our` string into an `Address` object.
+/// 2. Wait for the first message to be sent to the process.
+/// 3. Convert the message body into a string.
+/// 4. Call the `init` function you provide with the `Address` and the message body string.
+///
+/// This is best used by then using `clap` to create a `Command` and parsing the body string with it.
+macro_rules! script {
+    ($init_func:ident) => {
+        struct Component;
+        impl Guest for Component {
+            fn init(our: String) {
+                use kinode_process_lib::{await_message, println, Address, Message, Response};
+                let our: Address = our.parse().unwrap();
+                let Message::Request {
+                    body,
+                    expects_response,
+                    ..
+                } = await_message().unwrap()
+                else {
+                    return;
+                };
+                let body_string =
+                    format!("{} {}", our.process(), std::str::from_utf8(&body).unwrap());
+                let response_string: String = $init_func(our, body_string);
+                if expects_response.is_some() {
+                    Response::new()
+                        .body(response_string.as_bytes())
+                        .send()
+                        .unwrap();
+                } else {
+                    println!("{response_string}");
+                }
+            }
+        }
+        export!(Component);
+    };
+}