feat: expand lua scripting bridge and tooling

Author: BlindMaster24

crates/teamtalk/examples/lua_script_commands.rs

@@ -4,7 +4,7 @@ use teamtalk::extensions::scripts::ScriptManager;
 #[cfg(feature = "scripts")]
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     let mut manager = ScriptManager::new();
-    manager.load_script("commands", "scripts/commands.lua")?;
+    manager.load_script("commands", "crates/teamtalk/examples/scripts/commands.lua")?;
     let handled = manager.call_command("start", &["channel".to_string()])?;
     println!("handled: {}", handled);
     Ok(())

crates/teamtalk/examples/lua_script_events.rs

@@ -0,0 +1,16 @@
+#[cfg(feature = "scripts")]
+use teamtalk::Client;
+#[cfg(feature = "scripts")]
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let client = Client::new()?;
+    client.enable_scripts();
+    client.scripts_mut(|scripts| {
+        let _ = scripts.load_script("events", "crates/teamtalk/examples/scripts/events.lua");
+    });
+    Ok(())
+}
+
+#[cfg(not(feature = "scripts"))]
+fn main() {
+    eprintln!("Enable scripts feature: cargo run --example lua_script_events --features scripts");
+}

crates/teamtalk/examples/scripts/events.lua

@@ -0,0 +1,25 @@
+commands = {
+  start = function(args)
+    return true
+  end
+}
+
+state = {
+  total_text = 0
+}
+
+function on_event(ev)
+  if ev.type == "TextMessage" and ev.text ~= nil then
+    state.total_text = state.total_text + 1
+  end
+  return false
+end
+
+events = {
+  UserJoined = function(ev)
+    return false
+  end,
+  UserLeft = function(ev)
+    return false
+  end
+}

crates/teamtalk/src/client/core.rs

@@ -36,6 +36,8 @@ impl Client {
             self.update_cache_for_event(event, &message);
             self.invoke_hooks(event, &message);
             self.dispatch_bus(event, &message);
+            #[cfg(feature = "scripts")]
+            self.dispatch_scripts(event, &message);
             self.handle_auto_reconnect();
             Some((event, message))
         } else {

crates/teamtalk/src/client/mod.rs

@@ -1,5 +1,7 @@
 //! Core client type and message wrapper.
 use crate::events::{ConnectionState, Error, Event, Result};
+#[cfg(feature = "scripts")]
+use crate::extensions::scripts::ScriptManager;
 use crate::types::ClientId;
 use std::cell::{Cell, RefCell};
 use std::sync::atomic::{AtomicU64, Ordering};
@@ -43,6 +45,8 @@ pub struct Client {
     state: Cell<ConnectionState>,
     hooks: RefCell<ClientHooks>,
     bus: RefCell<bus::EventBus>,
+    #[cfg(feature = "scripts")]
+    scripts: RefCell<Option<ScriptManager>>,
     auto_reconnect: RefCell<AutoReconnectState>,
     cache: RefCell<cache::CacheState>,
 }
@@ -63,6 +67,8 @@ impl Client {
                 state: Cell::new(ConnectionState::Idle),
                 hooks: RefCell::new(ClientHooks::default()),
                 bus: RefCell::new(bus::EventBus::default()),
+                #[cfg(feature = "scripts")]
+                scripts: RefCell::new(None),
                 auto_reconnect: RefCell::new(AutoReconnectState::default()),
                 cache: RefCell::new(cache::CacheState::default()),
             })
@@ -89,6 +95,8 @@ impl Client {
                 state: Cell::new(ConnectionState::Idle),
                 hooks: RefCell::new(ClientHooks::default()),
                 bus: RefCell::new(bus::EventBus::default()),
+                #[cfg(feature = "scripts")]
+                scripts: RefCell::new(None),
                 auto_reconnect: RefCell::new(AutoReconnectState::default()),
                 cache: RefCell::new(cache::CacheState::default()),
             })
@@ -178,6 +186,32 @@ impl Client {
         *self.hooks.borrow_mut() = ClientHooks::default();
     }
 
+    #[cfg(feature = "scripts")]
+    pub fn enable_scripts(&self) {
+        let mut scripts = self.scripts.borrow_mut();
+        if scripts.is_none() {
+            *scripts = Some(ScriptManager::new());
+        }
+    }
+
+    #[cfg(feature = "scripts")]
+    pub fn set_script_manager(&self, manager: ScriptManager) {
+        *self.scripts.borrow_mut() = Some(manager);
+    }
+
+    #[cfg(feature = "scripts")]
+    pub fn clear_scripts(&self) {
+        *self.scripts.borrow_mut() = None;
+    }
+
+    #[cfg(feature = "scripts")]
+    pub fn scripts_mut<F, R>(&self, f: F) -> Option<R>
+    where
+        F: FnOnce(&mut ScriptManager) -> R,
+    {
+        self.scripts.borrow_mut().as_mut().map(f)
+    }
+
     pub(crate) fn set_connection_state(&self, state: ConnectionState) {
         self.state.set(state);
     }
@@ -190,6 +224,13 @@ impl Client {
         self.bus.borrow_mut().dispatch(self, event, msg);
     }
 
+    #[cfg(feature = "scripts")]
+    pub(crate) fn dispatch_scripts(&self, event: crate::events::Event, msg: &Message) {
+        if let Some(manager) = self.scripts.borrow().as_ref() {
+            let _ = manager.handle_event(event, msg);
+        }
+    }
+
     pub(crate) fn invoke_joined_hook(&self, channel_id: crate::types::ChannelId) {
         self.hooks.borrow_mut().fire_joined(self, channel_id);
     }