58f5d7c72e
* Update _TerminalCursorPositionChanged to use ThrottledFunc. * Rename previous ThrottledFunc to ThrottledArgFunc because now ThrottledFunc is for functions that do not take an argument. * Update ThrottledFunc and ThrottledArgFunc to accept a CoreDispatcher on which the function should be called for convenience. * Don't use coroutines/winrt::fire_and_forget in ThrottledFunc/ThrottledArgFunc because they are too slow (see PR). _AdjustCursorPosition went from 17% of samples to 3% in performance testing.
260 lines
13 KiB
C++
260 lines
13 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#pragma once
|
|
|
|
#include "TermControl.g.h"
|
|
#include "CopyToClipboardEventArgs.g.h"
|
|
#include "PasteFromClipboardEventArgs.g.h"
|
|
#include <winrt/Microsoft.Terminal.TerminalConnection.h>
|
|
#include <winrt/Microsoft.Terminal.Settings.h>
|
|
#include "../../renderer/base/Renderer.hpp"
|
|
#include "../../renderer/dx/DxRenderer.hpp"
|
|
#include "../../renderer/uia/UiaRenderer.hpp"
|
|
#include "../../cascadia/TerminalCore/Terminal.hpp"
|
|
#include "../buffer/out/search.h"
|
|
#include "cppwinrt_utils.h"
|
|
#include "SearchBoxControl.h"
|
|
#include "ThrottledFunc.h"
|
|
|
|
namespace winrt::Microsoft::Terminal::TerminalControl::implementation
|
|
{
|
|
struct CopyToClipboardEventArgs :
|
|
public CopyToClipboardEventArgsT<CopyToClipboardEventArgs>
|
|
{
|
|
public:
|
|
CopyToClipboardEventArgs(hstring text, hstring html, hstring rtf) :
|
|
_text(text),
|
|
_html(html),
|
|
_rtf(rtf) {}
|
|
|
|
hstring Text() { return _text; };
|
|
hstring Html() { return _html; };
|
|
hstring Rtf() { return _rtf; };
|
|
|
|
private:
|
|
hstring _text;
|
|
hstring _html;
|
|
hstring _rtf;
|
|
};
|
|
|
|
struct PasteFromClipboardEventArgs :
|
|
public PasteFromClipboardEventArgsT<PasteFromClipboardEventArgs>
|
|
{
|
|
public:
|
|
PasteFromClipboardEventArgs(std::function<void(std::wstring)> clipboardDataHandler) :
|
|
m_clipboardDataHandler(clipboardDataHandler) {}
|
|
|
|
void HandleClipboardData(hstring value)
|
|
{
|
|
m_clipboardDataHandler(static_cast<std::wstring>(value));
|
|
};
|
|
|
|
private:
|
|
std::function<void(std::wstring)> m_clipboardDataHandler;
|
|
};
|
|
|
|
struct TermControl : TermControlT<TermControl>
|
|
{
|
|
TermControl();
|
|
TermControl(Settings::IControlSettings settings, TerminalConnection::ITerminalConnection connection);
|
|
|
|
winrt::fire_and_forget UpdateSettings(Settings::IControlSettings newSettings);
|
|
|
|
hstring Title();
|
|
hstring GetProfileName() const;
|
|
|
|
bool CopySelectionToClipboard(bool collapseText = false);
|
|
void PasteTextFromClipboard();
|
|
void Close();
|
|
Windows::Foundation::Size CharacterDimensions() const;
|
|
Windows::Foundation::Size MinimumSize();
|
|
float SnapDimensionToGrid(const bool widthOrHeight, const float dimension);
|
|
|
|
void ScrollViewport(int viewTop);
|
|
int GetScrollOffset();
|
|
int GetViewHeight() const;
|
|
|
|
void AdjustFontSize(int fontSizeDelta);
|
|
void ResetFontSize();
|
|
|
|
winrt::fire_and_forget RenderEngineSwapChainChanged();
|
|
void _AttachDxgiSwapChainToXaml(IDXGISwapChain1* swapChain);
|
|
winrt::fire_and_forget _RendererEnteredErrorState();
|
|
void _RenderRetryButton_Click(IInspectable const& button, IInspectable const& args);
|
|
|
|
void CreateSearchBoxControl();
|
|
|
|
bool OnDirectKeyEvent(const uint32_t vkey, const bool down);
|
|
|
|
bool OnMouseWheel(const Windows::Foundation::Point location, const int32_t delta);
|
|
|
|
~TermControl();
|
|
|
|
Windows::UI::Xaml::Automation::Peers::AutomationPeer OnCreateAutomationPeer();
|
|
::Microsoft::Console::Types::IUiaData* GetUiaData() const;
|
|
const FontInfo GetActualFont() const;
|
|
const Windows::UI::Xaml::Thickness GetPadding();
|
|
|
|
TerminalConnection::ConnectionState ConnectionState() const;
|
|
|
|
static Windows::Foundation::Point GetProposedDimensions(Microsoft::Terminal::Settings::IControlSettings const& settings, const uint32_t dpi);
|
|
|
|
// clang-format off
|
|
// -------------------------------- WinRT Events ---------------------------------
|
|
DECLARE_EVENT(TitleChanged, _titleChangedHandlers, TerminalControl::TitleChangedEventArgs);
|
|
DECLARE_EVENT(FontSizeChanged, _fontSizeChangedHandlers, TerminalControl::FontSizeChangedEventArgs);
|
|
DECLARE_EVENT(ScrollPositionChanged, _scrollPositionChangedHandlers, TerminalControl::ScrollPositionChangedEventArgs);
|
|
|
|
DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(PasteFromClipboard, _clipboardPasteHandlers, TerminalControl::TermControl, TerminalControl::PasteFromClipboardEventArgs);
|
|
DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(CopyToClipboard, _clipboardCopyHandlers, TerminalControl::TermControl, TerminalControl::CopyToClipboardEventArgs);
|
|
|
|
TYPED_EVENT(ConnectionStateChanged, TerminalControl::TermControl, IInspectable);
|
|
TYPED_EVENT(Initialized, TerminalControl::TermControl, Windows::UI::Xaml::RoutedEventArgs);
|
|
// clang-format on
|
|
|
|
private:
|
|
friend struct TermControlT<TermControl>; // friend our parent so it can bind private event handlers
|
|
TerminalConnection::ITerminalConnection _connection;
|
|
bool _initializedTerminal;
|
|
|
|
winrt::com_ptr<SearchBoxControl> _searchBox;
|
|
|
|
event_token _connectionOutputEventToken;
|
|
TerminalConnection::ITerminalConnection::StateChanged_revoker _connectionStateChangedRevoker;
|
|
|
|
std::unique_ptr<::Microsoft::Terminal::Core::Terminal> _terminal;
|
|
|
|
std::unique_ptr<::Microsoft::Console::Render::Renderer> _renderer;
|
|
std::unique_ptr<::Microsoft::Console::Render::DxEngine> _renderEngine;
|
|
std::unique_ptr<::Microsoft::Console::Render::UiaEngine> _uiaEngine;
|
|
|
|
Settings::IControlSettings _settings;
|
|
bool _focused;
|
|
std::atomic<bool> _closing;
|
|
|
|
FontInfoDesired _desiredFont;
|
|
FontInfo _actualFont;
|
|
|
|
std::shared_ptr<ThrottledFunc<>> _tsfTryRedrawCanvas;
|
|
|
|
struct ScrollBarUpdate
|
|
{
|
|
std::optional<double> newValue;
|
|
double newMaximum;
|
|
double newMinimum;
|
|
double newViewportSize;
|
|
};
|
|
std::shared_ptr<ThrottledFunc<ScrollBarUpdate>> _updateScrollBar;
|
|
bool _isInternalScrollBarUpdate;
|
|
|
|
int _rowsToScroll;
|
|
|
|
// Auto scroll occurs when user, while selecting, drags cursor outside viewport. View is then scrolled to 'follow' the cursor.
|
|
double _autoScrollVelocity;
|
|
std::optional<Windows::UI::Input::PointerPoint> _autoScrollingPointerPoint;
|
|
Windows::UI::Xaml::DispatcherTimer _autoScrollTimer;
|
|
std::optional<std::chrono::high_resolution_clock::time_point> _lastAutoScrollUpdateTime;
|
|
|
|
// storage location for the leading surrogate of a utf-16 surrogate pair
|
|
std::optional<wchar_t> _leadingSurrogate;
|
|
|
|
std::optional<Windows::UI::Xaml::DispatcherTimer> _cursorTimer;
|
|
|
|
// If this is set, then we assume we are in the middle of panning the
|
|
// viewport via touch input.
|
|
std::optional<winrt::Windows::Foundation::Point> _touchAnchor;
|
|
|
|
using Timestamp = uint64_t;
|
|
|
|
// imported from WinUser
|
|
// Used for PointerPoint.Timestamp Property (https://docs.microsoft.com/en-us/uwp/api/windows.ui.input.pointerpoint.timestamp#Windows_UI_Input_PointerPoint_Timestamp)
|
|
Timestamp _multiClickTimer;
|
|
unsigned int _multiClickCounter;
|
|
Timestamp _lastMouseClickTimestamp;
|
|
std::optional<winrt::Windows::Foundation::Point> _lastMouseClickPos;
|
|
std::optional<winrt::Windows::Foundation::Point> _singleClickTouchdownPos;
|
|
// This field tracks whether the selection has changed meaningfully
|
|
// since it was last copied. It's generally used to prevent copyOnSelect
|
|
// from firing when the pointer _just happens_ to be released over the
|
|
// terminal.
|
|
bool _selectionNeedsToBeCopied;
|
|
|
|
winrt::Windows::UI::Xaml::Controls::SwapChainPanel::LayoutUpdated_revoker _layoutUpdatedRevoker;
|
|
|
|
void _ApplyUISettings();
|
|
void _InitializeBackgroundBrush();
|
|
winrt::fire_and_forget _BackgroundColorChanged(const COLORREF color);
|
|
bool _InitializeTerminal();
|
|
void _UpdateFont(const bool initialUpdate = false);
|
|
void _SetFontSize(int fontSize);
|
|
void _TappedHandler(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Input::TappedRoutedEventArgs const& e);
|
|
void _KeyDownHandler(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Input::KeyRoutedEventArgs const& e);
|
|
void _KeyUpHandler(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Input::KeyRoutedEventArgs const& e);
|
|
void _CharacterHandler(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Input::CharacterReceivedRoutedEventArgs const& e);
|
|
void _PointerPressedHandler(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Input::PointerRoutedEventArgs const& e);
|
|
void _PointerMovedHandler(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Input::PointerRoutedEventArgs const& e);
|
|
void _PointerReleasedHandler(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Input::PointerRoutedEventArgs const& e);
|
|
void _MouseWheelHandler(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Input::PointerRoutedEventArgs const& e);
|
|
void _ScrollbarChangeHandler(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Controls::Primitives::RangeBaseValueChangedEventArgs const& e);
|
|
void _GotFocusHandler(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::RoutedEventArgs const& e);
|
|
void _LostFocusHandler(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::RoutedEventArgs const& e);
|
|
winrt::fire_and_forget _DragDropHandler(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::DragEventArgs const e);
|
|
void _DragOverHandler(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::DragEventArgs const& e);
|
|
|
|
void _CursorTimerTick(Windows::Foundation::IInspectable const& sender, Windows::Foundation::IInspectable const& e);
|
|
void _SetEndSelectionPointAtCursor(Windows::Foundation::Point const& cursorPosition);
|
|
void _SendInputToConnection(const std::wstring& wstr);
|
|
void _SendPastedTextToConnection(const std::wstring& wstr);
|
|
void _SwapChainSizeChanged(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::SizeChangedEventArgs const& e);
|
|
void _SwapChainScaleChanged(Windows::UI::Xaml::Controls::SwapChainPanel const& sender, Windows::Foundation::IInspectable const& args);
|
|
void _DoResizeUnderLock(const double newWidth, const double newHeight);
|
|
void _RefreshSizeUnderLock();
|
|
void _TerminalTitleChanged(const std::wstring_view& wstr);
|
|
void _TerminalScrollPositionChanged(const int viewTop, const int viewHeight, const int bufferSize);
|
|
void _TerminalCursorPositionChanged();
|
|
|
|
void _MouseScrollHandler(const double mouseDelta, const Windows::Foundation::Point point, const bool isLeftButtonPressed);
|
|
void _MouseZoomHandler(const double delta);
|
|
void _MouseTransparencyHandler(const double delta);
|
|
bool _DoMouseWheel(const Windows::Foundation::Point point, const ::Microsoft::Terminal::Core::ControlKeyStates modifiers, const int32_t delta, const bool isLeftButtonPressed);
|
|
|
|
bool _CapturePointer(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Input::PointerRoutedEventArgs const& e);
|
|
bool _ReleasePointerCapture(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Input::PointerRoutedEventArgs const& e);
|
|
|
|
void _TryStartAutoScroll(Windows::UI::Input::PointerPoint const& pointerPoint, const double scrollVelocity);
|
|
void _TryStopAutoScroll(const uint32_t pointerId);
|
|
void _UpdateAutoScroll(Windows::Foundation::IInspectable const& sender, Windows::Foundation::IInspectable const& e);
|
|
|
|
static Windows::UI::Xaml::Thickness _ParseThicknessFromPadding(const hstring padding);
|
|
|
|
void _KeyHandler(Windows::UI::Xaml::Input::KeyRoutedEventArgs const& e, const bool keyDown);
|
|
::Microsoft::Terminal::Core::ControlKeyStates _GetPressedModifierKeys() const;
|
|
bool _TryHandleKeyBinding(const WORD vkey, ::Microsoft::Terminal::Core::ControlKeyStates modifiers) const;
|
|
bool _TrySendKeyEvent(const WORD vkey, const WORD scanCode, ::Microsoft::Terminal::Core::ControlKeyStates modifiers, const bool keyDown);
|
|
bool _TrySendMouseEvent(Windows::UI::Input::PointerPoint const& point);
|
|
bool _CanSendVTMouseInput();
|
|
|
|
const COORD _GetTerminalPosition(winrt::Windows::Foundation::Point cursorPosition);
|
|
const unsigned int _NumberOfClicks(winrt::Windows::Foundation::Point clickPos, Timestamp clickTime);
|
|
double _GetAutoScrollSpeed(double cursorDistanceFromBorder) const;
|
|
|
|
void _Search(const winrt::hstring& text, const bool goForward, const bool caseSensitive);
|
|
void _CloseSearchBoxControl(const winrt::Windows::Foundation::IInspectable& sender, Windows::UI::Xaml::RoutedEventArgs const& args);
|
|
|
|
// TSFInputControl Handlers
|
|
void _CompositionCompleted(winrt::hstring text);
|
|
void _CurrentCursorPositionHandler(const IInspectable& sender, const CursorPositionEventArgs& eventArgs);
|
|
void _FontInfoHandler(const IInspectable& sender, const FontInfoEventArgs& eventArgs);
|
|
|
|
winrt::fire_and_forget _AsyncCloseConnection();
|
|
};
|
|
}
|
|
|
|
namespace winrt::Microsoft::Terminal::TerminalControl::factory_implementation
|
|
{
|
|
struct TermControl : TermControlT<TermControl, implementation::TermControl>
|
|
{
|
|
};
|
|
}
|