2020-06-26 22:38:02 +02:00
|
|
|
// Copyright (c) Microsoft Corporation.
|
|
|
|
|
// Licensed under the MIT license.
|
|
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
|
|
#include "CommandPalette.g.h"
|
|
|
|
|
#include "../../cascadia/inc/cppwinrt_utils.h"
|
|
|
|
|
|
|
|
|
|
namespace winrt::TerminalApp::implementation
|
|
|
|
|
{
|
2020-08-11 16:03:12 +02:00
|
|
|
enum class CommandPaletteMode
|
|
|
|
|
{
|
|
|
|
|
ActionMode = 0,
|
2020-08-21 17:39:40 +02:00
|
|
|
TabSearchMode,
|
|
|
|
|
TabSwitchMode
|
2020-08-11 16:03:12 +02:00
|
|
|
};
|
|
|
|
|
|
2020-06-26 22:38:02 +02:00
|
|
|
struct CommandPalette : CommandPaletteT<CommandPalette>
|
|
|
|
|
{
|
|
|
|
|
CommandPalette();
|
|
|
|
|
|
|
|
|
|
Windows::Foundation::Collections::IObservableVector<TerminalApp::Command> FilteredActions();
|
2020-08-11 16:03:12 +02:00
|
|
|
|
|
|
|
|
void SetCommands(Windows::Foundation::Collections::IVector<TerminalApp::Command> const& actions);
|
2020-08-21 17:39:40 +02:00
|
|
|
void SetKeyBindings(Microsoft::Terminal::TerminalControl::IKeyBindings bindings);
|
|
|
|
|
|
2020-08-11 16:03:12 +02:00
|
|
|
void EnableCommandPaletteMode();
|
2020-06-26 22:38:02 +02:00
|
|
|
|
|
|
|
|
void SetDispatch(const winrt::TerminalApp::ShortcutActionDispatch& dispatch);
|
|
|
|
|
|
2020-08-21 17:39:40 +02:00
|
|
|
bool OnDirectKeyEvent(const uint32_t vkey, const uint8_t scanCode, const bool down);
|
|
|
|
|
|
|
|
|
|
void SelectNextItem(const bool moveDown);
|
|
|
|
|
|
2020-08-11 16:03:12 +02:00
|
|
|
// Tab Switcher
|
2020-08-21 17:39:40 +02:00
|
|
|
void EnableTabSwitcherMode(const bool searchMode, const uint32_t startIdx);
|
2020-08-11 16:03:12 +02:00
|
|
|
void OnTabsChanged(const Windows::Foundation::IInspectable& s, const Windows::Foundation::Collections::IVectorChangedEventArgs& e);
|
|
|
|
|
|
|
|
|
|
WINRT_CALLBACK(PropertyChanged, Windows::UI::Xaml::Data::PropertyChangedEventHandler);
|
|
|
|
|
OBSERVABLE_GETSET_PROPERTY(winrt::hstring, NoMatchesText, _PropertyChangedHandlers);
|
|
|
|
|
OBSERVABLE_GETSET_PROPERTY(winrt::hstring, SearchBoxText, _PropertyChangedHandlers);
|
|
|
|
|
OBSERVABLE_GETSET_PROPERTY(winrt::hstring, ControlName, _PropertyChangedHandlers);
|
2020-08-18 21:32:17 +02:00
|
|
|
OBSERVABLE_GETSET_PROPERTY(winrt::hstring, ParentCommandName, _PropertyChangedHandlers);
|
2020-08-11 16:03:12 +02:00
|
|
|
|
2020-06-26 22:38:02 +02:00
|
|
|
private:
|
|
|
|
|
friend struct CommandPaletteT<CommandPalette>; // for Xaml to bind events
|
|
|
|
|
|
Add support for iterable, nested commands (#6856)
## Summary of the Pull Request
This PR adds support for both _nested_ and _iterable_ commands in the Command palette.
* **Nested commands**: These are commands that include additional sub-commands. When the user selects on of these, the palette will update to only show the nested commands.
* **Iterable commands**: These are commands what allow the user to define only a single command, which is repeated once for every profile. (in the future, also repeated for color schemes, themes, etc.)
The above gif uses the following json:
```json
{
"name": "Split Pane...",
"commands": [
{
"iterateOn": "profiles",
"name": "Split with ${profile.name}...",
"commands": [
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "automatic" } },
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "vertical" } },
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "horizontal" } }
]
}
]
},
```
## References
## PR Checklist
* [x] Closes #3994
* [x] I work here
* [x] Tests added/passed
* [ ] Requires documentation to be updated - Sure does, but we'll finish polishing this first.
## Detailed Description of the Pull Request / Additional comments
We've now gotta keep the original json for a command around, so that once we know what all the profiles will be, we can expand the commands that need it.
We've also got to parse commands recursively, because they might have any number of child commands.
These together made the command parsing a _lot_ more complicated, but it feels good so far.
## Validation Steps Performed
* wrote a bunch of tests
* Played with it a bunch
2020-08-13 23:22:46 +02:00
|
|
|
Windows::Foundation::Collections::IVector<TerminalApp::Command> _allCommands{ nullptr };
|
|
|
|
|
Windows::Foundation::Collections::IVector<TerminalApp::Command> _currentNestedCommands{ nullptr };
|
2020-06-26 22:38:02 +02:00
|
|
|
Windows::Foundation::Collections::IObservableVector<TerminalApp::Command> _filteredActions{ nullptr };
|
Add support for iterable, nested commands (#6856)
## Summary of the Pull Request
This PR adds support for both _nested_ and _iterable_ commands in the Command palette.
* **Nested commands**: These are commands that include additional sub-commands. When the user selects on of these, the palette will update to only show the nested commands.
* **Iterable commands**: These are commands what allow the user to define only a single command, which is repeated once for every profile. (in the future, also repeated for color schemes, themes, etc.)
The above gif uses the following json:
```json
{
"name": "Split Pane...",
"commands": [
{
"iterateOn": "profiles",
"name": "Split with ${profile.name}...",
"commands": [
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "automatic" } },
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "vertical" } },
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "horizontal" } }
]
}
]
},
```
## References
## PR Checklist
* [x] Closes #3994
* [x] I work here
* [x] Tests added/passed
* [ ] Requires documentation to be updated - Sure does, but we'll finish polishing this first.
## Detailed Description of the Pull Request / Additional comments
We've now gotta keep the original json for a command around, so that once we know what all the profiles will be, we can expand the commands that need it.
We've also got to parse commands recursively, because they might have any number of child commands.
These together made the command parsing a _lot_ more complicated, but it feels good so far.
## Validation Steps Performed
* wrote a bunch of tests
* Played with it a bunch
2020-08-13 23:22:46 +02:00
|
|
|
Windows::Foundation::Collections::IVector<TerminalApp::Command> _nestedActionStack{ nullptr };
|
2020-08-11 16:03:12 +02:00
|
|
|
|
2020-06-26 22:38:02 +02:00
|
|
|
winrt::TerminalApp::ShortcutActionDispatch _dispatch;
|
|
|
|
|
|
2020-08-11 16:03:12 +02:00
|
|
|
Windows::Foundation::Collections::IVector<TerminalApp::Command> _commandsToFilter();
|
|
|
|
|
|
2020-06-26 22:38:02 +02:00
|
|
|
void _filterTextChanged(Windows::Foundation::IInspectable const& sender,
|
|
|
|
|
Windows::UI::Xaml::RoutedEventArgs const& args);
|
2020-08-11 16:03:12 +02:00
|
|
|
void _previewKeyDownHandler(Windows::Foundation::IInspectable const& sender,
|
|
|
|
|
Windows::UI::Xaml::Input::KeyRoutedEventArgs const& e);
|
2020-06-26 22:38:02 +02:00
|
|
|
void _keyDownHandler(Windows::Foundation::IInspectable const& sender,
|
|
|
|
|
Windows::UI::Xaml::Input::KeyRoutedEventArgs const& e);
|
2020-08-11 16:03:12 +02:00
|
|
|
void _keyUpHandler(Windows::Foundation::IInspectable const& sender,
|
|
|
|
|
Windows::UI::Xaml::Input::KeyRoutedEventArgs const& e);
|
2020-06-26 22:38:02 +02:00
|
|
|
|
Add support for iterable, nested commands (#6856)
## Summary of the Pull Request
This PR adds support for both _nested_ and _iterable_ commands in the Command palette.
* **Nested commands**: These are commands that include additional sub-commands. When the user selects on of these, the palette will update to only show the nested commands.
* **Iterable commands**: These are commands what allow the user to define only a single command, which is repeated once for every profile. (in the future, also repeated for color schemes, themes, etc.)
The above gif uses the following json:
```json
{
"name": "Split Pane...",
"commands": [
{
"iterateOn": "profiles",
"name": "Split with ${profile.name}...",
"commands": [
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "automatic" } },
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "vertical" } },
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "horizontal" } }
]
}
]
},
```
## References
## PR Checklist
* [x] Closes #3994
* [x] I work here
* [x] Tests added/passed
* [ ] Requires documentation to be updated - Sure does, but we'll finish polishing this first.
## Detailed Description of the Pull Request / Additional comments
We've now gotta keep the original json for a command around, so that once we know what all the profiles will be, we can expand the commands that need it.
We've also got to parse commands recursively, because they might have any number of child commands.
These together made the command parsing a _lot_ more complicated, but it feels good so far.
## Validation Steps Performed
* wrote a bunch of tests
* Played with it a bunch
2020-08-13 23:22:46 +02:00
|
|
|
void _updateUIForStackChange();
|
|
|
|
|
|
2020-06-26 22:38:02 +02:00
|
|
|
void _rootPointerPressed(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Input::PointerRoutedEventArgs const& e);
|
|
|
|
|
void _backdropPointerPressed(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Input::PointerRoutedEventArgs const& e);
|
|
|
|
|
|
|
|
|
|
void _listItemClicked(Windows::Foundation::IInspectable const& sender, Windows::UI::Xaml::Controls::ItemClickEventArgs const& e);
|
|
|
|
|
|
|
|
|
|
void _updateFilteredActions();
|
Add support for iterable, nested commands (#6856)
## Summary of the Pull Request
This PR adds support for both _nested_ and _iterable_ commands in the Command palette.
* **Nested commands**: These are commands that include additional sub-commands. When the user selects on of these, the palette will update to only show the nested commands.
* **Iterable commands**: These are commands what allow the user to define only a single command, which is repeated once for every profile. (in the future, also repeated for color schemes, themes, etc.)
The above gif uses the following json:
```json
{
"name": "Split Pane...",
"commands": [
{
"iterateOn": "profiles",
"name": "Split with ${profile.name}...",
"commands": [
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "automatic" } },
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "vertical" } },
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "horizontal" } }
]
}
]
},
```
## References
## PR Checklist
* [x] Closes #3994
* [x] I work here
* [x] Tests added/passed
* [ ] Requires documentation to be updated - Sure does, but we'll finish polishing this first.
## Detailed Description of the Pull Request / Additional comments
We've now gotta keep the original json for a command around, so that once we know what all the profiles will be, we can expand the commands that need it.
We've also got to parse commands recursively, because they might have any number of child commands.
These together made the command parsing a _lot_ more complicated, but it feels good so far.
## Validation Steps Performed
* wrote a bunch of tests
* Played with it a bunch
2020-08-13 23:22:46 +02:00
|
|
|
|
Smooth animation of command palette filtering (#6939)
The command palette is a ListView of commands. As you type into the
search box, commands are added or removed from the ListView. Currently,
each update is done by completely clearing the backing list, then adding
back any items that should be displayed. However, this defeats the
ListView's built-in animations: upon every keystroke, ListView displays
its list-clearing animation, then animates the insertion of every item
that wasn't deleted. This results in noticeable flickering.
This PR changes the update logic so that it updates the list using
(roughly) the minimum number of Insert and Remove calls, so the ListView
makes smoother transitions as you type.
I implemented it by keeping the existing code that builds the filtered
list, but I changed it to build into a scratch list. Then I grafted on
a generic delta algorithm to make the real list look like the scratch
list.
To verify the delta algorithm, I tested all 360,000 permutations of
pairs of up to 5 element lists in a toy C# app.
## Validation
I'm not sure if my screen capture tool really caught all the flickering
here, but the screencasts below should give a rough idea of the
difference. (All the flickering was becoming a nuisance while I was
testing out the HC changes.)
See the images in #6939 for more info.
Co-authored-by: Jeffrey Tippet <jtippet@microsoft.com>
2020-07-17 02:33:03 +02:00
|
|
|
std::vector<winrt::TerminalApp::Command> _collectFilteredActions();
|
Add support for iterable, nested commands (#6856)
## Summary of the Pull Request
This PR adds support for both _nested_ and _iterable_ commands in the Command palette.
* **Nested commands**: These are commands that include additional sub-commands. When the user selects on of these, the palette will update to only show the nested commands.
* **Iterable commands**: These are commands what allow the user to define only a single command, which is repeated once for every profile. (in the future, also repeated for color schemes, themes, etc.)
The above gif uses the following json:
```json
{
"name": "Split Pane...",
"commands": [
{
"iterateOn": "profiles",
"name": "Split with ${profile.name}...",
"commands": [
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "automatic" } },
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "vertical" } },
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "horizontal" } }
]
}
]
},
```
## References
## PR Checklist
* [x] Closes #3994
* [x] I work here
* [x] Tests added/passed
* [ ] Requires documentation to be updated - Sure does, but we'll finish polishing this first.
## Detailed Description of the Pull Request / Additional comments
We've now gotta keep the original json for a command around, so that once we know what all the profiles will be, we can expand the commands that need it.
We've also got to parse commands recursively, because they might have any number of child commands.
These together made the command parsing a _lot_ more complicated, but it feels good so far.
## Validation Steps Performed
* wrote a bunch of tests
* Played with it a bunch
2020-08-13 23:22:46 +02:00
|
|
|
|
2020-06-26 22:38:02 +02:00
|
|
|
static int _getWeight(const winrt::hstring& searchText, const winrt::hstring& name);
|
|
|
|
|
void _close();
|
2020-07-08 01:31:31 +02:00
|
|
|
|
2020-08-11 16:03:12 +02:00
|
|
|
CommandPaletteMode _currentMode;
|
|
|
|
|
void _switchToMode(CommandPaletteMode mode);
|
|
|
|
|
|
2020-08-21 17:39:40 +02:00
|
|
|
Microsoft::Terminal::TerminalControl::IKeyBindings _bindings;
|
|
|
|
|
|
2020-08-11 16:03:12 +02:00
|
|
|
// Tab Switcher
|
|
|
|
|
void GenerateCommandForTab(const uint32_t idx, bool inserted, winrt::TerminalApp::Tab& tab);
|
|
|
|
|
void UpdateTabIndices(const uint32_t startIdx);
|
|
|
|
|
Windows::Foundation::Collections::IVector<TerminalApp::Command> _allTabActions{ nullptr };
|
|
|
|
|
uint32_t _switcherStartIdx;
|
2020-08-21 17:39:40 +02:00
|
|
|
void _anchorKeyUpHandler();
|
2020-08-11 16:03:12 +02:00
|
|
|
|
|
|
|
|
winrt::Windows::UI::Xaml::Controls::ListView::SizeChanged_revoker _sizeChangedRevoker;
|
|
|
|
|
|
2020-07-08 01:31:31 +02:00
|
|
|
void _dispatchCommand(const TerminalApp::Command& command);
|
|
|
|
|
|
|
|
|
|
void _dismissPalette();
|
2020-06-26 22:38:02 +02:00
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
namespace winrt::TerminalApp::factory_implementation
|
|
|
|
|
{
|
|
|
|
|
BASIC_FACTORY(CommandPalette);
|
|
|
|
|
}
|
