7b7dea009c
Instead of having a separate method for setting each mouse and keyboard mode, this PR consolidates them all into a single method which takes a mode parameter, and stores the modes in a `til::enumset` rather than having a separate `bool` for each mode. This enables us to get rid of a lot of boilerplate code, and makes the code easier to extend when we want to introduce additional modes in the future. It'll also makes it easier to read back the state of the various modes when implementing the `DECRQM` query. Most of the complication is in the `TerminalInput` class, which had to be adjusted to work with an `enumset` in place of all the `bool` fields. For the rest, it was largely a matter of replacing calls to all the old mode setting methods with the new `SetInputMode` method, and deleting a bunch of unused code. One thing worth mentioning is that the `AdaptDispatch` implementation used to have a `_ShouldPassThroughInputModeChange` method that was called after every mode change. This code has now been moved up into the `SetInputMode` implementation in `ConhostInternalGetSet` so it's just handled in one place. Keeping this out of the dispatch class will also be beneficial for sharing the implementation with `TerminalDispatch`. ## Validation The updated interface necessitated some adjustments to the tests in `AdapterTest` and `MouseInputTest`, but the essential structure of the tests remains unchanged, and everything still passes. I've also tested the keyboard and mouse modes in Vttest and confirmed they still work at least as well as they did before (both conhost and Windows Terminal), and I tested the alternate scroll mode manually (conhost only). Simplifying the `ConGetSet` and `ITerminalApi` is also part of the plan to de-duplicate the `AdaptDispatch` and `TerminalDispatch` implementation (#3849).
137 lines
4.9 KiB
C++
137 lines
4.9 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- terminalInput.hpp
|
|
|
|
Abstract:
|
|
- This serves as an adapter between virtual key input from a user and the virtual terminal sequences that are
|
|
typically emitted by an xterm-compatible console.
|
|
|
|
Author(s):
|
|
- Michael Niksa (MiNiksa) 30-Oct-2015
|
|
--*/
|
|
|
|
#include <functional>
|
|
#include "../../types/inc/IInputEvent.hpp"
|
|
#pragma once
|
|
|
|
namespace Microsoft::Console::VirtualTerminal
|
|
{
|
|
class TerminalInput final
|
|
{
|
|
public:
|
|
TerminalInput(_In_ std::function<void(std::deque<std::unique_ptr<IInputEvent>>&)> pfn);
|
|
|
|
TerminalInput() = delete;
|
|
TerminalInput(const TerminalInput& old) = default;
|
|
TerminalInput(TerminalInput&& moved) = default;
|
|
|
|
TerminalInput& operator=(const TerminalInput& old) = default;
|
|
TerminalInput& operator=(TerminalInput&& moved) = default;
|
|
|
|
~TerminalInput() = default;
|
|
|
|
bool HandleKey(const IInputEvent* const pInEvent);
|
|
|
|
enum class Mode : size_t
|
|
{
|
|
Ansi,
|
|
Keypad,
|
|
CursorKey,
|
|
Win32,
|
|
|
|
Utf8MouseEncoding,
|
|
SgrMouseEncoding,
|
|
|
|
DefaultMouseTracking,
|
|
ButtonEventMouseTracking,
|
|
AnyEventMouseTracking,
|
|
|
|
AlternateScroll
|
|
};
|
|
|
|
void SetInputMode(const Mode mode, const bool enabled);
|
|
bool GetInputMode(const Mode mode) const;
|
|
void ForceDisableWin32InputMode(const bool win32InputMode) noexcept;
|
|
|
|
#pragma region MouseInput
|
|
// These methods are defined in mouseInput.cpp
|
|
|
|
struct MouseButtonState
|
|
{
|
|
bool isLeftButtonDown;
|
|
bool isMiddleButtonDown;
|
|
bool isRightButtonDown;
|
|
};
|
|
|
|
bool HandleMouse(const COORD position,
|
|
const unsigned int button,
|
|
const short modifierKeyState,
|
|
const short delta,
|
|
const MouseButtonState state);
|
|
|
|
bool IsTrackingMouseInput() const noexcept;
|
|
#pragma endregion
|
|
|
|
#pragma region MouseInputState Management
|
|
// These methods are defined in mouseInputState.cpp
|
|
void UseAlternateScreenBuffer() noexcept;
|
|
void UseMainScreenBuffer() noexcept;
|
|
#pragma endregion
|
|
|
|
private:
|
|
std::function<void(std::deque<std::unique_ptr<IInputEvent>>&)> _pfnWriteEvents;
|
|
|
|
// storage location for the leading surrogate of a utf-16 surrogate pair
|
|
std::optional<wchar_t> _leadingSurrogate;
|
|
|
|
til::enumset<Mode> _inputMode{ Mode::Ansi };
|
|
bool _forceDisableWin32InputMode{ false };
|
|
|
|
void _SendChar(const wchar_t ch);
|
|
void _SendNullInputSequence(const DWORD dwControlKeyState) const;
|
|
void _SendInputSequence(const std::wstring_view sequence) const noexcept;
|
|
void _SendEscapedInputSequence(const wchar_t wch) const;
|
|
static std::wstring _GenerateWin32KeySequence(const KeyEvent& key);
|
|
|
|
#pragma region MouseInputState Management
|
|
// These methods are defined in mouseInputState.cpp
|
|
struct MouseInputState
|
|
{
|
|
bool inAlternateBuffer{ false };
|
|
COORD lastPos{ -1, -1 };
|
|
unsigned int lastButton{ 0 };
|
|
int accumulatedDelta{ 0 };
|
|
};
|
|
|
|
MouseInputState _mouseInputState;
|
|
#pragma endregion
|
|
|
|
#pragma region MouseInput
|
|
static std::wstring _GenerateDefaultSequence(const COORD position,
|
|
const unsigned int button,
|
|
const bool isHover,
|
|
const short modifierKeyState,
|
|
const short delta);
|
|
static std::wstring _GenerateUtf8Sequence(const COORD position,
|
|
const unsigned int button,
|
|
const bool isHover,
|
|
const short modifierKeyState,
|
|
const short delta);
|
|
static std::wstring _GenerateSGRSequence(const COORD position,
|
|
const unsigned int button,
|
|
const bool isDown,
|
|
const bool isHover,
|
|
const short modifierKeyState,
|
|
const short delta);
|
|
|
|
bool _ShouldSendAlternateScroll(const unsigned int button, const short delta) const;
|
|
bool _SendAlternateScroll(const short delta) const;
|
|
|
|
static constexpr unsigned int s_GetPressedButton(const MouseButtonState state) noexcept;
|
|
#pragma endregion
|
|
};
|
|
}
|