UI Automation in Windows Console: improve reliability of visible range checks #9957

codeofdusk · 2019-07-22T06:49:30Z

Link to issue number:

Builds on #9614. Supersedes #9735 and #9899. Closes #9891.

Summary of the issue:

Currently:

When the console window is maximized (or the review cursor is otherwise placed outside the visible text), text review is not functional.
The review top line and review bottom line scripts do not function as intended.

Description of how this pull request fixes the issue:

This PR backports some functionality from #9735. In particular:

The isOffscreen property has been implemented as UIAUtils.isTextRangeOffscreen.
When checking if the text range is out of bounds, we now also check that oldRange is in bounds before stopping movement.
Re-implemented POSITION_FIRST and POSITION_LAST in terms of visible ranges.

Testing performed:

Repeated testing from #9899 and verified that the review top/bottom scripts are functional.

Known issues with pull request:

If review is out of bounds, the review top/bottom line scripts may not function as intended (i.e. they bring the cursor to the first/last visible range, not the first/last line of the buffer). This is likely needed to insure stability in the console.

Change log entry:

== Changes ==

Added a section to the user guide about NVDA in the Windows Console. (UI Automation in Windows Console: improve reliability of visible range checks #9957)

…ls and disable the console bounds checking code when oldRange is also offscreen.

…ges to fix review top/bottom scripts.

codeofdusk · 2019-07-22T06:53:04Z

Cc @arfy8820 @feerrenrut @francipvb @LeonarddeR

LeonarddeR · 2019-07-22T07:19:44Z

source/UIAUtils.py

+			UIAHandler.TextPatternRangeEndpoint_Start, lastVisiRange,
+			UIAHandler.TextPatternRangeEndpoint_End) >= 0
+	else:
+		# Visible ranges not available, so fail gracefully.


Why not raise an error here and catch that when calling?

source/NVDAObjects/UIA/winConsoleUIA.py

feerrenrut · 2019-07-23T09:02:45Z

source/UIAUtils.py

@@ -172,6 +172,23 @@ def getChildrenWithCacheFromUIATextRange(textRange,cacheRequest):
 	c=CacheableUIAElementArray(c)
 	return c

+def isTextRangeOffscreen(range, visiRanges):


Please change the range argument so it does not shadow the builtin function

feerrenrut

Overall the code looks ok, though from the PR description it's not really clear what use-cases this enables. After some playing with it I think I know what is going on, but it would be nice for others if there were steps (specifying key presses) to demonstrate.

While here I also think it is worth mentioning that you can also use incrementally select text with shift+up/down/left/right arrows, I was able to read many screens by:

shift+home, to select back to the first column
shift+up arrow, to select previous lines. Of course the lines are in reverse order.
shift+down arrow to then unselect the text and hear it in the right order.

As we discussed selecting and jumping by word (control+shift+left/right arrow) is broken when NVDA is running.

Can you update the user guide to mention control+up/down arrow and control+home/end to scroll the console window, since it's not obvious how you would know about it.

Also as mentioned, please change the param name from range to textRange

codeofdusk · 2019-07-27T13:08:02Z

Can you update the user guide to mention control+up/down arrow and control+home/end to scroll the console window, since it's not obvious how you would know about it.

