Event system logic rework

This commit is contained in:
2022-09-29 17:22:33 -05:00
parent a7fbc6eadb
commit ded86b81ec
15 changed files with 102 additions and 185 deletions

View File

@@ -5,6 +5,7 @@ import builtins, threading
# Application imports
from utils.event_system import EventSystem
from utils.endpoint_registry import EndpointRegistry
@@ -24,23 +25,6 @@ def daemon_threaded_wrapper(fn):
class EndpointRegistry():
def __init__(self):
self._endpoints = {}
def register(self, rule, **options):
def decorator(f):
self._endpoints[rule] = f
return f
return decorator
def get_endpoints(self):
return self._endpoints
# NOTE: Just reminding myself we can add to builtins two different ways...
# __builtins__.update({"event_system": Builtins()})
builtins.app_name = "SolarFM"

View File

@@ -28,52 +28,32 @@ class Controller(UIMixin, KeyboardSignalsMixin, IPCSignalsMixin, ExceptionHookMi
if debug:
self.window.set_interactive_debugging(True)
if not trace_debug:
self.gui_event_observer()
self._subscribe_to_events()
if unknownargs:
for arg in unknownargs:
if os.path.isdir(arg):
message = f"FILE|{arg}"
event_system.send_ipc_message(message)
event_system.post_event("post_file_to_ipc", message)
if args.new_tab and os.path.isdir(args.new_tab):
message = f"FILE|{args.new_tab}"
event_system.send_ipc_message(message)
event_system.post_event("post_file_to_ipc", message)
def _subscribe_to_events(self):
event_system.subscribe("handle_file_from_ipc", self.handle_file_from_ipc)
event_system.subscribe("get_current_state", self.get_current_state)
event_system.subscribe("display_message", self.display_message)
def tear_down(self, widget=None, eve=None):
self.fm_controller.save_state()
time.sleep(event_sleep_time)
Gtk.main_quit()
@daemon_threaded
def gui_event_observer(self):
while True:
time.sleep(event_sleep_time)
event = event_system.consume_gui_event()
if event:
try:
sender_id, method_target, parameters = event
if sender_id:
method = getattr(self.__class__, "handle_gui_event_and_return_message")
GLib.idle_add(method, *(self, sender_id, method_target, parameters))
else:
method = getattr(self.__class__, method_target)
GLib.idle_add(method, *(self, *parameters,))
except Exception as e:
print(repr(e))
def handle_gui_event_and_return_message(self, sender, method_target, parameters):
method = getattr(self.__class__, f"{method_target}")
data = method(*(self, *parameters))
event_system.push_module_event([sender, None, data])
def handle_plugin_key_event(self, sender, method_target, parameters=()):
event_system.push_module_event([sender, method_target, parameters])
def save_load_session(self, action="save_session"):
wid, tid = self.fm_controller.get_active_wid_and_tid()
tab = self.get_fm_window(wid).get_tab_by_id(tid)

View File

@@ -154,6 +154,8 @@ class Controller_Data:
# if self.to_cut_files:
# state.to_cut_files = self.format_to_uris(state.store, state.wid, state.tid, self.to_cut_files, True)
event_system.post_event("update_state_info_plugins", state)
return state

View File

@@ -13,10 +13,9 @@ class PluginBase:
self._builder = None
self._ui_objects = None
self._fm_state = None
self._event_system = None
self._event_sleep_time = .5
self._event_message = None
def set_fm_event_system(self, fm_event_system):
self._event_system = fm_event_system
@@ -24,32 +23,14 @@ class PluginBase:
def set_ui_object_collection(self, ui_objects):
self._ui_objects = ui_objects
def wait_for_fm_message(self):
while not self._event_message:
pass
def clear_children(self, widget: type) -> None:
''' Clear children of a gtk widget. '''
for child in widget.get_children():
widget.remove(child)
@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()
def subscribe_to_events(self):
self._event_system.subscribe("update_state_info_plugins", self._update_fm_state_info)
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))
def _update_fm_state_info(self, state):
self._fm_state = state

View File

@@ -93,6 +93,7 @@ class PluginsController:
if "pass_fm_events" in keys:
plugin.reference.set_fm_event_system(event_system)
plugin.reference.subscribe_to_events()
if "bind_keys" in keys:
self._keybindings.append_bindings( loading_data["bind_keys"] )

View File

@@ -0,0 +1,22 @@
# Python imports
# Lib imports
# Application imports
class EndpointRegistry():
def __init__(self):
self._endpoints = {}
def register(self, rule, **options):
def decorator(f):
self._endpoints[rule] = f
return f
return decorator
def get_endpoints(self):
return self._endpoints

View File

@@ -1,4 +1,5 @@
# Python imports
from collections import defaultdict
# Lib imports
@@ -7,57 +8,23 @@
class EventSystemPushException(Exception):
...
class EventSystem:
""" Inheret IPCServerMixin. Create an pub/sub systems. """
""" Create event system. """
def __init__(self):
# NOTE: The format used is list of ['who', target, (data,)] Where:
# who is the sender or target ID and is used for context and control flow,
# method_target is the method to call,
# data is the method parameters OR message data to give
# Where data may be any kind of data
self._gui_events = []
self._module_events = []
self.subscribers = defaultdict(list)
# Makeshift "events" system FIFO
def _pop_gui_event(self) -> None:
if len(self._gui_events) > 0:
return self._gui_events.pop(0)
return None
def subscribe(self, event_type, fn):
self.subscribers[event_type].append(fn)
def _pop_module_event(self) -> None:
if len(self._module_events) > 0:
return self._module_events.pop(0)
return None
def push_gui_event(self, event: list) -> None:
if len(event) == 3:
self._gui_events.append(event)
return None
raise EventSystemPushException("Invald event format! Please do: ['sender_id': str, method_target: method, (data,): any]")
def push_module_event(self, event: list) -> None:
if len(event) == 3:
self._module_events.append(event)
return None
raise EventSystemPushException("Invald event format! Please do: ['target_id': str, method_target: method, (data,): any]")
def read_gui_event(self) -> list:
return self._gui_events[0] if self._gui_events else None
def read_module_event(self) -> list:
return self._module_events[0] if self._module_events else None
def consume_gui_event(self) -> list:
return self._pop_gui_event()
def consume_module_event(self) -> list:
return self._pop_module_event()
def post_event(self, event_type, data):
if event_type in self.subscribers:
for fn in self.subscribers[event_type]:
if data:
if hasattr(data, '__iter__'):
fn(*data)
else:
fn(data)
else:
fn()

View File

@@ -29,6 +29,11 @@ class IPCServer:
elif conn_type == "local_network_unsecured":
self._ipc_authkey = None
self._subscribe_to_events()
def _subscribe_to_events(self):
event_system.subscribe("post_file_to_ipc", self.send_ipc_message)
@daemon_threaded
def create_ipc_listener(self) -> None:
@@ -60,7 +65,7 @@ class IPCServer:
if "FILE|" in msg:
file = msg.split("FILE|")[1].strip()
if file:
event_system.push_gui_event([None, "handle_file_from_ipc", (file,)])
event_system.post_event("handle_file_from_ipc", file)
conn.close()
break