22fd06e19b
This entirely removes `KeyMapping` from the settings model, and builds on the work done in #9543 to consolidate all actions (key bindings and commands) into a unified data structure (`ActionMap`). ## References #9428 - Spec #6900 - Actions page Closes #7441 ## Detailed Description of the Pull Request / Additional comments The important thing here is to remember that we're shifting our philosophy of how to interact/represent actions. Prior to this, the actions arrays in the JSON would be deserialized twice: once for key bindings, and again for commands. By thinking of every entry in the relevant JSON as a `Command`, we can remove a lot of the context switching between working with a key binding vs a command palette item. #9543 allows us to make that shift. Given the work in that PR, we can now deserialize all of the relevant information from each JSON action item. This allows us to simplify `ActionMap::FromJson` to simply iterate over each JSON action item, deserialize it, and add it to our `ActionMap`. Internally, our `ActionMap` operates as discussed in #9428 by maintaining a `_KeyMap` that points to an action ID, and using that action ID to retrieve the `Command` from the `_ActionMap`. Adding actions to the `ActionMap` automatically accounts for name/key-chord collisions. A `NameMap` can be constructed when requested; this is for the Command Palette. Querying the `ActionMap` is fairly straightforward. Helper functions were needed to be able to distinguish an explicit unbinding vs the command not being found in the current layer. Internally, we store explicitly unbound names/key-chords as `ShortcutAction::Invalid` commands. However, we return `nullptr` when a query points to an unbound command. This is done to hide this complexity away from any caller. The command palette still needs special handling for nested and iterable commands. Thankfully, the expansion of iterable commands is performed on an `IMapView`, so we can just expose `NameMap` as a consolidation of `ActionMap`'s `NameMap` with its parents. The same can be said for exposing key chords in nested commands. ## Validation Steps Performed All local tests pass.
179 lines
8.2 KiB
C++
179 lines
8.2 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#pragma once
|
|
|
|
#include "AppLogic.g.h"
|
|
#include "FindTargetWindowResult.g.h"
|
|
#include "TerminalPage.h"
|
|
#include "Jumplist.h"
|
|
#include "../../cascadia/inc/cppwinrt_utils.h"
|
|
|
|
#ifdef UNIT_TESTING
|
|
// fwdecl unittest classes
|
|
namespace TerminalAppLocalTests
|
|
{
|
|
class CommandlineTest;
|
|
};
|
|
#endif
|
|
|
|
namespace winrt::TerminalApp::implementation
|
|
{
|
|
struct FindTargetWindowResult : FindTargetWindowResultT<FindTargetWindowResult>
|
|
{
|
|
WINRT_PROPERTY(int32_t, WindowId, -1);
|
|
WINRT_PROPERTY(winrt::hstring, WindowName, L"");
|
|
|
|
public:
|
|
FindTargetWindowResult(const int32_t id, const winrt::hstring& name) :
|
|
_WindowId{ id }, _WindowName{ name } {};
|
|
|
|
FindTargetWindowResult(const int32_t id) :
|
|
FindTargetWindowResult(id, L""){};
|
|
};
|
|
|
|
struct AppLogic : AppLogicT<AppLogic, IInitializeWithWindow>
|
|
{
|
|
public:
|
|
static AppLogic* Current() noexcept;
|
|
static const Microsoft::Terminal::Settings::Model::CascadiaSettings CurrentAppSettings();
|
|
|
|
AppLogic();
|
|
~AppLogic() = default;
|
|
|
|
STDMETHODIMP Initialize(HWND hwnd);
|
|
|
|
void Create();
|
|
bool IsUwp() const noexcept;
|
|
void RunAsUwp();
|
|
bool IsElevated() const noexcept;
|
|
void LoadSettings();
|
|
[[nodiscard]] Microsoft::Terminal::Settings::Model::CascadiaSettings GetSettings() const noexcept;
|
|
|
|
int32_t SetStartupCommandline(array_view<const winrt::hstring> actions);
|
|
int32_t ExecuteCommandline(array_view<const winrt::hstring> actions, const winrt::hstring& cwd);
|
|
TerminalApp::FindTargetWindowResult FindTargetWindow(array_view<const winrt::hstring> actions);
|
|
winrt::hstring ParseCommandlineMessage();
|
|
bool ShouldExitEarly();
|
|
|
|
bool FocusMode() const;
|
|
bool Fullscreen() const;
|
|
bool AlwaysOnTop() const;
|
|
|
|
void IdentifyWindow();
|
|
void RenameFailed();
|
|
winrt::hstring WindowName();
|
|
void WindowName(const winrt::hstring& name);
|
|
uint64_t WindowId();
|
|
void WindowId(const uint64_t& id);
|
|
bool IsQuakeWindow() const noexcept;
|
|
|
|
Windows::Foundation::Size GetLaunchDimensions(uint32_t dpi);
|
|
bool CenterOnLaunch();
|
|
TerminalApp::InitialPosition GetInitialPosition(int64_t defaultInitialX, int64_t defaultInitialY);
|
|
winrt::Windows::UI::Xaml::ElementTheme GetRequestedTheme();
|
|
Microsoft::Terminal::Settings::Model::LaunchMode GetLaunchMode();
|
|
bool GetShowTabsInTitlebar();
|
|
bool GetInitialAlwaysOnTop();
|
|
float CalcSnappedDimension(const bool widthOrHeight, const float dimension) const;
|
|
|
|
Windows::UI::Xaml::UIElement GetRoot() noexcept;
|
|
|
|
hstring Title();
|
|
void TitlebarClicked();
|
|
bool OnDirectKeyEvent(const uint32_t vkey, const uint8_t scanCode, const bool down);
|
|
|
|
void WindowCloseButtonClicked();
|
|
|
|
size_t GetLastActiveControlTaskbarState();
|
|
size_t GetLastActiveControlTaskbarProgress();
|
|
|
|
winrt::Windows::Foundation::IAsyncOperation<winrt::Windows::UI::Xaml::Controls::ContentDialogResult> ShowDialog(winrt::Windows::UI::Xaml::Controls::ContentDialog dialog);
|
|
|
|
Windows::Foundation::Collections::IMapView<Microsoft::Terminal::Control::KeyChord, Microsoft::Terminal::Settings::Model::Command> GlobalHotkeys();
|
|
|
|
// -------------------------------- WinRT Events ---------------------------------
|
|
TYPED_EVENT(RequestedThemeChanged, winrt::Windows::Foundation::IInspectable, winrt::Windows::UI::Xaml::ElementTheme);
|
|
TYPED_EVENT(SettingsChanged, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable);
|
|
|
|
private:
|
|
bool _isUwp{ false };
|
|
bool _isElevated{ false };
|
|
|
|
// If you add controls here, but forget to null them either here or in
|
|
// the ctor, you're going to have a bad time. It'll mysteriously fail to
|
|
// activate the AppLogic.
|
|
// ALSO: If you add any UIElements as roots here, make sure they're
|
|
// updated in _ApplyTheme. The root currently is _root.
|
|
winrt::com_ptr<TerminalPage> _root{ nullptr };
|
|
|
|
Microsoft::Terminal::Settings::Model::CascadiaSettings _settings{ nullptr };
|
|
|
|
HRESULT _settingsLoadedResult;
|
|
winrt::hstring _settingsLoadExceptionText{};
|
|
|
|
bool _loadedInitialSettings;
|
|
|
|
wil::unique_folder_change_reader_nothrow _reader;
|
|
|
|
std::shared_mutex _dialogLock;
|
|
|
|
std::atomic<bool> _settingsReloadQueued{ false };
|
|
|
|
::TerminalApp::AppCommandlineArgs _appArgs;
|
|
::TerminalApp::AppCommandlineArgs _settingsAppArgs;
|
|
int _ParseArgs(winrt::array_view<const hstring>& args);
|
|
static TerminalApp::FindTargetWindowResult _doFindTargetWindow(winrt::array_view<const hstring> args,
|
|
const Microsoft::Terminal::Settings::Model::WindowingMode& windowingBehavior);
|
|
|
|
void _ShowLoadErrorsDialog(const winrt::hstring& titleKey, const winrt::hstring& contentKey, HRESULT settingsLoadedResult);
|
|
void _ShowLoadWarningsDialog();
|
|
bool _IsKeyboardServiceEnabled();
|
|
void _ShowKeyboardServiceDisabledDialog();
|
|
|
|
fire_and_forget _LoadErrorsDialogRoutine();
|
|
fire_and_forget _ShowLoadWarningsDialogRoutine();
|
|
fire_and_forget _RefreshThemeRoutine();
|
|
fire_and_forget _ApplyStartupTaskStateChange();
|
|
|
|
void _OnLoaded(const IInspectable& sender, const Windows::UI::Xaml::RoutedEventArgs& eventArgs);
|
|
|
|
[[nodiscard]] HRESULT _TryLoadSettings() noexcept;
|
|
void _RegisterSettingsChange();
|
|
fire_and_forget _DispatchReloadSettings();
|
|
void _ReloadSettings();
|
|
|
|
void _ApplyTheme(const Windows::UI::Xaml::ElementTheme& newTheme);
|
|
|
|
bool _hasCommandLineArguments{ false };
|
|
bool _hasSettingsStartupActions{ false };
|
|
std::vector<Microsoft::Terminal::Settings::Model::SettingsLoadWarnings> _warnings;
|
|
|
|
// These are events that are handled by the TerminalPage, but are
|
|
// exposed through the AppLogic. This macro is used to forward the event
|
|
// directly to them.
|
|
FORWARDED_TYPED_EVENT(SetTitleBarContent, winrt::Windows::Foundation::IInspectable, winrt::Windows::UI::Xaml::UIElement, _root, SetTitleBarContent);
|
|
FORWARDED_TYPED_EVENT(TitleChanged, winrt::Windows::Foundation::IInspectable, winrt::hstring, _root, TitleChanged);
|
|
FORWARDED_TYPED_EVENT(LastTabClosed, winrt::Windows::Foundation::IInspectable, winrt::TerminalApp::LastTabClosedEventArgs, _root, LastTabClosed);
|
|
FORWARDED_TYPED_EVENT(FocusModeChanged, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable, _root, FocusModeChanged);
|
|
FORWARDED_TYPED_EVENT(FullscreenChanged, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable, _root, FullscreenChanged);
|
|
FORWARDED_TYPED_EVENT(AlwaysOnTopChanged, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable, _root, AlwaysOnTopChanged);
|
|
FORWARDED_TYPED_EVENT(RaiseVisualBell, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable, _root, RaiseVisualBell);
|
|
FORWARDED_TYPED_EVENT(SetTaskbarProgress, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable, _root, SetTaskbarProgress);
|
|
FORWARDED_TYPED_EVENT(IdentifyWindowsRequested, Windows::Foundation::IInspectable, Windows::Foundation::IInspectable, _root, IdentifyWindowsRequested);
|
|
FORWARDED_TYPED_EVENT(RenameWindowRequested, Windows::Foundation::IInspectable, winrt::TerminalApp::RenameWindowRequestedArgs, _root, RenameWindowRequested);
|
|
FORWARDED_TYPED_EVENT(IsQuakeWindowChanged, Windows::Foundation::IInspectable, Windows::Foundation::IInspectable, _root, IsQuakeWindowChanged);
|
|
|
|
#ifdef UNIT_TESTING
|
|
friend class TerminalAppLocalTests::CommandlineTest;
|
|
#endif
|
|
};
|
|
}
|
|
|
|
namespace winrt::TerminalApp::factory_implementation
|
|
{
|
|
struct AppLogic : AppLogicT<AppLogic, implementation::AppLogic>
|
|
{
|
|
};
|
|
}
|