mirror of
https://github.com/microsoft/terminal.git
synced 2026-04-09 17:00:23 -04:00
This commit implements the OSC 9;4 sequence per the [ConEmu style]. | sequence | description | | ------------ | ------------ | | `ESC ] 9 ; 4 ; st ; pr ST` | Set progress state on taskbar and tab. | | | When `st` is: | | | | | | `0`: remove progress. | | | `1`: set progress value to `pr` (number, 0-100). | | | `2`: set the taskbar to the "Error" state | | | `3`: set the taskbar to the "Indeterminate" state | | | `4`: set the taskbar to the "Warning" state | We've also extended this with: * st 3: set indeterminate state * st 4: set paused state We handle multiple tabs sending the sequence by using the the last focused control's taskbar state/progress. Upon receiving the sequence in `TerminalApi`, we send an event that gets caught by `TerminalPage`. `TerminalPage` then fires another event that gets caught by `AppHost` and that's where we set the taskbar progress. Closes #3004 [ConEmu style]: https://conemu.github.io/en/AnsiEscapeCodes.html#ConEmu_specific_OSC
84 lines
4.3 KiB
C++
84 lines
4.3 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#include "../../terminal/adapter/termDispatch.hpp"
|
|
#include "ITerminalApi.hpp"
|
|
|
|
static constexpr size_t TaskbarMaxState{ 4 };
|
|
static constexpr size_t TaskbarMaxProgress{ 100 };
|
|
|
|
class TerminalDispatch : public Microsoft::Console::VirtualTerminal::TermDispatch
|
|
{
|
|
public:
|
|
TerminalDispatch(::Microsoft::Terminal::Core::ITerminalApi& terminalApi) noexcept;
|
|
|
|
void Execute(const wchar_t wchControl) noexcept override;
|
|
void Print(const wchar_t wchPrintable) noexcept override;
|
|
void PrintString(const std::wstring_view string) noexcept override;
|
|
|
|
bool SetGraphicsRendition(const ::Microsoft::Console::VirtualTerminal::VTParameters options) noexcept override;
|
|
|
|
bool CursorPosition(const size_t line,
|
|
const size_t column) noexcept override; // CUP
|
|
|
|
bool EnableWin32InputMode(const bool win32InputMode) noexcept override; // win32-input-mode
|
|
|
|
bool CursorVisibility(const bool isVisible) noexcept override; // DECTCEM
|
|
bool EnableCursorBlinking(const bool enable) noexcept override; // ATT610
|
|
|
|
bool CursorForward(const size_t distance) noexcept override;
|
|
bool CursorBackward(const size_t distance) noexcept override;
|
|
bool CursorUp(const size_t distance) noexcept override;
|
|
|
|
bool LineFeed(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::LineFeedType lineFeedType) noexcept override;
|
|
|
|
bool EraseCharacters(const size_t numChars) noexcept override;
|
|
bool WarningBell() noexcept override;
|
|
bool CarriageReturn() noexcept override;
|
|
bool SetWindowTitle(std::wstring_view title) noexcept override;
|
|
|
|
bool SetColorTableEntry(const size_t tableIndex, const DWORD color) noexcept override;
|
|
bool SetCursorStyle(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::CursorStyle cursorStyle) noexcept override;
|
|
bool SetCursorColor(const DWORD color) noexcept override;
|
|
|
|
bool SetClipboard(std::wstring_view content) noexcept override;
|
|
|
|
bool SetDefaultForeground(const DWORD color) noexcept override;
|
|
bool SetDefaultBackground(const DWORD color) noexcept override;
|
|
bool EraseInLine(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::EraseType eraseType) noexcept override; // ED
|
|
bool DeleteCharacter(const size_t count) noexcept override;
|
|
bool InsertCharacter(const size_t count) noexcept override;
|
|
bool EraseInDisplay(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::EraseType eraseType) noexcept override;
|
|
|
|
bool SetCursorKeysMode(const bool applicationMode) noexcept override; // DECCKM
|
|
bool SetKeypadMode(const bool applicationMode) noexcept override; // DECKPAM, DECKPNM
|
|
bool SetScreenMode(const bool reverseMode) noexcept override; // DECSCNM
|
|
|
|
bool SoftReset() noexcept override; // DECSTR
|
|
bool HardReset() noexcept override; // RIS
|
|
|
|
bool EnableVT200MouseMode(const bool enabled) noexcept override; // ?1000
|
|
bool EnableUTF8ExtendedMouseMode(const bool enabled) noexcept override; // ?1005
|
|
bool EnableSGRExtendedMouseMode(const bool enabled) noexcept override; // ?1006
|
|
bool EnableButtonEventMouseMode(const bool enabled) noexcept override; // ?1002
|
|
bool EnableAnyEventMouseMode(const bool enabled) noexcept override; // ?1003
|
|
bool EnableAlternateScroll(const bool enabled) noexcept override; // ?1007
|
|
|
|
bool SetPrivateMode(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::PrivateModeParams /*param*/) noexcept override; // DECSET
|
|
bool ResetPrivateMode(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::PrivateModeParams /*param*/) noexcept override; // DECRST
|
|
|
|
bool AddHyperlink(const std::wstring_view uri, const std::wstring_view params) noexcept override;
|
|
bool EndHyperlink() noexcept override;
|
|
|
|
bool DoConEmuAction(const std::wstring_view string) noexcept override;
|
|
|
|
private:
|
|
::Microsoft::Terminal::Core::ITerminalApi& _terminalApi;
|
|
|
|
size_t _SetRgbColorsHelper(const ::Microsoft::Console::VirtualTerminal::VTParameters options,
|
|
TextAttribute& attr,
|
|
const bool isForeground) noexcept;
|
|
|
|
bool _PrivateModeParamsHelper(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::PrivateModeParams param, const bool enable) noexcept;
|
|
};
|