Merge 0c53b5f into ca871a4

CyrilleB79 · web-flow · commit 07328b13032c · 2021-07-27T20:18:21.000+10:00
diff --git a/source/config/configSpec.py b/source/config/configSpec.py
@@ -279,6 +279,8 @@
 [featureFlag]
 	# 0:default, 1:yes, 2:no
 	cancelExpiredFocusSpeech = integer(0, 2, default=0)
+	# 0:Only in test versions, 1:yes
+	playErrorSound = integer(0, 1, default=0)
 """
 
 #: The configuration specification
diff --git a/source/gui/settingsDialogs.py b/source/gui/settingsDialogs.py
@@ -2838,6 +2838,20 @@ def __init__(self, parent):
 					self._getDefaultValue(['debugLog', x])
 			)
 		]
+		
+		# Translators: Label for the Play a sound for logged errors combobox, in the Advanced settings panel.
+		label = _("Play a sound for logged e&rrors:")
+		playErrorSoundChoices = (
+			# Translators: Label for a value in the Play a sound for logged errors combobox, in the Advanced settings panel.
+			pgettext("advanced.playErrorSound", "Only in NVDA test versions"),
+			# Translators: Label for a value in the Play a sound for logged errors combobox, in the Advanced settings panel.
+			pgettext("advanced.playErrorSound", "Yes"),
+		)
+		self.playErrorSoundCombo = debugLogGroup.addLabeledControl(label, wx.Choice, choices=playErrorSoundChoices)
+		self.bindHelpEvent("PlayErrorSound", self.playErrorSoundCombo)
+		self.playErrorSoundCombo.SetSelection(config.conf["featureFlag"]["playErrorSound"])
+		self.playErrorSoundCombo.defaultValue = self._getDefaultValue(["featureFlag", "playErrorSound"])
+		
 		self.Layout()
 
 	def onOpenScratchpadDir(self,evt):
@@ -2912,6 +2926,7 @@ def onSave(self):
 		config.conf["annotations"]["reportDetails"] = self.annotationsDetailsCheckBox.IsChecked()
 		for index,key in enumerate(self.logCategories):
 			config.conf['debugLog'][key]=self.logCategoriesList.IsChecked(index)
+		config.conf["featureFlag"]["playErrorSound"] = self.playErrorSoundCombo.GetSelection()
 
 class AdvancedPanel(SettingsPanel):
 	enableControlsCheckBox = None  # type: wx.CheckBox
diff --git a/source/logHandler.py b/source/logHandler.py
@@ -266,8 +266,13 @@ def emit(self, record):
 class FileHandler(logging.FileHandler):
 
 	def handle(self,record):
-		# Only play the error sound if this is a test version.
-		shouldPlayErrorSound =  buildVersion.isTestVersion
+		import config
+		# Only play the error sound if this is a test version or if the config states it explicitely.
+		shouldPlayErrorSound = (
+			buildVersion.isTestVersion
+			# Play error sound: 1 = Yes
+			or config.conf["featureFlag"]["playErrorSound"] == 1
+		)
 		if record.levelno>=logging.CRITICAL:
 			try:
 				winsound.PlaySound("SystemHand",winsound.SND_ALIAS)
diff --git a/user_docs/en/userGuide.t2t b/user_docs/en/userGuide.t2t
@@ -1915,6 +1915,11 @@ The checkboxes in this list allow you to enable specific categories of debug mes
 Logging these messages can result in decreased performance and large log files.
 Only turn one of these on if specifically instructed to by an NVDA developer e.g. when debugging why a braille display driver is not functioning correctly.
 
+==== Play a sound for logged errors ====[PlayErrorSound]
+This option allows you to specify if NVDA will play an error sound in case an error is logged.
+Choosing Only in test versions (default) makes NVDA play error sounds only if the current NVDA version is a test version (alpha, beta or run from source).
+Choosing Yes allows to enable error sounds whatever your current NVDA version is.
+
 ++ miscellaneous Settings ++[MiscSettings]
 Besides the [NVDA Settings #NVDASettings] dialog, The Preferences sub-menu of the NVDA Menu contains several other items which are outlined below.
 
