Revert "Use UIA caret events in Windows Terminal (#16873)"

[codeofdusk]

Link to issue number:

Reverts #16873.

Summary of the issue:

• When backspacing beyond the leftmost character of a line in Windows Terminal, the last character of the prompt is erroneously read in some environments.
• Some caret tracking issues (especially when connected to remote systems) are more apparent.

Description of how this pull request fixes the issue:

Revert the new behaviour until it can be fixed upstream or a workaround can be found.

Testing strategy:

Verified restoration of previous behaviour and that caret tracking works as before.

Known issues with pull request:

Please include in 2024.4.

Code Review Checklist:

• Documentation:
  • Change log entry
  • User Documentation
  • Developer / Technical Documentation
  • Context sensitive help for GUI changes
• Testing:
  • Unit tests
  • System (end to end) tests
  • Manual testing
• UX of all users considered:
  • Speech
  • Braille
  • Low Vision
  • Different web browsers
  • Localization in other languages / culture than English
• API is compatible with existing add-ons.
• Security precautions taken.

Summary by CodeRabbit

• New Features

  • Reinstated reliance on UIA events for caret movement in XAML and WPF text controls, improving caret tracking accuracy.
  • Updated Seika Notetaker driver for better braille input handling.

• Bug Fixes

  • Adjusted on-demand speech mode to reduce interruptions during specific actions.
  • Fixed garbage character output in braille when accessing Microsoft Word without UI Automation.
  • Improved braille cursor routing for better navigation with Unicode characters.

[coderabbitai]

Walkthrough

The recent updates to NVDA include bug fixes and enhancements focusing on caret movement detection, improved braille input functionality, and the suppression of unnecessary speech output in specific scenarios. These changes restore reliance on UIA events for caret tracking in XAML and WPF, adjust the Seika Notetaker driver for better braille input, and enhance the overall braille navigation experience.

Changes

Files	Change Summary
source/NVDAObjects/UIA/winConsoleUIA.py	Removed the _get_caretMovementDetectionUsesEvents method, affecting caret movement detection logic.
user_docs/en/changes.md	Restored UIA event reliance for caret movement in XAML/WPF, updated Seika Notetaker driver, adjusted on-demand speech mode, fixed braille character output in Microsoft Word, and improved braille cursor routing.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NVDA
    participant UIA
    participant BrailleDevice

    User->>NVDA: Perform action (e.g., typing)
    NVDA->>UIA: Detect caret movement using events
    UIA-->>NVDA: Return caret position
    NVDA->>BrailleDevice: Update braille output with caret position

Loading

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

Outside diff range, codebase verification and nitpick comments (1)

source/NVDAObjects/UIA/winConsoleUIA.py (1)

Line range hint 284-307: Consider adding more detailed logging for UIA notifications.

While the current logging warns about blocked notifications, additional logs could provide more context about the notifications being processed. This can be helpful for debugging and understanding the flow of events.

log.debug(f"Processing UIA notification: {kwargs}")

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: License check.
• PASS: Unit tests.
• PASS: Lint check.
• FAIL: System tests (tags: installer NVDA). See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/nl3rkuawicm8ul1a/artifacts/output/nvda_snapshot_pr17048-33502,d44d6587.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 1.3,
  INSTALL_END 1.0,
  BUILD_START 0.0,
  BUILD_END 12.7,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.4,
  TEST_START 0.0,
  TEST_END 18.7,
  FINISH_END 0.1

See test results for failed build of commit d44d6587a6

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: License check.
• PASS: Unit tests.
• PASS: Lint check.
• FAIL: System tests (tags: installer NVDA). See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/6v39t9dapoli8082/artifacts/output/nvda_snapshot_pr17048-33518,d44d6587.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 1.2,
  INSTALL_END 0.9,
  BUILD_START 0.0,
  BUILD_END 11.1,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.3,
  TEST_START 0.0,
  TEST_END 17.8,
  FINISH_END 0.1

See test results for failed build of commit d44d6587a6

[seanbudd]

Could you please use the revert template in future? https://github.com/nvaccess/nvda/blob/master/.github/PULL_REQUEST_TEMPLATE/revert.md