UI Automation in Windows Console: limit blank lines in review and initial word movement support

source/NVDAObjects/UIA/winConsoleUIA.py

@@ -4,6 +4,8 @@
 # See the file COPYING for more details.
 # Copyright (C) 2019 Bill Dengler
 
+import ctypes
+import NVDAHelper
 import time
 import textInfos
 import UIAHandler
@@ -16,10 +18,13 @@
 
 class consoleUIATextInfo(UIATextInfo):
 	_expandCollapseBeforeReview = False
+	_isCaret = False
+	_expandedToWord = False
 
 	def __init__(self, obj, position, _rangeObj=None):
 		super(consoleUIATextInfo, self).__init__(obj, position, _rangeObj)
 		if position == textInfos.POSITION_CARET:
+			self._isCaret = True
 			if isAtLeastWin10(1903):
 				# The UIA implementation in 1903 causes the caret to be
 				# off-by-one, so move it one position to the right
@@ -30,6 +35,115 @@ def __init__(self, obj, position, _rangeObj=None):
 					1
 				)
 
+	def move(self, unit, direction, endPoint=None):
+		if not self._isCaret:
+			# Insure we haven't gone beyond the visible text.
+			# UIA adds thousands of blank lines to the end of the console.
+			visiRanges = self.obj.UIATextPattern.GetVisibleRanges()
+			lastVisiRange = visiRanges.GetElement(visiRanges.length - 1)
+			if self._rangeObj.CompareEndPoints(
+				UIAHandler.TextPatternRangeEndpoint_Start,
+				lastVisiRange,
+				UIAHandler.TextPatternRangeEndpoint_End
+			) >= 0:
+				return 0
+		if unit == textInfos.UNIT_WORD and direction != 0:
+			# UIA doesn't implement word movement, so we need to do it manually.
+			offset = self._getCurrentOffset()
+			index = 1 if direction > 0 else 0
+			start, end = self._getWordOffsets(offset)
+			wordMoveDirections = (
+				(offset - start) * -1,
+				end - offset
+			)
+			res = self.move(
+				textInfos.UNIT_CHARACTER,
+				wordMoveDirections[index],
+				endPoint=endPoint
+			)
+			if res != 0:
+				return direction
+			else:
+				if self.move(textInfos.UNIT_CHARACTER, -1):
+					return self.move(unit, direction, endPoint=endPoint)
+				else:
+					return res
+		return super(consoleUIATextInfo, self).move(unit, direction, endPoint)
+
+	def expand(self, unit):
+		if unit == textInfos.UNIT_WORD:
+			self._expandedToWord = True
+		else:
+			self._expandedToWord = False
+			return super(consoleUIATextInfo, self).expand(unit)
+
+	def collapse(self):
+		self._expandedToWord = False
+		return super(consoleUIATextInfo, self).collapse()
+
+	def getTextWithFields(self, formatConfig=None):
+		if self._expandedToWord:
+			return [self.text]
+		return super(consoleUIATextInfo, self).getTextWithFields(
+			formatConfig=formatConfig
+		)
+
+	def _get_text(self):
+		if self._expandedToWord:
+			return self._getCurrentWord()
+		return super(consoleUIATextInfo, self)._get_text()
+
+	def _getCurrentOffset(self):
+		lineInfo = self.copy()
+		lineInfo.expand(textInfos.UNIT_LINE)
+		charInfo = self.copy()
+		res = 0
+		chars = None
+		while True:
+			charInfo.expand(textInfos.UNIT_CHARACTER)
+			chars = charInfo.move(textInfos.UNIT_CHARACTER, -1) * -1
+			if chars != 0 and charInfo.compareEndPoints(
+				lineInfo,
+				"startToStart"
+			) >= 0:
+				res += chars
+			else:
+				break
+		return res
+
+	def _getWordOffsets(self, offset):
+		lineInfo = self.copy()
+		lineInfo.expand(textInfos.UNIT_LINE)
+		lineText = lineInfo.text
+		# Convert NULL and non-breaking space to space to make sure
+		# that words will break on them
+		lineText = lineText.translate({0: u' ', 0xa0: u' '})
+		start = ctypes.c_int()
+		end = ctypes.c_int()
+		# Uniscribe does some strange things when you give it a string  with
+		# not more than two alphanumeric chars in a row.
+		# Inject two alphanumeric characters at the end to fix this.
+		lineText += "xx"
+		NVDAHelper.localLib.calculateWordOffsets(
+			lineText,
+			len(lineText),
+			offset,
+			ctypes.byref(start),
+			ctypes.byref(end)
+		)
+		return (
+			start.value,
+			min(end.value, len(lineText))
+		)
+
+	def _getCurrentWord(self):
+		lineInfo = self.copy()
+		lineInfo.expand(textInfos.UNIT_LINE)
+		lineText = lineInfo.text
+		offset = self._getCurrentOffset()
+		start, end = self._getWordOffsets(offset)
+		return lineText[start:end]
+
 
 class winConsoleUIA(Terminal):
 	_TextInfo = consoleUIATextInfo
@@ -39,7 +153,10 @@ class winConsoleUIA(Terminal):
 
 	def _reportNewText(self, line):
 		# Additional typed character filtering beyond that in LiveText
-		if self._isTyping and time.time() - self._lastCharTime <= self._TYPING_TIMEOUT:
+		if (
+			self._isTyping
+			and time.time() - self._lastCharTime <= self._TYPING_TIMEOUT
+		):
 			return
 		super(winConsoleUIA, self)._reportNewText(line)
 
@@ -56,7 +173,6 @@ def script_clear_isTyping(self, gesture):
 
 	def _getTextLines(self):
 		# Filter out extraneous empty lines from UIA
-		# Todo: do this (also) somewhere else so they aren't in document review either
 		ptr = self.UIATextPattern.GetVisibleRanges()
 		res = [ptr.GetElement(i).GetText(-1) for i in range(ptr.length)]
 		return res