Updates, additions, minor improvements

plugins/template/__init__.py

@@ -0,0 +1,3 @@
+"""
+    Pligin Module
+"""

plugins/template/__main__.py

@@ -1,53 +1,3 @@
-# Python imports
-import sys, threading, subprocess, time
-
-# Gtk imports
-import gi
-gi.require_version('Gtk', '3.0')
-from gi.repository import Gtk
-
-# Application imports
-
-
-def threaded(fn):
-    def wrapper(*args, **kwargs):
-        threading.Thread(target=fn, args=args, kwargs=kwargs, daemon=False).start()
-    return wrapper
-
-
-class Plugin:
-    def __init__(self, builder, event_system):
-        self._plugin_name  = "Example Plugin"
-        self._builder      = builder
-        self._event_system = event_system
-        self._message      = None
-        self._time_out     = 5
-
-        button             = Gtk.Button(label=self._plugin_name)
-        button.connect("button-release-event", self._do_action)
-
-        plugin_list  = self._builder.get_object("plugin_socket")
-        plugin_list.add(button)
-        plugin_list.show_all()
-
-
-    @threaded
-    def _do_action(self, widget=None, eve=None):
-        message = "Hello, World!"
-        self._event_system.push_gui_event(["some_type", "display_message", ("warning", message, None)])
-
-
-    def set_message(self, data):
-        self._message = data
-
-    def get_plugin_name(self):
-        return self._plugin_name
-
-    def get_socket_id(self):
-        return self._socket_id
-
-    def _run_timeout(self):
-        timeout = 0
-        while not self._message and timeout < self._time_out:
-            time.sleep(1)
-            timeout += 1
+"""
+    Pligin Package
+"""

plugins/template/manifest.json

@@ -0,0 +1,13 @@
+{
+    "manifest": {
+        "name": "Example Plugin",
+        "author": "John Doe",
+        "version": "0.0.1",
+        "support": "",
+        "requests": {
+            "ui_target": "plugin_control_list",
+            "pass_fm_events": "true",
+            "bind_keys": ["Example Plugin||send_message:<Control>f"]
+        }
+    }
+}

plugins/template/plugin.py

@@ -0,0 +1,76 @@
+# Python imports
+import os, threading, subprocess, time
+
+# Lib imports
+import gi
+gi.require_version('Gtk', '3.0')
+from gi.repository import Gtk
+
+# Application imports
+
+
+# NOTE: Threads WILL NOT die with parent's destruction.
+def threaded(fn):
+    def wrapper(*args, **kwargs):
+        threading.Thread(target=fn, args=args, kwargs=kwargs, daemon=False).start()
+    return wrapper
+
+# NOTE: Threads WILL die with parent's destruction.
+def daemon_threaded(fn):
+    def wrapper(*args, **kwargs):
+        threading.Thread(target=fn, args=args, kwargs=kwargs, daemon=True).start()
+    return wrapper
+
+
+
+
+class Plugin:
+    def __init__(self):
+        self.name               = "Example Plugin"  # NOTE: Need to remove after establishing private bidirectional 1-1 message bus
+                                                    #       where self.name should not be needed for message comms
+        self._event_system      = None
+        self._event_sleep_time  = .5
+        self._event_message     = None
+
+
+    def get_ui_element(self):
+        button = Gtk.Button(label=self.name)
+        button.connect("button-release-event", self.send_message)
+        return button
+
+    def set_fm_event_system(self, fm_event_system):
+        self._event_system = fm_event_system
+
+    def run(self):
+        self._module_event_observer()
+
+
+    def send_message(self, widget=None, eve=None):
+        message = "Hello, World!"
+        self._event_system.push_gui_event([self.name, "display_message", ("warning", message, None)])
+
+
+    def wait_for_fm_message(self):
+        while not self._event_message:
+            pass
+
+    @daemon_threaded
+    def _module_event_observer(self):
+        while True:
+            time.sleep(self._event_sleep_time)
+            event = self._event_system.read_module_event()
+            if event:
+                try:
+                    if event[0] == self.name:
+                        target_id, method_target, data = self._event_system.consume_module_event()
+
+                        if not method_target:
+                            self._event_message = data
+                        else:
+                            method = getattr(self.__class__, f"{method_target}")
+                            if data:
+                                data = method(*(self, *data))
+                            else:
+                                method(*(self,))
+                except Exception as e:
+                    print(repr(e))