refactor of sayAllHandler into speech

source/NVDAHelper.py

@@ -386,9 +386,9 @@ def nvdaControllerInternal_inputLangChangeNotify(threadID,hkl,layoutString):
 	#But threadIDs for console windows are always wrong so don't ignore for those.
 	if not isinstance(focus,NVDAObjects.window.Window) or (threadID!=focus.windowThreadID and focus.windowClassName!="ConsoleWindowClass"):
 		return 0
-	import sayAllHandler
+	from speech import sayAll
 	#Never announce changes while in sayAll (#1676)
-	if sayAllHandler.isRunning():
+	if sayAll.SayAllHandler.isRunning():
 		return 0
 	import queueHandler
 	import ui

source/NVDAObjects/IAccessible/winword.py

@@ -21,6 +21,9 @@
 from NVDAObjects.window import DisplayModelEditableText
 from ..behaviors import EditableTextWithoutAutoSelectDetection
 from NVDAObjects.window.winword import *
+from NVDAObjects.window.winword import WordDocumentTreeInterceptor
+from speech import sayAll
+
 
 class WordDocument(IAccessible,EditableTextWithoutAutoSelectDetection,WordDocument):
 
@@ -362,15 +365,15 @@ def script_nextParagraph(self,gesture):
 		info._rangeObj.move(wdParagraph,1)
 		info.updateCaret()
 		self._caretScriptPostMovedHelper(textInfos.UNIT_PARAGRAPH,gesture,None)
-	script_nextParagraph.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_nextParagraph.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def script_previousParagraph(self,gesture):
 		info=self.makeTextInfo(textInfos.POSITION_CARET)
 		# #4375: keeping cemetrical with nextParagraph script. 
 		info._rangeObj.move(wdParagraph,-1)
 		info.updateCaret()
 		self._caretScriptPostMovedHelper(textInfos.UNIT_PARAGRAPH,gesture,None)
-	script_previousParagraph.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_previousParagraph.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def focusOnActiveDocument(self, officeChartObject):
 		rangeStart=officeChartObject.Parent.Range.Start
@@ -462,4 +465,3 @@ def event_gainFocus(self):
 			ctypes.windll.user32.AttachThreadInput(curThreadID,document.windowThreadID,False)
 			if not document.WinwordWindowObject.active:
 				document.WinwordWindowObject.activate()
-

source/NVDAObjects/window/winword.py

@@ -14,7 +14,6 @@
 import locale
 import collections
 import colorsys
-import sayAllHandler
 import eventHandler
 import braille
 from scriptHandler import script
@@ -946,7 +945,7 @@ def collapse(self,end=False):
 			newEndOffset = self._rangeObj.end
 			# the new endOffset should not have become smaller than the old endOffset, this could cause an infinite loop in
 			# a case where you called move end then collapse until the size of the range is no longer being reduced.
-			# For an example of this see sayAll (specifically readTextHelper_generator in sayAllHandler.py)
+			# For an example of this see sayAll (specifically readTextHelper_generator in sayAll.py)
 			if newEndOffset < oldEndOffset :
 				raise RuntimeError
 

source/appModules/eclipse.py

@@ -12,7 +12,7 @@
 import braille
 import ui
 import api
-import sayAllHandler
+from speech import sayAll
 import eventHandler
 import keyboardHandler
 from scriptHandler import script
@@ -98,7 +98,7 @@ def script_readDocumentation(self, gesture):
 			if documentObj.role == controlTypes.ROLE_DOCUMENT:
 				api.setNavigatorObject(documentObj)
 				braille.handler.handleReviewMove()
-				sayAllHandler.readText(sayAllHandler.CURSOR_REVIEW)
+				sayAll.SayAllHandler.readText(sayAll.CURSOR.REVIEW)
 
 			elif documentObj.role == controlTypes.ROLE_EDITABLETEXT:
 				ui.message(documentObj.value)

source/appModules/kindle.py

@@ -8,7 +8,7 @@
 from comtypes.hresult import S_OK
 import appModuleHandler
 import speech
-import sayAllHandler
+from speech import sayAll
 import api
 from scriptHandler import willSayAllResume, isScriptWaiting
 import controlTypes
@@ -106,11 +106,11 @@ def _changePageScriptHelper(self,gesture,previous=False):
 
 	def script_moveByPage_forward(self,gesture):
 		self._changePageScriptHelper(gesture)
-	script_moveByPage_forward.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_moveByPage_forward.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def script_moveByPage_back(self,gesture):
 		self._changePageScriptHelper(gesture,previous=True)
-	script_moveByPage_back.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_moveByPage_back.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def _tabOverride(self,direction):
 		return False

source/appModules/powerpnt.py

