Merge pull request #16 from nvdaes/excludeSymbols

nvdaes · web-flow · commit 65a84277406a · 2025-08-10T21:34:18.000+02:00
Add ability to exclude symbols to be reported when typing
diff --git a/.github/workflows/automaticRelease.yaml b/.github/workflows/automaticRelease.yaml
@@ -12,4 +12,3 @@ on:
 jobs:
   pre-release:
     uses: nvdaes/nvdaAddonWorkflows/.github/workflows/automaticRelease.yaml@main
-    
diff --git a/.github/workflows/checkTranslatorsComments.yml b/.github/workflows/checkTranslatorsComments.yml
@@ -29,7 +29,7 @@ jobs:
         pip install scons markdown
         sudo apt update
         sudo apt install gettext
-    
+
     - name: Generate the .pot file
       run: scons pot
 
@@ -43,7 +43,7 @@ jobs:
       #  checkPot.EXPECTED_MESSAGES_WITHOUT_COMMENTS = set()
       #  res = checkPot.checkPot('$(ls *.pot)')
       #  exit(res)
-      #shell: python 
+      #shell: python
       run: |
         python -c "import checkPot;checkPot.EXPECTED_MESSAGES_WITHOUT_COMMENTS = set();exit(checkPot.checkPot('$(ls *.pot)'))"
         echo "nb_errors=$?" >> "$GITHUB_OUTPUT"
@@ -58,4 +58,3 @@ jobs:
         echo "Translators comments: FAIL"
         exit 1;
         fi
-      
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
diff --git a/.github/workflows/manualRelease.yaml b/.github/workflows/manualRelease.yaml
@@ -3,7 +3,7 @@ name: Manual release
 on:
   workflow_dispatch:
     inputs:
-      version:  
+      version:
         description: 'Add-on version'
         required: true
         default: '0.0.0'
@@ -44,7 +44,7 @@ jobs:
           f.seek(0)
           f.write(text)
           f.truncate()
-      shell: python 
+      shell: python
     - name: Build add-on
       run: scons
     - name: Push changes
@@ -61,7 +61,7 @@ jobs:
         gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
         passphrase: ${{ secrets.PASSPHRASE }}
     - if: ${{ inputs.signAddOn }}
-      name: Sign add-on  
+      name: Sign add-on
       run: gpg --detach-sign *.nvda-addon
     - name: Calculate sha256
       run: sha256sum *.nvda-addon >> sha256.txt
@@ -76,4 +76,3 @@ jobs:
         artifacts: "*.nvda-addon,*.sig,publicKey.asc,sha256.txt"
         generateReleaseNotes: true
         prerelease: ${{ inputs.prerelease }}
-        
diff --git a/addon/doc/bg/readme.md b/addon/doc/bg/readme.md
@@ -47,4 +47,3 @@
 *	Първо издание.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/de/readme.md b/addon/doc/de/readme.md
@@ -49,4 +49,3 @@ zugewiesen werden.
 *	Ehrstveröffentlichung.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/es/readme.md b/addon/doc/es/readme.md
@@ -46,4 +46,3 @@ submenú Preferencias, diálogo Gestos de entrada, categoría Configuración.
 *	Versión inicial.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/fi/readme.md b/addon/doc/fi/readme.md
@@ -48,4 +48,3 @@ Asetukset-kategoria.
 *	Ensimmäinen versio.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/fr/readme.md b/addon/doc/fr/readme.md
@@ -48,4 +48,3 @@ commandes, dans la catégorie Configuration.
 *	Première version.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/gl/readme.md b/addon/doc/gl/readme.md
@@ -46,4 +46,3 @@ submenú Preferencias, diálogo Xestos de entrada, categoría Configuración.
 *	Versión inicial.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/hr/readme.md b/addon/doc/hr/readme.md
@@ -48,4 +48,3 @@ kategorija Konfiguracija.
 *	Prva verzija.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/hu/readme.md b/addon/doc/hu/readme.md
@@ -15,7 +15,7 @@ távolítsa el a régit!
 
 ## Beállítások menü ##
 *	A "szimbólumok bemondása" bővítmény beállításai: lehetővé teszi a