Where in the user guide should this be mentioned? Also, since this is a Windows Console feature (not an NVDA one) should this still be in the NVDA user guide? It seems that we tend not to put application commands in the NVDA docs (i.e. if the command still works without NVDA on, we usually don't mention it).

feerrenrut · 2019-07-29T08:26:01Z

since this is a Windows Console feature (not an NVDA one) should this still be in the NVDA user guide?

It's true that we tend not to do this. However, it's quite a useful thing to know how to do when using NVDA, and not very discoverable. If there was not a built in feature, we would be trying to implement something similar I expect.

Overall I think a short guide to using the Windows Console is quite appropriate.

Where in the user guide should this be mentioned?

You can add a subsection to Application specific features:

Make sure that text that mentions "console" with context of windows console, links to this new subsection.
From the new subsection link back to 5.5. Reviewing Text

codeofdusk · 2019-07-30T12:50:46Z

since this is a Windows Console feature (not an NVDA one) should this still be in the NVDA user guide?

It's true that we tend not to do this. However, it's quite a useful thing to know how to do when using NVDA, and not very discoverable. If there was not a built in feature, we would be trying to implement something similar I expect.

Overall I think a short guide to using the Windows Console is quite appropriate.

Where in the user guide should this be mentioned?

You can add a subsection to Application specific features:

Make sure that text that mentions "console" with context of windows console, links to this new subsection.

From the new subsection link back to 5.5. Reviewing Text

Just updated. It's not exactly clear what control+home actually does though, so I didn't mention it yet.

feerrenrut · 2019-07-30T15:29:22Z

It's not exactly clear what control+home actually does though, so I didn't mention it yet.

control+home scrolls the cmd window back to the first line in the (history/buffer).

user_docs/en/userGuide.t2t

Co-Authored-By: Reef Turner <[email protected]>

…into cmduia9-offscreen

XLTechie · 2019-08-01T17:29:53Z

"new text is written, the content scroll upwards and previous text is no longer visible." "Scroll" s/b "scrolls".

codeofdusk added 3 commits July 22, 2019 14:06

Backport _getTextLines from nvaccess#9735.

9fbd6b4

Move the isOffscreen logic from nvaccess#9735 to a function in UIAUti…

90fe976

…ls and disable the console bounds checking code when oldRange is also offscreen.

Re-implement POSITION_FIRST and POSITION_LAST in terms of visible ran…

c5eee91

…ges to fix review top/bottom scripts.

codeofdusk mentioned this pull request Jul 22, 2019

Allow the review cursor to be bounded to onscreen text #9735

Closed

LeonarddeR reviewed Jul 22, 2019

View reviewed changes

Review actions.

78d59c1

feerrenrut reviewed Jul 23, 2019

View reviewed changes

feerrenrut suggested changes Jul 25, 2019

View reviewed changes

codeofdusk added 3 commits July 27, 2019 09:12

range -> textRange.

00d3745

Merge branch 'master' into cmduia9-offscreen

5c60d3c

Add parentheses for Python 3.

0ed4c34

Update user guide.

0241799

codeofdusk added 2 commits July 31, 2019 04:13

Update user guide.

984bea1

Update user guide.

dadb1b0

feerrenrut reviewed Aug 1, 2019

View reviewed changes

user_docs/en/userGuide.t2t Outdated Show resolved Hide resolved

codeofdusk and others added 4 commits August 1, 2019 10:58

Update user_docs/en/userGuide.t2t

532a71a

Co-Authored-By: Reef Turner <[email protected]>

Merge branch 'master' into cmduia9-offscreen

c7abfad

Merge branch 'cmduia9-offscreen' of https://github.com/codeofdusk/nvda …

da0b618

…into cmduia9-offscreen

Update user guide.

f4bfd26

feerrenrut approved these changes Aug 1, 2019

View reviewed changes

feerrenrut merged commit 8a8c1c2 into nvaccess:master Aug 1, 2019

nvaccessAuto added this to the 2019.3 milestone Aug 1, 2019

feerrenrut added a commit that referenced this pull request Aug 1, 2019

Update changes file for PR #9957

1af8775

codeofdusk mentioned this pull request Sep 25, 2019

UI Automation in Windows Console: backport some UIA console fixes to Python 2 (2019.2.1) #10274

Closed

codeofdusk mentioned this pull request Nov 19, 2019

UIA console: cmd/powershell crashes completely with a lot of text that scrolls #10406

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

UI Automation in Windows Console: improve reliability of visible range checks #9957

UI Automation in Windows Console: improve reliability of visible range checks #9957

codeofdusk commented Jul 22, 2019 •

edited

Loading

codeofdusk commented Jul 22, 2019

LeonarddeR Jul 22, 2019

feerrenrut Jul 23, 2019

feerrenrut left a comment

codeofdusk commented Jul 27, 2019 •

edited

Loading

feerrenrut commented Jul 29, 2019

codeofdusk commented Jul 30, 2019

feerrenrut commented Jul 30, 2019

XLTechie commented Aug 1, 2019 via email

UI Automation in Windows Console: improve reliability of visible range checks #9957

UI Automation in Windows Console: improve reliability of visible range checks #9957

Conversation

codeofdusk commented Jul 22, 2019 • edited Loading

Link to issue number:

Summary of the issue:

Description of how this pull request fixes the issue:

Testing performed:

Known issues with pull request:

Change log entry:

codeofdusk commented Jul 22, 2019

LeonarddeR Jul 22, 2019

Choose a reason for hiding this comment

feerrenrut Jul 23, 2019

Choose a reason for hiding this comment

feerrenrut left a comment

Choose a reason for hiding this comment

codeofdusk commented Jul 27, 2019 • edited Loading

feerrenrut commented Jul 29, 2019

codeofdusk commented Jul 30, 2019

feerrenrut commented Jul 30, 2019

XLTechie commented Aug 1, 2019 via email

codeofdusk commented Jul 22, 2019 •

edited

Loading

codeofdusk commented Jul 27, 2019 •

edited

Loading