[PR #13109] Fix handling of cursor position reports in passthrough mode #29403

Closed
opened 2026-01-31 09:34:40 +00:00 by claunia · 0 comments
Owner

Original Pull Request: https://github.com/microsoft/terminal/pull/13109

State: closed
Merged: Yes


Summary of the Pull Request

When the conpty passthrough mode is enabled, it often needs to send DSR-CPR queries (cursor position reports) to the client terminal to obtain the current cursor position. However, the code that originally handled the responses to these queries got broken by the refactoring of the ConGetSet API. This PR is an attempt to correct that regression.

References

The conpty passthrough mode was introduced in PR #11264.
The refactoring that broke the cursor position handling was in PR #12703.

PR Checklist

Detailed Description of the Pull Request / Additional comments

Prior to the ConGetSet refactoring, the code that handled DSR-CPR responses (InteractDispatch::MoveCursor) would pass the cursor position to ConGetSet::SetCursorPosition, which in turn would forward it to the SetConsoleCursorPositionImpl API, and from there to the VtIo class.

After the refactor, all of those intermediate steps were removed - the cursor was simply updated directly in InteractDispatch::MoveCursor, and the VtIo call was moved from SetConsoleCursorPositionImpl to InteractDispatch (since that was the only place it was actually required).

However, when the conpty passthrough mode was introduced - which happened in parallel - it relied on the SetConsoleCursorPositionImpl API being called from InteractDispatch in order to handle its own DSR-CPR responses, and that's why things stopped working when the two PRs merged.

So what I've done now is made InteractDispatch::MoveCursor method call SetConsoleCursorPositionImpl again (although without the intermediate ConGetSet overhead), and moved the VtIo::SetCursorPosition call back into SetConsoleCursorPositionImpl.

This is not ideal, and there are still a bunch of problems with the DSR-CPR handling in passthrough mode, but it's at least as good as it was before.

Validation Steps Performed

I've just manually tested various shells with passthrough mode enabled, and confirmed that they're working better now. There are still issues, but nothing that wasn't already a problem in the initial implementation, at least as far as I can tell.

**Original Pull Request:** https://github.com/microsoft/terminal/pull/13109 **State:** closed **Merged:** Yes --- ## Summary of the Pull Request When the conpty passthrough mode is enabled, it often needs to send `DSR-CPR` queries (cursor position reports) to the client terminal to obtain the current cursor position. However, the code that originally handled the responses to these queries got broken by the refactoring of the `ConGetSet` API. This PR is an attempt to correct that regression. ## References The conpty passthrough mode was introduced in PR #11264. The refactoring that broke the cursor position handling was in PR #12703. ## PR Checklist * [x] Closes #13106 * [x] CLA signed. * [ ] Tests added/passed * [ ] Documentation updated. If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/terminal) and link it here: #xxx * [ ] Schema updated. * [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx ## Detailed Description of the Pull Request / Additional comments Prior to the `ConGetSet` refactoring, the code that handled `DSR-CPR` responses (`InteractDispatch::MoveCursor`) would pass the cursor position to `ConGetSet::SetCursorPosition`, which in turn would forward it to the `SetConsoleCursorPositionImpl` API, and from there to the `VtIo` class. After the refactor, all of those intermediate steps were removed - the cursor was simply updated directly in `InteractDispatch::MoveCursor`, and the `VtIo` call was moved from `SetConsoleCursorPositionImpl` to `InteractDispatch` (since that was the only place it was actually required). However, when the conpty passthrough mode was introduced - which happened in parallel - it relied on the `SetConsoleCursorPositionImpl` API being called from `InteractDispatch` in order to handle its own `DSR-CPR` responses, and that's why things stopped working when the two PRs merged. So what I've done now is made `InteractDispatch::MoveCursor` method call `SetConsoleCursorPositionImpl` again (although without the intermediate `ConGetSet` overhead), and moved the `VtIo::SetCursorPosition` call back into `SetConsoleCursorPositionImpl`. This is not ideal, and there are still a bunch of problems with the `DSR-CPR` handling in passthrough mode, but it's at least as good as it was before. ## Validation Steps Performed I've just manually tested various shells with passthrough mode enabled, and confirmed that they're working better now. There are still issues, but nothing that wasn't already a problem in the initial implementation, at least as far as I can tell.
claunia added the pull-request label 2026-01-31 09:34:40 +00:00
Sign in to join this conversation.
No Label pull-request
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#29403