2019-05-03 00:29:04 +02:00
/*++
Copyright ( c ) Microsoft Corporation
Licensed under the MIT license .
Module Name :
- screenInfo . hpp
Abstract :
- This module represents the structures and functions required
for rendering one screen of the console host window .
Author ( s ) :
- Michael Niksa ( MiNiksa ) 10 - Apr - 2014
- Paul Campbell ( PaulCam ) 10 - Apr - 2014
Revision History :
- From components of output . h / . c and resize . c by Therese Stowell ( ThereseS ) 1990 - 1991
- - */
# pragma once
# include "conapi.h"
# include "settings.hpp"
# include "outputStream.hpp"
# include "ScreenBufferRenderTarget.hpp"
# include "../buffer/out/OutputCellRect.hpp"
# include "../buffer/out/TextAttribute.hpp"
# include "../buffer/out/textBuffer.hpp"
# include "../buffer/out/textBufferCellIterator.hpp"
# include "../buffer/out/textBufferTextIterator.hpp"
# include "IIoProvider.hpp"
# include "outputStream.hpp"
# include "../terminal/adapter/adaptDispatch.hpp"
# include "../terminal/parser/stateMachine.hpp"
# include "../terminal/parser/OutputStateMachineEngine.hpp"
# include "../server/ObjectHeader.h"
# include "../interactivity/inc/IAccessibilityNotifier.hpp"
2020-06-10 17:15:26 +02:00
# include "../interactivity/inc/IConsoleWindow.hpp"
2019-05-03 00:29:04 +02:00
# include "../interactivity/inc/IWindowMetrics.hpp"
# include "../inc/ITerminalOutputConnection.hpp"
# include "../renderer/inc/FontInfo.hpp"
# include "../renderer/inc/FontInfoDesired.hpp"
# include "../types/inc/Viewport.hpp"
class ConversionAreaInfo ; // forward decl window. circular reference
2020-01-29 17:33:06 +01:00
// fwdecl unittest classes
# ifdef UNIT_TESTING
namespace TerminalCoreUnitTests
{
class ConptyRoundtripTests ;
} ;
# endif
2019-05-03 00:29:04 +02:00
class SCREEN_INFORMATION : public ConsoleObjectHeader , public Microsoft : : Console : : IIoProvider
{
public :
2019-06-11 22:27:09 +02:00
[[nodiscard]] static NTSTATUS CreateInstance ( _In_ COORD coordWindowSize ,
const FontInfo fontInfo ,
_In_ COORD coordScreenBufferSize ,
const TextAttribute defaultAttributes ,
const TextAttribute popupAttributes ,
const UINT uiCursorSize ,
_Outptr_ SCREEN_INFORMATION * * const ppScreen ) ;
2019-05-03 00:29:04 +02:00
~ SCREEN_INFORMATION ( ) ;
void GetScreenBufferInformation ( _Out_ PCOORD pcoordSize ,
_Out_ PCOORD pcoordCursorPosition ,
_Out_ PSMALL_RECT psrWindow ,
_Out_ PWORD pwAttributes ,
_Out_ PCOORD pcoordMaximumWindowSize ,
_Out_ PWORD pwPopupAttributes ,
_Out_writes_ ( COLOR_TABLE_SIZE ) LPCOLORREF lpColorTable ) const ;
void GetRequiredConsoleSizeInPixels ( _Out_ PSIZE const pRequiredSize ) const ;
void MakeCurrentCursorVisible ( ) ;
void ClipToScreenBuffer ( _Inout_ SMALL_RECT * const psrClip ) const ;
COORD GetMinWindowSizeInCharacters ( const COORD coordFontSize = { 1 , 1 } ) const ;
COORD GetMaxWindowSizeInCharacters ( const COORD coordFontSize = { 1 , 1 } ) const ;
COORD GetLargestWindowSizeInCharacters ( const COORD coordFontSize = { 1 , 1 } ) const ;
COORD GetScrollBarSizesInCharacters ( ) const ;
Microsoft : : Console : : Types : : Viewport GetBufferSize ( ) const ;
Microsoft : : Console : : Types : : Viewport GetTerminalBufferSize ( ) const ;
COORD GetScreenFontSize ( ) const ;
void UpdateFont ( const FontInfo * const pfiNewFont ) ;
void RefreshFontWithRenderer ( ) ;
2019-06-11 22:27:09 +02:00
[[nodiscard]] NTSTATUS ResizeScreenBuffer ( const COORD coordNewScreenSize , const bool fDoScrollBarUpdate ) ;
2019-05-03 00:29:04 +02:00
2021-07-09 20:45:44 +02:00
bool HasAccessibilityEventing ( ) const noexcept ;
2019-05-03 00:29:04 +02:00
void NotifyAccessibilityEventing ( const short sStartX , const short sStartY , const short sEndX , const short sEndY ) ;
void UpdateScrollBars ( ) ;
void InternalUpdateScrollBars ( ) ;
bool IsMaximizedBoth ( ) const ;
bool IsMaximizedX ( ) const ;
bool IsMaximizedY ( ) const ;
const Microsoft : : Console : : Types : : Viewport & GetViewport ( ) const noexcept ;
void SetViewport ( const Microsoft : : Console : : Types : : Viewport & newViewport , const bool updateBottom ) ;
Microsoft : : Console : : Types : : Viewport GetVirtualViewport ( ) const noexcept ;
void ProcessResizeWindow ( const RECT * const prcClientNew , const RECT * const prcClientOld ) ;
void SetViewportSize ( const COORD * const pcoordSize ) ;
// Forwarders to Window if we're the active buffer.
2019-06-11 22:27:09 +02:00
[[nodiscard]] NTSTATUS SetViewportOrigin ( const bool fAbsolute , const COORD coordWindowOrigin , const bool updateBottom ) ;
2019-05-03 00:29:04 +02:00
bool SendNotifyBeep ( ) const ;
bool PostUpdateWindowSize ( ) const ;
// TODO: MSFT 9355062 these methods should probably be a part of construction/destruction. http://osgvsowi/9355062
static void s_InsertScreenBuffer ( _In_ SCREEN_INFORMATION * const pScreenInfo ) ;
static void s_RemoveScreenBuffer ( _In_ SCREEN_INFORMATION * const pScreenInfo ) ;
OutputCellRect ReadRect ( const Microsoft : : Console : : Types : : Viewport location ) const ;
TextBufferCellIterator GetCellDataAt ( const COORD at ) const ;
TextBufferCellIterator GetCellLineDataAt ( const COORD at ) const ;
TextBufferCellIterator GetCellDataAt ( const COORD at , const Microsoft : : Console : : Types : : Viewport limit ) const ;
TextBufferTextIterator GetTextDataAt ( const COORD at ) const ;
TextBufferTextIterator GetTextLineDataAt ( const COORD at ) const ;
TextBufferTextIterator GetTextDataAt ( const COORD at , const Microsoft : : Console : : Types : : Viewport limit ) const ;
OutputCellIterator Write ( const OutputCellIterator it ) ;
OutputCellIterator Write ( const OutputCellIterator it ,
make filling chars (and, thus, erase line/char) unset wrap (#2831)
EraseInLine calls `FillConsoleOutputCharacterW()`. In filling the row with
chars, we were setting the wrap flag. We need to specifically not do this on
ANY _FILL_ operation. Now a fill operation UNSETS the wrap flag if we fill to
the end of the line.
Originally, we had a boolean `setWrap` that would mean...
- **true**: if writing to the end of the row, SET the wrap value to true
- **false**: if writing to the end of the row, DON'T CHANGE the wrap value
Now we're making this bool a std::optional to allow for a ternary state. This
allows for us to handle the following cases completely. Refer to the table
below:
,- current wrap value
| ,- are we filling the last cell in the row?
| | ,- new wrap value
| | | ,- comments
|-- |-- |-- |
| 0 | 0 | 0 |
| 0 | 1 | 0 |
| 0 | 1 | 1 | THIS CASE WAS HANDLED CORRECTLY
| 1 | 0 | 0 | THIS CASE WAS UNHANDLED
| 1 | 0 | 1 |
| 1 | 1 | 1 |
To handle that special case (1-0-0), we need to UNSET the wrap. So now, we have
~setWrap~ `wrap` mean the following:
- **true**: if writing to the end of the row, SET the wrap value to TRUE
- **false**: if writing to the end of the row, SET the wrap value to FALSE
- **nullopt**: leave the wrap value as it is
Closes #1126
2019-10-01 03:16:31 +02:00
const COORD target ,
const std : : optional < bool > wrap = true ) ;
2019-05-03 00:29:04 +02:00
OutputCellIterator WriteRect ( const OutputCellIterator it ,
const Microsoft : : Console : : Types : : Viewport viewport ) ;
void WriteRect ( const OutputCellRect & data ,
const COORD location ) ;
void ClearTextData ( ) ;
std : : pair < COORD , COORD > GetWordBoundary ( const COORD position ) const ;
TextBuffer & GetTextBuffer ( ) noexcept ;
const TextBuffer & GetTextBuffer ( ) const noexcept ;
# pragma region IIoProvider
SCREEN_INFORMATION & GetActiveOutputBuffer ( ) override ;
const SCREEN_INFORMATION & GetActiveOutputBuffer ( ) const override ;
InputBuffer * const GetActiveInputBuffer ( ) const override ;
# pragma endregion
bool CursorIsDoubleWidth ( ) const ;
DWORD OutputMode ;
2019-06-11 22:27:09 +02:00
WORD ResizingWindow ; // > 0 if we should ignore WM_SIZE messages
2019-05-03 00:29:04 +02:00
short WheelDelta ;
short HWheelDelta ;
2019-06-11 22:27:09 +02:00
2019-05-03 00:29:04 +02:00
private :
std : : unique_ptr < TextBuffer > _textBuffer ;
2019-06-11 22:27:09 +02:00
2019-05-03 00:29:04 +02:00
public :
2019-06-11 22:27:09 +02:00
SCREEN_INFORMATION * Next ;
2019-05-03 00:29:04 +02:00
BYTE WriteConsoleDbcsLeadByte [ 2 ] ;
BYTE FillOutDbcsLeadChar ;
// non ownership pointer
ConversionAreaInfo * ConvScreenInfo ;
UINT ScrollScale ;
bool IsActiveScreenBuffer ( ) const ;
2019-05-30 20:14:21 +02:00
const Microsoft : : Console : : VirtualTerminal : : StateMachine & GetStateMachine ( ) const ;
Microsoft : : Console : : VirtualTerminal : : StateMachine & GetStateMachine ( ) ;
2019-05-03 00:29:04 +02:00
void SetCursorInformation ( const ULONG Size ,
const bool Visible ) noexcept ;
void SetCursorType ( const CursorType Type , const bool setMain = false ) noexcept ;
void SetCursorDBMode ( const bool DoubleCursor ) ;
2019-06-11 22:27:09 +02:00
[[nodiscard]] NTSTATUS SetCursorPosition ( const COORD Position , const bool TurnOn ) ;
2019-05-03 00:29:04 +02:00
void MakeCursorVisible ( const COORD CursorPosition , const bool updateBottom = true ) ;
Microsoft : : Console : : Types : : Viewport GetRelativeScrollMargins ( ) const ;
Microsoft : : Console : : Types : : Viewport GetAbsoluteScrollMargins ( ) const ;
void SetScrollMargins ( const Microsoft : : Console : : Types : : Viewport margins ) ;
bool AreMarginsSet ( ) const noexcept ;
2019-07-10 18:42:13 +02:00
bool IsCursorInMargins ( const COORD cursorPosition ) const noexcept ;
2019-05-03 00:29:04 +02:00
2019-06-11 22:27:09 +02:00
[[nodiscard]] NTSTATUS UseAlternateScreenBuffer ( ) ;
2019-05-03 00:29:04 +02:00
void UseMainScreenBuffer ( ) ;
SCREEN_INFORMATION & GetMainBuffer ( ) ;
const SCREEN_INFORMATION & GetMainBuffer ( ) const ;
SCREEN_INFORMATION & GetActiveBuffer ( ) ;
const SCREEN_INFORMATION & GetActiveBuffer ( ) const ;
TextAttribute GetAttributes ( ) const ;
Improve the legacy color conversions (#6358)
This PR provides a faster algorithm for converting 8-bit and 24-bit
colors into the 4-bit legacy values that are required by the Win32
console APIs. It also fixes areas of the code that were incorrectly
using a simple 16-color conversion that didn't handle 8-bit and 24-bit
values.
The faster conversion algorithm should be an improvement for issues #783
and #3950.
One of the main points of this PR was to fix the
`ReadConsoleOutputAttribute` API, which was using a simplified legacy
color conversion (the original `TextAttribute:GetLegacyAttributes`
method), which could only handle values from the 16-color table. RGB
values, and colors from the 256-color table, would be mapped to
completely nonsensical values. This API has now been updated to use the
more correct `Settings::GenerateLegacyAttributes` method.
But there were also a couple of other places in the code that were using
`GetLegacyAttributes` when they really had no reason to be working with
legacy attributes at all. This could result in colors being downgraded
to 4-bit values (often badly, as explained above), when the code was
already perfectly capable of displaying the full 24-bits.
This included the fill colors in the IME composer (in `ConsoleImeInfo`),
and the construction of the highlighting colors in the color
search/selection handler (`Selection::_HandleColorSelection`). I also
got rid of some legacy attribute code in the `Popup` class, which was
originally intended to update colors below the popup when the settings
changed, but actually caused more problems than it solved.
The other major goal of this PR was to improve the performance of the
`GenerateLegacyAttributes` method, since the existing implementation
could be quite slow when dealing with RGB values.
The simple cases are handled much the same as they were before. For an
`IsDefault` color, we get the default index from the
`Settings::_wFillAttribute` field. For an `IsIndex16` color, the index
can just be returned as is.
For an `IsRgb` color, the RGB components are compressed down to 8 bits
(3 red, 3 green, 2 blue), simply by dropping the least significant bits.
This 8-bit value is then used to lookup a representative 16-color value
from a hard-coded table. An `IsIndex256` color is also converted with a
lookup table, just using the existing 8-bit index.
The RGB mapping table was calculated by taking each compressed 8-bit
color, and picking a entry from the _Campbell_ palette that best
approximated that color. This was done by looking at a range of 24-bit
colors that mapped to the 8-bit value, finding the best _Campbell_ match
for each of them (using a [CIEDE2000] color difference calculation), and
then the most common match became the index that the 8-bit value would
map to.
The 256-color table was just a simpler version of this process. For each
entry in the table, we take the default RGB palette value, and find it's
closest match in the _Campbell_ palette.
Because these tables are hard-coded, the results won't adjust to changes
in the palette. However, they should still produce reasonable results
for palettes that follow the standard ANSI color range. And since
they're only a very loose approximation of the colors anyway, the exact
value really isn't that important.
That said, I have tried to make sure that if you take an RGB value for a
particular index in a reasonable color scheme, then the legacy color
mapped from that value should ideally match the same index. This will
never be possible for all color schemes, but I have tweaked a few of the
table entries to improve the results for some of the common schemes.
One other point worth making regarding the hard-coded tables: even if we
wanted to take the active palette into account, that wouldn't actually
be possible over a conpty connection, because we can't easily know what
color scheme the client application is using. At least this way the
results in conhost are guaranteed to be the same as in the Windows
Terminal.
[CIEDE2000]: https://en.wikipedia.org/wiki/Color_difference#CIEDE2000
## Validation Steps Performed
This code still passes the `TextAttributeTests` that check the basic
`GetLegacyAttribute` behaviour and verify the all legacy attributes
roundtrip correctly. However, some of the values in the `RgbColorTests`
had to be updated, since we're now intentionally returning different
values as a result of the changes to the RGB conversion algorithm.
I haven't added additional unit tests, but I have done a lot of manual
testing to see how well the new algorithm works with a range of colors
and a variety of different color schemes. It's not perfect in every
situation, but I think it works well enough for the purpose it serves.
I've also confirmed that the issues reported in #5940 and #6247 are now
fixed by these changes.
Closes #5940
Closes #6247
2020-06-08 21:05:06 +02:00
TextAttribute GetPopupAttributes ( ) const ;
2019-05-03 00:29:04 +02:00
void SetAttributes ( const TextAttribute & attributes ) ;
void SetPopupAttributes ( const TextAttribute & popupAttributes ) ;
void SetDefaultAttributes ( const TextAttribute & attributes ,
const TextAttribute & popupAttributes ) ;
2019-06-11 22:27:09 +02:00
[[nodiscard]] HRESULT VtEraseAll ( ) ;
2021-09-02 16:59:42 +02:00
[[nodiscard]] HRESULT ClearBuffer ( ) ;
2019-05-03 00:29:04 +02:00
void SetTerminalConnection ( _In_ Microsoft : : Console : : ITerminalOutputConnection * const pTtyConnection ) ;
void UpdateBottom ( ) ;
void MoveToBottom ( ) ;
Microsoft : : Console : : Render : : IRenderTarget & GetRenderTarget ( ) noexcept ;
FontInfo & GetCurrentFont ( ) noexcept ;
const FontInfo & GetCurrentFont ( ) const noexcept ;
FontInfoDesired & GetDesiredFont ( ) noexcept ;
const FontInfoDesired & GetDesiredFont ( ) const noexcept ;
void InitializeCursorRowAttributes ( ) ;
Reintroduce a color compatibility hack, but only for PowerShells (#6810)
There is going to be a very long tail of applications that will
explicitly request VT SGR 40/37 when what they really want is to
SetConsoleTextAttribute() with a black background/white foreground.
Instead of making those applications look bad (and therefore making us
look bad, because we're releasing this as an update to something that
"looks good" already), we're introducing this compatibility quirk.
Before the color reckoning in #6698 + #6506, *every* color was subject
to being spontaneously and erroneously turned into the default color.
Now, only the 16-color palette value that matches the active console
background/foreground color will be destroyed, and only when received
from specific applications.
Removal will be tracked by #6807.
Michael and I discussed what layer this quirk really belonged in. I
originally believed it would be sufficient to detect a background color
that matched the legacy default background, but @j4james provided an
example of where that wouldn't work out (powershell setting the
foreground color to white/gray). In addition, it was too heavyhanded: it
re-broke black backgrounds for every application.
Michael thought that it should live in the server, as a small VT parser
that righted the wrongs coming directly out of the application. On
further investigation, however, I realized that we'd need to push more
information up into the server (so that it could make the decision about
which VT was wrong and which was right) than should be strictly
necessary.
The host knows which colors are right and wrong, and it gets final say
in what ends up in the buffer.
Because of that, I chose to push the quirk state down through
WriteConsole to DoWriteConsole and toggle state on the
SCREEN_INFORMATION that indicates whether the colors coming out of the
application are to be distrusted. This quirk _only applies to pwsh.exe
and powershell.exe._
NOTE: This doesn't work for PowerShell the .NET Global tool, because it
is run as an assembly through dotnet.exe. I have no opinion on how to
fix this, or whether it is worth fixing.
VALIDATION
----------
I configured my terminals to have an incredibly garish color scheme to
show exactly what's going to happen as a result of this. The _default
terminal background_ is purple or red, and the foreground green. I've
printed out a heap of test colors to see how black interacts with them.
Pull request #6810 contains the images generated from this test.
The only color lines that change are the ones where black as a
background or white as a foreground is selected out of the 16-color
palette explicitly. Reverse video still works fine (because black is in
the foreground!), and it's even possible to represent "black on default"
and reverse it into "default on black", despite the black in question
having been `40`.
Fixes #6767.
2020-07-11 00:25:39 +02:00
void SetIgnoreLegacyEquivalentVTAttributes ( ) noexcept ;
void ResetIgnoreLegacyEquivalentVTAttributes ( ) noexcept ;
2019-05-03 00:29:04 +02:00
private :
2019-06-11 22:27:09 +02:00
SCREEN_INFORMATION ( _In_ Microsoft : : Console : : Interactivity : : IWindowMetrics * pMetrics ,
_In_ Microsoft : : Console : : Interactivity : : IAccessibilityNotifier * pNotifier ,
2019-05-03 00:29:04 +02:00
const TextAttribute popupAttributes ,
const FontInfo fontInfo ) ;
2019-06-11 22:27:09 +02:00
Microsoft : : Console : : Interactivity : : IWindowMetrics * _pConsoleWindowMetrics ;
Microsoft : : Console : : Interactivity : : IAccessibilityNotifier * _pAccessibilityNotifier ;
2019-05-03 00:29:04 +02:00
2019-06-11 22:27:09 +02:00
[[nodiscard]] HRESULT _AdjustScreenBufferHelper ( const RECT * const prcClientNew ,
const COORD coordBufferOld ,
_Out_ COORD * const pcoordClientNewCharacters ) ;
[[nodiscard]] HRESULT _AdjustScreenBuffer ( const RECT * const prcClientNew ) ;
2019-05-03 00:29:04 +02:00
void _CalculateViewportSize ( const RECT * const prcClientArea , _Out_ COORD * const pcoordSize ) ;
void _AdjustViewportSize ( const RECT * const prcClientNew , const RECT * const prcClientOld , const COORD * const pcoordSize ) ;
void _InternalSetViewportSize ( const COORD * const pcoordSize , const bool fResizeFromTop , const bool fResizeFromLeft ) ;
static void s_CalculateScrollbarVisibility ( const RECT * const prcClientArea ,
const COORD * const pcoordBufferSize ,
const COORD * const pcoordFontSize ,
_Out_ bool * const pfIsHorizontalVisible ,
_Out_ bool * const pfIsVerticalVisible ) ;
2019-06-11 22:27:09 +02:00
[[nodiscard]] NTSTATUS ResizeWithReflow ( const COORD coordnewScreenSize ) ;
[[nodiscard]] NTSTATUS ResizeTraditional ( const COORD coordNewScreenSize ) ;
2019-05-03 00:29:04 +02:00
2019-06-11 22:27:09 +02:00
[[nodiscard]] NTSTATUS _InitializeOutputStateMachine ( ) ;
2019-05-03 00:29:04 +02:00
void _FreeOutputStateMachine ( ) ;
2019-06-11 22:27:09 +02:00
[[nodiscard]] NTSTATUS _CreateAltBuffer ( _Out_ SCREEN_INFORMATION * * const ppsiNewScreenBuffer ) ;
2019-05-03 00:29:04 +02:00
bool _IsAltBuffer ( ) const ;
bool _IsInPtyMode ( ) const ;
Remove unneeded VT-specific control character handling (#4289)
## Summary of the Pull Request
This PR removes all of the VT-specific functionality from the `WriteCharsLegacy` function that dealt with control characters, since those controls are now handled in the state machine when in VT mode. It also removes most of the control character handling from the `Terminal::_WriteBuffer` method for the same reason.
## References
This is a followup to PR #4171
## PR Checklist
* [x] Closes #3971
* [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA
* [ ] Tests added/passed
* [ ] Requires documentation to be updated
* [x] 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: https://github.com/microsoft/terminal/issues/780#issuecomment-570287435
## Detailed Description of the Pull Request / Additional comments
There are four changes to the `WriteCharsLegacy` implementation:
1. The `TAB` character had special case handling in VT mode which is now no longer required. This fixes a bug in the Python REPL editor (when run from a cmd shell in Windows Terminal), which would prevent you tabbing past the end of the line. It also fixes #3971.
2. Following on from point 1, the `WC_NONDESTRUCTIVE_TAB` flag could also now be removed. It only ever applied in VT mode, in which case the `TAB` character isn't handled in `WriteCharsLegacy`, so there isn't a need for a non-destructive version.
3. There used to be special case handling for a `BS` character at the beginning of the line when in VT mode, and that is also no longer required. This fixes an edge-case bug which would prevent a glyph being output for code point 8 when `ENABLE_PROCESSED_OUTPUT` was disabled.
4. There was quite a lot of special case handling for control characters in the "end-of-line wrap" implementation, which is no longer required. This fixes a bug which would prevent "low ASCII" characters from wrapping when output at the end of a line.
Then in the `Terminal::_WriteBuffer` implementation, I've simply removed all control character handling, except for `LF`. The Terminal is always in VT mode, so the control characters are always handled by the state machine. The exception for the `LF` character is simply because it doesn't have a proper implementation yet, so it still passes the character through to `_WriteBuffer`. That will get cleaned up eventually, but I thought that could wait for a later PR.
Finally, with the removal of the VT mode handling in `WriteCharsLegacy`, there was no longer a need for the `SCREEN_INFORMATION::InVTMode` method to be publicly accessible. That has now been made private.
## Validation Steps Performed
I've only tested manually, making sure the conhost and Windows Terminal still basically work, and confirming that the above-mentioned bugs are fixed by these changes.
2020-01-29 20:18:46 +01:00
bool _IsInVTMode ( ) const ;
2019-05-03 00:29:04 +02:00
2019-05-30 20:14:21 +02:00
std : : shared_ptr < Microsoft : : Console : : VirtualTerminal : : StateMachine > _stateMachine ;
2019-05-03 00:29:04 +02:00
Microsoft : : Console : : Types : : Viewport _scrollMargins ; //The margins of the VT specified scroll region. Left and Right are currently unused, but could be in the future.
// Specifies which coordinates of the screen buffer are visible in the
// window client (the "viewport" into the buffer)
Microsoft : : Console : : Types : : Viewport _viewport ;
SCREEN_INFORMATION * _psiAlternateBuffer ; // The VT "Alternate" screen buffer.
SCREEN_INFORMATION * _psiMainBuffer ; // A pointer to the main buffer, if this is the alternate buffer.
RECT _rcAltSavedClientNew ;
RECT _rcAltSavedClientOld ;
bool _fAltWindowChanged ;
TextAttribute _PopupAttributes ;
FontInfo _currentFont ;
FontInfoDesired _desiredFont ;
// Tracks the last virtual position the viewport was at. This is not
// affected by the user scrolling the viewport, only when API calls cause
// the viewport to move (SetBufferInfo, WriteConsole, etc)
short _virtualBottom ;
ScreenBufferRenderTarget _renderTarget ;
Reintroduce a color compatibility hack, but only for PowerShells (#6810)
There is going to be a very long tail of applications that will
explicitly request VT SGR 40/37 when what they really want is to
SetConsoleTextAttribute() with a black background/white foreground.
Instead of making those applications look bad (and therefore making us
look bad, because we're releasing this as an update to something that
"looks good" already), we're introducing this compatibility quirk.
Before the color reckoning in #6698 + #6506, *every* color was subject
to being spontaneously and erroneously turned into the default color.
Now, only the 16-color palette value that matches the active console
background/foreground color will be destroyed, and only when received
from specific applications.
Removal will be tracked by #6807.
Michael and I discussed what layer this quirk really belonged in. I
originally believed it would be sufficient to detect a background color
that matched the legacy default background, but @j4james provided an
example of where that wouldn't work out (powershell setting the
foreground color to white/gray). In addition, it was too heavyhanded: it
re-broke black backgrounds for every application.
Michael thought that it should live in the server, as a small VT parser
that righted the wrongs coming directly out of the application. On
further investigation, however, I realized that we'd need to push more
information up into the server (so that it could make the decision about
which VT was wrong and which was right) than should be strictly
necessary.
The host knows which colors are right and wrong, and it gets final say
in what ends up in the buffer.
Because of that, I chose to push the quirk state down through
WriteConsole to DoWriteConsole and toggle state on the
SCREEN_INFORMATION that indicates whether the colors coming out of the
application are to be distrusted. This quirk _only applies to pwsh.exe
and powershell.exe._
NOTE: This doesn't work for PowerShell the .NET Global tool, because it
is run as an assembly through dotnet.exe. I have no opinion on how to
fix this, or whether it is worth fixing.
VALIDATION
----------
I configured my terminals to have an incredibly garish color scheme to
show exactly what's going to happen as a result of this. The _default
terminal background_ is purple or red, and the foreground green. I've
printed out a heap of test colors to see how black interacts with them.
Pull request #6810 contains the images generated from this test.
The only color lines that change are the ones where black as a
background or white as a foreground is selected out of the 16-color
palette explicitly. Reverse video still works fine (because black is in
the foreground!), and it's even possible to represent "black on default"
and reverse it into "default on black", despite the black in question
having been `40`.
Fixes #6767.
2020-07-11 00:25:39 +02:00
bool _ignoreLegacyEquivalentVTAttributes ;
2019-05-03 00:29:04 +02:00
# ifdef UNIT_TESTING
friend class TextBufferIteratorTests ;
friend class ScreenBufferTests ;
friend class CommonState ;
Create tests that roundtrip output through a conpty to a Terminal (#4213)
## Summary of the Pull Request
This PR adds two tests:
* First, I started by writing a test where I could write output to the console host and inspect what output came out of conpty. This is the `ConptyOutputTests` in the host unit tests.
* Then I got crazy and thought _"what if I could take that output and dump it straight into the `Terminal`"_? Hence, the `ConptyRoundtripTests` were born, into the TerminalCore unit tests.
## References
Done in pursuit of #4200, but I felt this warranted it's own atomic PR
## PR Checklist
* [x] Doesn't close anything on it's own.
* [x] I work here
* [x] you better believe this adds tests
* [n/a] Requires documentation to be updated
## Detailed Description of the Pull Request / Additional comments
From the comment in `ConptyRoundtripTests`:
> This test class creates an in-proc conpty host as well as a Terminal, to
> validate that strings written to the conpty create the same resopnse on the
> terminal end. Tests can be written that validate both the contents of the
> host buffer as well as the terminal buffer. Everytime that
> `renderer.PaintFrame()` is called, the tests will validate the expected
> output, and then flush the output of the VtEngine straight to th
Also, some other bits had to be updated:
* The renderer needed to be able to survive without a thread, so I hadded a simple check that it actually had a thread before calling `pThread->NotifyPaint`
* Bits in `CommonState` used `NTSTATUS_FROM_HRESULT` which did _not_ work outside the host project. Since the `NTSTATUS` didn't seem that important, I replaced that with a `HRESULT`
* `CommonState` likes to initialize the console to some _weird_ defaults. I added an optional param to let us just use the defaults.
2020-01-17 17:40:12 +01:00
friend class ConptyOutputTests ;
2020-01-29 17:33:06 +01:00
friend class TerminalCoreUnitTests : : ConptyRoundtripTests ;
2019-05-03 00:29:04 +02:00
# endif
} ;
