798 lines
39 KiB
C++
798 lines
39 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#include "pch.h"
|
|
|
|
#include "../TerminalSettingsModel/ColorScheme.h"
|
|
#include "../TerminalSettingsModel/CascadiaSettings.h"
|
|
#include "../TerminalSettingsModel/ActionMap.h"
|
|
#include "JsonTestClass.h"
|
|
#include "TestUtils.h"
|
|
|
|
using namespace Microsoft::Console;
|
|
using namespace winrt::Microsoft::Terminal::Settings::Model;
|
|
using namespace winrt::Microsoft::Terminal::Control;
|
|
using namespace WEX::Logging;
|
|
using namespace WEX::TestExecution;
|
|
using namespace WEX::Common;
|
|
using VirtualKeyModifiers = winrt::Windows::System::VirtualKeyModifiers;
|
|
|
|
namespace SettingsModelLocalTests
|
|
{
|
|
// TODO:microsoft/terminal#3838:
|
|
// Unfortunately, these tests _WILL NOT_ work in our CI. We're waiting for
|
|
// an updated TAEF that will let us install framework packages when the test
|
|
// package is deployed. Until then, these tests won't deploy in CI.
|
|
|
|
class KeyBindingsTests : public JsonTestClass
|
|
{
|
|
// Use a custom AppxManifest to ensure that we can activate winrt types
|
|
// from our test. This property will tell taef to manually use this as
|
|
// the AppxManifest for this test class.
|
|
// This does not yet work for anything XAML-y. See TabTests.cpp for more
|
|
// details on that.
|
|
BEGIN_TEST_CLASS(KeyBindingsTests)
|
|
TEST_CLASS_PROPERTY(L"RunAs", L"UAP")
|
|
TEST_CLASS_PROPERTY(L"UAP:AppXManifest", L"TestHostAppXManifest.xml")
|
|
END_TEST_CLASS()
|
|
|
|
TEST_METHOD(KeyChords);
|
|
TEST_METHOD(ManyKeysSameAction);
|
|
TEST_METHOD(LayerKeybindings);
|
|
TEST_METHOD(UnbindKeybindings);
|
|
|
|
TEST_METHOD(LayerScancodeKeybindings);
|
|
|
|
TEST_METHOD(TestExplicitUnbind);
|
|
|
|
TEST_METHOD(TestArbitraryArgs);
|
|
TEST_METHOD(TestSplitPaneArgs);
|
|
|
|
TEST_METHOD(TestStringOverload);
|
|
|
|
TEST_METHOD(TestSetTabColorArgs);
|
|
|
|
TEST_METHOD(TestScrollArgs);
|
|
|
|
TEST_METHOD(TestToggleCommandPaletteArgs);
|
|
TEST_METHOD(TestMoveTabArgs);
|
|
|
|
TEST_METHOD(TestGetKeyBindingForAction);
|
|
TEST_METHOD(KeybindingsWithoutVkey);
|
|
};
|
|
|
|
void KeyBindingsTests::KeyChords()
|
|
{
|
|
struct testCase
|
|
{
|
|
VirtualKeyModifiers modifiers;
|
|
int32_t vkey;
|
|
int32_t scanCode;
|
|
std::wstring_view expected;
|
|
};
|
|
|
|
static constexpr std::array testCases{
|
|
testCase{
|
|
VirtualKeyModifiers::None,
|
|
'A',
|
|
0,
|
|
L"a",
|
|
},
|
|
testCase{
|
|
VirtualKeyModifiers::Control,
|
|
'A',
|
|
0,
|
|
L"ctrl+a",
|
|
},
|
|
testCase{
|
|
VirtualKeyModifiers::Control | VirtualKeyModifiers::Shift,
|
|
VK_OEM_PLUS,
|
|
0,
|
|
L"ctrl+shift+plus",
|
|
},
|
|
testCase{
|
|
VirtualKeyModifiers::Control | VirtualKeyModifiers::Menu | VirtualKeyModifiers::Shift | VirtualKeyModifiers::Windows,
|
|
255,
|
|
0,
|
|
L"win+ctrl+alt+shift+vk(255)",
|
|
},
|
|
testCase{
|
|
VirtualKeyModifiers::Control | VirtualKeyModifiers::Menu | VirtualKeyModifiers::Shift | VirtualKeyModifiers::Windows,
|
|
0,
|
|
123,
|
|
L"win+ctrl+alt+shift+sc(123)",
|
|
},
|
|
};
|
|
|
|
for (const auto& tc : testCases)
|
|
{
|
|
Log::Comment(NoThrowString().Format(L"Testing case:\"%s\"", tc.expected.data()));
|
|
|
|
const auto actualString = KeyChordSerialization::ToString({ tc.modifiers, tc.vkey, tc.scanCode });
|
|
VERIFY_ARE_EQUAL(tc.expected, actualString);
|
|
|
|
auto expectedVkey = tc.vkey;
|
|
if (!expectedVkey)
|
|
{
|
|
expectedVkey = MapVirtualKeyW(tc.scanCode, MAPVK_VSC_TO_VK_EX);
|
|
}
|
|
|
|
const auto actualKeyChord = KeyChordSerialization::FromString(actualString);
|
|
VERIFY_ARE_EQUAL(tc.modifiers, actualKeyChord.Modifiers());
|
|
VERIFY_ARE_EQUAL(expectedVkey, actualKeyChord.Vkey());
|
|
VERIFY_ARE_EQUAL(tc.scanCode, actualKeyChord.ScanCode());
|
|
}
|
|
}
|
|
|
|
void KeyBindingsTests::ManyKeysSameAction()
|
|
{
|
|
const std::string bindings0String{ R"([ { "command": "copy", "keys": ["ctrl+c"] } ])" };
|
|
const std::string bindings1String{ R"([ { "command": "copy", "keys": ["enter"] } ])" };
|
|
const std::string bindings2String{ R"([
|
|
{ "command": "paste", "keys": ["ctrl+v"] },
|
|
{ "command": "paste", "keys": ["ctrl+shift+v"] }
|
|
])" };
|
|
|
|
const auto bindings0Json = VerifyParseSucceeded(bindings0String);
|
|
const auto bindings1Json = VerifyParseSucceeded(bindings1String);
|
|
const auto bindings2Json = VerifyParseSucceeded(bindings2String);
|
|
|
|
auto actionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_ARE_EQUAL(0u, actionMap->_KeyMap.size());
|
|
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
|
|
actionMap->LayerJson(bindings1Json);
|
|
VERIFY_ARE_EQUAL(2u, actionMap->_KeyMap.size());
|
|
|
|
actionMap->LayerJson(bindings2Json);
|
|
VERIFY_ARE_EQUAL(4u, actionMap->_KeyMap.size());
|
|
}
|
|
|
|
void KeyBindingsTests::LayerKeybindings()
|
|
{
|
|
const std::string bindings0String{ R"([ { "command": "copy", "keys": ["ctrl+c"] } ])" };
|
|
const std::string bindings1String{ R"([ { "command": "paste", "keys": ["ctrl+c"] } ])" };
|
|
const std::string bindings2String{ R"([ { "command": "copy", "keys": ["enter"] } ])" };
|
|
|
|
const auto bindings0Json = VerifyParseSucceeded(bindings0String);
|
|
const auto bindings1Json = VerifyParseSucceeded(bindings1String);
|
|
const auto bindings2Json = VerifyParseSucceeded(bindings2String);
|
|
|
|
auto actionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_ARE_EQUAL(0u, actionMap->_KeyMap.size());
|
|
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
|
|
actionMap->LayerJson(bindings1Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
|
|
actionMap->LayerJson(bindings2Json);
|
|
VERIFY_ARE_EQUAL(2u, actionMap->_KeyMap.size());
|
|
}
|
|
|
|
void KeyBindingsTests::UnbindKeybindings()
|
|
{
|
|
const std::string bindings0String{ R"([ { "command": "copy", "keys": ["ctrl+c"] } ])" };
|
|
const std::string bindings1String{ R"([ { "command": "paste", "keys": ["ctrl+c"] } ])" };
|
|
const std::string bindings2String{ R"([ { "command": "unbound", "keys": ["ctrl+c"] } ])" };
|
|
const std::string bindings3String{ R"([ { "command": null, "keys": ["ctrl+c"] } ])" };
|
|
const std::string bindings4String{ R"([ { "command": "garbage", "keys": ["ctrl+c"] } ])" };
|
|
const std::string bindings5String{ R"([ { "command": 5, "keys": ["ctrl+c"] } ])" };
|
|
|
|
const auto bindings0Json = VerifyParseSucceeded(bindings0String);
|
|
const auto bindings1Json = VerifyParseSucceeded(bindings1String);
|
|
const auto bindings2Json = VerifyParseSucceeded(bindings2String);
|
|
const auto bindings3Json = VerifyParseSucceeded(bindings3String);
|
|
const auto bindings4Json = VerifyParseSucceeded(bindings4String);
|
|
const auto bindings5Json = VerifyParseSucceeded(bindings5String);
|
|
|
|
auto actionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_ARE_EQUAL(0u, actionMap->_KeyMap.size());
|
|
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
|
|
actionMap->LayerJson(bindings1Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Try unbinding a key using `\"unbound\"` to unbind the key"));
|
|
actionMap->LayerJson(bindings2Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
VERIFY_IS_NULL(actionMap->GetActionByKeyChord({ VirtualKeyModifiers::Control, static_cast<int32_t>('C'), 0 }));
|
|
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Try unbinding a key using `null` to unbind the key"));
|
|
// First add back a good binding
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
// Then try layering in the bad setting
|
|
actionMap->LayerJson(bindings3Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
VERIFY_IS_NULL(actionMap->GetActionByKeyChord({ VirtualKeyModifiers::Control, static_cast<int32_t>('C'), 0 }));
|
|
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Try unbinding a key using an unrecognized command to unbind the key"));
|
|
// First add back a good binding
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
// Then try layering in the bad setting
|
|
actionMap->LayerJson(bindings4Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
VERIFY_IS_NULL(actionMap->GetActionByKeyChord({ VirtualKeyModifiers::Control, static_cast<int32_t>('C'), 0 }));
|
|
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Try unbinding a key using a straight up invalid value to unbind the key"));
|
|
// First add back a good binding
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
// Then try layering in the bad setting
|
|
actionMap->LayerJson(bindings5Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
VERIFY_IS_NULL(actionMap->GetActionByKeyChord({ VirtualKeyModifiers::Control, static_cast<int32_t>('C'), 0 }));
|
|
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Try unbinding a key that wasn't bound at all"));
|
|
actionMap->LayerJson(bindings2Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
VERIFY_IS_NULL(actionMap->GetActionByKeyChord({ VirtualKeyModifiers::Control, static_cast<int32_t>('C'), 0 }));
|
|
}
|
|
|
|
void KeyBindingsTests::TestExplicitUnbind()
|
|
{
|
|
const std::string bindings0String{ R"([ { "command": "copy", "keys": ["ctrl+c"] } ])" };
|
|
const std::string bindings1String{ R"([ { "command": "unbound", "keys": ["ctrl+c"] } ])" };
|
|
const std::string bindings2String{ R"([ { "command": "copy", "keys": ["ctrl+c"] } ])" };
|
|
|
|
const auto bindings0Json = VerifyParseSucceeded(bindings0String);
|
|
const auto bindings1Json = VerifyParseSucceeded(bindings1String);
|
|
const auto bindings2Json = VerifyParseSucceeded(bindings2String);
|
|
|
|
const KeyChord keyChord{ VirtualKeyModifiers::Control, static_cast<int32_t>('C'), 0 };
|
|
|
|
auto actionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_IS_FALSE(actionMap->IsKeyChordExplicitlyUnbound(keyChord));
|
|
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_IS_FALSE(actionMap->IsKeyChordExplicitlyUnbound(keyChord));
|
|
|
|
actionMap->LayerJson(bindings1Json);
|
|
VERIFY_IS_TRUE(actionMap->IsKeyChordExplicitlyUnbound(keyChord));
|
|
|
|
actionMap->LayerJson(bindings2Json);
|
|
VERIFY_IS_FALSE(actionMap->IsKeyChordExplicitlyUnbound(keyChord));
|
|
}
|
|
|
|
void KeyBindingsTests::TestArbitraryArgs()
|
|
{
|
|
const std::string bindings0String{ R"([
|
|
{ "command": "copy", "keys": ["ctrl+c"] },
|
|
{ "command": { "action": "copy", "singleLine": false }, "keys": ["ctrl+shift+c"] },
|
|
{ "command": { "action": "copy", "singleLine": true }, "keys": ["alt+shift+c"] },
|
|
|
|
{ "command": "newTab", "keys": ["ctrl+t"] },
|
|
{ "command": { "action": "newTab", "index": 0 }, "keys": ["ctrl+shift+t"] },
|
|
{ "command": { "action": "newTab", "index": 11 }, "keys": ["ctrl+shift+y"] },
|
|
|
|
{ "command": { "action": "copy", "madeUpBool": true }, "keys": ["ctrl+b"] },
|
|
{ "command": { "action": "copy" }, "keys": ["ctrl+shift+b"] },
|
|
|
|
{ "command": { "action": "adjustFontSize", "delta": 1 }, "keys": ["ctrl+f"] },
|
|
{ "command": { "action": "adjustFontSize", "delta": -1 }, "keys": ["ctrl+g"] }
|
|
|
|
])" };
|
|
|
|
const auto bindings0Json = VerifyParseSucceeded(bindings0String);
|
|
|
|
auto actionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_ARE_EQUAL(0u, actionMap->_KeyMap.size());
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_ARE_EQUAL(10u, actionMap->_KeyMap.size());
|
|
|
|
{
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Verify that `copy` without args parses as Copy(SingleLine=false)"));
|
|
KeyChord kc{ true, false, false, false, static_cast<int32_t>('C'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
const auto& realArgs = actionAndArgs.Args().as<CopyTextArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_FALSE(realArgs.SingleLine());
|
|
}
|
|
|
|
{
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Verify that `copy` with args parses them correctly"));
|
|
KeyChord kc{ true, false, true, false, static_cast<int32_t>('C'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
const auto& realArgs = actionAndArgs.Args().as<CopyTextArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_FALSE(realArgs.SingleLine());
|
|
}
|
|
|
|
{
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Verify that `copy` with args parses them correctly"));
|
|
KeyChord kc{ false, true, true, false, static_cast<int32_t>('C'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
const auto& realArgs = actionAndArgs.Args().as<CopyTextArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_TRUE(realArgs.SingleLine());
|
|
}
|
|
|
|
{
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Verify that `newTab` without args parses as NewTab(Index=null)"));
|
|
KeyChord kc{ true, false, false, false, static_cast<int32_t>('T'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::NewTab, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<NewTabArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_NULL(realArgs.TerminalArgs().ProfileIndex());
|
|
}
|
|
{
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Verify that `newTab` parses args correctly"));
|
|
KeyChord kc{ true, false, true, false, static_cast<int32_t>('T'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::NewTab, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<NewTabArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs().ProfileIndex());
|
|
VERIFY_ARE_EQUAL(0, realArgs.TerminalArgs().ProfileIndex().Value());
|
|
}
|
|
{
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Verify that `newTab` with an index greater than the legacy "
|
|
L"args afforded parses correctly"));
|
|
KeyChord kc{ true, false, true, false, static_cast<int32_t>('Y'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::NewTab, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<NewTabArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs().ProfileIndex());
|
|
VERIFY_ARE_EQUAL(11, realArgs.TerminalArgs().ProfileIndex().Value());
|
|
}
|
|
|
|
{
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Verify that `copy` ignores args it doesn't understand"));
|
|
KeyChord kc{ true, false, true, false, static_cast<int32_t>('B'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::CopyText, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<CopyTextArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_FALSE(realArgs.SingleLine());
|
|
}
|
|
|
|
{
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Verify that `copy` null as it's `args` parses as the default option"));
|
|
KeyChord kc{ true, false, true, false, static_cast<int32_t>('B'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::CopyText, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<CopyTextArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_FALSE(realArgs.SingleLine());
|
|
}
|
|
|
|
{
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Verify that `adjustFontSize` with a positive delta parses args correctly"));
|
|
KeyChord kc{ true, false, false, false, static_cast<int32_t>('F'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::AdjustFontSize, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<AdjustFontSizeArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(1, realArgs.Delta());
|
|
}
|
|
|
|
{
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Verify that `adjustFontSize` with a negative delta parses args correctly"));
|
|
KeyChord kc{ true, false, false, false, static_cast<int32_t>('G'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::AdjustFontSize, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<AdjustFontSizeArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(-1, realArgs.Delta());
|
|
}
|
|
}
|
|
|
|
void KeyBindingsTests::TestSplitPaneArgs()
|
|
{
|
|
const std::string bindings0String{ R"([
|
|
{ "keys": ["ctrl+d"], "command": { "action": "splitPane", "split": "vertical" } },
|
|
{ "keys": ["ctrl+e"], "command": { "action": "splitPane", "split": "horizontal" } },
|
|
{ "keys": ["ctrl+g"], "command": { "action": "splitPane" } },
|
|
{ "keys": ["ctrl+h"], "command": { "action": "splitPane", "split": "auto" } }
|
|
])" };
|
|
|
|
const auto bindings0Json = VerifyParseSucceeded(bindings0String);
|
|
|
|
auto actionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_ARE_EQUAL(0u, actionMap->_KeyMap.size());
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_ARE_EQUAL(4u, actionMap->_KeyMap.size());
|
|
|
|
{
|
|
KeyChord kc{ true, false, false, false, static_cast<int32_t>('D'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<SplitPaneArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitDirection::Right, realArgs.SplitDirection());
|
|
}
|
|
{
|
|
KeyChord kc{ true, false, false, false, static_cast<int32_t>('E'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<SplitPaneArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitDirection::Down, realArgs.SplitDirection());
|
|
}
|
|
{
|
|
KeyChord kc{ true, false, false, false, static_cast<int32_t>('G'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<SplitPaneArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitDirection::Automatic, realArgs.SplitDirection());
|
|
}
|
|
{
|
|
KeyChord kc{ true, false, false, false, static_cast<int32_t>('H'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<SplitPaneArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitDirection::Automatic, realArgs.SplitDirection());
|
|
}
|
|
}
|
|
|
|
void KeyBindingsTests::TestSetTabColorArgs()
|
|
{
|
|
const std::string bindings0String{ R"([
|
|
{ "keys": ["ctrl+c"], "command": { "action": "setTabColor", "color": null } },
|
|
{ "keys": ["ctrl+d"], "command": { "action": "setTabColor", "color": "#123456" } },
|
|
{ "keys": ["ctrl+f"], "command": "setTabColor" },
|
|
])" };
|
|
|
|
const auto bindings0Json = VerifyParseSucceeded(bindings0String);
|
|
|
|
auto actionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_ARE_EQUAL(0u, actionMap->_KeyMap.size());
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_ARE_EQUAL(3u, actionMap->_KeyMap.size());
|
|
|
|
{
|
|
KeyChord kc{ true, false, false, false, static_cast<int32_t>('C'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SetTabColor, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<SetTabColorArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_NULL(realArgs.TabColor());
|
|
}
|
|
{
|
|
KeyChord kc{ true, false, false, false, static_cast<int32_t>('D'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SetTabColor, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<SetTabColorArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_NOT_NULL(realArgs.TabColor());
|
|
// Remember that COLORREFs are actually BBGGRR order, while the string is in #RRGGBB order
|
|
VERIFY_ARE_EQUAL(til::color(0x563412), til::color(realArgs.TabColor().Value()));
|
|
}
|
|
{
|
|
KeyChord kc{ true, false, false, false, static_cast<int32_t>('F'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SetTabColor, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<SetTabColorArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_NULL(realArgs.TabColor());
|
|
}
|
|
}
|
|
|
|
void KeyBindingsTests::TestStringOverload()
|
|
{
|
|
const std::string bindings0String{ R"([
|
|
{ "command": "copy", "keys": "ctrl+c" }
|
|
])" };
|
|
|
|
const auto bindings0Json = VerifyParseSucceeded(bindings0String);
|
|
|
|
auto actionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_ARE_EQUAL(0u, actionMap->_KeyMap.size());
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
|
|
{
|
|
KeyChord kc{ true, false, false, false, static_cast<int32_t>('C'), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
const auto& realArgs = actionAndArgs.Args().as<CopyTextArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_FALSE(realArgs.SingleLine());
|
|
}
|
|
}
|
|
|
|
void KeyBindingsTests::TestScrollArgs()
|
|
{
|
|
const std::string bindings0String{ R"([
|
|
{ "keys": ["up"], "command": "scrollUp" },
|
|
{ "keys": ["down"], "command": "scrollDown" },
|
|
{ "keys": ["ctrl+up"], "command": { "action": "scrollUp" } },
|
|
{ "keys": ["ctrl+down"], "command": { "action": "scrollDown" } },
|
|
{ "keys": ["ctrl+shift+up"], "command": { "action": "scrollUp", "rowsToScroll": 10 } },
|
|
{ "keys": ["ctrl+shift+down"], "command": { "action": "scrollDown", "rowsToScroll": 10 } }
|
|
])" };
|
|
|
|
const auto bindings0Json = VerifyParseSucceeded(bindings0String);
|
|
|
|
auto actionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_ARE_EQUAL(0u, actionMap->_KeyMap.size());
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_ARE_EQUAL(6u, actionMap->_KeyMap.size());
|
|
|
|
{
|
|
KeyChord kc{ false, false, false, false, static_cast<int32_t>(VK_UP), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::ScrollUp, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<ScrollUpArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_NULL(realArgs.RowsToScroll());
|
|
}
|
|
{
|
|
KeyChord kc{ false, false, false, false, static_cast<int32_t>(VK_DOWN), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::ScrollDown, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<ScrollDownArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_NULL(realArgs.RowsToScroll());
|
|
}
|
|
{
|
|
KeyChord kc{ true, false, false, false, static_cast<int32_t>(VK_UP), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::ScrollUp, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<ScrollUpArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_NULL(realArgs.RowsToScroll());
|
|
}
|
|
{
|
|
KeyChord kc{ true, false, false, false, static_cast<int32_t>(VK_DOWN), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::ScrollDown, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<ScrollDownArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_NULL(realArgs.RowsToScroll());
|
|
}
|
|
{
|
|
KeyChord kc{ true, false, true, false, static_cast<int32_t>(VK_UP), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::ScrollUp, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<ScrollUpArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_NOT_NULL(realArgs.RowsToScroll());
|
|
VERIFY_ARE_EQUAL(10u, realArgs.RowsToScroll().Value());
|
|
}
|
|
{
|
|
KeyChord kc{ true, false, true, false, static_cast<int32_t>(VK_DOWN), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::ScrollDown, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<ScrollDownArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_NOT_NULL(realArgs.RowsToScroll());
|
|
VERIFY_ARE_EQUAL(10u, realArgs.RowsToScroll().Value());
|
|
}
|
|
{
|
|
const std::string bindingsInvalidString{ R"([{ "keys": ["up"], "command": { "action": "scrollDown", "rowsToScroll": -1 } }])" };
|
|
const auto bindingsInvalidJson = VerifyParseSucceeded(bindingsInvalidString);
|
|
auto invalidActionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_ARE_EQUAL(0u, invalidActionMap->_KeyMap.size());
|
|
VERIFY_THROWS(invalidActionMap->LayerJson(bindingsInvalidJson);, std::exception);
|
|
}
|
|
}
|
|
|
|
void KeyBindingsTests::TestMoveTabArgs()
|
|
{
|
|
const std::string bindings0String{ R"([
|
|
{ "keys": ["up"], "command": { "action": "moveTab", "direction": "forward" } },
|
|
{ "keys": ["down"], "command": { "action": "moveTab", "direction": "backward" } }
|
|
])" };
|
|
|
|
const auto bindings0Json = VerifyParseSucceeded(bindings0String);
|
|
|
|
auto actionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_ARE_EQUAL(0u, actionMap->_KeyMap.size());
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_ARE_EQUAL(2u, actionMap->_KeyMap.size());
|
|
|
|
{
|
|
KeyChord kc{ false, false, false, false, static_cast<int32_t>(VK_UP), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::MoveTab, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<MoveTabArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(realArgs.Direction(), MoveTabDirection::Forward);
|
|
}
|
|
{
|
|
KeyChord kc{ false, false, false, false, static_cast<int32_t>(VK_DOWN), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::MoveTab, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<MoveTabArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(realArgs.Direction(), MoveTabDirection::Backward);
|
|
}
|
|
{
|
|
const std::string bindingsInvalidString{ R"([{ "keys": ["up"], "command": "moveTab" }])" };
|
|
auto actionMapNoArgs = winrt::make_self<implementation::ActionMap>();
|
|
actionMapNoArgs->LayerJson(bindingsInvalidString);
|
|
VERIFY_ARE_EQUAL(0u, actionMapNoArgs->_KeyMap.size());
|
|
}
|
|
{
|
|
const std::string bindingsInvalidString{ R"([{ "keys": ["up"], "command": { "action": "moveTab", "direction": "bad" } }])" };
|
|
const auto bindingsInvalidJson = VerifyParseSucceeded(bindingsInvalidString);
|
|
auto invalidActionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_ARE_EQUAL(0u, invalidActionMap->_KeyMap.size());
|
|
VERIFY_THROWS(invalidActionMap->LayerJson(bindingsInvalidJson);, std::exception);
|
|
}
|
|
}
|
|
|
|
void KeyBindingsTests::TestToggleCommandPaletteArgs()
|
|
{
|
|
const std::string bindings0String{ R"([
|
|
{ "keys": ["up"], "command": "commandPalette" },
|
|
{ "keys": ["ctrl+up"], "command": { "action": "commandPalette", "launchMode" : "action" } },
|
|
{ "keys": ["ctrl+shift+up"], "command": { "action": "commandPalette", "launchMode" : "commandLine" } }
|
|
])" };
|
|
|
|
const auto bindings0Json = VerifyParseSucceeded(bindings0String);
|
|
|
|
auto actionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_ARE_EQUAL(0u, actionMap->_KeyMap.size());
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_ARE_EQUAL(3u, actionMap->_KeyMap.size());
|
|
|
|
{
|
|
KeyChord kc{ false, false, false, false, static_cast<int32_t>(VK_UP), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::ToggleCommandPalette, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<ToggleCommandPaletteArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(realArgs.LaunchMode(), CommandPaletteLaunchMode::Action);
|
|
}
|
|
{
|
|
KeyChord kc{ true, false, false, false, static_cast<int32_t>(VK_UP), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::ToggleCommandPalette, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<ToggleCommandPaletteArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(realArgs.LaunchMode(), CommandPaletteLaunchMode::Action);
|
|
}
|
|
{
|
|
KeyChord kc{ true, false, true, false, static_cast<int32_t>(VK_UP), 0 };
|
|
auto actionAndArgs = ::TestUtils::GetActionAndArgs(*actionMap, kc);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::ToggleCommandPalette, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().as<ToggleCommandPaletteArgs>();
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(realArgs.LaunchMode(), CommandPaletteLaunchMode::CommandLine);
|
|
}
|
|
{
|
|
const std::string bindingsInvalidString{ R"([{ "keys": ["up"], "command": { "action": "commandPalette", "launchMode": "bad" } }])" };
|
|
const auto bindingsInvalidJson = VerifyParseSucceeded(bindingsInvalidString);
|
|
auto invalidActionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_ARE_EQUAL(0u, invalidActionMap->_KeyMap.size());
|
|
VERIFY_THROWS(invalidActionMap->LayerJson(bindingsInvalidJson);, std::exception);
|
|
}
|
|
}
|
|
|
|
void KeyBindingsTests::TestGetKeyBindingForAction()
|
|
{
|
|
const std::string bindings0String{ R"([ { "command": "closeWindow", "keys": "ctrl+a" } ])" };
|
|
const std::string bindings1String{ R"([ { "command": { "action": "copy", "singleLine": true }, "keys": "ctrl+b" } ])" };
|
|
const std::string bindings2String{ R"([ { "command": { "action": "newTab", "index": 0 }, "keys": "ctrl+c" } ])" };
|
|
const std::string bindings3String{ R"([ { "command": "commandPalette", "keys": "ctrl+shift+p" } ])" };
|
|
|
|
const auto bindings0Json = VerifyParseSucceeded(bindings0String);
|
|
const auto bindings1Json = VerifyParseSucceeded(bindings1String);
|
|
const auto bindings2Json = VerifyParseSucceeded(bindings2String);
|
|
const auto bindings3Json = VerifyParseSucceeded(bindings3String);
|
|
|
|
auto VerifyKeyChordEquality = [](const KeyChord& expected, const KeyChord& actual) {
|
|
if (expected)
|
|
{
|
|
VERIFY_IS_NOT_NULL(actual);
|
|
VERIFY_ARE_EQUAL(expected.Modifiers(), actual.Modifiers());
|
|
VERIFY_ARE_EQUAL(expected.Vkey(), actual.Vkey());
|
|
}
|
|
else
|
|
{
|
|
VERIFY_IS_NULL(actual);
|
|
}
|
|
};
|
|
|
|
auto actionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_ARE_EQUAL(0u, actionMap->_KeyMap.size());
|
|
|
|
{
|
|
Log::Comment(L"simple command: no args");
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
const auto& kbd{ actionMap->GetKeyBindingForAction(ShortcutAction::CloseWindow) };
|
|
VerifyKeyChordEquality({ VirtualKeyModifiers::Control, static_cast<int32_t>('A'), 0 }, kbd);
|
|
}
|
|
{
|
|
Log::Comment(L"command with args");
|
|
actionMap->LayerJson(bindings1Json);
|
|
VERIFY_ARE_EQUAL(2u, actionMap->_KeyMap.size());
|
|
|
|
auto args{ winrt::make_self<implementation::CopyTextArgs>() };
|
|
args->SingleLine(true);
|
|
|
|
const auto& kbd{ actionMap->GetKeyBindingForAction(ShortcutAction::CopyText, *args) };
|
|
VerifyKeyChordEquality({ VirtualKeyModifiers::Control, static_cast<int32_t>('B'), 0 }, kbd);
|
|
}
|
|
{
|
|
Log::Comment(L"command with new terminal args");
|
|
actionMap->LayerJson(bindings2Json);
|
|
VERIFY_ARE_EQUAL(3u, actionMap->_KeyMap.size());
|
|
|
|
auto newTerminalArgs{ winrt::make_self<implementation::NewTerminalArgs>() };
|
|
newTerminalArgs->ProfileIndex(0);
|
|
auto args{ winrt::make_self<implementation::NewTabArgs>(*newTerminalArgs) };
|
|
|
|
const auto& kbd{ actionMap->GetKeyBindingForAction(ShortcutAction::NewTab, *args) };
|
|
VerifyKeyChordEquality({ VirtualKeyModifiers::Control, static_cast<int32_t>('C'), 0 }, kbd);
|
|
}
|
|
{
|
|
Log::Comment(L"command with hidden args");
|
|
actionMap->LayerJson(bindings3Json);
|
|
VERIFY_ARE_EQUAL(4u, actionMap->_KeyMap.size());
|
|
|
|
const auto& kbd{ actionMap->GetKeyBindingForAction(ShortcutAction::ToggleCommandPalette) };
|
|
VerifyKeyChordEquality({ VirtualKeyModifiers::Control | VirtualKeyModifiers::Shift, static_cast<int32_t>('P'), 0 }, kbd);
|
|
}
|
|
}
|
|
|
|
void KeyBindingsTests::LayerScancodeKeybindings()
|
|
{
|
|
Log::Comment(L"Layering a keybinding with a character literal on top of"
|
|
L" an equivalent sc() key should replace it.");
|
|
|
|
// Wrap the first one in `R"!(...)!"` because it has `()` internally.
|
|
const std::string bindings0String{ R"!([ { "command": "quakeMode", "keys":"win+sc(41)" } ])!" };
|
|
const std::string bindings1String{ R"([ { "keys": "win+`", "command": { "action": "globalSummon", "monitor": "any" } } ])" };
|
|
const std::string bindings2String{ R"([ { "keys": "ctrl+shift+`", "command": { "action": "quakeMode" } } ])" };
|
|
|
|
const auto bindings0Json = VerifyParseSucceeded(bindings0String);
|
|
const auto bindings1Json = VerifyParseSucceeded(bindings1String);
|
|
const auto bindings2Json = VerifyParseSucceeded(bindings2String);
|
|
|
|
auto actionMap = winrt::make_self<implementation::ActionMap>();
|
|
VERIFY_ARE_EQUAL(0u, actionMap->_KeyMap.size());
|
|
|
|
actionMap->LayerJson(bindings0Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size());
|
|
|
|
actionMap->LayerJson(bindings1Json);
|
|
VERIFY_ARE_EQUAL(1u, actionMap->_KeyMap.size(), L"Layering the second action should replace the first one.");
|
|
|
|
actionMap->LayerJson(bindings2Json);
|
|
VERIFY_ARE_EQUAL(2u, actionMap->_KeyMap.size());
|
|
}
|
|
|
|
void KeyBindingsTests::KeybindingsWithoutVkey()
|
|
{
|
|
const auto json = VerifyParseSucceeded(R"!([{"command": "quakeMode", "keys":"shift+sc(255)"}])!");
|
|
|
|
const auto actionMap = winrt::make_self<implementation::ActionMap>();
|
|
actionMap->LayerJson(json);
|
|
|
|
const auto action = actionMap->GetActionByKeyChord({ VirtualKeyModifiers::Shift, 0, 255 });
|
|
VERIFY_IS_NOT_NULL(action);
|
|
}
|
|
}
|