Add support for Windows Terminal

[codeofdusk]

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]

• Build (for testing PR)
• PR introduces Flake8 errors

See test results for failed build of commit 89b418db2e

[codeofdusk]

Cc @LeonarddeR @michaelDCurran

[codeofdusk]

@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]

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

[codeofdusk]

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

[feerrenrut]

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]

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]

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]

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

[codeofdusk]

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

@LeonarddeR Could you please have another look?

[dpy013]

hi @codeofdusk
Is pr basically complete now?
thanks

[codeofdusk]

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!

[codeofdusk]

@LeonarddeR @feerrenrut Could you please have another look?

[LeonarddeR]

Thanks @codeofdusk

[michaelDCurran]

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

[michaelDCurran]

I shall try to review this on Monday.

[codeofdusk]

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:

1. Enable "speak typed words".
2. Open Open Console (the 21H1 conhost).
3. Run git log.
4. Press q to close the pager.
5. 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.

[michaelDCurran]

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

[codeofdusk]

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