Introduces a new TerminalSettingsModel (TSM) project. This project is responsible for (de)serializing and exposing Windows Terminal's settings as WinRT objects. ## References #885: TSM epic #1564: Settings UI is dependent on this for data binding and settings access #6904: TSM Spec In the process of ripping out TSM from TerminalApp, a few other changes were made to make this possible: 1. AppLogic's `ApplicationDisplayName` and `ApplicationVersion` was moved to `CascadiaSettings` - These are defined as static functions. They also no longer check if `AppLogic::Current()` is nullptr. 2. `enum LaunchMode` was moved from TerminalApp to TSM 3. `AzureConnectionType` and `TelnetConnectionType` were moved from the profile generators to their respective TerminalConnections 4. CascadiaSettings' `SettingsPath` and `DefaultSettingsPath` are exposed as `hstring` instead of `std::filesystem::path` 5. `Command::ExpandCommands()` was exposed via the IDL - This required some of the warnings to be saved to an `IVector` instead of `std::vector`, among some other small changes. 6. The localization resources had to be split into two halves. - Resource file linked in init.cpp. Verified at runtime thanks to the StaticResourceLoader. 7. Added constructors to some `ActionArgs` 8. Utils.h/cpp were moved to `cascadia/inc`. `JsonKey()` was moved to `JsonUtils`. Both TermApp and TSM need access to Utils.h/cpp. A large amount of work includes moving to the new namespace (`TerminalApp` --> `Microsoft::Terminal::Settings::Model`). Fixing the tests had its own complications. Testing required us to split up TSM into a DLL and LIB, similar to TermApp. Discussion on creating a non-local test variant can be found in #7743. Closes #885
114 lines
3.8 KiB
C++
114 lines
3.8 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#include "pch.h"
|
|
#include "KeyMapping.h"
|
|
#include "KeyChordSerialization.h"
|
|
|
|
#include "KeyMapping.g.cpp"
|
|
|
|
using namespace winrt::Microsoft::Terminal::Settings::Model;
|
|
using namespace winrt::Microsoft::Terminal::TerminalControl;
|
|
|
|
namespace winrt::Microsoft::Terminal::Settings::Model::implementation
|
|
{
|
|
Microsoft::Terminal::Settings::Model::ActionAndArgs KeyMapping::TryLookup(KeyChord const& chord) const
|
|
{
|
|
const auto result = _keyShortcuts.find(chord);
|
|
if (result != _keyShortcuts.end())
|
|
{
|
|
return result->second;
|
|
}
|
|
return nullptr;
|
|
}
|
|
|
|
uint64_t KeyMapping::Size() const
|
|
{
|
|
return _keyShortcuts.size();
|
|
}
|
|
|
|
void KeyMapping::SetKeyBinding(const Microsoft::Terminal::Settings::Model::ActionAndArgs& actionAndArgs,
|
|
const KeyChord& chord)
|
|
{
|
|
_keyShortcuts[chord] = actionAndArgs;
|
|
}
|
|
|
|
// Method Description:
|
|
// - Remove the action that's bound to a particular KeyChord.
|
|
// Arguments:
|
|
// - chord: the keystroke to remove the action for.
|
|
// Return Value:
|
|
// - <none>
|
|
void KeyMapping::ClearKeyBinding(const KeyChord& chord)
|
|
{
|
|
_keyShortcuts.erase(chord);
|
|
}
|
|
|
|
KeyChord KeyMapping::GetKeyBindingForAction(Microsoft::Terminal::Settings::Model::ShortcutAction const& action)
|
|
{
|
|
for (auto& kv : _keyShortcuts)
|
|
{
|
|
if (kv.second.Action() == action)
|
|
{
|
|
return kv.first;
|
|
}
|
|
}
|
|
return { nullptr };
|
|
}
|
|
|
|
// Method Description:
|
|
// - Lookup the keychord bound to a particular combination of ShortcutAction
|
|
// and IActionArgs. This enables searching no only for the binding of a
|
|
// particular ShortcutAction, but also a particular set of values for
|
|
// arguments to that action.
|
|
// Arguments:
|
|
// - actionAndArgs: The ActionAndArgs to lookup the keybinding for.
|
|
// Return Value:
|
|
// - The bound keychord, if this ActionAndArgs is bound to a key, otherwise nullptr.
|
|
KeyChord KeyMapping::GetKeyBindingForActionWithArgs(Microsoft::Terminal::Settings::Model::ActionAndArgs const& actionAndArgs)
|
|
{
|
|
if (actionAndArgs == nullptr)
|
|
{
|
|
return { nullptr };
|
|
}
|
|
|
|
for (auto& kv : _keyShortcuts)
|
|
{
|
|
const auto action = kv.second.Action();
|
|
const auto args = kv.second.Args();
|
|
const auto actionMatched = action == actionAndArgs.Action();
|
|
const auto argsMatched = args ? args.Equals(actionAndArgs.Args()) : args == actionAndArgs.Args();
|
|
if (actionMatched && argsMatched)
|
|
{
|
|
return kv.first;
|
|
}
|
|
}
|
|
return { nullptr };
|
|
}
|
|
|
|
// Method Description:
|
|
// - Takes the KeyModifier flags from Terminal and maps them to the WinRT types which are used by XAML
|
|
// Return Value:
|
|
// - a Windows::System::VirtualKeyModifiers object with the flags of which modifiers used.
|
|
Windows::System::VirtualKeyModifiers KeyMapping::ConvertVKModifiers(KeyModifiers modifiers)
|
|
{
|
|
Windows::System::VirtualKeyModifiers keyModifiers = Windows::System::VirtualKeyModifiers::None;
|
|
|
|
if (WI_IsFlagSet(modifiers, KeyModifiers::Ctrl))
|
|
{
|
|
keyModifiers |= Windows::System::VirtualKeyModifiers::Control;
|
|
}
|
|
if (WI_IsFlagSet(modifiers, KeyModifiers::Shift))
|
|
{
|
|
keyModifiers |= Windows::System::VirtualKeyModifiers::Shift;
|
|
}
|
|
if (WI_IsFlagSet(modifiers, KeyModifiers::Alt))
|
|
{
|
|
// note: Menu is the Alt VK_MENU
|
|
keyModifiers |= Windows::System::VirtualKeyModifiers::Menu;
|
|
}
|
|
|
|
return keyModifiers;
|
|
}
|
|
}
|