Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable VT processing by default for conpty #2824

Merged
merged 2 commits into from
Sep 23, 2019

Conversation

zadjii-msft
Copy link
Member

Summary of the Pull Request

This change enables VT processing by default for all conpty clients. See #1965 for a discussion on why we believe this is a righteous change.

PR Checklist

Detailed Description of the Pull Request / Additional comments

Also mentioned in the issue was the idea of only checking the VirtualTerminalLevel reg key in the conpty startup. I don't think this would be a more difficult change, looks like all we'd need is a simple reg.LoadGlobalsFromRegistry(); call instead of this change.

Validation Steps Performed

Manually launched a scratch app in both the terminal and the console. The console launch's output mode was 0x3, and the terminal's was 0x7. 0x4 is the ENABLE_VIRTUAL_TERMINAL_PROCESSING flag, which the client now had by default in the Terminal.

@zadjii-msft zadjii-msft added Product-Conpty For console issues specifically related to conpty Issue-Bug It either shouldn't be doing this or needs an investigation. labels Sep 20, 2019
Copy link
Contributor

@DHowett-MSFT DHowett-MSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Tyriar: do you know of any VSCode users who would become upset about this?

@Tyriar
Copy link
Member

Tyriar commented Sep 20, 2019

@DHowett-MSFT I thought this is how it always worked? Not sure how to repro within vscode:

image

@DHowett-MSFT DHowett-MSFT added the Needs-Second It's a PR that needs another sign-off label Sep 20, 2019
src/host/srvinit.cpp Outdated Show resolved Hide resolved
@miniksa miniksa removed the Needs-Second It's a PR that needs another sign-off label Sep 20, 2019
Co-Authored-By: Carlos Zamora <carlos.zamora@microsoft.com>
@miniksa
Copy link
Member

miniksa commented Sep 23, 2019

Merged Carlos's comment. I'll squash this to master with the approvals on Mike's behalf since he's out today (presuming the CI completes).

@DHowett-MSFT DHowett-MSFT merged commit 1c412d4 into master Sep 23, 2019
@DHowett-MSFT DHowett-MSFT deleted the dev/migrie/b/1965-vt-all-the-things branch September 23, 2019 22:07
@ghost
Copy link

ghost commented Sep 24, 2019

🎉Windows Terminal Preview v0.5.2661.0 has been released which incorporates this pull request.:tada:

Handy links:

DHowett-MSFT pushed a commit that referenced this pull request Sep 26, 2019
This change enables VT processing by default for _all_ conpty clients. See #1965 for a discussion on why we believe this is a righteous change.

Also mentioned in the issue was the idea of only checking the `VirtualTerminalLevel` reg key in the conpty startup. I don't think this would be a more difficult change, looks like all we'd need is a simple `reg.LoadGlobalsFromRegistry();` call instead of this change.

# Validation Steps Performed
Manually launched a scratch app in both the terminal and the console. The console launch's output mode was 0x3, and the terminal's was 0x7. 0x4 is the ` ENABLE_VIRTUAL_TERMINAL_PROCESSING` flag, which the client now had by default in the Terminal.

Closes #1965

(cherry picked from commit 1c412d4)
DHowett-MSFT pushed a commit that referenced this pull request Sep 26, 2019
- Remember last-used string in the Find dialog in conhost (GH-2845)

  (cherry picked from commit bfb1484)

- Bugfix: TextBuffer Line Wrapping from VTRenderer (GH-2797)

  Change VT renderer to do erase line instead of a ton of erase chars

  (cherry picked from commit 8afc5b2)

- Add some retry support to Renderer::PaintFrame (GH-2830)

  If _PaintFrameForEngine returns E_PENDING, we'll give it another two
  tries to get itself straight. If it continues to fail, we'll take down
  the application.

  We observed that the DX renderer was failing to present the swap chain
  and failfast'ing when it did so; however, there are some errors from
  which DXGI guidance suggests we try to recover. We'll now return
  E_PENDING (and destroy our device resources) when we hit those errors.

  Fixes GH-2265.

  (cherry picked from commit 277acc3)

- Enable VT processing by default for ConPTY (GH-2824)

  This change enables VT processing by default for _all_ conpty clients. See
  GH-1965 for a discussion on why we believe this is a righteous change.

  Also mentioned in the issue was the idea of only checking the
  `VirtualTerminalLevel` reg key in the conpty startup. I don't think this would
  be a more difficult change, looks like all we'd need is a simple
  `reg.LoadGlobalsFromRegistry();` call instead of this change.

  **Validation Steps Performed**
  Manually launched a scratch app in both the terminal and the console. The
  console launch's output mode was 0x3, and the terminal's was 0x7. 0x4 is the `
  ENABLE_VIRTUAL_TERMINAL_PROCESSING` flag, which the client now had by default
  in the Terminal.

  Closes GH-1965

  (cherry picked from commit 1c412d4)

- Remove unwanted DECSTBM clipping (GH-2764)

  The `DECSTBM` margins are meant to define the range of lines within which
  certain vertical scrolling operations take place. However, we were applying
  these margin restrictions in the `ScrollRegion` function, which is also used in
  a number of places that shouldn't be affected by `DECSTBM`.

  This includes the `ICH` and `DCH` escape sequences (which are only affected by
  the horizontal margins, which we don't yet support), the
  `ScrollConsoleScreenBuffer` API (which is public Console API, not meant to be
  affected by the VT terminal emulation), and the `CSI 3 J` erase scrollback
  extension (which isn't really scrolling as such, but uses the `ScrollRegion`
  function to manipulate the scrollback buffer).

  This commit moves the margin clipping out of the `ScrollRegion` function, so it
  can be applied exclusively in the places that need it.

  While testing, I also noticed that one of the `ScrollRegion` calls in the
  `AdjustCursorPosition` function was not setting the horizontal range correctly
  - the scrolling should always affect the full buffer width rather than just the
    viewport width - so ...

Related work items: #23507749, #23563809, #23563819, #23563837, #23563841, #23563844
@fpqc
Copy link

fpqc commented Sep 28, 2019

Hey, would it be a big problem to add additional granularity to enabling VT processing? I have an idea for a patch #2946 , but making it secure by making OSC 52 processing opt-in seems like it would need an additional level of granularity.

Note: This particular example does not run afoul of the double-VT-processing objection:
#1965 (comment), since the OSC52 control sequence is not a screen-visible sequence. Allowing it to pass through to the Terminal (or other conpty consumer) should be less of an issue, so that is another option.

On the other hand, maybe I'm misunderstanding VT-processing vs VT-rendering. I tried looking through the source code, and it was unclear to me which thing means which.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Issue-Bug It either shouldn't be doing this or needs an investigation. Product-Conpty For console issues specifically related to conpty
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Escape sequences behave strangely over conpty when VirtualTerminalLevel is set
6 participants