Don't report out of errors when errors shouldn't be reported with speech

Author: nvdaes

include/liblouis

@@ -40,6 +40,8 @@
 	SuppressUnicodeNormalizationCommand,
 	CharacterModeCommand,
 	WaveFileCommand,
+	CallbackCommand,
+	_CancellableSpeechCommand,
 )
 from .shortcutKeys import getKeyboardShortcutsSpeech
 
@@ -87,6 +89,8 @@
 _speechState: Optional["SpeechState"] = None
 _curWordChars: List[str] = []
 IDEOGRAPHIC_COMMA: Final[str] = "\u3001"
+_lastSpeech: tuple[SpeechSequence, characterProcessing.SymbolLevel | None] | None = None
+"""Last spoken text and the symbol level with which it was spoken."""
 
 
 class SpeechMode(DisplayStringIntEnum):
@@ -141,6 +145,24 @@ def setSpeechMode(newMode: SpeechMode):
 	_speechState.speechMode = newMode
 
 
+def _setLastSpeechString(
+	speechSequence: SpeechSequence,
+	symbolLevel: characterProcessing.SymbolLevel | None,
+	priority: Spri,
+):
+	# Check if the speech sequence contains text to speak
+	if any(isinstance(item, str) for item in speechSequence):
+		global _lastSpeech
+		_lastSpeech = (
+			[
+				item
+				for item in speechSequence
+				if not isinstance(item, (CallbackCommand, _CancellableSpeechCommand))
+			],
+			symbolLevel,
+		)
+
+
 def initialize():
 	global _speechState
 	_speechState = SpeechState()
