Added ability for braille to show what NVDA is speaking

source/braille.py

@@ -41,6 +41,7 @@
 from config.configFlags import (
 	ShowMessages,
 	TetherTo,
+	BrailleMode,
 	ReportTableHeaders,
 )
 from config.featureFlagEnums import ReviewRoutingMovesSystemCaretFlag
@@ -2385,6 +2386,7 @@ def message(self, text):
 			not self.enabled
 			or config.conf["braille"]["showMessages"] == ShowMessages.DISABLED
 			or text is None
+			or config.conf["braille"]["mode"] == BrailleMode.SPEECH_OUTPUT.value
 		):
 			return
 		if self.buffer is self.messageBuffer:
@@ -2427,7 +2429,7 @@ def _dismissMessage(self, shouldUpdate: bool = True):
 			self.update()
 
 	def handleGainFocus(self, obj: "NVDAObject", shouldAutoTether: bool = True) -> None:
-		if not self.enabled:
+		if not self.enabled or config.conf["braille"]["mode"] == BrailleMode.SPEECH_OUTPUT.value:
 			return
 		if objectBelowLockScreenAndWindowsIsLocked(obj):
 			return
@@ -2472,7 +2474,7 @@ def handleCaretMove(
 			obj: "NVDAObject",
 			shouldAutoTether: bool = True
 	) -> None:
-		if not self.enabled:
+		if not self.enabled or config.conf["braille"]["mode"] == BrailleMode.SPEECH_OUTPUT.value:
 			return
 		if objectBelowLockScreenAndWindowsIsLocked(obj):
 			return
@@ -2582,7 +2584,7 @@ def handleUpdate(self, obj: "NVDAObject") -> None:
 		self._regionsPendingUpdate.add(region)
 
 	def handleReviewMove(self, shouldAutoTether=True):
-		if not self.enabled:
+		if not self.enabled or config.conf["braille"]["mode"] == BrailleMode.SPEECH_OUTPUT.value:
 			return
 		reviewPos = api.getReviewPosition()
 		if shouldAutoTether:

source/config/configFlags.py

@@ -97,6 +97,25 @@ def _displayStringLabels(self):
 		}
 
 
