Merge c33ef89 into 9157916

Author: burmancomp

source/braille.py

@@ -42,6 +42,7 @@
 	TetherTo,
 	ReportTableHeaders,
 )
+from config.featureFlag import FeatureFlag
 from config.featureFlagEnums import ReviewRoutingMovesSystemCaretFlag
 from logHandler import log
 import controlTypes
@@ -1569,6 +1570,7 @@ def bufferPosToRegionPos(self, bufferPos):
 		raise LookupError("No such position")
 
 	def regionPosToBufferPos(self, region, pos, allowNearest=False):
+		start: int = 0
 		for testRegion, start, end in self.regionsWithPositions:
 			if region == testRegion:
 				if pos < end - start:
@@ -2003,6 +2005,22 @@ def formatCellsForLog(cells: List[int]) -> str:
 """
 
 
+class UpdateTimer(wx.Timer):
+	"""Repeating timer for keeping display content always up to date."""
+
+	def __init__(self):
+		"""Constructor."""
+		super().__init__()
+
+	def Notify(self) -> None:
+		"""Check if braille needs update."""
+		handler.brailleUpdateCheck()
+
+
+BRAILLE_UPDATE_CHECK_INTERVAL: int = 500
+"""Timer interval in milliseconds for L{BrailleHandler._brailleUpdateCheck}."""
+
+
 class BrailleHandler(baseObject.AutoPropertyObject):
 	# TETHER_AUTO, TETHER_FOCUS, TETHER_REVIEW and tetherValues
 	# are deprecated, but remain to retain API backwards compatibility
@@ -2042,6 +2060,12 @@ def __init__(self):
 		self._cursorPos = None
 		self._cursorBlinkUp = True
 		self._cells = []
+		self._showSelection: FeatureFlag = config.conf["braille"]["showSelection"]
+		self._showCursor: bool = config.conf["braille"]["showCursor"]
+		# Was braille line updated during previous timer cycle.
+		self._alreadyUpdated: bool = False
+		self._updateTimer = UpdateTimer()
+		self._updateTimer.Start(BRAILLE_UPDATE_CHECK_INTERVAL)
 		self._cursorBlinkTimer = None
 		config.post_configProfileSwitch.register(self.handlePostConfigProfileSwitch)
 		if config.conf["braille"]["tetherTo"] == TetherTo.AUTO.value:
@@ -2064,6 +2088,9 @@ def terminate(self):
 		if self._cursorBlinkTimer:
 			self._cursorBlinkTimer.Stop()
 			self._cursorBlinkTimer = None
+		if self._updateTimer:
+			self._updateTimer.Stop()
+			self._updateTimer = None
 		config.post_configProfileSwitch.unregister(self.handlePostConfigProfileSwitch)
 		if self.display:
 			self.display.terminate()
@@ -2332,6 +2359,7 @@ def _blink(self):
 		self._displayWithCursor()
 
 	def update(self):
+		self._alreadyUpdated = True
 		cells = self.buffer.windowBrailleCells
 		self._rawText = self.buffer.windowRawText
 		if log.isEnabledFor(log.IO):
@@ -2341,6 +2369,8 @@ def update(self):
 		self._cells = cells + [0] * (self.displaySize - len(cells))
 		self._cursorPos = self.buffer.cursorWindowPos
 		self._updateDisplay()
+		self._showSelection = config.conf["braille"]["showSelection"]
+		self._showCursor = config.conf["braille"]["showCursor"]
 
 	def scrollForward(self):
 		self.buffer.scrollForward()
@@ -2468,6 +2498,12 @@ def handleCaretMove(
 		if shouldAutoTether:
 			self.setTether(TetherTo.FOCUS.value, auto=True)
 		if self._tether != TetherTo.FOCUS.value:
+			# Braille display content is updated in case where:
+			# braille is tethered to review, review cursor does not follow system caret,
+			# and focus object is navigator object.
+			if not config.conf["reviewCursor"]["followCaret"]:
+				if obj == api.getNavigatorObject():
+					self.handleUpdate(obj)
 			return
 		region = self.mainBuffer.regions[-1] if self.mainBuffer.regions else None
 		if region and region.obj==obj:
@@ -2686,6 +2722,28 @@ def _ackTimeoutResetter(self, param: int):
 			self.display._awaitingAck = False
 			self._writeCellsInBackground()
 
+	def brailleUpdateCheck(self) -> None:
+		"""Braille may need update when show cursor or show selection state change or when in terminal window."""
+		if self.buffer is not self.mainBuffer:
+			return
+		if self._alreadyUpdated:
+			self._alreadyUpdated = False
+			return
+		obj: NVDAObject
+		if api.isObjectInActiveTreeInterceptor(api.getNavigatorObject()):
+			obj = api.getCaretObject()
+		elif self.getTether() == TetherTo.FOCUS.value:
+			obj = api.getFocusObject()
+		else:
+			obj = api.getNavigatorObject()
+		if (
+			hasattr(obj, "role") and obj.role == controlTypes.Role.TERMINAL
+			or self._showSelection != config.conf["braille"]["showSelection"]
+		):
+			self.handleUpdate(obj)
+		elif self._showCursor != config.conf["braille"]["showCursor"]:
+			self.update()
+
 
 # Maps old braille display driver names to new drivers that supersede old drivers.
 # Ensure that if a user has set a preferred driver which has changed name, the new
@@ -2728,6 +2786,7 @@ def terminate():
 	handler.terminate()
 	handler = None
 
+
 class BrailleDisplayDriver(driverHandler.Driver):
 	"""Abstract base braille display driver.
 	Each braille display driver should be a separate Python module in the root brailleDisplayDrivers directory