-  "szimbólumok bemondása" bővítmény beállításainak elvégzését. 
+  "szimbólumok bemondása" bővítmény beállításainak elvégzését.
 
 Megjegyzés: ha ezt a párbeszédpanelt billentyűparanccsal szeretné megnyitni,
 hozzáadhat billentyűparancsot az NVDA/beállítások/beviteli parancsok
diff --git a/addon/doc/it/readme.md b/addon/doc/it/readme.md
@@ -49,4 +49,3 @@ Configurazione.
 *	Versione iniziale.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/ko/readme.md b/addon/doc/ko/readme.md
@@ -40,4 +40,3 @@
 *	첫 번째 버전
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/pl/readme.md b/addon/doc/pl/readme.md
@@ -47,4 +47,3 @@ Konfiguracja.
 *	Wersja pierwoant.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/pt_BR/readme.md b/addon/doc/pt_BR/readme.md
@@ -47,4 +47,3 @@ entrada), categoria Configuração.
 *	Versão inicial.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/pt_PT/readme.md b/addon/doc/pt_PT/readme.md
@@ -46,4 +46,3 @@ NVDA, Preferências, Definir comandos, na categoria Configuração.
 *	Versão inicial.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/ro/readme.md b/addon/doc/ro/readme.md
@@ -47,4 +47,3 @@ Configurare.
 *	Versiunea inițială.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/ru/readme.md b/addon/doc/ru/readme.md
@@ -45,4 +45,3 @@
 *	Первоначальная версия.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/sk/readme.md b/addon/doc/sk/readme.md
@@ -42,4 +42,3 @@ môžete tak urobiť v dialógu klávesové skratky, vetva možnosti.
 *	Prvé vydanie.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/tr/readme.md b/addon/doc/tr/readme.md
@@ -47,4 +47,3 @@ atanabilir.
 *	İlk sürüm.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/uk/readme.md b/addon/doc/uk/readme.md
@@ -45,4 +45,3 @@
 *	Перша версія.
 
 [[!tag dev stable]]
-
diff --git a/addon/doc/zh_CN/readme.md b/addon/doc/zh_CN/readme.md
@@ -38,4 +38,3 @@
 *	初始版本。
 
 [[!tag dev stable]]
-
diff --git a/addon/globalPlugins/reportSymbols.py b/addon/globalPlugins/reportSymbols.py
@@ -5,10 +5,13 @@
 # Released under GPL 2
 
 import wx
+import copy
 
 import addonHandler
 import globalPluginHandler
 import api
+import characterProcessing
+import ui
 import config
 import speech
 import gui
@@ -27,6 +30,7 @@
 	"speakTypedSpaces": "boolean(default=False)",
 	"speakEnter": "boolean(default=False)",
 	"speakTab": "boolean(default=False)",
+	"excludedSymbols": "string_list(default=list())",
 }
 config.conf.spec["reportSymbols"] = confspec
 
@@ -63,6 +67,8 @@ def onSave(self):
 
 
 class GlobalPlugin(globalPluginHandler.GlobalPlugin):
+	scriptCategory = ADDON_SUMMARY
+
 	def __init__(self):
 		super(globalPluginHandler.GlobalPlugin, self).__init__()
 		NVDASettingsDialog.categoryClasses.append(AddonSettingsPanel)
@@ -88,6 +94,7 @@ def event_typedCharacter(self, obj, nextHandler, ch):
 				and not ch.isalnum()
 				and not ch.isspace()
 				and ord(ch) >= 32
+				and ch not in config.conf["reportSymbols"]["excludedSymbols"]
 			):
 				speech.speakSpelling(ch)
 			elif config.conf["reportSymbols"]["speakTypedSpaces"] and ord(ch) == 32:
@@ -105,6 +112,52 @@ def event_typedCharacter(self, obj, nextHandler, ch):
 	def onSettings(self, evt):
 		gui.mainFrame.popupSettingsDialog(NVDASettingsDialog, AddonSettingsPanel)
 
