Redesign and refactor

Author: Danstiv

addon/globalPlugins/devBox/__init__.py

@@ -2,90 +2,68 @@
 
 import addonHandler
 import api
-import characterProcessing
+import config
 import globalCommands
 import globalPluginHandler
-import languageHandler
 import nvwave
 import scriptHandler
 import speech
 import textInfos
 
-SOUNDS_DIR = Path(__file__).parent / "media"
+from . import interface
+from .features.diff_sounds import DiffSoundsFeature
+from .features.space_folding import SpaceFoldingFeature
+
+config.conf.spec["devBox"] = {
+    "features": {
+        "diffSounds": "boolean(default=false)",
+        "spaceFolding": "boolean(default=false)",
+    },
+}
+ADDON_ROOT = Path(addonHandler.getCodeAddon().installPath).resolve()
+SOUNDS_DIR = ADDON_ROOT / "media"
 DIFF_SOUNDS = {
     "-": "diffLineDeleted.wav",
     "+": "diffLineInserted.wav",
 }
 DIFF_SOUNDS = {k: str(SOUNDS_DIR / v) for k, v in DIFF_SOUNDS.items()}
 
-SPACE = characterProcessing.processSpeechSymbol(languageHandler.getLanguage(), " ")
-end_utterance_command = speech.commands.EndUtteranceCommand()
 
 # We need this to get translations fromNVDA standard catalog.
 gettext = _
-addonHandler.initTranslation()
 
 
-def get_spelling_speech_decorator(func):
-    def wrapper(*args, **kwargs):
-        original_commands = list(func(*args, **kwargs))
-        new_commands = []
-        spaces_buffer = []
-
-        def flush_spaces_buffer():
-            spaces_amount = len(spaces_buffer) // 2
-            if spaces_amount < 2:
-                new_commands.extend(spaces_buffer)
-            else:
-                new_commands.append(f"{spaces_amount} {SPACE}")
-                new_commands.append(end_utterance_command)
-            spaces_buffer.clear()
-
-        cursor = 0
-        while cursor < len(original_commands):
-            command = original_commands[cursor]
-            if isinstance(command, str) and command == SPACE:
-                spaces_buffer.extend(original_commands[cursor : cursor + 2])
-                cursor += 2  # Space and end utterance command
-                continue
-            flush_spaces_buffer()
-            new_commands.append(command)
-            cursor += 1
-        flush_spaces_buffer()
-        return new_commands
-
-    return wrapper
+addonHandler.initTranslation()
 
 
 class GlobalPlugin(globalPluginHandler.GlobalPlugin):
     scriptCategory = "Dev Box"
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self._speech__getSpellingSpeechWithoutCharMode = (
-            speech._getSpellingSpeechWithoutCharMode
-        )
-        speech._getSpellingSpeechWithoutCharMode = get_spelling_speech_decorator(
-            speech._getSpellingSpeechWithoutCharMode
-        )
-        self._speech_speech__getSpellingSpeechWithoutCharMode = (
-            speech.speech._getSpellingSpeechWithoutCharMode
-        )
-        speech.speech._getSpellingSpeechWithoutCharMode = get_spelling_speech_decorator(
-            speech.speech._getSpellingSpeechWithoutCharMode
-        )
+        self.config = config.conf["devBox"]
+        self._diff_sounds_enabled = False
+        self.features = [SpaceFoldingFeature(self), DiffSoundsFeature(self)]
+        self.sync_features()
+        interface.add_settings(self.on_config_change)
+        config.post_configProfileSwitch.register(self.on_profile_switch)
+
+    def on_config_change(self):
+        self.sync_features()
+
+    def on_profile_switch(self):
+        self.sync_features()
+
+    def sync_features(self):
+        [feature.sync() for feature in self.features]
 
     def terminate(self):
