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
99 lines
6.1 KiB
C++
99 lines
6.1 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
/*
|
|
Module Name:
|
|
- termDispatch.hpp
|
|
|
|
Abstract:
|
|
- This is a useful default implementation of all of the ITermDispatch callbacks.
|
|
Fails on every callback, but handy for tests.
|
|
*/
|
|
#include "ITermDispatch.hpp"
|
|
#pragma once
|
|
|
|
namespace Microsoft::Console::VirtualTerminal
|
|
{
|
|
class TermDispatch;
|
|
};
|
|
|
|
class Microsoft::Console::VirtualTerminal::TermDispatch : public Microsoft::Console::VirtualTerminal::ITermDispatch
|
|
{
|
|
public:
|
|
virtual void Execute(const wchar_t wchControl) = 0;
|
|
virtual void Print(const wchar_t wchPrintable) = 0;
|
|
virtual void PrintString(const wchar_t* const rgwch, const size_t cch) = 0;
|
|
|
|
virtual bool CursorUp(const unsigned int /*uiDistance*/) { return false; }; // CUU
|
|
virtual bool CursorDown(const unsigned int /*uiDistance*/) { return false; } // CUD
|
|
virtual bool CursorForward(const unsigned int /*uiDistance*/) { return false; } // CUF
|
|
virtual bool CursorBackward(const unsigned int /*uiDistance*/) { return false; } // CUB
|
|
virtual bool CursorNextLine(const unsigned int /*uiDistance*/) { return false; } // CNL
|
|
virtual bool CursorPrevLine(const unsigned int /*uiDistance*/) { return false; } // CPL
|
|
virtual bool CursorHorizontalPositionAbsolute(const unsigned int /*uiColumn*/) { return false; } // CHA
|
|
virtual bool VerticalLinePositionAbsolute(const unsigned int /*uiLine*/) { return false; } // VPA
|
|
virtual bool CursorPosition(const unsigned int /*uiLine*/, const unsigned int /*uiColumn*/) { return false; } // CUP
|
|
virtual bool CursorSavePosition() { return false; } // DECSC
|
|
virtual bool CursorRestorePosition() { return false; } // DECRC
|
|
virtual bool CursorVisibility(const bool /*fIsVisible*/) { return false; } // DECTCEM
|
|
virtual bool InsertCharacter(const unsigned int /*uiCount*/) { return false; } // ICH
|
|
virtual bool DeleteCharacter(const unsigned int /*uiCount*/) { return false; } // DCH
|
|
virtual bool ScrollUp(const unsigned int /*uiDistance*/) { return false; } // SU
|
|
virtual bool ScrollDown(const unsigned int /*uiDistance*/) { return false; } // SD
|
|
virtual bool InsertLine(const unsigned int /*uiDistance*/) { return false; } // IL
|
|
virtual bool DeleteLine(const unsigned int /*uiDistance*/) { return false; } // DL
|
|
virtual bool SetColumns(const unsigned int /*uiColumns*/) { return false; } // DECSCPP, DECCOLM
|
|
virtual bool SetCursorKeysMode(const bool /*fApplicationMode*/) { return false; } // DECCKM
|
|
virtual bool SetKeypadMode(const bool /*fApplicationMode*/) { return false; } // DECKPAM, DECKPNM
|
|
virtual bool EnableCursorBlinking(const bool /*fEnable*/) { return false; } // ATT610
|
|
virtual bool SetTopBottomScrollingMargins(const SHORT /*sTopMargin*/, const SHORT /*sBottomMargin*/) { return false; } // DECSTBM
|
|
virtual bool ReverseLineFeed() { return false; } // RI
|
|
virtual bool SetWindowTitle(std::wstring_view /*title*/) { return false; } // OscWindowTitle
|
|
virtual bool UseAlternateScreenBuffer() { return false; } // ASBSET
|
|
virtual bool UseMainScreenBuffer() { return false; } // ASBRST
|
|
virtual bool HorizontalTabSet() { return false; } // HTS
|
|
virtual bool ForwardTab(const SHORT /*sNumTabs*/) { return false; } // CHT
|
|
virtual bool BackwardsTab(const SHORT /*sNumTabs*/) { return false; } // CBT
|
|
virtual bool TabClear(const SHORT /*sClearType*/) { return false; } // TBC
|
|
virtual bool EnableVT200MouseMode(const bool /*fEnabled*/) { return false; } // ?1000
|
|
virtual bool EnableUTF8ExtendedMouseMode(const bool /*fEnabled*/) { return false; } // ?1005
|
|
virtual bool EnableSGRExtendedMouseMode(const bool /*fEnabled*/) { return false; } // ?1006
|
|
virtual bool EnableButtonEventMouseMode(const bool /*fEnabled*/) { return false; } // ?1002
|
|
virtual bool EnableAnyEventMouseMode(const bool /*fEnabled*/) { return false; } // ?1003
|
|
virtual bool EnableAlternateScroll(const bool /*fEnabled*/) { return false; } // ?1007
|
|
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 EraseInLine(const DispatchTypes::EraseType /* eraseType*/) { return false; } // EL
|
|
virtual bool EraseCharacters(const unsigned int /*uiNumChars*/){ return false; } // ECH
|
|
|
|
virtual bool SetGraphicsRendition(_In_reads_(_Param_(2)) const DispatchTypes::GraphicsOptions* const /*rgOptions*/,
|
|
const size_t /*cOptions*/) { return false; } // SGR
|
|
|
|
virtual bool SetPrivateModes(_In_reads_(_Param_(2)) const DispatchTypes::PrivateModeParams* const /*rgParams*/,
|
|
const size_t /*cParams*/) { return false; } // DECSET
|
|
|
|
virtual bool ResetPrivateModes(_In_reads_(_Param_(2)) const DispatchTypes::PrivateModeParams* const /*rgParams*/,
|
|
const size_t /*cParams*/) { return false; } // DECRST
|
|
|
|
virtual bool DeviceStatusReport(const DispatchTypes::AnsiStatusType /*statusType*/) { return false; } // DSR
|
|
virtual bool DeviceAttributes() { return false; } // DA
|
|
|
|
virtual bool DesignateCharset(const wchar_t /*wchCharset*/){ return false; } // DesignateCharset
|
|
|
|
virtual bool SoftReset(){ return false; } // DECSTR
|
|
virtual bool HardReset(){ return false; } // RIS
|
|
|
|
virtual bool SetCursorStyle(const DispatchTypes::CursorStyle /*cursorStyle*/){ return false; } // DECSCUSR
|
|
virtual bool SetCursorColor(const COLORREF /*Color*/) { return false; } // OSCSetCursorColor, OSCResetCursorColor
|
|
|
|
// DTTERM_WindowManipulation
|
|
virtual bool WindowManipulation(const DispatchTypes::WindowManipulationType /*uiFunction*/,
|
|
_In_reads_(_Param_(3)) const unsigned short* const /*rgusParams*/,
|
|
const size_t /*cParams*/) { return false; }
|
|
|
|
};
|
|
|