efd69990c6
* 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
175 lines
9.1 KiB
C++
175 lines
9.1 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- adaptDispatch.hpp
|
|
|
|
Abstract:
|
|
- This serves as the Windows Console API-specific implementation of the callbacks from our generic Virtual Terminal parser.
|
|
|
|
Author(s):
|
|
- Michael Niksa (MiNiksa) 30-July-2015
|
|
--*/
|
|
|
|
#pragma once
|
|
|
|
#include "termDispatch.hpp"
|
|
#include "DispatchCommon.hpp"
|
|
#include "conGetSet.hpp"
|
|
#include "adaptDefaults.hpp"
|
|
#include "terminalOutput.hpp"
|
|
#include <math.h>
|
|
|
|
#define XTERM_COLOR_TABLE_SIZE (256)
|
|
|
|
|
|
namespace Microsoft::Console::VirtualTerminal
|
|
{
|
|
class AdaptDispatch : public ITermDispatch
|
|
{
|
|
public:
|
|
|
|
AdaptDispatch(ConGetSet* const pConApi,
|
|
AdaptDefaults* const pDefaults);
|
|
|
|
virtual void Execute(const wchar_t wchControl)
|
|
{
|
|
_pDefaults->Execute(wchControl);
|
|
}
|
|
|
|
virtual void PrintString(const wchar_t* const rgwch, const size_t cch);
|
|
virtual void Print(const wchar_t wchPrintable);
|
|
|
|
virtual bool CursorUp(_In_ unsigned int const uiDistance); // CUU
|
|
virtual bool CursorDown(_In_ unsigned int const uiDistance); // CUD
|
|
virtual bool CursorForward(_In_ unsigned int const uiDistance); // CUF
|
|
virtual bool CursorBackward(_In_ unsigned int const uiDistance); // CUB
|
|
virtual bool CursorNextLine(_In_ unsigned int const uiDistance); // CNL
|
|
virtual bool CursorPrevLine(_In_ unsigned int const uiDistance); // CPL
|
|
virtual bool CursorHorizontalPositionAbsolute(_In_ unsigned int const uiColumn); // CHA
|
|
virtual bool VerticalLinePositionAbsolute(_In_ unsigned int const uiLine); // VPA
|
|
virtual bool CursorPosition(_In_ unsigned int const uiLine, _In_ unsigned int const uiColumn); // CUP
|
|
virtual bool CursorSavePosition(); // DECSC
|
|
virtual bool CursorRestorePosition(); // DECRC
|
|
virtual bool CursorVisibility(const bool fIsVisible); // DECTCEM
|
|
virtual bool EraseInDisplay(const DispatchTypes::EraseType eraseType); // ED
|
|
virtual bool EraseInLine(const DispatchTypes::EraseType eraseType); // EL
|
|
virtual bool EraseCharacters(_In_ unsigned int const uiNumChars); // ECH
|
|
virtual bool InsertCharacter(_In_ unsigned int const uiCount); // ICH
|
|
virtual bool DeleteCharacter(_In_ unsigned int const uiCount); // DCH
|
|
virtual bool SetGraphicsRendition(_In_reads_(cOptions) const DispatchTypes::GraphicsOptions* const rgOptions,
|
|
const size_t cOptions); // SGR
|
|
virtual bool DeviceStatusReport(const DispatchTypes::AnsiStatusType statusType); // DSR
|
|
virtual bool DeviceAttributes(); // DA
|
|
virtual bool ScrollUp(_In_ unsigned int const uiDistance); // SU
|
|
virtual bool ScrollDown(_In_ unsigned int const uiDistance); // SD
|
|
virtual bool InsertLine(_In_ unsigned int const uiDistance); // IL
|
|
virtual bool DeleteLine(_In_ unsigned int const uiDistance); // DL
|
|
virtual bool SetColumns(_In_ unsigned int const uiColumns); // DECSCPP, DECCOLM
|
|
virtual bool SetPrivateModes(_In_reads_(cParams) const DispatchTypes::PrivateModeParams* const rParams,
|
|
const size_t cParams); // DECSET
|
|
virtual bool ResetPrivateModes(_In_reads_(cParams) const DispatchTypes::PrivateModeParams* const rParams,
|
|
const size_t cParams); // DECRST
|
|
virtual bool SetCursorKeysMode(const bool fApplicationMode); // DECCKM
|
|
virtual bool SetKeypadMode(const bool fApplicationMode); // DECKPAM, DECKPNM
|
|
virtual bool EnableCursorBlinking(const bool bEnable); // ATT610
|
|
virtual bool SetTopBottomScrollingMargins(const SHORT sTopMargin,
|
|
const SHORT sBottomMargin); // DECSTBM
|
|
virtual bool ReverseLineFeed(); // RI
|
|
virtual bool SetWindowTitle(const std::wstring_view title) override; // OscWindowTitle
|
|
virtual bool UseAlternateScreenBuffer(); // ASBSET
|
|
virtual bool UseMainScreenBuffer(); // ASBRST
|
|
virtual bool HorizontalTabSet(); // HTS
|
|
virtual bool ForwardTab(const SHORT sNumTabs); // CHT
|
|
virtual bool BackwardsTab(const SHORT sNumTabs); // CBT
|
|
virtual bool TabClear(const SHORT sClearType); // TBC
|
|
virtual bool DesignateCharset(const wchar_t wchCharset); // DesignateCharset
|
|
virtual bool SoftReset(); // DECSTR
|
|
virtual bool HardReset(); // RIS
|
|
virtual bool EnableVT200MouseMode(const bool fEnabled); // ?1000
|
|
virtual bool EnableUTF8ExtendedMouseMode(const bool fEnabled); // ?1005
|
|
virtual bool EnableSGRExtendedMouseMode(const bool fEnabled); // ?1006
|
|
virtual bool EnableButtonEventMouseMode(const bool fEnabled); // ?1002
|
|
virtual bool EnableAnyEventMouseMode(const bool fEnabled); // ?1003
|
|
virtual bool EnableAlternateScroll(const bool fEnabled); // ?1007
|
|
virtual bool SetCursorStyle(const DispatchTypes::CursorStyle cursorStyle); // DECSCUSR
|
|
virtual bool SetCursorColor(const COLORREF cursorColor);
|
|
|
|
virtual bool SetColorTableEntry(const size_t tableIndex, 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,
|
|
_In_reads_(cParams) const unsigned short* const rgusParams,
|
|
const size_t cParams); // DTTERM_WindowManipulation
|
|
|
|
private:
|
|
|
|
enum class CursorDirection
|
|
{
|
|
Up,
|
|
Down,
|
|
Left,
|
|
Right,
|
|
NextLine,
|
|
PrevLine
|
|
};
|
|
enum class ScrollDirection
|
|
{
|
|
Up,
|
|
Down
|
|
};
|
|
|
|
bool _CursorMovement(const CursorDirection dir, _In_ unsigned int const uiDistance) const;
|
|
bool _CursorMovePosition(_In_opt_ const unsigned int* const puiRow, _In_opt_ const unsigned int* const puiCol) const;
|
|
bool _EraseSingleLineHelper(const CONSOLE_SCREEN_BUFFER_INFOEX* const pcsbiex, const DispatchTypes::EraseType eraseType, const SHORT sLineId, const WORD wFillColor) const;
|
|
void _SetGraphicsOptionHelper(const DispatchTypes::GraphicsOptions opt, _Inout_ WORD* const pAttr);
|
|
bool _EraseAreaHelper(const COORD coordStartPosition, const COORD coordLastPosition, const WORD wFillColor);
|
|
bool _EraseSingleLineDistanceHelper(const COORD coordStartPosition, const DWORD dwLength, const WORD wFillColor) const;
|
|
bool _EraseScrollback();
|
|
bool _EraseAll();
|
|
void _SetGraphicsOptionHelper(const DispatchTypes::GraphicsOptions opt, _Inout_ WORD* const pAttr) const;
|
|
bool _InsertDeleteHelper(_In_ unsigned int const uiCount, const bool fIsInsert) const;
|
|
bool _ScrollMovement(const ScrollDirection dir, _In_ unsigned int const uiDistance) const;
|
|
static void s_DisableAllColors(_Inout_ WORD* const pAttr, const bool fIsForeground);
|
|
static void s_ApplyColors(_Inout_ WORD* const pAttr, const WORD wApplyThis, const bool fIsForeground);
|
|
|
|
bool _DoSetTopBottomScrollingMargins(const SHORT sTopMargin,
|
|
const SHORT sBottomMargin);
|
|
bool _CursorPositionReport() const;
|
|
|
|
bool _WriteResponse(_In_reads_(cchReply) PCWSTR pwszReply, const size_t cchReply) const;
|
|
bool _SetResetPrivateModes(_In_reads_(cParams) const DispatchTypes::PrivateModeParams* const rgParams, const size_t cParams, const bool fEnable);
|
|
bool _PrivateModeParamsHelper(_In_ DispatchTypes::PrivateModeParams const param, const bool fEnable);
|
|
bool _DoDECCOLMHelper(_In_ unsigned int uiColumns);
|
|
|
|
std::unique_ptr<ConGetSet> _conApi;
|
|
std::unique_ptr<AdaptDefaults> _pDefaults;
|
|
TerminalOutput _TermOutput;
|
|
|
|
COORD _coordSavedCursor;
|
|
SMALL_RECT _srScrollMargins;
|
|
|
|
bool _fIsSetColumnsEnabled;
|
|
|
|
bool _fChangedForeground;
|
|
bool _fChangedBackground;
|
|
bool _fChangedMetaAttrs;
|
|
|
|
bool _SetRgbColorsHelper(_In_reads_(cOptions) const DispatchTypes::GraphicsOptions* const rgOptions,
|
|
const size_t cOptions,
|
|
_Out_ COLORREF* const prgbColor,
|
|
_Out_ bool* const pfIsForeground,
|
|
_Out_ size_t* const pcOptionsConsumed);
|
|
|
|
bool _SetBoldColorHelper(const DispatchTypes::GraphicsOptions option);
|
|
bool _SetDefaultColorHelper(const DispatchTypes::GraphicsOptions option);
|
|
|
|
static bool s_IsXtermColorOption(const DispatchTypes::GraphicsOptions opt);
|
|
static bool s_IsRgbColorOption(const DispatchTypes::GraphicsOptions opt);
|
|
static bool s_IsBoldColorOption(const DispatchTypes::GraphicsOptions opt) noexcept;
|
|
static bool s_IsDefaultColorOption(const DispatchTypes::GraphicsOptions opt) noexcept;
|
|
};
|
|
}
|