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
117 lines
4 KiB
C++
117 lines
4 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- cursor.h
|
|
|
|
Abstract:
|
|
- This file implements the NT console server cursor routines.
|
|
|
|
Author:
|
|
- Therese Stowell (ThereseS) 5-Dec-1990
|
|
|
|
Revision History:
|
|
- Grouped into class and items made private. (MiNiksa, 2014)
|
|
--*/
|
|
|
|
#pragma once
|
|
|
|
#include "../inc/conattrs.hpp"
|
|
|
|
class TextBuffer;
|
|
|
|
class Cursor final
|
|
{
|
|
public:
|
|
// the following values are used to create the textmode cursor.
|
|
static constexpr unsigned int CURSOR_SMALL_SIZE = 25; // large enough to be one pixel on a six pixel font
|
|
|
|
Cursor(const ULONG ulSize, TextBuffer& parentBuffer) noexcept;
|
|
|
|
~Cursor();
|
|
|
|
// No Copy. It will copy the timer handle. Bad news.
|
|
Cursor(const Cursor&) = delete;
|
|
Cursor& operator=(const Cursor&) & = delete;
|
|
|
|
Cursor(Cursor&&) = default;
|
|
Cursor& operator=(Cursor&&) & = delete;
|
|
|
|
bool HasMoved() const noexcept;
|
|
bool IsVisible() const noexcept;
|
|
bool IsOn() const noexcept;
|
|
bool IsBlinkingAllowed() const noexcept;
|
|
bool IsDouble() const noexcept;
|
|
bool IsConversionArea() const noexcept;
|
|
bool IsPopupShown() const noexcept;
|
|
bool GetDelay() const noexcept;
|
|
ULONG GetSize() const noexcept;
|
|
COORD GetPosition() const noexcept;
|
|
|
|
const CursorType GetType() const noexcept;
|
|
|
|
void StartDeferDrawing() noexcept;
|
|
bool IsDeferDrawing() noexcept;
|
|
void EndDeferDrawing() noexcept;
|
|
|
|
void SetHasMoved(const bool fHasMoved) noexcept;
|
|
void SetIsVisible(const bool fIsVisible) noexcept;
|
|
void SetIsOn(const bool fIsOn) noexcept;
|
|
void SetBlinkingAllowed(const bool fIsOn) noexcept;
|
|
void SetIsDouble(const bool fIsDouble) noexcept;
|
|
void SetIsConversionArea(const bool fIsConversionArea) noexcept;
|
|
void SetIsPopupShown(const bool fIsPopupShown) noexcept;
|
|
void SetDelay(const bool fDelay) noexcept;
|
|
void SetSize(const ULONG ulSize) noexcept;
|
|
void SetStyle(const ULONG ulSize, const CursorType type) noexcept;
|
|
|
|
void SetPosition(const COORD cPosition) noexcept;
|
|
void SetXPosition(const int NewX) noexcept;
|
|
void SetYPosition(const int NewY) noexcept;
|
|
void IncrementXPosition(const int DeltaX) noexcept;
|
|
void IncrementYPosition(const int DeltaY) noexcept;
|
|
void DecrementXPosition(const int DeltaX) noexcept;
|
|
void DecrementYPosition(const int DeltaY) noexcept;
|
|
|
|
void CopyProperties(const Cursor& OtherCursor) noexcept;
|
|
|
|
void DelayEOLWrap(const COORD coordDelayedAt) noexcept;
|
|
void ResetDelayEOLWrap() noexcept;
|
|
COORD GetDelayedAtPosition() const noexcept;
|
|
bool IsDelayedEOLWrap() const noexcept;
|
|
|
|
void SetType(const CursorType type) noexcept;
|
|
|
|
private:
|
|
TextBuffer& _parentBuffer;
|
|
|
|
//TODO: separate the rendering and text placement
|
|
|
|
// NOTE: If you are adding a property here, go add it to CopyProperties.
|
|
|
|
COORD _cPosition; // current position on screen (in screen buffer coords).
|
|
|
|
bool _fHasMoved;
|
|
bool _fIsVisible; // whether cursor is visible (set only through the API)
|
|
bool _fIsOn; // whether blinking cursor is on or not
|
|
bool _fIsDouble; // whether the cursor size should be doubled
|
|
bool _fBlinkingAllowed; //Whether or not the cursor is allowed to blink at all. only set through VT (^[[?12h/l)
|
|
bool _fDelay; // don't blink scursor on next timer message
|
|
bool _fIsConversionArea; // is attached to a conversion area so it doesn't actually need to display the cursor.
|
|
bool _fIsPopupShown; // if a popup is being shown, turn off, stop blinking.
|
|
|
|
bool _fDelayedEolWrap; // don't wrap at EOL till the next char comes in.
|
|
COORD _coordDelayedAt; // coordinate the EOL wrap was delayed at.
|
|
|
|
bool _fDeferCursorRedraw; // whether we should defer redrawing the cursor or not
|
|
bool _fHaveDeferredCursorRedraw; // have we been asked to redraw the cursor while it was being deferred?
|
|
|
|
ULONG _ulSize;
|
|
|
|
void _RedrawCursor() noexcept;
|
|
void _RedrawCursorAlways() noexcept;
|
|
|
|
CursorType _cursorType;
|
|
};
|