@@ -15,7 +15,7 @@
 import colors
 import api
 import speech
-import sayAllHandler
+from speech import sayAll
 import NVDAHelper
 import winUser
 import msoAutoShapeTypes
@@ -1097,7 +1097,7 @@ def makeTextInfo(self,position):
 
 	def reportNewSlide(self):
 		self.makeTextInfo(textInfos.POSITION_FIRST).updateCaret()
-		sayAllHandler.readText(sayAllHandler.CURSOR_CARET)
+		sayAll.SayAllHandler.readText(sayAll.CURSOR.CARET)
 
 	def script_toggleNotesMode(self,gesture):
 		self.rootNVDAObject.notesMode=not self.rootNVDAObject.notesMode

source/browseMode.py

@@ -33,7 +33,7 @@
 import braille
 import vision
 import speech
-import sayAllHandler
+from speech import sayAll
 import treeInterceptorHandler
 import inputCore
 import api
@@ -470,7 +470,7 @@ def addQuickNav(
 		script = lambda self,gesture: self._quickNavScript(gesture, itemType, "next", nextError, readUnit)
 		script.__doc__ = nextDoc
 		script.__name__ = funcName
-		script.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+		script.resumeSayAllMode = sayAll.CURSOR.CARET
 		setattr(cls, funcName, script)
 		if key is not None:
 			cls.__gestures["kb:%s" % key] = scriptName
@@ -479,7 +479,7 @@ def addQuickNav(
 		script = lambda self,gesture: self._quickNavScript(gesture, itemType, "previous", prevError, readUnit)
 		script.__doc__ = prevDoc
 		script.__name__ = funcName
-		script.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+		script.resumeSayAllMode = sayAll.CURSOR.CARET
 		setattr(cls, funcName, script)
 		if key is not None:
 			cls.__gestures["kb:shift+%s" % key] = scriptName
@@ -1287,7 +1287,7 @@ def event_treeInterceptor_gainFocus(self):
 		if not self.passThrough:
 			if doSayAll:
 				speech.speakObjectProperties(self.rootNVDAObject, name=True, states=True, reason=OutputReason.FOCUS)
-				sayAllHandler.readText(sayAllHandler.CURSOR_CARET)
+				sayAll.SayAllHandler.readText(sayAll.CURSOR.CARET)
 			else:
 				# Speak it like we would speak focus on any other document object.
 				# This includes when entering the treeInterceptor for the first time:
@@ -1590,7 +1590,7 @@ def event_gainFocus(self, obj, nextHandler):
 			# The virtual caret is not within the focus node.
 			oldPassThrough=self.passThrough
 			passThrough = self.shouldPassThrough(obj, reason=OutputReason.FOCUS)
-			if not oldPassThrough and (passThrough or sayAllHandler.isRunning()):
+			if not oldPassThrough and (passThrough or sayAll.SayAllHandler.isRunning()):
 				# If pass-through is disabled, cancel speech, as a focus change should cause page reading to stop.
 				# This must be done before auto-pass-through occurs, as we want to stop page reading even if pass-through will be automatically enabled by this focus change.
 				speech.cancelSpeech()
@@ -1821,7 +1821,7 @@ def script_moveToStartOfContainer(self,gesture):
 		if not willSayAllResume(gesture):
 			container.expand(textInfos.UNIT_LINE)
 			speech.speakTextInfo(container, reason=OutputReason.FOCUS)
-	script_moveToStartOfContainer.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_moveToStartOfContainer.resumeSayAllMode = sayAll.CURSOR.CARET
 	# Translators: Description for the Move to start of container command in browse mode. 
 	script_moveToStartOfContainer.__doc__=_("Moves to the start of the container element, such as a list or table")
 
@@ -1846,7 +1846,7 @@ def script_movePastEndOfContainer(self,gesture):
 		if not willSayAllResume(gesture):
 			container.expand(textInfos.UNIT_LINE)
 			speech.speakTextInfo(container, reason=OutputReason.FOCUS)
-	script_movePastEndOfContainer.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_movePastEndOfContainer.resumeSayAllMode = sayAll.CURSOR.CARET
 	# Translators: Description for the Move past end of container command in browse mode. 
 	script_movePastEndOfContainer.__doc__=_("Moves past the end  of the container element, such as a list or table")
 

source/core.py

@@ -351,6 +351,9 @@ def main():
 	import speech
 	log.debug("Initializing speech")
 	speech.initialize()
+	from speech import sayAll
+	log.debug("Initializing sayAllHandler")
+	sayAll.initialize()
 	if not globalVars.appArgs.minimal and (time.time()-globalVars.startTime)>5:
 		log.debugWarning("Slow starting core (%.2f sec)" % (time.time()-globalVars.startTime))
 		# Translators: This is spoken when NVDA is starting.

source/cursorManager.py

@@ -16,7 +16,7 @@
 import gui
 from gui import guiHelper
 import gui.contextHelp
-import sayAllHandler
+from speech import sayAll
 import review
 from scriptHandler import willSayAllResume, script
 import textInfos
@@ -197,7 +197,7 @@ def run():
 			"find the next occurrence of the previously entered text string from the current cursor's position"
 		),
 		gesture="kb:NVDA+f3",
-		resumeSayAllMode=sayAllHandler.CURSOR_CARET,
+		resumeSayAllMode=sayAll.CURSOR.CARET,
 	)
 	def script_findNext(self,gesture):
 		if not self._lastFindText:
@@ -215,7 +215,7 @@ def script_findNext(self,gesture):
 			"find the previous occurrence of the previously entered text string from the current cursor's position"
 		),
 		gesture="kb:NVDA+shift+f3",
-		resumeSayAllMode=sayAllHandler.CURSOR_CARET,
+		resumeSayAllMode=sayAll.CURSOR.CARET,
 	)
 	def script_findPrevious(self,gesture):
 		if not self._lastFindText:
@@ -230,11 +230,11 @@ def script_findPrevious(self,gesture):
 
 	def script_moveByPage_back(self,gesture):
 		self._caretMovementScriptHelper(gesture,textInfos.UNIT_LINE,-config.conf["virtualBuffers"]["linesPerPage"],extraDetail=False)
-	script_moveByPage_back.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_moveByPage_back.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def script_moveByPage_forward(self,gesture):
 		self._caretMovementScriptHelper(gesture,textInfos.UNIT_LINE,config.conf["virtualBuffers"]["linesPerPage"],extraDetail=False)
-	script_moveByPage_forward.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_moveByPage_forward.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def script_moveByCharacter_back(self,gesture):
 		self._caretMovementScriptHelper(gesture,textInfos.UNIT_CHARACTER,-1,extraDetail=True,handleSymbols=True)
@@ -250,27 +250,27 @@ def script_moveByWord_forward(self,gesture):
 
 	def script_moveByLine_back(self,gesture):
 		self._caretMovementScriptHelper(gesture,textInfos.UNIT_LINE,-1)
-	script_moveByLine_back.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_moveByLine_back.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def script_moveByLine_forward(self,gesture):
 		self._caretMovementScriptHelper(gesture,textInfos.UNIT_LINE,1)
-	script_moveByLine_forward.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_moveByLine_forward.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def script_moveBySentence_back(self,gesture):
 		self._caretMovementScriptHelper(gesture,textInfos.UNIT_SENTENCE,-1)
-	script_moveBySentence_back.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_moveBySentence_back.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def script_moveBySentence_forward(self,gesture):
 		self._caretMovementScriptHelper(gesture,textInfos.UNIT_SENTENCE,1)
-	script_moveBySentence_forward.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_moveBySentence_forward.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def script_moveByParagraph_back(self,gesture):
 		self._caretMovementScriptHelper(gesture,textInfos.UNIT_PARAGRAPH,-1)
-	script_moveByParagraph_back.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_moveByParagraph_back.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def script_moveByParagraph_forward(self,gesture):
 		self._caretMovementScriptHelper(gesture,textInfos.UNIT_PARAGRAPH,1)
-	script_moveByParagraph_forward.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_moveByParagraph_forward.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def script_startOfLine(self,gesture):
 		self._caretMovementScriptHelper(gesture,textInfos.UNIT_CHARACTER,posUnit=textInfos.UNIT_LINE,extraDetail=True,handleSymbols=True)

source/editableText.py

