Steps towards the action ordering option interface

Author: WhiteMagic

gremlin/config.py

@@ -22,7 +22,7 @@
 import re
 import uuid
 
-from typing import Any
+from typing import Any, List, Tuple
 
 from PySide6 import QtCore
 
@@ -205,7 +205,7 @@ def register(
                 logging.getLogger("system").warning(
                     f"Data type for parameter '{key}' changed, updating from " +
                     f"'{self._data[key]["data_type"]}' to '{data_type}'")
-                self._data.key["data_type"] = data_type
+                self._data[key]["data_type"] = data_type
 
             if description != self._data[key]["description"]:
                 self._data[key]["description"] = description
@@ -446,7 +446,7 @@ def get_calibration(
             self,
             uuid: uuid.UUID,
             axis_id: int
-    ) -> list[int, int, int, int, bool]:
+    ) -> tuple[int, int, int, int, bool]:
         """Returns the calibration data of a given axis.
 
         Args:
@@ -459,13 +459,13 @@ def get_calibration(
         if self.exists("calibration", str(uuid).upper(), str(axis_id)):
             return self.value("calibration", str(uuid).upper(), str(axis_id))
         else:
-            return [-32768, 0, 0, 32767, True]
+            return (-32768, 0, 0, 32767, True)
 
     def set_calibration(
             self,
             uuid: uuid.UUID,
             axis_id: int,
-            data: list[int, int, int, int, bool]
+            data: Tuple[int, int, int, int, bool]
     ) -> None:
         self.set("calibration", str(uuid).upper(), str(axis_id), data)
 

gremlin/ui/action_model.py

@@ -22,6 +22,7 @@
 from PySide6 import QtCore, QtQml
 from PySide6.QtCore import Property, Signal, Slot
 
+import gremlin.config
 from gremlin import input_cache
 from gremlin.error import MissingImplementationError, GremlinError
 from gremlin.plugin_manager import PluginManager
@@ -344,3 +345,40 @@ def _compatible_actions(self) -> List[str]:
         fset=_set_activate_on_release,
         notify=actionChanged
     )
+
+
+class ActionPriorityListModel(QtCore.QAbstractListModel):
+
+    # TODO: Needs to be treated as a normal action property type and then
+    #       rendered in the UI
+
+    roles = {
+        QtCore.Qt.UserRole + 1: QtCore.QByteArray("name".encode()),
+        QtCore.Qt.UserRole + 2: QtCore.QByteArray("visible".encode()),
+    }
+
+    def __init__(self, parent: QtCore.QObject=...) -> None:
+        super().__init__(parent)
+        self._config = gremlin.config.Configuration()
+        self._cfg_key = ["global", "general", "action_priorities"]
+
+    def rowCount(self, parent:QtCore.QModelIndex=...) -> int:
+        return len(self._config.value(*self._cfg_key))
+
+    def data(self, index: QtCore.QModelIndex, role: int=...) -> int:
+        if role in ActionPriorityListModel.roles:
+            role_name = ActionPriorityListModel.roles[role].data().decode()
+            data = self._config.value(*self._cfg_key)[index.row()]
+            match role_name:
+                case "name":
+                    return data[0]
+                case "visible":
+                    return data[1]
+                case _:
+                    raise GremlinError(f"Unknown role name {role_name}")
+
+        else:
+            raise GremlinError("Invalid role encountered")
+
+    def roleNames(self) -> Dict:
+        return ActionPriorityListModel.roles

gremlin/ui/config.py

@@ -74,6 +74,8 @@ class ConfigGroupModel(QtCore.QAbstractListModel):
     list model.
     """
 
+    changed = Signal()
+
     roles = {
         QtCore.Qt.UserRole + 1: QtCore.QByteArray("groupName".encode()),
         QtCore.Qt.UserRole + 2: QtCore.QByteArray("entryModel".encode()),
@@ -85,6 +87,10 @@ def __init__(self, section: str, parent: Optional[QtCore.QObject]=None) -> None:
         self._config = gremlin.config.Configuration()
         self._section_name = section
 
+    @Property(str, notify=changed)
+    def sectionName(self) -> str:
+        return self._section_name
+
     def rowCount(self, parent: Optional[QtCore.QModelIndex]) -> int:
         return len(self._config.groups(self._section_name))
 

gremlin/ui/device.py

@@ -277,7 +277,7 @@ def update_model(self) -> None:
     def rowCount(self, parent:QtCore.QModelIndex=...) -> int:
         return len(self._devices)
 
-    def data(self, index:QtCore.QModelIndex, role:int=...) -> Any:
+    def data(self, index: QtCore.QModelIndex, role: int=...) -> Any:
         if role in DeviceListModel.roles:
             role_name = DeviceListModel.roles[role].data().decode()
             return DeviceListModel.role_query[role_name](

joystick_gremlin.py

@@ -62,6 +62,7 @@
 import gremlin.config
 import gremlin.error
 import gremlin.device_initialization
+import gremlin.event_handler
 import gremlin.plugin_manager
 import gremlin.types
 import gremlin.signal
@@ -142,6 +143,35 @@ def register_config_options() -> None:
         "Directory containing additional action plugins", {},
         True
     )
+    cfg.register(
+        "global", "general", "action_priorities",
+        PropertyType.List, [],
+        "Priority order of the actions", {},
+        True
+
+    )
+
+
+def update_action_priorities():
+    cfg = gremlin.config.Configuration()
+    key = ["global", "general", "action_priorities"]
+    priorities = []
+    if cfg.exists(*key):
+        priorities = cfg.value(*key)
+    priorities_tags = [v[0] for v in priorities]
+    plugin_tags = gremlin.plugin_manager.PluginManager().repository.keys()
+
+    for tag in plugin_tags:
+        if tag not in priorities_tags:
+            priorities.append((tag, True))
+    to_delete = []
+    for i, tag in enumerate(priorities_tags):
+        if tag not in plugin_tags:
+            to_delete.append(i)
+    for idx in reversed(to_delete):
+        del priorities[idx]
+
+    cfg.set(*key, priorities)
 
 
 def make_gremlin_app(argv):
@@ -257,9 +287,10 @@ def make_gremlin_app(argv):
     syslog.info("Initializing plugins")
     gremlin.plugin_manager.PluginManager()
 
-    # Purgre configuration options that have not been registered
+    # Purgre configuration options that have not been registered and update
+    # the action priority information
     cfg.purge_unused()
-
+    update_action_priorities()
 
     # +-------------------------------------------------------------------------
     # | Start Gremlin UI