-        speech._getSpellingSpeechWithoutCharMode = (
-            self._speech__getSpellingSpeechWithoutCharMode
-        )
-        speech.speech._getSpellingSpeechWithoutCharMode = (
-            self._speech_speech__getSpellingSpeechWithoutCharMode
-        )
+        [feature.terminate() for feature in self.features]
+        interface.remove_settings()
+        config.post_configProfileSwitch.unregister(self.on_profile_switch)
 
     @scriptHandler.script(
         description=gettext(
-            # Translators: Input help mode message for move review cursor to previous line command.
             "Moves the review cursor to the previous line of the current navigator object and speaks it",
         ),
         resumeSayAllMode=speech.sayAll.CURSOR.REVIEW,
@@ -99,7 +77,6 @@ def script_review_previous_line(self, gesture):
 
     @scriptHandler.script(
         description=gettext(
-            # Translators: Input help mode message for read current line under review cursor command.
             "Reports the line of the current navigator object where the review cursor is situated. "
             "If this key is pressed twice, the current line will be spelled. "
             "Pressing three times will spell the line using character descriptions.",
@@ -116,7 +93,6 @@ def script_review_currentLine(self, gesture):
 
     @scriptHandler.script(
         description=gettext(
-            # Translators: Input help mode message for move review cursor to next line command.
             "Moves the review cursor to the next line of the current navigator object and speaks it",
         ),
         resumeSayAllMode=speech.sayAll.CURSOR.REVIEW,
@@ -129,6 +105,8 @@ def script_review_nextLine(self, gesture):
         return result
 
     def report_diff_line_status(self):
+        if not self._diff_sounds_enabled:
+            return
         info = api.getReviewPosition().copy()
         info.expand(textInfos.UNIT_LINE)
         text = info.text

addon/globalPlugins/devBox/features/__init__.py

@@ -0,0 +1,47 @@
+from abc import ABC, abstractmethod
+
+import config
+from globalPluginHandler import GlobalPlugin
+
+
+class BaseFeature(ABC):
+    def __init__(self, global_plugin, config_key):
+        self.config_key = config_key
+        self.global_plugin: GlobalPlugin = global_plugin
+        self.is_enabled = False
+
+    @property
+    def features_config(self):
+        return config.conf["devBox"]["features"]
+
+    @property
+    def should_be_enabled(self):
+        return bool(self.features_config[self.config_key])
+
+    def sync(self):
+        if self.should_be_enabled:
+            if not self.is_enabled:
+                self._enable()
+        else:
+            if self.is_enabled:
+                self._disable()
+
+    def terminate(self):
+        if self.is_enabled:
+            self._disable()
+
+    def _enable(self):
+        self.enable()
+        self.is_enabled = True
+
+    def _disable(self):
+        self.disable()
+        self.is_enabled = False
+
+    @abstractmethod
+    def enable(self):
+        pass
+
+    @abstractmethod
+    def disable(self):
+        pass

addon/globalPlugins/devBox/features/base.py

@@ -0,0 +1,12 @@
+from .base import BaseFeature
+
+
+class DiffSoundsFeature(BaseFeature):
+    def __init__(self, global_plugin):
+        super().__init__(global_plugin, "diffSounds")
+
+    def enable(self):
+        self.global_plugin._diff_sounds_enabled = True
+
+    def disable(self):
+        self.global_plugin._diff_sounds_enabled = False

addon/globalPlugins/devBox/features/diff_sounds.py

@@ -0,0 +1,66 @@
+import characterProcessing
+import languageHandler
+import speech
+
+from .base import BaseFeature
+
+SPACE = characterProcessing.processSpeechSymbol(languageHandler.getLanguage(), " ")
+end_utterance_command = speech.commands.EndUtteranceCommand()
+
+
+def get_spelling_speech_decorator(func):
+    def wrapper(*args, **kwargs):
+        original_commands = list(func(*args, **kwargs))
+        new_commands = []
+        spaces_buffer = []
+
+        def flush_spaces_buffer():
+            spaces_amount = len(spaces_buffer) // 2
+            if spaces_amount < 2:
+                new_commands.extend(spaces_buffer)
+            else:
+                new_commands.append(f"{spaces_amount} {SPACE}")
+                new_commands.append(end_utterance_command)
+            spaces_buffer.clear()
+
+        cursor = 0
+        while cursor < len(original_commands):
+            command = original_commands[cursor]
+            if isinstance(command, str) and command == SPACE:
+                spaces_buffer.extend(original_commands[cursor : cursor + 2])
+                cursor += 2  # Space and end utterance command
+                continue
+            flush_spaces_buffer()
+            new_commands.append(command)
+            cursor += 1
+        flush_spaces_buffer()
+        return new_commands
+
+    return wrapper
+
+
+class SpaceFoldingFeature(BaseFeature):
+    def __init__(self, global_plugin):
+        super().__init__(global_plugin, "spaceFolding")
+
+    def enable(self):
+        self._speech__getSpellingSpeechWithoutCharMode = (
+            speech._getSpellingSpeechWithoutCharMode
+        )
+        speech._getSpellingSpeechWithoutCharMode = get_spelling_speech_decorator(
+            speech._getSpellingSpeechWithoutCharMode
+        )
+        self._speech_speech__getSpellingSpeechWithoutCharMode = (
+            speech.speech._getSpellingSpeechWithoutCharMode
+        )
+        speech.speech._getSpellingSpeechWithoutCharMode = get_spelling_speech_decorator(
+            speech.speech._getSpellingSpeechWithoutCharMode
+        )
+
+    def disable(self):
+        speech._getSpellingSpeechWithoutCharMode = (
+            self._speech__getSpellingSpeechWithoutCharMode
+        )
+        speech.speech._getSpellingSpeechWithoutCharMode = (
+            self._speech_speech__getSpellingSpeechWithoutCharMode
+        )

addon/globalPlugins/devBox/features/space_folding.py

@@ -0,0 +1,40 @@
+import addonHandler
+import config
+import gui
+from gui.nvdaControls import CustomCheckListBox
+
+from .interface_helpers import (
+    CheckListBoxToDictConverter,
+    ConfigBoundSettingsPanel,
+    bind_with_config,
+)
+
+addonHandler.initTranslation()
+
+
+class DevBoxSettingsPanel(ConfigBoundSettingsPanel):
+    title = addonHandler.getCodeAddon().manifest["summary"]
+
+    def makeSettings(self, settings_sizer):
+        self.config = config.conf["devBox"]
+        sizer = gui.guiHelper.BoxSizerHelper(self, sizer=settings_sizer)
+        # bind_with_config will try to check checkboxes, so let's add elements first
+        features_list = sizer.addLabeledControl(
+            _("Features"),
+            CustomCheckListBox,
+        )
+        features_list.Append(_("Space folding"), "spaceFolding")
+        features_list.Append(_("Diff sounds"), "diffSounds")
+        self.feature_list = bind_with_config(
+            features_list, "features", CheckListBoxToDictConverter
+        )
+        self.feature_list.SetSelection(0)
+
+
+def add_settings(on_save_callback):
+    DevBoxSettingsPanel.on_save_callback = on_save_callback
+    gui.settingsDialogs.NVDASettingsDialog.categoryClasses.append(DevBoxSettingsPanel)
+
+
+def remove_settings():
+    gui.settingsDialogs.NVDASettingsDialog.categoryClasses.remove(DevBoxSettingsPanel)