@@ -9,7 +9,7 @@
 """
 
 import time
-import sayAllHandler
+from speech import sayAll
 import api
 import review
 from baseObject import ScriptableObject
@@ -222,7 +222,7 @@ def _caretMoveBySentenceHelper(self, gesture, direction):
 
 	def script_caret_moveByLine(self,gesture):
 		self._caretMovementScriptHelper(gesture, textInfos.UNIT_LINE)
-	script_caret_moveByLine.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_caret_moveByLine.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def script_caret_moveByCharacter(self,gesture):
 		self._caretMovementScriptHelper(gesture, textInfos.UNIT_CHARACTER)
@@ -232,15 +232,15 @@ def script_caret_moveByWord(self,gesture):
 
 	def script_caret_moveByParagraph(self,gesture):
 		self._caretMovementScriptHelper(gesture, textInfos.UNIT_PARAGRAPH)
-	script_caret_moveByParagraph.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_caret_moveByParagraph.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def script_caret_previousSentence(self,gesture):
 		self._caretMoveBySentenceHelper(gesture, -1)
-	script_caret_previousSentence.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_caret_previousSentence.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def script_caret_nextSentence(self,gesture):
 		self._caretMoveBySentenceHelper(gesture, 1)
-	script_caret_nextSentence.resumeSayAllMode=sayAllHandler.CURSOR_CARET
+	script_caret_nextSentence.resumeSayAllMode = sayAll.CURSOR.CARET
 
 	def _backspaceScriptHelper(self,unit,gesture):
 		try:
@@ -394,7 +394,7 @@ def script_caret_changeSelection(self,gesture):
 		try:
 			self.reportSelectionChange(oldInfo)
 		except:
-			return
+			return
 
 	__changeSelectionGestures = (
 		"kb:shift+upArrow",

source/globalCommands.py

@@ -19,7 +19,7 @@
 import api
 import textInfos
 import speech
-import sayAllHandler
+from speech import sayAll
 from NVDAObjects import NVDAObject, NVDAObjectTextInfo
 import globalVars
 from logHandler import log
@@ -1253,7 +1253,7 @@ def script_review_top(self,gesture):
 	@script(
 		# Translators: Input help mode message for move review cursor to previous line command.
 		description=_("Moves the review cursor to the previous line of the current navigator object and speaks it"),
-		resumeSayAllMode=sayAllHandler.CURSOR_REVIEW,
+		resumeSayAllMode=sayAll.CURSOR.REVIEW,
 		category=SCRCAT_TEXTREVIEW,
 		gestures=("kb:numpad7", "kb(laptop):NVDA+upArrow", "ts(text):flickUp")
 	)
@@ -1294,7 +1294,7 @@ def script_review_currentLine(self,gesture):
 	@script(
 		# Translators: Input help mode message for move review cursor to next line command.
 		description=_("Moves the review cursor to the next line of the current navigator object and speaks it"),
-		resumeSayAllMode=sayAllHandler.CURSOR_REVIEW,
+		resumeSayAllMode=sayAll.CURSOR.REVIEW,
 		category=SCRCAT_TEXTREVIEW,
 		gestures=("kb:numpad9", "kb(laptop):NVDA+downArrow", "ts(text):flickDown")
 	)
@@ -1675,7 +1675,7 @@ def script_showGui(self,gesture):
 		gestures=("kb:numpadPlus", "kb(laptop):NVDA+shift+a", "ts(text):3finger_flickDown")
 	)
 	def script_review_sayAll(self,gesture):
-		sayAllHandler.readText(sayAllHandler.CURSOR_REVIEW)
+		sayAll.SayAllHandler.readText(sayAll.CURSOR.REVIEW)
 
 	@script(
 		# Translators: Input help mode message for say all with system caret command.
@@ -1684,7 +1684,7 @@ def script_review_sayAll(self,gesture):
 		gestures=("kb(desktop):NVDA+downArrow", "kb(laptop):NVDA+a")
 	)
 	def script_sayAll(self,gesture):
-		sayAllHandler.readText(sayAllHandler.CURSOR_CARET)
+		sayAll.SayAllHandler.readText(sayAll.CURSOR.CARET)
 
 	def _reportFormattingHelper(self, info, browseable=False):
 		# Report all formatting-related changes regardless of user settings
@@ -1991,7 +1991,7 @@ def script_title(self,gesture):
 	def script_speakForeground(self,gesture):
 		obj=api.getForegroundObject()
 		if obj:
-			sayAllHandler.readObjects(obj)
+			sayAll.SayAllHandler.readObjects(obj)
 
 	@script(
 		gesture="kb(desktop):NVDA+control+f2"

source/inputCore.py

@@ -18,7 +18,7 @@
 from typing import Dict, Any, Tuple, List, Union
 
 import configobj
-import sayAllHandler
+from speech import sayAll
 import baseObject
 import scriptHandler
 import queueHandler
@@ -455,12 +455,12 @@ def executeGesture(self, gesture):
 		wasInSayAll=False
 		if gesture.isModifier:
 			if not self.lastModifierWasInSayAll:
-				wasInSayAll=self.lastModifierWasInSayAll=sayAllHandler.isRunning()
+				wasInSayAll = self.lastModifierWasInSayAll = sayAll.SayAllHandler.isRunning()
 		elif self.lastModifierWasInSayAll:
 			wasInSayAll=True
 			self.lastModifierWasInSayAll=False
 		else:
-			wasInSayAll=sayAllHandler.isRunning()
+			wasInSayAll = sayAll.SayAllHandler.isRunning()
 		if wasInSayAll:
 			gesture.wasInSayAll=True