From c967b21aa36de96bd38fd451f47b6c665c8077d4 Mon Sep 17 00:00:00 2001
From: James Teh <jamie@nvaccess.org>
Date: Wed, 21 Jun 2017 11:26:25 +1000
Subject: [PATCH] Avoid full caret move timeout when pressing the delete key by
 treating valueChange events as caret moves. Also, treat caret events as caret
 moves as well, as this should be more reliable than comparing bookmarks in
 some cases.

---
 source/editableText.py | 34 +++++++++++++++++++++++++++-------
 1 file changed, 27 insertions(+), 7 deletions(-)

diff --git a/source/editableText.py b/source/editableText.py
index 8e63d30ab00..4e2270a3e99 100755
--- a/source/editableText.py
+++ b/source/editableText.py
@@ -71,17 +71,37 @@ def _hasCaretMoved(self, bookmark, retryInterval=0.01, timeout=None):
 				return (False,None)
 			api.processPendingEvents(processEventQueue=False)
 			if eventHandler.isPendingEvents("gainFocus"):
+				log.debug("Focus event. Elapsed: %d ms" % elapsed)
 				return (True,None)
-			#The caret may stop working as the focus jumps, we want to stay in the while loop though
+			# If the focus changes after this point, fetching the caret may fail,
+			# but we still want to stay in this loop.
 			try:
 				newInfo = self.makeTextInfo(textInfos.POSITION_CARET)
-				newBookmark = newInfo.bookmark
 			except (RuntimeError,NotImplementedError):
-				newInfo=None
-			else:
-				if newBookmark!=bookmark:
-					log.debug("Caret moved. Elapsed: %d ms" % elapsed)
-					return (True,newInfo)
+				newInfo = None
+			if eventHandler.isPendingEvents("caret"):
+				log.debug("caret event. Elapsed: %d ms" % elapsed)
+				return (True, newInfo)
+			if eventHandler.isPendingEvents("valueChange"):
+				# When pressing delete, the caret might not physically move,
+				# so the control might not fire a caret event,
+				# even though the text under the caret changes.
+				# We still want to treat this as a caret move.
+				# Otherwise, the user will have to wait
+				# the full timeout for feedback after pressing delete.
+				log.debug("valueChange event. Elapsed: %d ms" % elapsed)
+				return (True, newInfo)
+			# Some controls don't fire caret events.
+			# Try to detect with bookmarks.
+			newBookmark = None
+			if newInfo:
+				try:
+					newBookmark = newInfo.bookmark
+				except (RuntimeError,NotImplementedError):
+					pass
+			if newBookmark and newBookmark!=bookmark:
+				log.debug("Caret move detected using bookmarks. Elapsed: %d ms" % elapsed)
+				return (True, newInfo)
 			if  elapsed >= timeoutMs:
 				break
 			time.sleep(retryInterval)