7612044363
## Summary of the Pull Request This PR implements a pair of shims for `cmd` and `powershell`, so that their `cls` and `Clear-Host` functions will clear the entire terminal buffer (like they do in conhost), instead of just the viewport. With the conpty viewport and buffer being the same size, there's effectively no way to know if an application is calling these API's in this way with the intention of clearing the buffer or the viewport. We absolutely have to guess. Each of these shims checks to see if the way that the API is being called exactly matches the way `cmd` or `powershell` would call these APIs. If it does, we manually write a `^[[3J` to the connected terminal, to get he Terminal to clear it's own scrollback. ~~_⚠️ If another application were trying to clear the **viewport** with an exactly similar API call, this would also cause the terminal scrollback to get cleared ⚠️_~~ * [x] Should these shims be restricted to when the process that's calling them is actually `cmd.exe` or `powershell.exe`? Can I even do this? I think we've done such a good job of isolating the client process information from the rest of the host code that I can't figure out how to do this. - YES, this can be done, and I did it. * [ ] **TODO**: _While I'm here_, should I have `DoSrvPrivateEraseAll` (the implementation for `^[[2J`, in `getset.cpp`) also manually trigger a EraseAll in the terminal in conpty mode? ## PR Checklist * [x] Closes #3126 * [x] Actually closes #1305 too, which is really the same thing, but probably deserves a callout * [x] I work here * [x] Tests added/passed * [n/a] Requires documentation to be updated ## Validation Steps Performed * ran tests * checked `cls` in the Terminal * checked `Clear-Host` in the Terminal * Checked running `powershell clear-host` from `cmd.exe`
35 lines
941 B
C++
35 lines
941 B
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#include "precomp.h"
|
|
|
|
#include "globals.h"
|
|
|
|
#pragma hdrstop
|
|
|
|
CONSOLE_INFORMATION& Globals::getConsoleInformation()
|
|
{
|
|
return ciConsoleInformation;
|
|
}
|
|
|
|
bool Globals::IsHeadless() const
|
|
{
|
|
return launchArgs.IsHeadless();
|
|
}
|
|
|
|
#ifdef UNIT_TESTING
|
|
// Method Description:
|
|
// - This is a test helper method. It can be used to trick us into responding
|
|
// true to `IsHeadless`, which will cause the console host to act in conpty
|
|
// mode.
|
|
// Arguments:
|
|
// - vtRenderEngine: a VT renderer that our VtIo should use as the vt engine during these tests
|
|
// Return Value:
|
|
// - <none>
|
|
void Globals::EnableConptyModeForTests(std::unique_ptr<Microsoft::Console::Render::VtEngine> vtRenderEngine)
|
|
{
|
|
launchArgs.EnableConptyModeForTests();
|
|
getConsoleInformation().GetVtIo()->EnableConptyModeForTests(std::move(vtRenderEngine));
|
|
}
|
|
#endif
|