add color type validation and custom type

Author: antheas

docs/http.md

@@ -28,7 +28,7 @@ may not check if they exist.
 Each setting has a title which is meant to be shown in the UI and an optional 
 hint meant to be shown under a hover hint or `?` button.
 
-Each setting may include tags, which work like classes. 
+Each setting may include a family, which has a number of tags that work like classes. 
 For example, a keyboard mapping setting may have the tags 
 `[razer_lycosa_123, razer_kbd, keyboard, advanced]`, which would allow the UI
 to customize the presentation based on the specific device make, manufacturer,

src/hhd/__main__.py

@@ -4,9 +4,9 @@
 import os
 import signal
 from os.path import join
-from threading import Condition, RLock
+from threading import Condition
 from threading import Event as TEvent
-from threading import Lock
+from threading import Lock, RLock
 from time import sleep
 from typing import Sequence, cast
 
@@ -23,15 +23,16 @@
     load_relative_yaml,
 )
 from .plugins.settings import (
+    Validator,
     get_default_state,
+    load_blacklist_yaml,
     load_profile_yaml,
     load_state_yaml,
     merge_settings,
+    save_blacklist_yaml,
     save_profile_yaml,
     save_state_yaml,
     validate_config,
-    load_blacklist_yaml,
-    save_blacklist_yaml,
 )
 from .utils import expanduser, fix_perms, get_context, switch_priviledge
 
@@ -198,6 +199,9 @@ def main():
         for plugs in plugins.values():
             sorted_plugins.extend(plugs)
         sorted_plugins.sort(key=lambda x: x.priority)
+        validator: Validator = lambda family, config, value: any(
+            p.validate(family, config, value) for p in sorted_plugins
+        )
 
         if not sorted_plugins:
             logger.error(f"No plugins started, exiting...")
@@ -276,7 +280,7 @@ def main():
                     name = fn.replace(".yml", "")
                     s = load_profile_yaml(join(profile_dir, fn))
                     if s:
-                        validate_config(s, settings, use_defaults=False)
+                        validate_config(s, settings, validator, use_defaults=False)
                         if name.startswith("_"):
                             templates[name] = s
                         else:
@@ -374,7 +378,10 @@ def main():
                             with lock:
                                 profiles[ev["name"]] = ev["config"]
                             validate_config(
-                                profiles[ev["name"]], settings, use_defaults=False
+                                profiles[ev["name"]],
+                                settings,
+                                validator,
+                                use_defaults=False,
                             )
                         else:
                             with lock:
@@ -389,7 +396,7 @@ def main():
                         logger.error(f"Invalid event type submitted: '{other}'")
 
             # Validate config
-            validate_config(conf, settings)
+            validate_config(conf, settings, validator)
 
             # If settings changed, the configuration needs to reload
             # but it needs to be saved first

src/hhd/plugins/plugin.py

@@ -75,6 +75,9 @@ def open(
     def settings(self) -> HHDSettings:
         return {}
 
+    def validate(self, family: Sequence[str], config: Any, value: Any):
+        return False
+
     def prepare(self, conf: Config):
         pass
 

src/hhd/plugins/settings.py

@@ -8,6 +8,7 @@
     Sequence,
     TypedDict,
     cast,
+    Protocol,
 )
 from copy import copy
 
@@ -91,6 +92,12 @@ class IntegerSetting(TypedDict):
     default: int | None
 
 
+class Color(TypedDict):
+    red: int
+    green: int
+    blue: int
+
+
 class ColorSetting(TypedDict):
     """RGB color setting."""
 
@@ -99,7 +106,29 @@ class ColorSetting(TypedDict):
     title: str
     hint: str | None
 
-    default: Mapping | None
+    default: Color | None
+
+
+class CustomSetting(TypedDict):
+    """Custom plugin setting.
+
+    Can be used for any required custom setting that is not covered by the
+    default ones (e.g., fan curves, deadzones).
+
+    The setting type is defined by family.
+    Then, the config variable can be used to supply option specific information
+    (e.g., for fan curves how many temperature points are available).
+
+    To validate this setting, each loaded plugin's validate function is called,
+    with the family, config data, and the supplied value."""
+
+    type: Literal["custom"]
+    family: Sequence[str]
+    title: str
+    hint: str | None
+
+    config: Any | None
+    default: Any | None
 
 
 Setting = (
@@ -110,6 +139,7 @@ class ColorSetting(TypedDict):
     | NumericalSetting
     | IntegerSetting
     | ColorSetting
+    | CustomSetting
 )
 
 #
@@ -244,6 +274,8 @@ def fill_in_defaults(s: Setting | Container | Mode):
         case "integer" | "float":
             s["min"] = s.get("min", None)
             s["max"] = s.get("max", None)
+        case "custom":
+            s["config"] = s.get("config", None)
     return s
 
 
@@ -625,7 +657,14 @@ def unravel_options(settings: HHDSettings):
     return options
 
 
-def validate_config(conf: Config, settings: HHDSettings, use_defaults: bool = True):
+class Validator(Protocol):
+    def __call__(self, family: Sequence[str], config: Any, value: Any) -> bool:
+        return False
+
+
+def validate_config(
+    conf: Config, settings: HHDSettings, validator: Validator, use_defaults: bool = True
+):
     options = unravel_options(settings)
 
     for k, d in options.items():
@@ -667,5 +706,25 @@ def validate_config(conf: Config, settings: HHDSettings, use_defaults: bool = Tr
                 if v > d["max"]:
                     conf[k] = d["max"]
             case "color":
-                # TODO
-                pass
+                invalid = False
+
+                if not isinstance(v, Mapping):
+                    invalid = True
+                else:
+                    for c in ("red", "green", "blue"):
+                        if c not in v:
+                            invalid = True
+                        elif not (0 <= v[c] < 256):
+                            invalid = True
+
+                if invalid:
+                    if use_defaults:
+                        conf[k] = default
+                    else:
+                        del conf[k]
+            case "custom":
+                if not validator(d["family"], d["config"], v):
+                    if use_defaults:
+                        conf[k] = default
+                    else:
+                        del conf[k]