bb71179a24
This PR merges the default colors and cursor color into the main color table, enabling us to simplify the `ConGetSet` and `ITerminalApi` interfaces, with just two methods required for getting and setting any form of color palette entry. The is a follow-up to the color table standardization in #11602, and a another small step towards de-duplicating `AdaptDispatch` and `TerminalDispatch` for issue #3849. It should also make it easier to support color queries (#3718) and a configurable bold color (#5682) in the future. On the conhost side, default colors could originally be either indexed positions in the 16-color table, or separate standalone RGB values. With the new system, the default colors will always be in the color table, so we just need to track their index positions. To make this work, those positions need to be calculated at startup based on the loaded registry/shortcut settings, and updated when settings are changed (this is handled in `CalculateDefaultColorIndices`). But the plus side is that it's now much easier to lookup the default color values for rendering. For now the default colors in Windows Terminal use hardcoded positions, because it doesn't need indexed default colors like conhost. But in the future I'd like to extend the index handling to both terminals, so we can eventually support the VT525 indexed color operations. As for the cursor color, that was previously stored in the `Cursor` class, which meant that it needed to be copied around in various places where cursors were being instantiated. Now that it's managed separately in the color table, a lot of that code is no longer required. ## Validation Some of the unit test initialization code needed to be updated to setup the color table and default index values as required for the new system. There were also some adjustments needed to account for API changes, in particular for methods that now take index values for the default colors in place of COLORREFs. But for the most part, the essential behavior of the tests remains unchanged. I've also run a variety of manual tests looking at the legacy console APIs as well as the various VT color sequences, and checking that everything works as expected when color schemes are changed, both in Windows Terminal and conhost, and in the latter case with both indexed colors and RGB values. Closes #11768
110 lines
4.8 KiB
C++
110 lines
4.8 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- conGetSet.hpp
|
|
|
|
Abstract:
|
|
- This serves as an abstraction layer for the adapters to connect to the console API functions.
|
|
- The abstraction allows for the substitution of the functions for internal/external to Conhost.exe use as well as easy testing.
|
|
|
|
Author(s):
|
|
- Michael Niksa (MiNiksa) 30-July-2015
|
|
--*/
|
|
|
|
#pragma once
|
|
|
|
#include "../input/terminalInput.hpp"
|
|
#include "../parser/stateMachine.hpp"
|
|
#include "../../types/inc/IInputEvent.hpp"
|
|
#include "../../buffer/out/LineRendition.hpp"
|
|
#include "../../buffer/out/TextAttribute.hpp"
|
|
#include "../../inc/conattrs.hpp"
|
|
|
|
#include <deque>
|
|
#include <memory>
|
|
|
|
namespace Microsoft::Console::VirtualTerminal
|
|
{
|
|
class ConGetSet
|
|
{
|
|
public:
|
|
virtual ~ConGetSet() = default;
|
|
virtual bool GetConsoleScreenBufferInfoEx(CONSOLE_SCREEN_BUFFER_INFOEX& screenBufferInfo) const = 0;
|
|
virtual bool SetConsoleScreenBufferInfoEx(const CONSOLE_SCREEN_BUFFER_INFOEX& screenBufferInfo) = 0;
|
|
virtual bool SetConsoleCursorPosition(const COORD position) = 0;
|
|
|
|
virtual bool PrivateIsVtInputEnabled() const = 0;
|
|
|
|
virtual bool PrivateGetTextAttributes(TextAttribute& attrs) const = 0;
|
|
virtual bool PrivateSetTextAttributes(const TextAttribute& attrs) = 0;
|
|
|
|
virtual bool PrivateSetCurrentLineRendition(const LineRendition lineRendition) = 0;
|
|
virtual bool PrivateResetLineRenditionRange(const size_t startRow, const size_t endRow) = 0;
|
|
virtual SHORT PrivateGetLineWidth(const size_t row) const = 0;
|
|
|
|
virtual bool PrivateWriteConsoleInputW(std::deque<std::unique_ptr<IInputEvent>>& events,
|
|
size_t& eventsWritten) = 0;
|
|
virtual bool SetConsoleWindowInfo(const bool absolute,
|
|
const SMALL_RECT& window) = 0;
|
|
|
|
virtual bool SetInputMode(const TerminalInput::Mode mode, const bool enabled) = 0;
|
|
virtual bool SetParserMode(const StateMachine::Mode mode, const bool enabled) = 0;
|
|
virtual bool GetParserMode(const StateMachine::Mode mode) const = 0;
|
|
|
|
virtual bool PrivateSetScreenMode(const bool reverseMode) = 0;
|
|
virtual bool PrivateSetAutoWrapMode(const bool wrapAtEOL) = 0;
|
|
|
|
virtual bool PrivateShowCursor(const bool show) = 0;
|
|
virtual bool PrivateAllowCursorBlinking(const bool enable) = 0;
|
|
|
|
virtual bool PrivateSetScrollingRegion(const SMALL_RECT& scrollMargins) = 0;
|
|
virtual bool PrivateWarningBell() = 0;
|
|
virtual bool PrivateGetLineFeedMode() const = 0;
|
|
virtual bool PrivateLineFeed(const bool withReturn) = 0;
|
|
virtual bool PrivateReverseLineFeed() = 0;
|
|
virtual bool SetConsoleTitleW(const std::wstring_view title) = 0;
|
|
virtual bool PrivateUseAlternateScreenBuffer() = 0;
|
|
virtual bool PrivateUseMainScreenBuffer() = 0;
|
|
|
|
virtual bool PrivateEraseAll() = 0;
|
|
virtual bool PrivateClearBuffer() = 0;
|
|
virtual bool GetUserDefaultCursorStyle(CursorType& style) = 0;
|
|
virtual bool SetCursorStyle(const CursorType style) = 0;
|
|
virtual bool PrivateWriteConsoleControlInput(const KeyEvent key) = 0;
|
|
virtual bool PrivateRefreshWindow() = 0;
|
|
|
|
virtual bool SetConsoleOutputCP(const unsigned int codepage) = 0;
|
|
virtual bool GetConsoleOutputCP(unsigned int& codepage) = 0;
|
|
|
|
virtual bool PrivateSuppressResizeRepaint() = 0;
|
|
virtual bool IsConsolePty() const = 0;
|
|
|
|
virtual bool DeleteLines(const size_t count) = 0;
|
|
virtual bool InsertLines(const size_t count) = 0;
|
|
|
|
virtual bool MoveToBottom() const = 0;
|
|
|
|
virtual COLORREF GetColorTableEntry(const size_t tableIndex) const = 0;
|
|
virtual bool SetColorTableEntry(const size_t tableIndex, const COLORREF color) = 0;
|
|
|
|
virtual bool PrivateFillRegion(const COORD startPosition,
|
|
const size_t fillLength,
|
|
const wchar_t fillChar,
|
|
const bool standardFillAttrs) = 0;
|
|
|
|
virtual bool PrivateScrollRegion(const SMALL_RECT scrollRect,
|
|
const std::optional<SMALL_RECT> clipRect,
|
|
const COORD destinationOrigin,
|
|
const bool standardFillAttrs) = 0;
|
|
|
|
virtual bool PrivateAddHyperlink(const std::wstring_view uri, const std::wstring_view params) const = 0;
|
|
virtual bool PrivateEndHyperlink() const = 0;
|
|
|
|
virtual bool PrivateUpdateSoftFont(const gsl::span<const uint16_t> bitPattern,
|
|
const SIZE cellSize,
|
|
const size_t centeringHint) = 0;
|
|
};
|
|
}
|