+	@classmethod
+	def __new__(cls, *args, **kwargs):
+		# Iterate through the available symbols, creating scripts for them.
+		for symbol in cls.getSymbols():
+			cls.addScriptForSymbol(symbol)
+		return super(GlobalPlugin, cls).__new__(cls)
+
+	@classmethod
+	def getSymbols(cls):
+		try:
+			processor = characterProcessing._localeSpeechSymbolProcessors.fetchLocaleData(
+				speech.getCurrentLanguage(),
+			)
+		except LookupError:
+			processor = characterProcessing._localeSpeechSymbolProcessors.fetchLocaleData("en")
+		symbols = [copy.copy(symbol) for symbol in processor.computedSymbols.values()]
+		return symbols
+
+	@classmethod
+	def _getScriptNameForSymbol(cls, symbol):
+		name = symbol.replacement.replace(" ", "_")
+		return "symbol_%s" % name
+
+	@classmethod
+	def _symbolScript(cls, symbol):
+		if symbol.identifier not in config.conf["reportSymbols"]["excludedSymbols"]:
+			config.conf["reportSymbols"]["excludedSymbols"].append(symbol.identifier)
+			# Translators: Reported when a symbol has been added to excludedSymbols.
+			ui.message(_("{symbol} excluded from symbols to report").format(symbol=symbol.replacement))
+		else:
+			config.conf["reportSymbols"]["excludedSymbols"].remove(symbol.identifier)
+			# Translators: Reported when a symbol has been removed to excludedSymbols.
+			ui.message(_("{symbol} included in symbols to report").format(symbol=symbol.replacement))
+
+	@classmethod
+	def addScriptForSymbol(cls, symbol):
+		script = lambda self, gesture: cls._symbolScript(symbol)  # Noqa E731
+		funcName = script.__name__ = "script_%s" % cls._getScriptNameForSymbol(symbol)
+		# Just set the doc string of the script, using the decorator is overkill here.
+		script.__doc__ = _(
+			# Translators: Message presented in input help mode.
+			"Excludes or includes the %s symbol in the set of signs to be reported when typing"
+			% symbol.replacement,
+		)
+		setattr(cls, funcName, script)
+
 	@script(
 		category=SCRCAT_CONFIG,
 		# Translators: message presented in input mode.
diff --git a/readme.md b/readme.md
@@ -10,6 +10,14 @@ It's based on the old ReportSymbols add-on, developed by the same author. You sh
 
 Note: A gesture to open this dialog can be assigned from NVDA menu, Preferences submenu, Input gestures dialog, Configuration category.
 
+## Exclude symbols
+
+From NVDA's menu, Preferences submenu, Input gestures dialog, reportSymbols category, you can assing a gesture to exclude (or include again) symbols to be reported when typing.
+
+## Changes for 29.0.0
+
+* Added ability to assing gestures to exclude or include symbols to be reported when typing.
+
 ## Changes for 8.0
 * Compatible with NVDA 2023.1.
 

Original file line number	Diff line number	Diff line change
`@@ -47,4 +47,3 @@`
`47`	`47`	`* Първо издание.`
`48`	`48`
`49`	`49`	`[[!tag dev stable]]`
`50`		`-`
Original file line number	Diff line number	Diff line change
`@@ -49,4 +49,3 @@ zugewiesen werden.`
`49`	`49`	`* Ehrstveröffentlichung.`
`50`	`50`
`51`	`51`	`[[!tag dev stable]]`
`52`		`-`
Original file line number	Diff line number	Diff line change
`@@ -46,4 +46,3 @@ submenú Preferencias, diálogo Gestos de entrada, categoría Configuración.`
`46`	`46`	`* Versión inicial.`
`47`	`47`
`48`	`48`	`[[!tag dev stable]]`
`49`		`-`
Original file line number	Diff line number	Diff line change
`@@ -48,4 +48,3 @@ Asetukset-kategoria.`
`48`	`48`	`* Ensimmäinen versio.`
`49`	`49`
`50`	`50`	`[[!tag dev stable]]`
`51`		`-`
Original file line number	Diff line number	Diff line change
`@@ -48,4 +48,3 @@ commandes, dans la catégorie Configuration.`
`48`	`48`	`* Première version.`
`49`	`49`
`50`	`50`	`[[!tag dev stable]]`
`51`		`-`