starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-03 21:25:34 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

ScrollRegion function generates inappropriate EVENT_CONSOLE_UPDATE_SCROLL #16964

New Issue
Open
opened 2026-01-31 05:28:36 +00:00 by claunia · 1 comment
claunia commented 2026-01-31 05:28:36 +00:00
Owner
Copy Link

Originally created by @j4james on GitHub (Mar 10, 2022).

Windows Terminal version

n/a

Windows build number

10.0.19041.1415

Other Software

No response

Steps to reproduce

The ScrollRegion function is used in conhost to "scroll" an area of the screen buffer in multiple directions. It's used in a variety of places, but the closest equivalent in the public API is the ScrollConsoleScreenBuffer function. It doesn't pan the viewport, as typically occurs when the console scrolls - it's more akin to copying a chunk of the buffer from one position to another.

But if you look at the code for ScrollRegion, it makes a call to _ScrollScreen, which then makes a call to NotifyConsoleUpdateScrollEvent like this:

3bd3a4f712/src/host/output.cpp (L279)

That code is a bit obfuscated by the use of Origin, but it essentially boils down to:

pNotifier->NotifyConsoleUpdateScrollEvent(target.Left() - source.Left(), target.Top() - source.RightInclusive());

Quite clearly the second parameter is nonsense.

That said, I'm not sure a scroll event should be used here at all. As mentioned above, it's not the equivalent of the viewport scrolling, so I don't think it makes sense to trigger an EVENT_CONSOLE_UPDATE_SCROLL.

Hopefully someone that is more knowledgable about accessibility can chime in here, but it seemed to me that EVENT_CONSOLE_UPDATE_SCROLL was how you would track the movement of the viewport. Other update events use absolute coordinates, so you need to know the viewport position in order to obtain their relative location. And if something like ScrollRegion is sending unrelated scroll events, that makes that data useless.

Expected Behavior

I don't think ScrollRegion should be triggering EVENT_CONSOLE_UPDATE_SCROLL at all, but if it does, it should at least give meaningful deltas.

Actual Behavior

ScrollRegion is triggering meaningless EVENT_CONSOLE_UPDATE_SCROLL notifications.

Originally created by @j4james on GitHub (Mar 10, 2022). ### Windows Terminal version n/a ### Windows build number 10.0.19041.1415 ### Other Software _No response_ ### Steps to reproduce The `ScrollRegion` function is used in conhost to "scroll" an area of the screen buffer in multiple directions. It's used in a variety of places, but the closest equivalent in the public API is the [ScrollConsoleScreenBuffer](https://docs.microsoft.com/en-us/windows/console/scrollconsolescreenbuffer) function. It doesn't pan the viewport, as typically occurs when the console scrolls - it's more akin to copying a chunk of the buffer from one position to another. But if you look at the code for [`ScrollRegion`](https://github.com/microsoft/terminal/blob/3bd3a4f712006d752b59d66e104aeb6bc5f7f9d6/src/host/output.cpp#L436-L437), it makes a call to `_ScrollScreen`, which then makes a call to `NotifyConsoleUpdateScrollEvent` like this: https://github.com/microsoft/terminal/blob/3bd3a4f712006d752b59d66e104aeb6bc5f7f9d6/src/host/output.cpp#L279 That code is a bit obfuscated by the use of `Origin`, but it essentially boils down to: ```cpp pNotifier->NotifyConsoleUpdateScrollEvent(target.Left() - source.Left(), target.Top() - source.RightInclusive()); ``` Quite clearly the second parameter is nonsense. That said, I'm not sure a scroll event should be used here at all. As mentioned above, it's not the equivalent of the viewport scrolling, so I don't think it makes sense to trigger an `EVENT_CONSOLE_UPDATE_SCROLL`. Hopefully someone that is more knowledgable about accessibility can chime in here, but it seemed to me that `EVENT_CONSOLE_UPDATE_SCROLL` was how you would track the movement of the viewport. Other update events use absolute coordinates, so you need to know the viewport position in order to obtain their relative location. And if something like `ScrollRegion` is sending unrelated scroll events, that makes that data useless. ### Expected Behavior I don't think `ScrollRegion` should be triggering `EVENT_CONSOLE_UPDATE_SCROLL` at all, but if it does, it should at least give meaningful deltas. ### Actual Behavior `ScrollRegion` is triggering meaningless `EVENT_CONSOLE_UPDATE_SCROLL` notifications.
claunia added the Help WantedProduct-ConhostArea-OutputIssue-BugPriority-3 labels 2026-01-31 05:28:36 +00:00
claunia commented 2026-01-31 05:28:37 +00:00
Author
Owner
Copy Link

@j4james commented on GitHub (Mar 10, 2022):

Btw, I thought at first that it might make sense to send an EVENT_CONSOLE_UPDATE_REGION here, indicating the area of the screen that had changed, but I suspect that's not right either. I tried that out with the screen reader running, and it forces it to start reading that whole area of the screen again. If you're doing something that scrolls in a window, I would think all you care about is the newly revealed lines - you don't need to be told about the parts that have just moved and which you've likely already seen.

@j4james commented on GitHub (Mar 10, 2022): Btw, I thought at first that it might make sense to send an `EVENT_CONSOLE_UPDATE_REGION` here, indicating the area of the screen that had changed, but I suspect that's not right either. I tried that out with the screen reader running, and it forces it to start reading that whole area of the screen again. If you're doing something that scrolls in a window, I would think all you care about is the newly revealed lines - you don't need to be told about the parts that have just moved and which you've likely already seen.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Area-Output Help Wanted Issue-Bug Priority-3 Product-Conhost
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#16964
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?