@@ -365,6 +387,8 @@ def _getSpellingSpeechAddCharMode(
 				yield CharacterModeCommand(False)
 				charMode = False
 		yield item
+	if charMode:
+		yield CharacterModeCommand(False)
 
 
 def _getSpellingCharAddCapNotification(
@@ -425,6 +449,7 @@ def _getSpellingSpeechWithoutCharMode(
 	fallbackToCharIfNoDescription: bool = True,
 	unicodeNormalization: bool = False,
 	reportNormalizedForCharacterNavigation: bool = False,
+	endsUtterance: bool = True,
 ) -> Generator[SequenceItemT, None, None]:
 	"""
 	Processes text when spelling by character.
@@ -446,6 +471,7 @@ def _getSpellingSpeechWithoutCharMode(
 	:param unicodeNormalization: Whether to use Unicode normalization for the given text.
 	:param reportNormalizedForCharacterNavigation: When unicodeNormalization is true, indicates if 'normalized'
 		should be reported along with the currently spelled character.
+	:param endsUtterance: Whether an EndUtteranceCommand should be yielded at the end.
 	:returns: A speech sequence generator.
 	"""
 	defaultLanguage = getCurrentLanguage()
@@ -521,7 +547,8 @@ def _getSpellingSpeechWithoutCharMode(
 				uppercase and beepForCapitals,
 				itemIsNormalized and reportNormalizedForCharacterNavigation,
 			)
-			yield EndUtteranceCommand()
+			if endsUtterance:
+				yield EndUtteranceCommand()
 
 
 def getSingleCharDescriptionDelayMS() -> int:
@@ -574,9 +601,20 @@ def getSingleCharDescription(
 
 def getSpellingSpeech(
 	text: str,
-	locale: Optional[str] = None,
+	locale: str | None = None,
 	useCharacterDescriptions: bool = False,
+	endsUtterance: bool = True,
+	useCharMode: bool = True,
 ) -> Generator[SequenceItemT, None, None]:
+	"""
+	Gets a speech sequence for spelling text.
+	:param text: The text to be spelled.
+	:param locale: The locale to use for character descriptions, if applicable.
+	:param useCharacterDescriptions: Whether or not to use character descriptions, e.g. speak "a" as "alpha".
+	:param endsUtterance: Whether an EndUtteranceCommand should be yielded at the end.
+	:param useCharMode: Whether to wrap the sequence in CharacterModeCommand.
+	:returns: A speech sequence generator.
+	"""
 	synth = getSynth()
 	synthConfig = config.conf["speech"][synth.name]
 
@@ -598,8 +636,9 @@ def getSpellingSpeech(
 		reportNormalizedForCharacterNavigation=config.conf["speech"][
 			"reportNormalizedForCharacterNavigation"
 		],
+		endsUtterance=endsUtterance,
 	)
-	if synthConfig["useSpellingFunctionality"]:
+	if useCharMode and synthConfig["useSpellingFunctionality"]:
 		seq = _getSpellingSpeechAddCharMode(seq)
 	# This function applies Unicode normalization as appropriate.
 	# Therefore, suppress the global normalization that might still occur
@@ -1189,7 +1228,7 @@ def speak(  # noqa: C901
 
 def speakPreselectedText(
 	text: str,
-	priority: Optional[Spri] = None,
+	priority: Spri | None = None,
 ):
 	"""Helper method to announce that a newly focused control already has
 	text selected. This method is in contrast with L{speakTextSelected}.
@@ -1228,8 +1267,8 @@ def getPreselectedTextSpeech(
 
 
 def speakTextSelected(
-	text: str,
-	priority: Optional[Spri] = None,
+	text: str | SpeechSequence,
+	priority: Spri | None = None,
 ):
 	"""Helper method to announce that the user has caused text to be selected.
 	This method is in contrast with L{speakPreselectedText}.
@@ -1246,8 +1285,8 @@ def speakTextSelected(
 
 def speakSelectionMessage(
 	message: str,
-	text: str,
-	priority: Optional[Spri] = None,
+	text: str | SpeechSequence,
+	priority: Spri | None = None,
 ):
 	seq = _getSelectionMessageSpeech(message, text)
 	if seq:
@@ -1259,8 +1298,26 @@ def speakSelectionMessage(
 
 def _getSelectionMessageSpeech(
 	message: str,
-	text: str,
+	text: str | SpeechSequence,
 ) -> SpeechSequence:
+	if isinstance(text, list):
+		# If text is a speech sequence, we can't use string formatting.
+		# Instead, split the message by %s and insert the sequence.
+		# This allows for correct localization order (e.g. prefix vs suffix).
+		prefix, sep, suffix = message.partition("%s")
+		if not sep:
+			log.warning("Selection message '%s' does not contain '%%s'", message)
+			return _getSpeakMessageSpeech(message) + text
+
+		seq = list(text)
+		# Insert prefix/suffix as separate items so they remain outside any
+		# speech commands (e.g. PitchCommand for capitals).
+		if prefix:
+			seq.insert(0, prefix)
+		if suffix:
+			seq.append(suffix)
+		return seq
+
 	if len(text) < MAX_LENGTH_FOR_SELECTION_REPORTING:
 		return _getSpeakMessageSpeech(message % text)
 	textLength = len(text)
@@ -1279,7 +1336,7 @@ def speakSelectionChange(  # noqa: C901
 	speakSelected: bool = True,
 	speakUnselected: bool = True,
 	generalize: bool = False,
-	priority: Optional[Spri] = None,
+	priority: Spri | None = None,
 ):
 	"""Speaks a change in selection, either selected or unselected text.
 	@param oldInfo: a TextInfo instance representing what the selection was before
@@ -1327,25 +1384,25 @@ def speakSelectionChange(  # noqa: C901
 		if not generalize:
 			for text in selectedTextList:
 				if len(text) == 1:
-					text = characterProcessing.processSpeechSymbol(locale, text)
+					text = list(getSpellingSpeech(text, locale, endsUtterance=False, useCharMode=False))
 				speakTextSelected(text, priority=priority)
 		elif len(selectedTextList) > 0:
 			text = newInfo.text
 			if len(text) == 1:
-				text = characterProcessing.processSpeechSymbol(locale, text)
+				text = list(getSpellingSpeech(text, locale, endsUtterance=False, useCharMode=False))
 			speakTextSelected(text, priority=priority)
 	if speakUnselected:
 		if not generalize:
 			for text in unselectedTextList:
 				if len(text) == 1:
-					text = characterProcessing.processSpeechSymbol(locale, text)
+					text = list(getSpellingSpeech(text, locale, endsUtterance=False, useCharMode=False))
 				# Translators: This is spoken to indicate what has been unselected. for example 'hello unselected'
 				speakSelectionMessage(_("%s unselected"), text, priority=priority)
 		elif len(unselectedTextList) > 0:
 			if not newInfo.isCollapsed:
 				text = newInfo.text
 				if len(text) == 1:
-					text = characterProcessing.processSpeechSymbol(locale, text)
+					text = list(getSpellingSpeech(text, locale, endsUtterance=False, useCharMode=False))
 				# Translators: This is spoken to indicate when the previous selection was removed and a new selection was made. for example 'hello world selected instead'
 				speakSelectionMessage(_("%s selected instead"), text, priority=priority)
 			else:
@@ -3018,7 +3075,7 @@ def getFormatFieldSpeech(  # noqa: C901
 				if formatConfig["reportSpellingErrors2"] & ReportSpellingErrors.SPEECH.value:
 					# Translators: Reported when text contains a spelling error.
 					texts.append(_("spelling error"))
-			elif extraDetail:
+			elif extraDetail and formatConfig["reportSpellingErrors2"] & ReportSpellingErrors.SPEECH.value:
 				# Translators: Reported when moving out of text containing a spelling error.
 				texts.append(_("out of spelling error"))
 			textList.extend(texts)
@@ -3032,7 +3089,7 @@ def getFormatFieldSpeech(  # noqa: C901
 				if formatConfig["reportSpellingErrors2"] & ReportSpellingErrors.SPEECH.value:
 					# Translators: Reported when text contains a grammar error.
 					texts.append(_("grammar error"))
-			elif extraDetail:
+			elif extraDetail and formatConfig["reportSpellingErrors2"] & ReportSpellingErrors.SPEECH.value:
 				# Translators: Reported when moving out of text containing a grammar error.
 				texts.append(_("out of grammar error"))
 			textList.extend(texts)