Add support for Windows Terminal by codeofdusk · Pull Request #10784 · nvaccess/nvda

codeofdusk · 2020-02-13T19:16:54Z

Link to issue number:

Closes #10305. Supersedes #10716 for now.

Summary of the issue:

The new Windows Terminal does not support automatic readout, suppression of password characters, and other terminal niceties.

Since newer Windows Console builds correctly set the end of text ranges as exclusive, NVDA's current UIA console workarounds produce incorrect behaviour in these builds.

Description of how this pull request fixes the issue:

Like UI Automation in Windows Console: Use UIA by default on Windows 10 version 2004 and later #10716, splits the consoleUIATextInfo workarounds into a subclass. This will be useful for Windows 10 version 21H1, where making UIA default in consoles will be strongly worth considering.
Adds a new winConsoleUIA.WinTerminalUIA class and attaches it to Windows Terminal controls.
Re-introduces support for IUIAutomationTextPattern::GetVisibleRanges for consoles returning one contiguous range (see UIA: Fix GetVisibleRanges() and add Tracing microsoft/terminal#4495).
Factors out the password/doubled character suppression into a NVDAObjects.behaviors.EnhancedTermTypedCharSupport class, which KeyboardHandlerBasedTypedCharSupport now subclasses.
Adds new logic to properly choose the textInfo implementation to use based on the number of visible ranges presented by the console (newer builds present just one range).

Testing performed:

Tested that Windows Terminal controls correctly receive the WinTerminalUIA type and that consoles work as expected (including keyboard support enhancements).

Tested that in newer Windoes Console (built from the terminal master branch), bounding works as expected even after the window is maximized and a large amount of text is written.

Tested that automatic readout, password suppression, and typed character reporting are functional in the Windows Terminal build in microsoft/terminal#2447.

Tested that the correct textInfo implementation is chosen for the included console on Windows 10 version 1909 Vs. the latest open console from Microsoft.

Known issues with pull request:

None.

Change log entry:

== new features ==

Added support for Windows Terminal. (Add support for Windows Terminal #10305)

AppVeyorBot · 2020-02-13T19:26:06Z

Build (for testing PR)
PR introduces Flake8 errors

See test results for failed build of commit 89b418db2e

codeofdusk · 2020-02-13T20:42:59Z

Cc @LeonarddeR @michaelDCurran

codeofdusk · 2020-03-06T18:22:19Z

@LeonarddeR @michaelDCurran Could you please have another look? I think this is now ready for merge, and will become functional with microsoft/terminal#4826.

codeofdusk · 2020-03-06T18:23:05Z

The PR description has also been updated with additional changes and testing notes.

codeofdusk · 2020-03-18T02:25:11Z

Cc @feerrenrut and @michaelDCurran Could this PR please be reviewed?

feerrenrut · 2020-03-18T10:19:37Z

I haven't yet looked through the changes carefully, my initial impression is concern for regressions. Anything you can do here to reduce the chance of regression (particularly in windows console) will help us to get confidence in this PR.

We are planning to try to clear the backlog of PR's soon, we will initially focus on bug fixes and small PR's.

codeofdusk · 2020-03-18T13:07:52Z

I haven't yet looked through the changes carefully, my initial impression is concern for regressions. Anything you can do here to reduce the chance of regression (particularly in windows console) will help us to get confidence in this PR.

We are planning to try to clear the backlog of PR's soon, we will initially focus on bug fixes and small PR's.

Chance of regressions seems fairly low, as the new terminal and old console functionality are in separate subclasses (WinConsoleUIA and WinTerminalUIA). However, this PR does lay the groundwork for improved UIA console support in Windows 10 2104, which may (likely will) be good enough to use as default when new conhost (including microsoft/terminal#4018) ships. The 2104 console changes will be implemented in a separate PR (that will depend on this one).

LeonarddeR

Have you tested this on insider builds of Windows 2004?

josephsl · 2020-03-31T07:06:03Z

Hi, or better yet, it might be best to call it 21H1, as we don’t know if it’s going to be called 2103 or 2104 – won’t find out until December at the earliest. Thanks.

codeofdusk · 2020-03-31T09:36:39Z

@LeonarddeR I think all requested changes have now been made.

… add _shouldUseToUnicodeEx flag and set False for WinTerminalUIA.

codeofdusk · 2020-04-01T21:18:50Z

I've rebased this PR on master as it's been open for a while.

@LeonarddeR Could you please have another look?

dpy013 · 2020-04-02T05:51:47Z

hi @codeofdusk
Is pr basically complete now?
thanks

codeofdusk · 2020-04-02T05:53:19Z

hi @codeofdusk
Is pr basically complete now?
thanks

Yes, awaiting review from @LeonarddeR and @michaelDCurran.

LeonarddeR

Yay, this shortens the diff significantly, that's good!

Co-Authored-By: Leonard de Ruijter <leonardder@users.noreply.github.com>

codeofdusk · 2020-04-03T10:47:01Z

@LeonarddeR @feerrenrut Could you please have another look?

LeonarddeR

Thanks @codeofdusk

michaelDCurran · 2020-04-04T22:11:51Z

Try build: https://ci.appveyor.com/api/buildjobs/milyub46w9dmxg7l/artifacts/output%2Fnvda_snapshot_try-t10305-19897%2C6ff9867f.exe

michaelDCurran · 2020-04-04T22:12:53Z

I shall try to review this on Monday.

codeofdusk · 2020-04-05T04:26:32Z

Perhaps in a separate PR, we may need to rethink how and when we clear the typed word buffer for new text lines in EnhancedTermTypedCharSupport._calculateNewText.

STR:

Enable "speak typed words".
Open Open Console (the 21H1 conhost).
Run git log.
Press q to close the pager.
Type git and press space.

NVDA says "qgit", not "git".

For reference, the 21H1 console (OpenConsole.exe) and Windows Terminal (WindowsTerminal.exe) as of commit microsoft/terminal@4f8acb4 can be found here. On my system, I've replaced the default conhost with this version (see microsoft/terminal#1817). The pre-21H1 console still works as expected after this PR.

This saves us from scanning the old and new lines twice in _calculateNewText (once for diffing and once for finding nonblank indices), and fixes typed word reporting for 21H1 console. This new approach does not resolve nvaccess#10942.

michaelDCurran · 2020-04-06T00:59:04Z

@codeofdusk I'm happy with this. Are you ready for me to merge this?

codeofdusk · 2020-04-06T01:01:20Z

Yes – Future changes, if necessary, will be made in subsequent PRs.

codeofdusk mentioned this pull request Feb 13, 2020

UI Automation in Windows Console: Use UIA by default on Windows 10 version 2004 and later #10716

Closed

LeonarddeR approved these changes Feb 17, 2020

View reviewed changes

lukaszgo1 reviewed Feb 17, 2020

View reviewed changes

Comment thread source/NVDAObjects/UIA/winConsoleUIA.py Outdated

codeofdusk mentioned this pull request Feb 23, 2020

Conhost: UIA word navigation is slow microsoft/terminal#4703

Closed

codeofdusk mentioned this pull request Mar 6, 2020

Accessibility: Signaling Model microsoft/terminal#2447

Closed

5 tasks

codeofdusk mentioned this pull request Mar 7, 2020

Fire UIA Events for Output and Cursor Movement microsoft/terminal#4826

Merged

feerrenrut added enhancement app/windows-terminal New terminal app, potentially supersedes app/windows-console (repo: microsoft/terminal) labels Mar 18, 2020

This comment has been minimized.

Sign in to view

LeonarddeR suggested changes Mar 31, 2020

View reviewed changes

codeofdusk added 10 commits April 1, 2020 16:45

Bring over ConsoleUIATextInfo refactoring from nvaccess#10716.

53362b6

Add WinTerminalUIA

bd3a1d8

Style.

0ced21e

Review actions.

1746259

microsoft/terminal#4495: support fixed GetVisibleRanges.

b113e55

KeyboardHandlerBasedTypedCharSupport -> EnhancedTermTypedCharSupport,…

fe6bb27

… add _shouldUseToUnicodeEx flag and set False for WinTerminalUIA.

Update doc comments.

d29b819

Update copyrights.

84914f0

Review actions.

27858c9

Factor out bounding into separate method.

f3c2537

codeofdusk added 2 commits April 2, 2020 01:30

Revert another no longer necessary copyright header change.

8955839

Fix comments.

103a383

Update docstring.

7524a7a

LeonarddeR suggested changes Apr 2, 2020

View reviewed changes

Comment thread source/NVDAObjects/UIA/winConsoleUIA.py

Comment thread source/NVDAObjects/UIA/winConsoleUIA.py

Comment thread source/NVDAObjects/UIA/winConsoleUIA.py Outdated

Comment thread source/NVDAObjects/UIA/winConsoleUIA.py

Comment thread source/NVDAObjects/behaviors.py Outdated

codeofdusk and others added 3 commits April 2, 2020 10:16

Review actions.

9d9857f

Update source/NVDAObjects/behaviors.py

2c4178c

Co-Authored-By: Leonard de Ruijter <leonardder@users.noreply.github.com>

Add class docstring.

8bdd8e5

Merge branch 'master' into t10305

6ff9867

LeonarddeR approved these changes Apr 4, 2020

View reviewed changes

LeonarddeR requested a review from michaelDCurran April 4, 2020 07:26

codeofdusk added 2 commits April 5, 2020 01:02

Update inaccurate information in user guide.

224c684

michaelDCurran approved these changes Apr 6, 2020

View reviewed changes

michaelDCurran merged commit a0f9bea into nvaccess:master Apr 6, 2020

nvaccessAuto added this to the 2020.1 milestone Apr 6, 2020

michaelDCurran added a commit that referenced this pull request Apr 6, 2020

Update what's new for pr #10784

b1b1de2

codeofdusk mentioned this pull request Apr 6, 2020

Scenario: Add Support for UI Automation microsoft/terminal#4533

Closed

22 tasks

feerrenrut modified the milestones: 2020.1, 2020.2 Apr 6, 2020

codeofdusk mentioned this pull request Apr 8, 2020

UI Automation in Windows Console: make default in FORMATTED consoles (Windows 11 Sun Valley 2) #10964

Merged

chinwobble mentioned this pull request Sep 20, 2020

Add screen reader support onivim/oni2#2489

Open

Uh oh!

Conversation

codeofdusk commented Feb 13, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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:

Uh oh!

AppVeyorBot commented Feb 13, 2020

Uh oh!

codeofdusk commented Feb 13, 2020

Uh oh!

Uh oh!

codeofdusk commented Mar 6, 2020

Uh oh!

codeofdusk commented Mar 6, 2020

Uh oh!

codeofdusk commented Mar 18, 2020

Uh oh!

feerrenrut commented Mar 18, 2020

Uh oh!

codeofdusk commented Mar 18, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

LeonarddeR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

josephsl commented Mar 31, 2020 via email • edited by feerrenrut Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codeofdusk commented Mar 31, 2020

Uh oh!

codeofdusk commented Apr 1, 2020

Uh oh!

dpy013 commented Apr 2, 2020

Uh oh!

codeofdusk commented Apr 2, 2020

Uh oh!

LeonarddeR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codeofdusk commented Apr 3, 2020

Uh oh!

LeonarddeR left a comment

Choose a reason for hiding this comment

Uh oh!

michaelDCurran commented Apr 4, 2020

Uh oh!

michaelDCurran commented Apr 4, 2020

Uh oh!

codeofdusk commented Apr 5, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

michaelDCurran commented Apr 6, 2020

Uh oh!

codeofdusk commented Apr 6, 2020 via email

Uh oh!

Reviewers

Assignees

Labels

codeofdusk commented Feb 13, 2020 •

edited

Loading

codeofdusk commented Mar 18, 2020 •

edited

Loading

josephsl commented Mar 31, 2020 via email •

edited by feerrenrut

Loading

codeofdusk commented Apr 5, 2020 •

edited

Loading