+@unique
+class BrailleMode(DisplayStringStrEnum):
+	"""Enumeration containing the possible config values for "Braille mode" option in braille settings.
+	Use BrailleMode.MEMBER.value to compare with the config;
+	use BrailleMode.MEMBER.displayString in the UI for a translatable description of this member.
+	"""
+	FOLLOW_CURSORS = "followCursors"
+	SPEECH_OUTPUT = "speechOutput"
+
+	@property
+	def _displayStringLabels(self):
+		return{
+			# Translators: The label for a braille mode
+			BrailleMode.FOLLOW_CURSORS: _("follow cursors"),
+			# Translators: The label for a braille mode
+			BrailleMode.SPEECH_OUTPUT: _("display speech output")
+		}
+
+
 @unique
 class ReportLineIndentation(DisplayStringIntEnum):
 	"""Enumeration containing the possible config values to report line indent.

source/config/configSpec.py

@@ -58,6 +58,7 @@
 # Braille settings
 [braille]
 	display = string(default=auto)
+	mode = option("followCursors", "speechOutput", default="followCursors")
 	translationTable = string(default=en-ueb-g1.ctb)
 	inputTable = string(default=en-ueb-g1.ctb)
 	expandAtCursor = boolean(default=true)

source/globalCommands.py

@@ -43,6 +43,7 @@
 from config.configFlags import (
 	TetherTo,
 	ShowMessages,
+	BrailleMode,
 )
 from config.featureFlag import FeatureFlag
 from config.featureFlagEnums import BoolFlag
@@ -114,6 +115,7 @@
 # Translators: The name of a category of NVDA commands.
 SCRCAT_DOCUMENTFORMATTING = _("Document formatting")
 
+
 class GlobalCommands(ScriptableObject):
 	"""Commands that are available at all times, regardless of the current focus.
 	"""
@@ -3287,6 +3289,7 @@ def script_toggleBrailleViewer(self, gesture: inputCore.InputGesture):
 		category=SCRCAT_BRAILLE,
 		gesture="kb:NVDA+control+t"
 	)
+	@gui.blockAction.when(gui.blockAction.Context.BRAILLE_MODE_SPEECH_OUTPUT)
 	def script_braille_toggleTether(self, gesture):
 		values = [x.value for x in TetherTo]
 		index = values.index(config.conf["braille"]["tetherTo"])
@@ -3304,12 +3307,38 @@ def script_braille_toggleTether(self, gesture):
 		# (braille can be tethered automatically or to either focus or review position).
 		ui.message(_("Braille tethered %s") % TetherTo(newTetherChoice).displayString)
 
+	@script(
+		# Translators: Input help mode message for toggle braille mode command
+		description=_('Toggles braille mode between follow cursors and display speech output'),
+		category=SCRCAT_BRAILLE,
+		gesture="kb:nvda+alt+t"
+	)
+	def script_toggleBrailleMode(self, gesture: inputCore.InputGesture):
+		curMode = BrailleMode(config.conf["braille"]["mode"])
+		modeList = list(BrailleMode)
+		index = modeList.index(curMode)
+		index = index + 1 if not index == len(modeList) - 1 else 0
+		newMode = modeList[index]
+		config.conf["braille"]["mode"] = newMode.value
+		if braille.handler.buffer == braille.handler.messageBuffer:
+			braille.handler._dismissMessage()
+		braille.handler.mainBuffer.clear()
+		# Translators: The message reported when switching braille modes
+		ui.message(_("Braille mode {brailleMode}").format(brailleMode=newMode.displayString))
+		if newMode == BrailleMode.SPEECH_OUTPUT:
+			return
+		if braille.handler.getTether() == TetherTo.REVIEW.value:
+			braille.handler.handleReviewMove(shouldAutoTether=braille.handler.shouldAutoTether)
+			return
+		braille.handler.handleGainFocus(api.getFocusObject())
+
 	@script(
 		# Translators: Input help mode message for cycle through
 		# braille move system caret when routing review cursor command.
 		description=_("Cycle through the braille move system caret when routing review cursor states"),
 		category=SCRCAT_BRAILLE
 	)
+	@gui.blockAction.when(gui.blockAction.Context.BRAILLE_MODE_SPEECH_OUTPUT)
 	def script_braille_cycleReviewRoutingMovesSystemCaret(self, gesture: inputCore.InputGesture) -> None:
 		# If braille is not tethered to focus, set next state of
 		# braille Move system caret when routing review cursor.
@@ -3345,6 +3374,7 @@ def script_braille_cycleReviewRoutingMovesSystemCaret(self, gesture: inputCore.I
 		description=_("Toggle the way context information is presented in braille"),
 		category=SCRCAT_BRAILLE
 	)
+	@gui.blockAction.when(gui.blockAction.Context.BRAILLE_MODE_SPEECH_OUTPUT)
 	def script_braille_toggleFocusContextPresentation(self, gesture):
 		values = [x[0] for x in braille.focusContextPresentations]
 		labels = [x[1] for x in braille.focusContextPresentations]
@@ -3366,6 +3396,7 @@ def script_braille_toggleFocusContextPresentation(self, gesture):
 		description=_("Toggle the braille cursor on and off"),
 		category=SCRCAT_BRAILLE
 	)
+	@gui.blockAction.when(gui.blockAction.Context.BRAILLE_MODE_SPEECH_OUTPUT)
 	def script_braille_toggleShowCursor(self, gesture):
 		if config.conf["braille"]["showCursor"]:
 			# Translators: The message announced when toggling the braille cursor.
@@ -3384,6 +3415,7 @@ def script_braille_toggleShowCursor(self, gesture):
 		description=_("Cycle through the braille cursor shapes"),
 		category=SCRCAT_BRAILLE
 	)
+	@gui.blockAction.when(gui.blockAction.Context.BRAILLE_MODE_SPEECH_OUTPUT)
 	def script_braille_cycleCursorShape(self, gesture):
 		if not config.conf["braille"]["showCursor"]:
 			# Translators: A message reported when changing the braille cursor shape when the braille cursor is turned off.
@@ -3410,6 +3442,7 @@ def script_braille_cycleCursorShape(self, gesture):
 		description=_("Cycle through the braille show messages modes"),
 		category=SCRCAT_BRAILLE
 	)
+	@gui.blockAction.when(gui.blockAction.Context.BRAILLE_MODE_SPEECH_OUTPUT)
 	def script_braille_cycleShowMessages(self, gesture: inputCore.InputGesture) -> None:
 		"""Set next state of braille show messages and reports it with ui.message."""
 		values = [x.value for x in ShowMessages]
@@ -3427,6 +3460,7 @@ def script_braille_cycleShowMessages(self, gesture: inputCore.InputGesture) -> N
 		description=_("Cycle through the braille show selection states"),
 		category=SCRCAT_BRAILLE
 	)
+	@gui.blockAction.when(gui.blockAction.Context.BRAILLE_MODE_SPEECH_OUTPUT)
 	def script_braille_cycleShowSelection(self, gesture: inputCore.InputGesture) -> None:
 		"""Set next state of braille show selection and reports it with ui.message."""
 		featureFlag: FeatureFlag = config.conf["braille"]["showSelection"]

source/gui/blockAction.py

@@ -4,6 +4,7 @@
 # See the file COPYING for more details.
 
 import config
+from config.configFlags import BrailleMode
 from dataclasses import dataclass
 from enum import Enum
 from functools import wraps
@@ -50,7 +51,11 @@ class Context(_Context, Enum):
 		# version
 		_("Action unavailable in a temporary version of NVDA"),
 	)
-
+	BRAILLE_MODE_SPEECH_OUTPUT = (
+		lambda: config.conf["braille"]["mode"] == BrailleMode.SPEECH_OUTPUT.value,
+		# Translators: Reported when trying to toggle an unsupported setting in speech emulation mode.
+		_("Action unavailable while the braille mode is set to speech emulation"),
+	)
 
 def when(*contexts: Context):
 	"""Returns a function wrapper.