Implement diff indication

Author: Danstiv

addon/globalPlugins/devHelper/__init__.py

@@ -1,11 +1,30 @@
+from pathlib import Path
+
+import addonHandler
+import api
 import characterProcessing
+import globalCommands
 import globalPluginHandler
 import languageHandler
+import nvwave
+import scriptHandler
 import speech
+import textInfos
+
+SOUNDS_DIR = Path(__file__).parent / "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):
@@ -63,3 +82,56 @@ def terminate(self):
         speech.speech._getSpellingSpeechWithoutCharMode = (
             self._speech_speech__getSpellingSpeechWithoutCharMode
         )
+
+    @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,
+        category=globalCommands.SCRCAT_TEXTREVIEW,
+        gestures=("kb:numpad7", "kb(laptop):NVDA+upArrow", "ts(text):flickUp"),
+    )
+    def script_review_previous_line(self, gesture):
+        result = globalCommands.commands.script_review_previousLine(gesture)
+        self.report_diff_line_status()
+        return result
+
+    @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.",
+        ),
+        category=globalCommands.SCRCAT_TEXTREVIEW,
+        gestures=("kb:numpad8", "kb(laptop):NVDA+shift+."),
+        speakOnDemand=True,
+    )
+    def script_review_currentLine(self, gesture):
+        result = globalCommands.commands.script_review_currentLine(gesture)
+        if scriptHandler.getLastScriptRepeatCount() == 0:
+            self.report_diff_line_status()
+        return result
+
+    @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,
+        category=globalCommands.SCRCAT_TEXTREVIEW,
+        gestures=("kb:numpad9", "kb(laptop):NVDA+downArrow", "ts(text):flickDown"),
+    )
+    def script_review_nextLine(self, gesture):
+        result = globalCommands.commands.script_review_nextLine(gesture)
+        self.report_diff_line_status()
+        return result
+
+    def report_diff_line_status(self):
+        info = api.getReviewPosition().copy()
+        info.expand(textInfos.UNIT_LINE)
+        text = info.text
+        if not text or text[0] not in DIFF_SOUNDS:
+            return
+        nvwave.playWaveFile(DIFF_SOUNDS[text[0]])

addon/globalPlugins/devHelper/media/diffLineDeleted.wav

@@ -18,8 +18,6 @@ This addon detects 2 or more consecutive spaces, and folds them into a short seq
 For example "space space space space space" becomes "5 space".
 
 ### Diff indication
-Not in upstream for now, I'll add it later.
-
 When navigating through an object using numpad7 or numpad9, the addon checks for a diff character at the beginning of the line.
 
 The space is ignored,  for the plus or minus a sound is played, to make addition/deletion easy to identify.