Add support for OSC 10 and 11 to set the default colors (#891)
* Support OSC to set default background and foreground colors * Update the Terminal theme when the background changes * Fix whitespace per code-review * Add Documentation Comments Also fix a few outdated comments and whitespace * Update Telemetry codes per code review * Add Unit Tests for OSC ForegroundColor and BackgroundColor * Add a couple additional test cases * Minor doc and whitespace change per PR review * Update comment help per code review * Add another OSC 10 & 11 test case, improve output * Comments and syntax cleanup per code reviews
This commit is contained in:
parent
2fdcb679ab
commit
efd69990c6
|
@ -158,8 +158,7 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
|
||||||
// - Style our UI elements based on the values in our _settings, and set up
|
// - Style our UI elements based on the values in our _settings, and set up
|
||||||
// other control-specific settings. This method will be called whenever
|
// other control-specific settings. This method will be called whenever
|
||||||
// the settings are reloaded.
|
// the settings are reloaded.
|
||||||
// * Sets up the background of the control with the provided BG color,
|
// * Calls _BackgroundColorChanged to style the background of the control
|
||||||
// acrylic or not, and if acrylic, then uses the opacity from _settings.
|
|
||||||
// - Core settings will be passed to the terminal in _InitializeTerminal
|
// - Core settings will be passed to the terminal in _InitializeTerminal
|
||||||
// Arguments:
|
// Arguments:
|
||||||
// - <none>
|
// - <none>
|
||||||
|
@ -167,37 +166,8 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
|
||||||
// - <none>
|
// - <none>
|
||||||
void TermControl::_ApplyUISettings()
|
void TermControl::_ApplyUISettings()
|
||||||
{
|
{
|
||||||
winrt::Windows::UI::Color bgColor{};
|
|
||||||
uint32_t bg = _settings.DefaultBackground();
|
uint32_t bg = _settings.DefaultBackground();
|
||||||
const auto R = GetRValue(bg);
|
_BackgroundColorChanged(bg);
|
||||||
const auto G = GetGValue(bg);
|
|
||||||
const auto B = GetBValue(bg);
|
|
||||||
bgColor.R = R;
|
|
||||||
bgColor.G = G;
|
|
||||||
bgColor.B = B;
|
|
||||||
bgColor.A = 255;
|
|
||||||
|
|
||||||
if (_settings.UseAcrylic())
|
|
||||||
{
|
|
||||||
Media::AcrylicBrush acrylic{};
|
|
||||||
acrylic.BackgroundSource(Media::AcrylicBackgroundSource::HostBackdrop);
|
|
||||||
acrylic.FallbackColor(bgColor);
|
|
||||||
acrylic.TintColor(bgColor);
|
|
||||||
acrylic.TintOpacity(_settings.TintOpacity());
|
|
||||||
_root.Background(acrylic);
|
|
||||||
|
|
||||||
// If we're acrylic, we want to make sure that the default BG color
|
|
||||||
// is transparent, so we can see the acrylic effect on text with the
|
|
||||||
// default BG color.
|
|
||||||
_settings.DefaultBackground(ARGB(0, R, G, B));
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
Media::SolidColorBrush solidColor{};
|
|
||||||
solidColor.Color(bgColor);
|
|
||||||
_root.Background(solidColor);
|
|
||||||
_settings.DefaultBackground(RGB(R, G, B));
|
|
||||||
}
|
|
||||||
|
|
||||||
// Apply padding to the root Grid
|
// Apply padding to the root Grid
|
||||||
auto thickness = _ParseThicknessFromPadding(_settings.Padding());
|
auto thickness = _ParseThicknessFromPadding(_settings.Padding());
|
||||||
|
@ -216,6 +186,50 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
|
||||||
_desiredFont = { _actualFont };
|
_desiredFont = { _actualFont };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Method Description:
|
||||||
|
// - Style the background of the control with the provided background color
|
||||||
|
// - Respects the settings for acrylic and opacity from _settings
|
||||||
|
// Arguments:
|
||||||
|
// - color: The background color to use as a uint32 (aka DWORD COLORREF)
|
||||||
|
// Return Value:
|
||||||
|
// - <none>
|
||||||
|
void TermControl::_BackgroundColorChanged(const uint32_t color)
|
||||||
|
{
|
||||||
|
_root.Dispatcher().RunAsync(CoreDispatcherPriority::Normal, [this, color]() {
|
||||||
|
const auto R = GetRValue(color);
|
||||||
|
const auto G = GetGValue(color);
|
||||||
|
const auto B = GetBValue(color);
|
||||||
|
|
||||||
|
winrt::Windows::UI::Color bgColor{};
|
||||||
|
bgColor.R = R;
|
||||||
|
bgColor.G = G;
|
||||||
|
bgColor.B = B;
|
||||||
|
bgColor.A = 255;
|
||||||
|
|
||||||
|
if (_settings.UseAcrylic())
|
||||||
|
{
|
||||||
|
Media::AcrylicBrush acrylic{};
|
||||||
|
acrylic.BackgroundSource(Media::AcrylicBackgroundSource::HostBackdrop);
|
||||||
|
acrylic.FallbackColor(bgColor);
|
||||||
|
acrylic.TintColor(bgColor);
|
||||||
|
acrylic.TintOpacity(_settings.TintOpacity());
|
||||||
|
_root.Background(acrylic);
|
||||||
|
|
||||||
|
// If we're acrylic, we want to make sure that the default BG color
|
||||||
|
// is transparent, so we can see the acrylic effect on text with the
|
||||||
|
// default BG color.
|
||||||
|
_settings.DefaultBackground(ARGB(0, R, G, B));
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
Media::SolidColorBrush solidColor{};
|
||||||
|
solidColor.Color(bgColor);
|
||||||
|
_root.Background(solidColor);
|
||||||
|
_settings.DefaultBackground(RGB(R, G, B));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
// Method Description:
|
// Method Description:
|
||||||
// - Create a connection based on the values in our settings object.
|
// - Create a connection based on the values in our settings object.
|
||||||
// * Gets the commandline and working directory out of the _settings and
|
// * Gets the commandline and working directory out of the _settings and
|
||||||
|
@ -406,6 +420,9 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
|
||||||
auto pfnTitleChanged = std::bind(&TermControl::_TerminalTitleChanged, this, std::placeholders::_1);
|
auto pfnTitleChanged = std::bind(&TermControl::_TerminalTitleChanged, this, std::placeholders::_1);
|
||||||
_terminal->SetTitleChangedCallback(pfnTitleChanged);
|
_terminal->SetTitleChangedCallback(pfnTitleChanged);
|
||||||
|
|
||||||
|
auto pfnBackgroundColorChanged = std::bind(&TermControl::_BackgroundColorChanged, this, std::placeholders::_1);
|
||||||
|
_terminal->SetBackgroundCallback(pfnBackgroundColorChanged);
|
||||||
|
|
||||||
auto pfnScrollPositionChanged = std::bind(&TermControl::_TerminalScrollPositionChanged, this, std::placeholders::_1, std::placeholders::_2, std::placeholders::_3);
|
auto pfnScrollPositionChanged = std::bind(&TermControl::_TerminalScrollPositionChanged, this, std::placeholders::_1, std::placeholders::_2, std::placeholders::_3);
|
||||||
_terminal->SetScrollPositionChangedCallback(pfnScrollPositionChanged);
|
_terminal->SetScrollPositionChangedCallback(pfnScrollPositionChanged);
|
||||||
|
|
||||||
|
|
|
@ -95,6 +95,7 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
|
||||||
|
|
||||||
void _Create();
|
void _Create();
|
||||||
void _ApplyUISettings();
|
void _ApplyUISettings();
|
||||||
|
void _BackgroundColorChanged(const uint32_t color);
|
||||||
void _ApplyConnectionSettings();
|
void _ApplyConnectionSettings();
|
||||||
void _InitializeTerminal();
|
void _InitializeTerminal();
|
||||||
void _UpdateFont();
|
void _UpdateFont();
|
||||||
|
|
|
@ -31,5 +31,8 @@ namespace Microsoft::Terminal::Core
|
||||||
virtual bool SetColorTableEntry(const size_t tableIndex, const DWORD dwColor) = 0;
|
virtual bool SetColorTableEntry(const size_t tableIndex, const DWORD dwColor) = 0;
|
||||||
|
|
||||||
virtual bool SetCursorStyle(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::CursorStyle cursorStyle) = 0;
|
virtual bool SetCursorStyle(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::CursorStyle cursorStyle) = 0;
|
||||||
|
|
||||||
|
virtual bool SetDefaultForeground(const DWORD dwColor) = 0;
|
||||||
|
virtual bool SetDefaultBackground(const DWORD dwColor) = 0;
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
|
@ -442,6 +442,15 @@ void Terminal::SetScrollPositionChangedCallback(std::function<void(const int, co
|
||||||
_pfnScrollPositionChanged = pfn;
|
_pfnScrollPositionChanged = pfn;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Method Description:
|
||||||
|
// - Allows setting a callback for when the background color is changed
|
||||||
|
// Arguments:
|
||||||
|
// - pfn: a function callback that takes a uint32 (DWORD COLORREF) color in the format 0x00BBGGRR
|
||||||
|
void Terminal::SetBackgroundCallback(std::function<void(const uint32_t)> pfn) noexcept
|
||||||
|
{
|
||||||
|
_pfnBackgroundColorChanged = pfn;
|
||||||
|
}
|
||||||
|
|
||||||
// Method Description:
|
// Method Description:
|
||||||
// - Checks if selection is active
|
// - Checks if selection is active
|
||||||
// Return Value:
|
// Return Value:
|
||||||
|
|
|
@ -70,8 +70,10 @@ public:
|
||||||
COORD GetCursorPosition() override;
|
COORD GetCursorPosition() override;
|
||||||
bool EraseCharacters(const unsigned int numChars) override;
|
bool EraseCharacters(const unsigned int numChars) override;
|
||||||
bool SetWindowTitle(std::wstring_view title) override;
|
bool SetWindowTitle(std::wstring_view title) override;
|
||||||
bool SetColorTableEntry(const size_t tableIndex, const DWORD dwColor) override;
|
bool SetColorTableEntry(const size_t tableIndex, const COLORREF dwColor) override;
|
||||||
bool SetCursorStyle(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::CursorStyle cursorStyle) override;
|
bool SetCursorStyle(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::CursorStyle cursorStyle) override;
|
||||||
|
bool SetDefaultForeground(const COLORREF dwColor) override;
|
||||||
|
bool SetDefaultBackground(const COLORREF dwColor) override;
|
||||||
#pragma endregion
|
#pragma endregion
|
||||||
|
|
||||||
#pragma region ITerminalInput
|
#pragma region ITerminalInput
|
||||||
|
@ -113,6 +115,7 @@ public:
|
||||||
void SetWriteInputCallback(std::function<void(std::wstring&)> pfn) noexcept;
|
void SetWriteInputCallback(std::function<void(std::wstring&)> pfn) noexcept;
|
||||||
void SetTitleChangedCallback(std::function<void(const std::wstring_view&)> pfn) noexcept;
|
void SetTitleChangedCallback(std::function<void(const std::wstring_view&)> pfn) noexcept;
|
||||||
void SetScrollPositionChangedCallback(std::function<void(const int, const int, const int)> pfn) noexcept;
|
void SetScrollPositionChangedCallback(std::function<void(const int, const int, const int)> pfn) noexcept;
|
||||||
|
void SetBackgroundCallback(std::function<void(const uint32_t)> pfn) noexcept;
|
||||||
|
|
||||||
void SetCursorVisible(const bool isVisible) noexcept;
|
void SetCursorVisible(const bool isVisible) noexcept;
|
||||||
bool IsCursorBlinkingAllowed() const noexcept;
|
bool IsCursorBlinkingAllowed() const noexcept;
|
||||||
|
@ -131,6 +134,7 @@ public:
|
||||||
std::function<void(std::wstring&)> _pfnWriteInput;
|
std::function<void(std::wstring&)> _pfnWriteInput;
|
||||||
std::function<void(const std::wstring_view&)> _pfnTitleChanged;
|
std::function<void(const std::wstring_view&)> _pfnTitleChanged;
|
||||||
std::function<void(const int, const int, const int)> _pfnScrollPositionChanged;
|
std::function<void(const int, const int, const int)> _pfnScrollPositionChanged;
|
||||||
|
std::function<void(const uint32_t)> _pfnBackgroundColorChanged;
|
||||||
|
|
||||||
std::unique_ptr<::Microsoft::Console::VirtualTerminal::StateMachine> _stateMachine;
|
std::unique_ptr<::Microsoft::Console::VirtualTerminal::StateMachine> _stateMachine;
|
||||||
std::unique_ptr<::Microsoft::Console::VirtualTerminal::TerminalInput> _terminalInput;
|
std::unique_ptr<::Microsoft::Console::VirtualTerminal::TerminalInput> _terminalInput;
|
||||||
|
|
|
@ -157,7 +157,7 @@ bool Terminal::SetWindowTitle(std::wstring_view title)
|
||||||
// - dwColor: the new COLORREF to use as that color table value.
|
// - dwColor: the new COLORREF to use as that color table value.
|
||||||
// Return Value:
|
// Return Value:
|
||||||
// - true iff we successfully updated the color table entry.
|
// - true iff we successfully updated the color table entry.
|
||||||
bool Terminal::SetColorTableEntry(const size_t tableIndex, const DWORD dwColor)
|
bool Terminal::SetColorTableEntry(const size_t tableIndex, const COLORREF dwColor)
|
||||||
{
|
{
|
||||||
if (tableIndex > _colorTable.size())
|
if (tableIndex > _colorTable.size())
|
||||||
{
|
{
|
||||||
|
@ -219,3 +219,34 @@ bool Terminal::SetCursorStyle(const DispatchTypes::CursorStyle cursorStyle)
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Method Description:
|
||||||
|
// - Updates the default foreground color from a COLORREF, format 0x00BBGGRR.
|
||||||
|
// Arguments:
|
||||||
|
// - dwColor: the new COLORREF to use as the default foreground color
|
||||||
|
// Return Value:
|
||||||
|
// - true
|
||||||
|
bool Terminal::SetDefaultForeground(const COLORREF dwColor)
|
||||||
|
{
|
||||||
|
_defaultFg = dwColor;
|
||||||
|
|
||||||
|
// Repaint everything - the colors might have changed
|
||||||
|
_buffer->GetRenderTarget().TriggerRedrawAll();
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Method Description:
|
||||||
|
// - Updates the default background color from a COLORREF, format 0x00BBGGRR.
|
||||||
|
// Arguments:
|
||||||
|
// - dwColor: the new COLORREF to use as the default background color
|
||||||
|
// Return Value:
|
||||||
|
// - true
|
||||||
|
bool Terminal::SetDefaultBackground(const COLORREF dwColor)
|
||||||
|
{
|
||||||
|
_defaultBg = dwColor;
|
||||||
|
_pfnBackgroundColorChanged(dwColor);
|
||||||
|
|
||||||
|
// Repaint everything - the colors might have changed
|
||||||
|
_buffer->GetRenderTarget().TriggerRedrawAll();
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
|
@ -64,7 +64,7 @@ bool TerminalDispatch::SetWindowTitle(std::wstring_view title)
|
||||||
// - tableIndex: The VT color table index
|
// - tableIndex: The VT color table index
|
||||||
// - dwColor: The new RGB color value to use.
|
// - dwColor: The new RGB color value to use.
|
||||||
// Return Value:
|
// Return Value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool TerminalDispatch::SetColorTableEntry(const size_t tableIndex,
|
bool TerminalDispatch::SetColorTableEntry(const size_t tableIndex,
|
||||||
const DWORD dwColor)
|
const DWORD dwColor)
|
||||||
{
|
{
|
||||||
|
@ -75,3 +75,25 @@ bool TerminalDispatch::SetCursorStyle(const DispatchTypes::CursorStyle cursorSty
|
||||||
{
|
{
|
||||||
return _terminalApi.SetCursorStyle(cursorStyle);
|
return _terminalApi.SetCursorStyle(cursorStyle);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Method Description:
|
||||||
|
// - Sets the default foreground color to a new value
|
||||||
|
// Arguments:
|
||||||
|
// - dwColor: The new RGB color value to use, in 0x00BBGGRR form
|
||||||
|
// Return Value:
|
||||||
|
// True if handled successfully. False otherwise.
|
||||||
|
bool TerminalDispatch::SetDefaultForeground(const DWORD dwColor)
|
||||||
|
{
|
||||||
|
return _terminalApi.SetDefaultForeground(dwColor);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Method Description:
|
||||||
|
// - Sets the default background color to a new value
|
||||||
|
// Arguments:
|
||||||
|
// - dwColor: The new RGB color value to use, in 0x00BBGGRR form
|
||||||
|
// Return Value:
|
||||||
|
// True if handled successfully. False otherwise.
|
||||||
|
bool TerminalDispatch::SetDefaultBackground(const DWORD dwColor)
|
||||||
|
{
|
||||||
|
return _terminalApi.SetDefaultBackground(dwColor);
|
||||||
|
}
|
||||||
|
|
|
@ -27,6 +27,9 @@ public:
|
||||||
bool SetColorTableEntry(const size_t tableIndex, const DWORD dwColor) override;
|
bool SetColorTableEntry(const size_t tableIndex, const DWORD dwColor) override;
|
||||||
bool SetCursorStyle(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::CursorStyle cursorStyle) override;
|
bool SetCursorStyle(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::CursorStyle cursorStyle) override;
|
||||||
|
|
||||||
|
bool SetDefaultForeground(const DWORD dwColor) override;
|
||||||
|
bool SetDefaultBackground(const DWORD dwColor) override;
|
||||||
|
|
||||||
private:
|
private:
|
||||||
::Microsoft::Terminal::Core::ITerminalApi& _terminalApi;
|
::Microsoft::Terminal::Core::ITerminalApi& _terminalApi;
|
||||||
|
|
||||||
|
|
|
@ -2170,3 +2170,59 @@ HRESULT DoSrvPrivateSetColorTableEntry(const short index, const COLORREF value)
|
||||||
CATCH_RETURN();
|
CATCH_RETURN();
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Method Description:
|
||||||
|
// - Sets the default foreground color to the color specified in value.
|
||||||
|
// Arguments:
|
||||||
|
// - value: the new RGB value to use, as a COLORREF, format 0x00BBGGRR.
|
||||||
|
// Return Value:
|
||||||
|
// - S_OK
|
||||||
|
[[nodiscard]]
|
||||||
|
HRESULT DoSrvPrivateSetDefaultForegroundColor(const COLORREF value) noexcept
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
Globals& g = ServiceLocator::LocateGlobals();
|
||||||
|
CONSOLE_INFORMATION& gci = g.getConsoleInformation();
|
||||||
|
|
||||||
|
gci.SetDefaultForegroundColor(value);
|
||||||
|
|
||||||
|
// Update the screen colors if we're not a pty
|
||||||
|
// No need to force a redraw in pty mode.
|
||||||
|
if (g.pRender && !gci.IsInVtIoMode())
|
||||||
|
{
|
||||||
|
g.pRender->TriggerRedrawAll();
|
||||||
|
}
|
||||||
|
|
||||||
|
return S_OK;
|
||||||
|
}
|
||||||
|
CATCH_RETURN();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Method Description:
|
||||||
|
// - Sets the default background color to the color specified in value.
|
||||||
|
// Arguments:
|
||||||
|
// - value: the new RGB value to use, as a COLORREF, format 0x00BBGGRR.
|
||||||
|
// Return Value:
|
||||||
|
// - S_OK
|
||||||
|
[[nodiscard]]
|
||||||
|
HRESULT DoSrvPrivateSetDefaultBackgroundColor(const COLORREF value) noexcept
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
Globals& g = ServiceLocator::LocateGlobals();
|
||||||
|
CONSOLE_INFORMATION& gci = g.getConsoleInformation();
|
||||||
|
|
||||||
|
gci.SetDefaultBackgroundColor(value);
|
||||||
|
|
||||||
|
// Update the screen colors if we're not a pty
|
||||||
|
// No need to force a redraw in pty mode.
|
||||||
|
if (g.pRender && !gci.IsInVtIoMode())
|
||||||
|
{
|
||||||
|
g.pRender->TriggerRedrawAll();
|
||||||
|
}
|
||||||
|
|
||||||
|
return S_OK;
|
||||||
|
}
|
||||||
|
CATCH_RETURN();
|
||||||
|
}
|
||||||
|
|
|
@ -99,3 +99,9 @@ void DoSrvPrivateMoveToBottom(SCREEN_INFORMATION& screenInfo);
|
||||||
|
|
||||||
[[nodiscard]]
|
[[nodiscard]]
|
||||||
HRESULT DoSrvPrivateSetColorTableEntry(const short index, const COLORREF value) noexcept;
|
HRESULT DoSrvPrivateSetColorTableEntry(const short index, const COLORREF value) noexcept;
|
||||||
|
|
||||||
|
[[nodiscard]]
|
||||||
|
HRESULT DoSrvPrivateSetDefaultForegroundColor(const COLORREF value) noexcept;
|
||||||
|
|
||||||
|
[[nodiscard]]
|
||||||
|
HRESULT DoSrvPrivateSetDefaultBackgroundColor(const COLORREF value) noexcept;
|
||||||
|
|
|
@ -761,3 +761,27 @@ BOOL ConhostInternalGetSet::PrivateSetColorTableEntry(const short index, const C
|
||||||
{
|
{
|
||||||
return SUCCEEDED(DoSrvPrivateSetColorTableEntry(index, value));
|
return SUCCEEDED(DoSrvPrivateSetColorTableEntry(index, value));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Method Description:
|
||||||
|
// - Connects the PrivateSetDefaultForeground call directly into our Driver Message servicing
|
||||||
|
// call inside Conhost.exe
|
||||||
|
// Arguments:
|
||||||
|
// - value: the new RGB value to use, as a COLORREF, format 0x00BBGGRR.
|
||||||
|
// Return Value:
|
||||||
|
// - TRUE if successful (see DoSrvPrivateSetDefaultForegroundColor). FALSE otherwise.
|
||||||
|
BOOL ConhostInternalGetSet::PrivateSetDefaultForeground(const COLORREF value) const noexcept
|
||||||
|
{
|
||||||
|
return SUCCEEDED(DoSrvPrivateSetDefaultForegroundColor(value));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Method Description:
|
||||||
|
// - Connects the PrivateSetDefaultBackground call directly into our Driver Message servicing
|
||||||
|
// call inside Conhost.exe
|
||||||
|
// Arguments:
|
||||||
|
// - value: the new RGB value to use, as a COLORREF, format 0x00BBGGRR.
|
||||||
|
// Return Value:
|
||||||
|
// - TRUE if successful (see DoSrvPrivateSetDefaultBackgroundColor). FALSE otherwise.
|
||||||
|
BOOL ConhostInternalGetSet::PrivateSetDefaultBackground(const COLORREF value) const noexcept
|
||||||
|
{
|
||||||
|
return SUCCEEDED(DoSrvPrivateSetDefaultBackgroundColor(value));
|
||||||
|
}
|
||||||
|
|
|
@ -157,6 +157,10 @@ public:
|
||||||
|
|
||||||
BOOL PrivateSetColorTableEntry(const short index, const COLORREF value) const noexcept override;
|
BOOL PrivateSetColorTableEntry(const short index, const COLORREF value) const noexcept override;
|
||||||
|
|
||||||
|
BOOL PrivateSetDefaultForeground(const COLORREF value) const noexcept override;
|
||||||
|
|
||||||
|
BOOL PrivateSetDefaultBackground(const COLORREF value) const noexcept override;
|
||||||
|
|
||||||
private:
|
private:
|
||||||
Microsoft::Console::IIoProvider& _io;
|
Microsoft::Console::IIoProvider& _io;
|
||||||
};
|
};
|
||||||
|
|
|
@ -149,6 +149,10 @@ class ScreenBufferTests
|
||||||
|
|
||||||
TEST_METHOD(SetColorTableThreeDigits);
|
TEST_METHOD(SetColorTableThreeDigits);
|
||||||
|
|
||||||
|
TEST_METHOD(SetDefaultForegroundColor);
|
||||||
|
|
||||||
|
TEST_METHOD(SetDefaultBackgroundColor);
|
||||||
|
|
||||||
TEST_METHOD(DeleteCharsNearEndOfLine);
|
TEST_METHOD(DeleteCharsNearEndOfLine);
|
||||||
TEST_METHOD(DeleteCharsNearEndOfLineSimpleFirstCase);
|
TEST_METHOD(DeleteCharsNearEndOfLineSimpleFirstCase);
|
||||||
TEST_METHOD(DeleteCharsNearEndOfLineSimpleSecondCase);
|
TEST_METHOD(DeleteCharsNearEndOfLineSimpleSecondCase);
|
||||||
|
@ -2502,6 +2506,126 @@ void ScreenBufferTests::SetColorTableThreeDigits()
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
void ScreenBufferTests::SetDefaultForegroundColor()
|
||||||
|
{
|
||||||
|
// Setting the default foreground color should work
|
||||||
|
|
||||||
|
CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
|
||||||
|
gci.LockConsole(); // Lock must be taken to swap buffers.
|
||||||
|
auto unlock = wil::scope_exit([&] { gci.UnlockConsole(); });
|
||||||
|
|
||||||
|
SCREEN_INFORMATION& mainBuffer = gci.GetActiveOutputBuffer();
|
||||||
|
VERIFY_IS_FALSE(mainBuffer._IsAltBuffer());
|
||||||
|
WI_SetFlag(mainBuffer.OutputMode, ENABLE_VIRTUAL_TERMINAL_PROCESSING);
|
||||||
|
VERIFY_IS_TRUE(WI_IsFlagSet(mainBuffer.OutputMode, ENABLE_VIRTUAL_TERMINAL_PROCESSING));
|
||||||
|
|
||||||
|
StateMachine& stateMachine = mainBuffer.GetStateMachine();
|
||||||
|
|
||||||
|
COLORREF originalColor = gci.GetDefaultForegroundColor();
|
||||||
|
COLORREF newColor = gci.GetDefaultForegroundColor();
|
||||||
|
COLORREF testColor = RGB(0x33, 0x66, 0x99);
|
||||||
|
VERIFY_ARE_NOT_EQUAL(originalColor, testColor);
|
||||||
|
|
||||||
|
Log::Comment(L"Valid Hexadecimal Notation");
|
||||||
|
std::wstring seq = L"\x1b]10;rgb:33/66/99\x1b\\";
|
||||||
|
stateMachine.ProcessString(seq);
|
||||||
|
|
||||||
|
newColor = gci.GetDefaultForegroundColor();
|
||||||
|
VERIFY_ARE_EQUAL(testColor, newColor);
|
||||||
|
|
||||||
|
Log::Comment(L"Valid Hexadecimal Notation");
|
||||||
|
originalColor = newColor;
|
||||||
|
testColor = RGB(0xff, 0xff, 0xff);
|
||||||
|
seq = L"\x1b]10;rgb:ff/ff/ff\x1b\\";
|
||||||
|
stateMachine.ProcessString(seq);
|
||||||
|
|
||||||
|
newColor = gci.GetDefaultForegroundColor();
|
||||||
|
VERIFY_ARE_EQUAL(testColor, newColor);
|
||||||
|
|
||||||
|
Log::Comment(L"Invalid Decimal Notation");
|
||||||
|
originalColor = newColor;
|
||||||
|
testColor = RGB(153, 102, 51);
|
||||||
|
seq = L"\x1b]10;rgb:153/102/51\x1b\\";
|
||||||
|
stateMachine.ProcessString(seq);
|
||||||
|
|
||||||
|
newColor = gci.GetDefaultForegroundColor();
|
||||||
|
VERIFY_ARE_NOT_EQUAL(testColor, newColor);
|
||||||
|
// it will, in fact leave the color the way it was
|
||||||
|
VERIFY_ARE_EQUAL(originalColor, newColor);
|
||||||
|
|
||||||
|
Log::Comment(L"Invalid syntax");
|
||||||
|
testColor = RGB(153, 102, 51);
|
||||||
|
seq = L"\x1b]10;99/66/33\x1b\\";
|
||||||
|
stateMachine.ProcessString(seq);
|
||||||
|
|
||||||
|
newColor = gci.GetDefaultForegroundColor();
|
||||||
|
VERIFY_ARE_NOT_EQUAL(testColor, newColor);
|
||||||
|
// it will, in fact leave the color the way it was
|
||||||
|
VERIFY_ARE_EQUAL(originalColor, newColor);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
void ScreenBufferTests::SetDefaultBackgroundColor()
|
||||||
|
{
|
||||||
|
// Setting the default Background color should work
|
||||||
|
|
||||||
|
CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
|
||||||
|
gci.LockConsole(); // Lock must be taken to swap buffers.
|
||||||
|
auto unlock = wil::scope_exit([&] { gci.UnlockConsole(); });
|
||||||
|
|
||||||
|
SCREEN_INFORMATION& mainBuffer = gci.GetActiveOutputBuffer();
|
||||||
|
VERIFY_IS_FALSE(mainBuffer._IsAltBuffer());
|
||||||
|
WI_SetFlag(mainBuffer.OutputMode, ENABLE_VIRTUAL_TERMINAL_PROCESSING);
|
||||||
|
VERIFY_IS_TRUE(WI_IsFlagSet(mainBuffer.OutputMode, ENABLE_VIRTUAL_TERMINAL_PROCESSING));
|
||||||
|
|
||||||
|
StateMachine& stateMachine = mainBuffer.GetStateMachine();
|
||||||
|
|
||||||
|
COLORREF originalColor = gci.GetDefaultBackgroundColor();
|
||||||
|
COLORREF newColor = gci.GetDefaultBackgroundColor();
|
||||||
|
COLORREF testColor = RGB(0x33, 0x66, 0x99);
|
||||||
|
VERIFY_ARE_NOT_EQUAL(originalColor, testColor);
|
||||||
|
|
||||||
|
Log::Comment(L"Valid Hexadecimal Notation");
|
||||||
|
std::wstring seq = L"\x1b]11;rgb:33/66/99\x1b\\";
|
||||||
|
stateMachine.ProcessString(seq);
|
||||||
|
|
||||||
|
newColor = gci.GetDefaultBackgroundColor();
|
||||||
|
VERIFY_ARE_EQUAL(testColor, newColor);
|
||||||
|
|
||||||
|
Log::Comment(L"Valid Hexadecimal Notation");
|
||||||
|
originalColor = newColor;
|
||||||
|
testColor = RGB(0xff, 0xff, 0xff);
|
||||||
|
seq = L"\x1b]11;rgb:ff/ff/ff\x1b\\";
|
||||||
|
stateMachine.ProcessString(seq);
|
||||||
|
|
||||||
|
newColor = gci.GetDefaultBackgroundColor();
|
||||||
|
VERIFY_ARE_EQUAL(testColor, newColor);
|
||||||
|
|
||||||
|
Log::Comment(L"Invalid Decimal Notation");
|
||||||
|
originalColor = newColor;
|
||||||
|
testColor = RGB(153, 102, 51);
|
||||||
|
seq = L"\x1b]11;rgb:153/102/51\x1b\\";
|
||||||
|
stateMachine.ProcessString(seq);
|
||||||
|
|
||||||
|
newColor = gci.GetDefaultBackgroundColor();
|
||||||
|
VERIFY_ARE_NOT_EQUAL(testColor, newColor);
|
||||||
|
// it will, in fact leave the color the way it was
|
||||||
|
VERIFY_ARE_EQUAL(originalColor, newColor);
|
||||||
|
|
||||||
|
Log::Comment(L"Invalid Syntax");
|
||||||
|
testColor = RGB(153, 102, 51);
|
||||||
|
seq = L"\x1b]11;99/66/33\x1b\\";
|
||||||
|
stateMachine.ProcessString(seq);
|
||||||
|
|
||||||
|
newColor = gci.GetDefaultBackgroundColor();
|
||||||
|
VERIFY_ARE_NOT_EQUAL(testColor, newColor);
|
||||||
|
// it will, in fact leave the color the way it was
|
||||||
|
VERIFY_ARE_EQUAL(originalColor, newColor);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
void ScreenBufferTests::DeleteCharsNearEndOfLine()
|
void ScreenBufferTests::DeleteCharsNearEndOfLine()
|
||||||
{
|
{
|
||||||
// Created for MSFT:19888564.
|
// Created for MSFT:19888564.
|
||||||
|
|
|
@ -65,6 +65,8 @@ public:
|
||||||
virtual bool EnableAnyEventMouseMode(const bool fEnabled) = 0; // ?1003
|
virtual bool EnableAnyEventMouseMode(const bool fEnabled) = 0; // ?1003
|
||||||
virtual bool EnableAlternateScroll(const bool fEnabled) = 0; // ?1007
|
virtual bool EnableAlternateScroll(const bool fEnabled) = 0; // ?1007
|
||||||
virtual bool SetColorTableEntry(const size_t tableIndex, const DWORD dwColor) = 0; // OSCColorTable
|
virtual bool SetColorTableEntry(const size_t tableIndex, const DWORD dwColor) = 0; // OSCColorTable
|
||||||
|
virtual bool SetDefaultForeground(const DWORD dwColor) = 0; // OSCDefaultForeground
|
||||||
|
virtual bool SetDefaultBackground(const DWORD dwColor) = 0; // OSCDefaultBackground
|
||||||
|
|
||||||
virtual bool EraseInDisplay(const DispatchTypes::EraseType eraseType) = 0; // ED
|
virtual bool EraseInDisplay(const DispatchTypes::EraseType eraseType) = 0; // ED
|
||||||
virtual bool EraseInLine(const DispatchTypes::EraseType eraseType) = 0; // EL
|
virtual bool EraseInLine(const DispatchTypes::EraseType eraseType) = 0; // EL
|
||||||
|
@ -97,4 +99,3 @@ public:
|
||||||
|
|
||||||
};
|
};
|
||||||
inline Microsoft::Console::VirtualTerminal::ITermDispatch::~ITermDispatch() { }
|
inline Microsoft::Console::VirtualTerminal::ITermDispatch::~ITermDispatch() { }
|
||||||
|
|
||||||
|
|
|
@ -1389,7 +1389,7 @@ bool AdaptDispatch::UseMainScreenBuffer()
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// - None
|
// - None
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::HorizontalTabSet()
|
bool AdaptDispatch::HorizontalTabSet()
|
||||||
{
|
{
|
||||||
return !!_conApi->PrivateHorizontalTabSet();
|
return !!_conApi->PrivateHorizontalTabSet();
|
||||||
|
@ -1403,7 +1403,7 @@ bool AdaptDispatch::HorizontalTabSet()
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// - sNumTabs - the number of tabs to perform
|
// - sNumTabs - the number of tabs to perform
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::ForwardTab(const SHORT sNumTabs)
|
bool AdaptDispatch::ForwardTab(const SHORT sNumTabs)
|
||||||
{
|
{
|
||||||
return !!_conApi->PrivateForwardTab(sNumTabs);
|
return !!_conApi->PrivateForwardTab(sNumTabs);
|
||||||
|
@ -1415,7 +1415,7 @@ bool AdaptDispatch::ForwardTab(const SHORT sNumTabs)
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// - sNumTabs - the number of tabs to perform
|
// - sNumTabs - the number of tabs to perform
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::BackwardsTab(const SHORT sNumTabs)
|
bool AdaptDispatch::BackwardsTab(const SHORT sNumTabs)
|
||||||
{
|
{
|
||||||
return !!_conApi->PrivateBackwardsTab(sNumTabs);
|
return !!_conApi->PrivateBackwardsTab(sNumTabs);
|
||||||
|
@ -1428,7 +1428,7 @@ bool AdaptDispatch::BackwardsTab(const SHORT sNumTabs)
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// - sClearType - Whether to clear the current column, or all columns, defined in DispatchTypes::TabClearType
|
// - sClearType - Whether to clear the current column, or all columns, defined in DispatchTypes::TabClearType
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::TabClear(const SHORT sClearType)
|
bool AdaptDispatch::TabClear(const SHORT sClearType)
|
||||||
{
|
{
|
||||||
bool fSuccess = false;
|
bool fSuccess = false;
|
||||||
|
@ -1453,7 +1453,7 @@ bool AdaptDispatch::TabClear(const SHORT sClearType)
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// - wchCharset - The character indicating the charset we should switch to.
|
// - wchCharset - The character indicating the charset we should switch to.
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::DesignateCharset(const wchar_t wchCharset)
|
bool AdaptDispatch::DesignateCharset(const wchar_t wchCharset)
|
||||||
{
|
{
|
||||||
return _TermOutput.DesignateCharset(wchCharset);
|
return _TermOutput.DesignateCharset(wchCharset);
|
||||||
|
@ -1489,7 +1489,7 @@ bool AdaptDispatch::DesignateCharset(const wchar_t wchCharset)
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// <none>
|
// <none>
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::SoftReset()
|
bool AdaptDispatch::SoftReset()
|
||||||
{
|
{
|
||||||
bool fSuccess = CursorVisibility(true); // Cursor enabled.
|
bool fSuccess = CursorVisibility(true); // Cursor enabled.
|
||||||
|
@ -1542,7 +1542,7 @@ bool AdaptDispatch::SoftReset()
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// <none>
|
// <none>
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::HardReset()
|
bool AdaptDispatch::HardReset()
|
||||||
{
|
{
|
||||||
// Clears the screen - Needs to be done in two operations.
|
// Clears the screen - Needs to be done in two operations.
|
||||||
|
@ -1581,7 +1581,7 @@ bool AdaptDispatch::HardReset()
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// <none>
|
// <none>
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::_EraseScrollback()
|
bool AdaptDispatch::_EraseScrollback()
|
||||||
{
|
{
|
||||||
CONSOLE_SCREEN_BUFFER_INFOEX csbiex = { 0 };
|
CONSOLE_SCREEN_BUFFER_INFOEX csbiex = { 0 };
|
||||||
|
@ -1667,7 +1667,7 @@ bool AdaptDispatch::_EraseScrollback()
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// <none>
|
// <none>
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::_EraseAll()
|
bool AdaptDispatch::_EraseAll()
|
||||||
{
|
{
|
||||||
return !!_conApi->PrivateEraseAll();
|
return !!_conApi->PrivateEraseAll();
|
||||||
|
@ -1678,7 +1678,7 @@ bool AdaptDispatch::_EraseAll()
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// - fEnabled - true to enable, false to disable.
|
// - fEnabled - true to enable, false to disable.
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::EnableVT200MouseMode(const bool fEnabled)
|
bool AdaptDispatch::EnableVT200MouseMode(const bool fEnabled)
|
||||||
{
|
{
|
||||||
return !!_conApi->PrivateEnableVT200MouseMode(fEnabled);
|
return !!_conApi->PrivateEnableVT200MouseMode(fEnabled);
|
||||||
|
@ -1690,7 +1690,7 @@ bool AdaptDispatch::EnableVT200MouseMode(const bool fEnabled)
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// - fEnabled - true to enable, false to disable.
|
// - fEnabled - true to enable, false to disable.
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::EnableUTF8ExtendedMouseMode(const bool fEnabled)
|
bool AdaptDispatch::EnableUTF8ExtendedMouseMode(const bool fEnabled)
|
||||||
{
|
{
|
||||||
return !!_conApi->PrivateEnableUTF8ExtendedMouseMode(fEnabled);
|
return !!_conApi->PrivateEnableUTF8ExtendedMouseMode(fEnabled);
|
||||||
|
@ -1702,7 +1702,7 @@ bool AdaptDispatch::EnableUTF8ExtendedMouseMode(const bool fEnabled)
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// - fEnabled - true to enable, false to disable.
|
// - fEnabled - true to enable, false to disable.
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::EnableSGRExtendedMouseMode(const bool fEnabled)
|
bool AdaptDispatch::EnableSGRExtendedMouseMode(const bool fEnabled)
|
||||||
{
|
{
|
||||||
return !!_conApi->PrivateEnableSGRExtendedMouseMode(fEnabled);
|
return !!_conApi->PrivateEnableSGRExtendedMouseMode(fEnabled);
|
||||||
|
@ -1713,7 +1713,7 @@ bool AdaptDispatch::EnableSGRExtendedMouseMode(const bool fEnabled)
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// - fEnabled - true to enable, false to disable.
|
// - fEnabled - true to enable, false to disable.
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::EnableButtonEventMouseMode(const bool fEnabled)
|
bool AdaptDispatch::EnableButtonEventMouseMode(const bool fEnabled)
|
||||||
{
|
{
|
||||||
return !!_conApi->PrivateEnableButtonEventMouseMode(fEnabled);
|
return !!_conApi->PrivateEnableButtonEventMouseMode(fEnabled);
|
||||||
|
@ -1725,7 +1725,7 @@ bool AdaptDispatch::EnableButtonEventMouseMode(const bool fEnabled)
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// - fEnabled - true to enable, false to disable.
|
// - fEnabled - true to enable, false to disable.
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::EnableAnyEventMouseMode(const bool fEnabled)
|
bool AdaptDispatch::EnableAnyEventMouseMode(const bool fEnabled)
|
||||||
{
|
{
|
||||||
return !!_conApi->PrivateEnableAnyEventMouseMode(fEnabled);
|
return !!_conApi->PrivateEnableAnyEventMouseMode(fEnabled);
|
||||||
|
@ -1737,7 +1737,7 @@ bool AdaptDispatch::EnableAnyEventMouseMode(const bool fEnabled)
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// - fEnabled - true to enable, false to disable.
|
// - fEnabled - true to enable, false to disable.
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::EnableAlternateScroll(const bool fEnabled)
|
bool AdaptDispatch::EnableAlternateScroll(const bool fEnabled)
|
||||||
{
|
{
|
||||||
return !!_conApi->PrivateEnableAlternateScroll(fEnabled);
|
return !!_conApi->PrivateEnableAlternateScroll(fEnabled);
|
||||||
|
@ -1749,7 +1749,7 @@ bool AdaptDispatch::EnableAlternateScroll(const bool fEnabled)
|
||||||
//Arguments:
|
//Arguments:
|
||||||
// - cursorStyle - The unix-like cursor style to apply to the cursor
|
// - cursorStyle - The unix-like cursor style to apply to the cursor
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::SetCursorStyle(const DispatchTypes::CursorStyle cursorStyle)
|
bool AdaptDispatch::SetCursorStyle(const DispatchTypes::CursorStyle cursorStyle)
|
||||||
{
|
{
|
||||||
bool isPty = false;
|
bool isPty = false;
|
||||||
|
@ -1808,7 +1808,7 @@ bool AdaptDispatch::SetCursorStyle(const DispatchTypes::CursorStyle cursorStyle)
|
||||||
// - tableIndex: The VT color table index
|
// - tableIndex: The VT color table index
|
||||||
// - dwColor: The new RGB color value to use.
|
// - dwColor: The new RGB color value to use.
|
||||||
// Return Value:
|
// Return Value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::SetCursorColor(const COLORREF cursorColor)
|
bool AdaptDispatch::SetCursorColor(const COLORREF cursorColor)
|
||||||
{
|
{
|
||||||
bool isPty = false;
|
bool isPty = false;
|
||||||
|
@ -1827,9 +1827,8 @@ bool AdaptDispatch::SetCursorColor(const COLORREF cursorColor)
|
||||||
// - tableIndex: The VT color table index
|
// - tableIndex: The VT color table index
|
||||||
// - dwColor: The new RGB color value to use.
|
// - dwColor: The new RGB color value to use.
|
||||||
// Return Value:
|
// Return Value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::SetColorTableEntry(const size_t tableIndex,
|
bool AdaptDispatch::SetColorTableEntry(const size_t tableIndex, const DWORD dwColor)
|
||||||
const DWORD dwColor)
|
|
||||||
{
|
{
|
||||||
|
|
||||||
bool fSuccess = tableIndex < 256;
|
bool fSuccess = tableIndex < 256;
|
||||||
|
@ -1853,6 +1852,56 @@ bool AdaptDispatch::SetColorTableEntry(const size_t tableIndex,
|
||||||
return fSuccess;
|
return fSuccess;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Method Description:
|
||||||
|
// - Sets the default foreground color to a new value
|
||||||
|
// Arguments:
|
||||||
|
// - dwColor: The new RGB color value to use, as a COLORREF, format 0x00BBGGRR.
|
||||||
|
// Return Value:
|
||||||
|
// True if handled successfully. False otherwise.
|
||||||
|
bool Microsoft::Console::VirtualTerminal::AdaptDispatch::SetDefaultForeground(const DWORD dwColor)
|
||||||
|
{
|
||||||
|
bool fSuccess = true;
|
||||||
|
fSuccess = !!_conApi->PrivateSetDefaultForeground(dwColor);
|
||||||
|
|
||||||
|
// If we're a conpty, always return false, so that we send the updated color
|
||||||
|
// value to the terminal. Still handle the sequence so apps that use
|
||||||
|
// the API or VT to query the values of the color table still read the
|
||||||
|
// correct color.
|
||||||
|
bool isPty = false;
|
||||||
|
_conApi->IsConsolePty(&isPty);
|
||||||
|
if (isPty)
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return fSuccess;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Method Description:
|
||||||
|
// - Sets the default background color to a new value
|
||||||
|
// Arguments:
|
||||||
|
// - dwColor: The new RGB color value to use, as a COLORREF, format 0x00BBGGRR.
|
||||||
|
// Return Value:
|
||||||
|
// True if handled successfully. False otherwise.
|
||||||
|
bool Microsoft::Console::VirtualTerminal::AdaptDispatch::SetDefaultBackground(const DWORD dwColor)
|
||||||
|
{
|
||||||
|
bool fSuccess = true;
|
||||||
|
fSuccess = !!_conApi->PrivateSetDefaultBackground(dwColor);
|
||||||
|
|
||||||
|
// If we're a conpty, always return false, so that we send the updated color
|
||||||
|
// value to the terminal. Still handle the sequence so apps that use
|
||||||
|
// the API or VT to query the values of the color table still read the
|
||||||
|
// correct color.
|
||||||
|
bool isPty = false;
|
||||||
|
_conApi->IsConsolePty(&isPty);
|
||||||
|
if (isPty)
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return fSuccess;
|
||||||
|
}
|
||||||
|
|
||||||
//Routine Description:
|
//Routine Description:
|
||||||
// Window Manipulation - Performs a variety of actions relating to the window,
|
// Window Manipulation - Performs a variety of actions relating to the window,
|
||||||
// such as moving the window position, resizing the window, querying
|
// such as moving the window position, resizing the window, querying
|
||||||
|
@ -1864,7 +1913,7 @@ bool AdaptDispatch::SetColorTableEntry(const size_t tableIndex,
|
||||||
// - rgusParams - Additional parameters to pass to the function
|
// - rgusParams - Additional parameters to pass to the function
|
||||||
// - cParams - size of rgusParams
|
// - cParams - size of rgusParams
|
||||||
// Return value:
|
// Return value:
|
||||||
// True if handled successfully. False othewise.
|
// True if handled successfully. False otherwise.
|
||||||
bool AdaptDispatch::WindowManipulation(const DispatchTypes::WindowManipulationType uiFunction,
|
bool AdaptDispatch::WindowManipulation(const DispatchTypes::WindowManipulationType uiFunction,
|
||||||
_In_reads_(cParams) const unsigned short* const rgusParams,
|
_In_reads_(cParams) const unsigned short* const rgusParams,
|
||||||
const size_t cParams)
|
const size_t cParams)
|
||||||
|
|
|
@ -96,8 +96,10 @@ namespace Microsoft::Console::VirtualTerminal
|
||||||
virtual bool SetCursorStyle(const DispatchTypes::CursorStyle cursorStyle); // DECSCUSR
|
virtual bool SetCursorStyle(const DispatchTypes::CursorStyle cursorStyle); // DECSCUSR
|
||||||
virtual bool SetCursorColor(const COLORREF cursorColor);
|
virtual bool SetCursorColor(const COLORREF cursorColor);
|
||||||
|
|
||||||
virtual bool SetColorTableEntry(const size_t tableIndex,
|
virtual bool SetColorTableEntry(const size_t tableIndex, const DWORD dwColor); // OscColorTable
|
||||||
const DWORD dwColor); // OscColorTable
|
virtual bool SetDefaultForeground(const DWORD dwColor); // OSCDefaultForeground
|
||||||
|
virtual bool SetDefaultBackground(const DWORD dwColor); // OSCDefaultBackground
|
||||||
|
|
||||||
virtual bool WindowManipulation(const DispatchTypes::WindowManipulationType uiFunction,
|
virtual bool WindowManipulation(const DispatchTypes::WindowManipulationType uiFunction,
|
||||||
_In_reads_(cParams) const unsigned short* const rgusParams,
|
_In_reads_(cParams) const unsigned short* const rgusParams,
|
||||||
const size_t cParams); // DTTERM_WindowManipulation
|
const size_t cParams); // DTTERM_WindowManipulation
|
||||||
|
|
|
@ -107,6 +107,8 @@ namespace Microsoft::Console::VirtualTerminal
|
||||||
virtual BOOL MoveToBottom() const = 0;
|
virtual BOOL MoveToBottom() const = 0;
|
||||||
|
|
||||||
virtual BOOL PrivateSetColorTableEntry(const short index, const COLORREF value) const = 0;
|
virtual BOOL PrivateSetColorTableEntry(const short index, const COLORREF value) const = 0;
|
||||||
|
virtual BOOL PrivateSetDefaultForeground(const COLORREF value) const = 0;
|
||||||
|
virtual BOOL PrivateSetDefaultBackground(const COLORREF value) const = 0;
|
||||||
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
|
@ -62,6 +62,8 @@ public:
|
||||||
virtual bool EnableAnyEventMouseMode(const bool /*fEnabled*/) { return false; } // ?1003
|
virtual bool EnableAnyEventMouseMode(const bool /*fEnabled*/) { return false; } // ?1003
|
||||||
virtual bool EnableAlternateScroll(const bool /*fEnabled*/) { return false; } // ?1007
|
virtual bool EnableAlternateScroll(const bool /*fEnabled*/) { return false; } // ?1007
|
||||||
virtual bool SetColorTableEntry(const size_t /*tableIndex*/, const DWORD /*dwColor*/) { return false; } // OSCColorTable
|
virtual bool SetColorTableEntry(const size_t /*tableIndex*/, const DWORD /*dwColor*/) { return false; } // OSCColorTable
|
||||||
|
virtual bool SetDefaultForeground(const DWORD /*dwColor*/) { return false; } // OSCDefaultForeground
|
||||||
|
virtual bool SetDefaultBackground(const DWORD /*dwColor*/) { return false; } // OSCDefaultBackground
|
||||||
|
|
||||||
virtual bool EraseInDisplay(const DispatchTypes::EraseType /* eraseType*/) { return false; } // ED
|
virtual bool EraseInDisplay(const DispatchTypes::EraseType /* eraseType*/) { return false; } // ED
|
||||||
virtual bool EraseInLine(const DispatchTypes::EraseType /* eraseType*/) { return false; } // EL
|
virtual bool EraseInLine(const DispatchTypes::EraseType /* eraseType*/) { return false; } // EL
|
||||||
|
|
|
@ -776,6 +776,28 @@ public:
|
||||||
return _fPrivateSetColorTableEntryResult;
|
return _fPrivateSetColorTableEntryResult;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
BOOL PrivateSetDefaultForeground(const COLORREF value) const noexcept override
|
||||||
|
{
|
||||||
|
Log::Comment(L"PrivateSetDefaultForeground MOCK called...");
|
||||||
|
if (_fPrivateSetDefaultForegroundResult)
|
||||||
|
{
|
||||||
|
VERIFY_ARE_EQUAL(_expectedDefaultForegroundColorValue, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
return _fPrivateSetDefaultForegroundResult;
|
||||||
|
}
|
||||||
|
|
||||||
|
BOOL PrivateSetDefaultBackground(const COLORREF value) const noexcept override
|
||||||
|
{
|
||||||
|
Log::Comment(L"PrivateSetDefaultForeground MOCK called...");
|
||||||
|
if (_fPrivateSetDefaultBackgroundResult)
|
||||||
|
{
|
||||||
|
VERIFY_ARE_EQUAL(_expectedDefaultBackgroundColorValue, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
return _fPrivateSetDefaultBackgroundResult;
|
||||||
|
}
|
||||||
|
|
||||||
void _IncrementCoordPos(_Inout_ COORD* pcoord)
|
void _IncrementCoordPos(_Inout_ COORD* pcoord)
|
||||||
{
|
{
|
||||||
pcoord->X++;
|
pcoord->X++;
|
||||||
|
@ -1378,6 +1400,12 @@ public:
|
||||||
short _expectedColorTableIndex = -1;
|
short _expectedColorTableIndex = -1;
|
||||||
COLORREF _expectedColorValue = INVALID_COLOR;
|
COLORREF _expectedColorValue = INVALID_COLOR;
|
||||||
|
|
||||||
|
bool _fPrivateSetDefaultForegroundResult = false;
|
||||||
|
COLORREF _expectedDefaultForegroundColorValue = INVALID_COLOR;
|
||||||
|
|
||||||
|
bool _fPrivateSetDefaultBackgroundResult = false;
|
||||||
|
COLORREF _expectedDefaultBackgroundColorValue = INVALID_COLOR;
|
||||||
|
|
||||||
private:
|
private:
|
||||||
HANDLE _hCon;
|
HANDLE _hCon;
|
||||||
};
|
};
|
||||||
|
|
|
@ -697,8 +697,10 @@ bool OutputStateMachineEngine::ActionOscDispatch(const wchar_t /*wch*/,
|
||||||
case OscActionCodes::SetColor:
|
case OscActionCodes::SetColor:
|
||||||
fSuccess = _GetOscSetColorTable(pwchOscStringBuffer, cchOscString, &tableIndex, &dwColor);
|
fSuccess = _GetOscSetColorTable(pwchOscStringBuffer, cchOscString, &tableIndex, &dwColor);
|
||||||
break;
|
break;
|
||||||
|
case OscActionCodes::SetForegroundColor:
|
||||||
|
case OscActionCodes::SetBackgroundColor:
|
||||||
case OscActionCodes::SetCursorColor:
|
case OscActionCodes::SetCursorColor:
|
||||||
fSuccess = _GetOscSetCursorColor(pwchOscStringBuffer, cchOscString, &dwColor);
|
fSuccess = _GetOscSetColor(pwchOscStringBuffer, cchOscString, &dwColor);
|
||||||
break;
|
break;
|
||||||
case OscActionCodes::ResetCursorColor:
|
case OscActionCodes::ResetCursorColor:
|
||||||
// the console uses 0xffffffff as an "invalid color" value
|
// the console uses 0xffffffff as an "invalid color" value
|
||||||
|
@ -724,6 +726,14 @@ bool OutputStateMachineEngine::ActionOscDispatch(const wchar_t /*wch*/,
|
||||||
fSuccess = _dispatch->SetColorTableEntry(tableIndex, dwColor);
|
fSuccess = _dispatch->SetColorTableEntry(tableIndex, dwColor);
|
||||||
TermTelemetry::Instance().Log(TermTelemetry::Codes::OSCCT);
|
TermTelemetry::Instance().Log(TermTelemetry::Codes::OSCCT);
|
||||||
break;
|
break;
|
||||||
|
case OscActionCodes::SetForegroundColor:
|
||||||
|
fSuccess = _dispatch->SetDefaultForeground(dwColor);
|
||||||
|
TermTelemetry::Instance().Log(TermTelemetry::Codes::OSCFG);
|
||||||
|
break;
|
||||||
|
case OscActionCodes::SetBackgroundColor:
|
||||||
|
fSuccess = _dispatch->SetDefaultBackground(dwColor);
|
||||||
|
TermTelemetry::Instance().Log(TermTelemetry::Codes::OSCBG);
|
||||||
|
break;
|
||||||
case OscActionCodes::SetCursorColor:
|
case OscActionCodes::SetCursorColor:
|
||||||
fSuccess = _dispatch->SetCursorColor(dwColor);
|
fSuccess = _dispatch->SetCursorColor(dwColor);
|
||||||
TermTelemetry::Instance().Log(TermTelemetry::Codes::OSCSCC);
|
TermTelemetry::Instance().Log(TermTelemetry::Codes::OSCSCC);
|
||||||
|
@ -1162,7 +1172,7 @@ bool OutputStateMachineEngine::_VerifyDeviceAttributesParams(_In_reads_(cParams)
|
||||||
// - Null terminates, then returns, the string that we've collected as part of the OSC string.
|
// - Null terminates, then returns, the string that we've collected as part of the OSC string.
|
||||||
// Arguments:
|
// Arguments:
|
||||||
// - ppwchTitle - a pointer to point to the Osc String to use as a title.
|
// - ppwchTitle - a pointer to point to the Osc String to use as a title.
|
||||||
// - pcchTitleLength - a pointer place the length of ppwchTitle into.
|
// - pcchTitle - a pointer place the length of ppwchTitle into.
|
||||||
// Return Value:
|
// Return Value:
|
||||||
// - True if there was a title to output. (a title with length=0 is still valid)
|
// - True if there was a title to output. (a title with length=0 is still valid)
|
||||||
_Success_(return)
|
_Success_(return)
|
||||||
|
@ -1476,10 +1486,12 @@ bool OutputStateMachineEngine::s_ParseColorSpec(_In_reads_(cchBuffer) const wcha
|
||||||
// "rgb:<red>/<green>/<blue>"
|
// "rgb:<red>/<green>/<blue>"
|
||||||
// where <color> is two hex digits
|
// where <color> is two hex digits
|
||||||
// Arguments:
|
// Arguments:
|
||||||
// - ppwchTitle - a pointer to point to the Osc String to use as a title.
|
// - pwchOscStringBuffer - a pointer to the Osc String to parse
|
||||||
// - pcchTitleLength - a pointer place the length of ppwchTitle into.
|
// - cchOscString - the length of the Osc String
|
||||||
|
// - pTableIndex - a pointer that recieves the table index
|
||||||
|
// - pRgb - a pointer that recieves the color that we parsed in the format: 0x00BBGGRR
|
||||||
// Return Value:
|
// Return Value:
|
||||||
// - True if there was a title to output. (a title with length=0 is still valid)
|
// - True if a table index and color was parsed successfully. False otherwise.
|
||||||
bool OutputStateMachineEngine::_GetOscSetColorTable(_In_reads_(cchOscString) const wchar_t* const pwchOscStringBuffer,
|
bool OutputStateMachineEngine::_GetOscSetColorTable(_In_reads_(cchOscString) const wchar_t* const pwchOscStringBuffer,
|
||||||
const size_t cchOscString,
|
const size_t cchOscString,
|
||||||
_Out_ size_t* const pTableIndex,
|
_Out_ size_t* const pTableIndex,
|
||||||
|
@ -1548,16 +1560,17 @@ bool OutputStateMachineEngine::_GetOscSetColorTable(_In_reads_(cchOscString) con
|
||||||
}
|
}
|
||||||
|
|
||||||
// Routine Description:
|
// Routine Description:
|
||||||
// - OSC 12 ; spec ST
|
// - OSC 10, 11, 12 ; spec ST
|
||||||
// spec: a color in the following format:
|
// spec: a color in the following format:
|
||||||
// "rgb:<red>/<green>/<blue>"
|
// "rgb:<red>/<green>/<blue>"
|
||||||
// where <color> is two hex digits
|
// where <color> is two hex digits
|
||||||
// Arguments:
|
// Arguments:
|
||||||
// - ppwchTitle - a pointer to point to the Osc String to use as a title.
|
// - pwchOscStringBuffer - a pointer to the Osc String to parse
|
||||||
// - pcchTitleLength - a pointer place the length of ppwchTitle into.
|
// - cchOscString - the length of the Osc String
|
||||||
|
// - pRgb - a pointer that recieves the color that we parsed in the format: 0x00BBGGRR
|
||||||
// Return Value:
|
// Return Value:
|
||||||
// - True if there was a title to output. (a title with length=0 is still valid)
|
// - True if a table index and color was parsed successfully. False otherwise.
|
||||||
bool OutputStateMachineEngine::_GetOscSetCursorColor(_In_reads_(cchOscString) const wchar_t* const pwchOscStringBuffer,
|
bool OutputStateMachineEngine::_GetOscSetColor(_In_reads_(cchOscString) const wchar_t* const pwchOscStringBuffer,
|
||||||
const size_t cchOscString,
|
const size_t cchOscString,
|
||||||
_Out_ DWORD* const pRgb) const
|
_Out_ DWORD* const pRgb) const
|
||||||
{
|
{
|
||||||
|
|
|
@ -131,8 +131,13 @@ namespace Microsoft::Console::VirtualTerminal
|
||||||
SetIconAndWindowTitle = 0,
|
SetIconAndWindowTitle = 0,
|
||||||
SetWindowIcon = 1,
|
SetWindowIcon = 1,
|
||||||
SetWindowTitle = 2,
|
SetWindowTitle = 2,
|
||||||
|
SetWindowProperty = 3, // Not implemented
|
||||||
SetColor = 4,
|
SetColor = 4,
|
||||||
|
SetForegroundColor = 10,
|
||||||
|
SetBackgroundColor = 11,
|
||||||
SetCursorColor = 12,
|
SetCursorColor = 12,
|
||||||
|
ResetForegroundColor = 110, // Not implemented
|
||||||
|
ResetBackgroundColor = 111, // Not implemented
|
||||||
ResetCursorColor = 112,
|
ResetCursorColor = 112,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -251,9 +256,9 @@ namespace Microsoft::Console::VirtualTerminal
|
||||||
const size_t cchBuffer,
|
const size_t cchBuffer,
|
||||||
_Out_ DWORD* const pRgb);
|
_Out_ DWORD* const pRgb);
|
||||||
|
|
||||||
bool _GetOscSetCursorColor(_In_reads_(cchOscString) const wchar_t* const pwchOscStringBuffer,
|
bool _GetOscSetColor(_In_reads_(cchOscString) const wchar_t* const pwchOscStringBuffer,
|
||||||
const size_t cchOscString,
|
const size_t cchOscString,
|
||||||
_Out_ DWORD* const pRgb) const;
|
_Out_ DWORD* const pRgb) const;
|
||||||
|
|
||||||
static const DispatchTypes::CursorStyle s_defaultCursorStyle = DispatchTypes::CursorStyle::BlinkingBlockDefault;
|
static const DispatchTypes::CursorStyle s_defaultCursorStyle = DispatchTypes::CursorStyle::BlinkingBlockDefault;
|
||||||
_Success_(return)
|
_Success_(return)
|
||||||
|
|
|
@ -243,6 +243,8 @@ void TermTelemetry::WriteFinalTraceLog() const
|
||||||
TraceLoggingUInt32(_uiTimesUsed[OSCCT], "OscColorTable"),
|
TraceLoggingUInt32(_uiTimesUsed[OSCCT], "OscColorTable"),
|
||||||
TraceLoggingUInt32(_uiTimesUsed[OSCSCC], "OscSetCursorColor"),
|
TraceLoggingUInt32(_uiTimesUsed[OSCSCC], "OscSetCursorColor"),
|
||||||
TraceLoggingUInt32(_uiTimesUsed[OSCRCC], "OscResetCursorColor"),
|
TraceLoggingUInt32(_uiTimesUsed[OSCRCC], "OscResetCursorColor"),
|
||||||
|
TraceLoggingUInt32(_uiTimesUsed[OSCFG], "OscForegroundColor"),
|
||||||
|
TraceLoggingUInt32(_uiTimesUsed[OSCBG], "OscBackgroundColor"),
|
||||||
TraceLoggingUInt32(_uiTimesUsed[REP], "REP"),
|
TraceLoggingUInt32(_uiTimesUsed[REP], "REP"),
|
||||||
TraceLoggingUInt32Array(_uiTimesFailed, ARRAYSIZE(_uiTimesFailed), "Failed"),
|
TraceLoggingUInt32Array(_uiTimesFailed, ARRAYSIZE(_uiTimesFailed), "Failed"),
|
||||||
TraceLoggingUInt32(_uiTimesFailedOutsideRange, "FailedOutsideRange"));
|
TraceLoggingUInt32(_uiTimesFailedOutsideRange, "FailedOutsideRange"));
|
||||||
|
|
|
@ -83,6 +83,8 @@ namespace Microsoft::Console::VirtualTerminal
|
||||||
OSCSCC,
|
OSCSCC,
|
||||||
OSCRCC,
|
OSCRCC,
|
||||||
REP,
|
REP,
|
||||||
|
OSCFG,
|
||||||
|
OSCBG,
|
||||||
// Only use this last enum as a count of the number of codes.
|
// Only use this last enum as a count of the number of codes.
|
||||||
NUMBER_OF_CODES
|
NUMBER_OF_CODES
|
||||||
};
|
};
|
||||||
|
|
Loading…
Reference in a new issue