Merge c6d2bdb into 74a1998

Author: beqabeqa473

projectDocs/dev/developerGuide/developerGuide.t2t

@@ -1041,6 +1041,7 @@ For examples of how to define and use new extension points, please see the code
 ++ speech ++[speechExtPts]
 || Type | Extension Point | Description |
 | ``Action`` | ``speechCanceled`` | Triggered when speech is canceled. |
+| ``Action`` | ``speechSequencePreFilter`` | Triggered when new speech sequence appears. |
 | ``Filter`` | ``filter_speechSequence`` | Allows components or add-ons to filter speech sequence before it passes to the Synth driver. |
 
 ++ synthDriverHandler ++[synthDriverHandlerExtPts]

source/speech/extensions.py

@@ -16,6 +16,20 @@
 Handlers are called without arguments.
 """
 
+post_filter_speechSequence = Action()
+"""
+Notifies when requested speech has been filtered and is ready to be passed onto the synthesizer.
+
+:param value: a planned speech sequence.
+:type value: SpeechSequence
+What NVDA would speak with speech turned on and uninterrupted.
+A speech sequence that has been requested somewhere in NVDA,
+and is finished being processed or modified by external modules such as add-ons.
+Prepared speech may be cancelled or processed further to prepare it for the synthesizer.
+This extension point is useful for tracking prepared speech in NVDA.
+i.e. for speech viewer, capturing speech history, or mirroring speech in braille.
+"""
+
 filter_speechSequence = Filter[SpeechSequence]()
 """
 Filters speech sequence before it passes to synthDriver.

source/speech/speech.py

@@ -25,7 +25,7 @@
 import characterProcessing
 import languageHandler
 from . import manager
-from .extensions import filter_speechSequence, speechCanceled
+from .extensions import filter_speechSequence, speechCanceled, speechSequencePreFilter
 from .commands import (
 	# Commands that are used in this file.
 	BreakCommand,
@@ -960,16 +960,14 @@ def speak(  # noqa: C901
 	@param symbolLevel: The symbol verbosity level; C{None} (default) to use the user's configuration.
 	@param priority: The speech priority.
 	"""
+	speechSequencePreFilter.notify(sequence=speechSequence)
 	speechSequence = filter_speechSequence.apply(speechSequence)
 	logBadSequenceTypes(speechSequence)
 	# in case priority was explicitly passed in as None, set to default.
 	priority: Spri = Spri.NORMAL if priority is None else priority
 
 	if not speechSequence:  # Pointless - nothing to speak
 		return
-	import speechViewer
-	if speechViewer.isActive:
-		speechViewer.appendSpeechSequence(speechSequence)
 	if _speechState.speechMode == SpeechMode.off:
 		return
 	elif _speechState.speechMode == SpeechMode.beeps:

source/speechViewer.py

@@ -12,6 +12,7 @@
 import config
 from logHandler import log
 from speech import SpeechSequence
+from speech.extensions import speechSequencePreFilter
 from gui import blockAction
 import gui.contextHelp
 from utils.security import isLockScreenModeActive, post_sessionLockStateChanged
@@ -47,6 +48,7 @@ def __init__(self, onDestroyCallBack: Callable[[], None]):
 			style=wx.CAPTION | wx.CLOSE_BOX | wx.RESIZE_BORDER | wx.STAY_ON_TOP
 		)
 		post_sessionLockStateChanged.register(self.onSessionLockStateChange)
+		speechSequencePreFilter.register(appendSpeechSequence)
 		self._isDestroyed = False
 		self.onDestroyCallBack = onDestroyCallBack
 		self.Bind(wx.EVT_CLOSE, self.onClose)
@@ -128,6 +130,7 @@ def onShouldShowOnStartupChanged(self, evt: wx.CommandEvent):
 	def onDestroy(self, evt: wx.Event):
 		self._isDestroyed = True
 		post_sessionLockStateChanged.unregister(self.onSessionLockStateChange)
+		speechSequencePreFilter.unregister(appendSpeechSequence)
 		log.debug("SpeechViewer destroyed")
 		self.onDestroyCallBack()
 		evt.Skip()