Teach CommandPalette model to natively support tabs and command lines (…

…#8420) First step towards #8415: * Introduce `PaletteItem` and derive from it to provide native support for tabs and command lines (`ActionPaletteItem` / `TabPaletteItem`, `CommandLinePaltteItem`) * Remove business logic behind PaletteItem from palette (aka dispatch commands and preview tabs externally)
microsoft · Dec 10, 2020 · 89d82ff · 89d82ff
1 parent e1a8657
commit 89d82ff
Show file tree

Hide file tree

Showing 31 changed files with 585 additions and 327 deletions.
diff --git a/src/cascadia/LocalTests_TerminalApp/FilteredCommandTests.cpp b/src/cascadia/LocalTests_TerminalApp/FilteredCommandTests.cpp
diff --git a/src/cascadia/LocalTests_TerminalApp/TabTests.cpp b/src/cascadia/LocalTests_TerminalApp/TabTests.cpp
@@ -865,14 +865,14 @@ namespace TerminalAppLocalTests
             page->_OpenNewTab(newTerminalArgs);
             page->_OpenNewTab(newTerminalArgs);
         });
-        VERIFY_ARE_EQUAL(4u, page->_mruTabActions.Size());
+        VERIFY_ARE_EQUAL(4u, page->_mruTabs.Size());
 
         Log::Comment(L"give alphabetical names to all switch tab actions");
         RunOnUIThread([&page]() {
-            page->_tabs.GetAt(0).SwitchToTabCommand().Name(L"a");
-            page->_tabs.GetAt(1).SwitchToTabCommand().Name(L"b");
-            page->_tabs.GetAt(2).SwitchToTabCommand().Name(L"c");
-            page->_tabs.GetAt(3).SwitchToTabCommand().Name(L"d");
+            page->_GetTerminalTabImpl(page->_tabs.GetAt(0))->Title(L"a");
+            page->_GetTerminalTabImpl(page->_tabs.GetAt(1))->Title(L"b");
+            page->_GetTerminalTabImpl(page->_tabs.GetAt(2))->Title(L"c");
+            page->_GetTerminalTabImpl(page->_tabs.GetAt(3))->Title(L"d");
         });
 
         Log::Comment(L"Change the tab switch order to MRU switching");
@@ -888,11 +888,11 @@ namespace TerminalAppLocalTests
             page->_UpdatedSelectedTab(3);
         });
 
-        VERIFY_ARE_EQUAL(4u, page->_mruTabActions.Size());
-        VERIFY_ARE_EQUAL(L"d", page->_mruTabActions.GetAt(0).Name());
-        VERIFY_ARE_EQUAL(L"c", page->_mruTabActions.GetAt(1).Name());
-        VERIFY_ARE_EQUAL(L"b", page->_mruTabActions.GetAt(2).Name());
-        VERIFY_ARE_EQUAL(L"a", page->_mruTabActions.GetAt(3).Name());
+        VERIFY_ARE_EQUAL(4u, page->_mruTabs.Size());
+        VERIFY_ARE_EQUAL(L"d", page->_mruTabs.GetAt(0).Title());
+        VERIFY_ARE_EQUAL(L"c", page->_mruTabs.GetAt(1).Title());
+        VERIFY_ARE_EQUAL(L"b", page->_mruTabs.GetAt(2).Title());
+        VERIFY_ARE_EQUAL(L"a", page->_mruTabs.GetAt(3).Title());
 
         Log::Comment(L"Switch to the next MRU tab, which is the third tab");
         RunOnUIThread([&page]() {
@@ -906,9 +906,9 @@ namespace TerminalAppLocalTests
 
         Log::Comment(L"Verify command palette preserves MRU order of tabs");
         VERIFY_ARE_EQUAL(4u, palette->_filteredActions.Size());
-        VERIFY_ARE_EQUAL(L"d", palette->_filteredActions.GetAt(0).Command().Name());
-        VERIFY_ARE_EQUAL(L"c", palette->_filteredActions.GetAt(1).Command().Name());
-        VERIFY_ARE_EQUAL(L"b", palette->_filteredActions.GetAt(2).Command().Name());
-        VERIFY_ARE_EQUAL(L"a", palette->_filteredActions.GetAt(3).Command().Name());
+        VERIFY_ARE_EQUAL(L"d", palette->_filteredActions.GetAt(0).Item().Name());
+        VERIFY_ARE_EQUAL(L"c", palette->_filteredActions.GetAt(1).Item().Name());
+        VERIFY_ARE_EQUAL(L"b", palette->_filteredActions.GetAt(2).Item().Name());
+        VERIFY_ARE_EQUAL(L"a", palette->_filteredActions.GetAt(3).Item().Name());
     }
 }
diff --git a/src/cascadia/TerminalApp/ActionPaletteItem.cpp b/src/cascadia/TerminalApp/ActionPaletteItem.cpp
@@ -0,0 +1,50 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+#include "pch.h"
+#include "ActionPaletteItem.h"
+#include <LibraryResources.h>
+
+#include "ActionPaletteItem.g.cpp"
+
+using namespace winrt;
+using namespace winrt::TerminalApp;
+using namespace winrt::Windows::UI::Core;
+using namespace winrt::Windows::UI::Xaml;
+using namespace winrt::Windows::System;
+using namespace winrt::Windows::Foundation;
+using namespace winrt::Windows::Foundation::Collections;
+using namespace winrt::Microsoft::Terminal::Settings::Model;
+
+namespace winrt::TerminalApp::implementation
+{
+    ActionPaletteItem::ActionPaletteItem(Microsoft::Terminal::Settings::Model::Command const& command) :
+        _Command(command)
+    {
+        Name(command.Name());
+        KeyChordText(command.KeyChordText());
+        Icon(command.Icon());
+
+        _commandChangedRevoker = command.PropertyChanged(winrt::auto_revoke, [weakThis{ get_weak() }](auto& sender, auto& e) {
+            auto item{ weakThis.get() };
+            auto senderCommand{ sender.try_as<Microsoft::Terminal::Settings::Model::Command>() };
+
+            if (item && senderCommand)
+            {
+                auto changedProperty = e.PropertyName();
+                if (changedProperty == L"Name")
+                {
+                    item->Name(senderCommand.Name());
+                }
+                else if (changedProperty == L"KeyChordText")
+                {
+                    item->KeyChordText(senderCommand.KeyChordText());
+                }
+                else if (changedProperty == L"Icon")
+                {
+                    item->Icon(senderCommand.Icon());
+                }
+            }
+        });
+    }
+}
diff --git a/src/cascadia/TerminalApp/ActionPaletteItem.h b/src/cascadia/TerminalApp/ActionPaletteItem.h
@@ -0,0 +1,27 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+#pragma once
+
+#include "PaletteItem.h"
+#include "ActionPaletteItem.g.h"
+#include "inc/cppwinrt_utils.h"
+
+namespace winrt::TerminalApp::implementation
+{
+    struct ActionPaletteItem : ActionPaletteItemT<ActionPaletteItem, PaletteItem>
+    {
+        ActionPaletteItem() = default;
+        ActionPaletteItem(Microsoft::Terminal::Settings::Model::Command const& command);
+
+        GETSET_PROPERTY(Microsoft::Terminal::Settings::Model::Command, Command, nullptr);
+
+    private:
+        Windows::UI::Xaml::Data::INotifyPropertyChanged::PropertyChanged_revoker _commandChangedRevoker;
+    };
+}
+
+namespace winrt::TerminalApp::factory_implementation
+{
+    BASIC_FACTORY(ActionPaletteItem);
+}
diff --git a/src/cascadia/TerminalApp/ActionPaletteItem.idl b/src/cascadia/TerminalApp/ActionPaletteItem.idl
@@ -0,0 +1,14 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import "PaletteItem.idl";
+
+namespace TerminalApp
+{
+    [default_interface] runtimeclass ActionPaletteItem : PaletteItem
+    {
+        ActionPaletteItem(Microsoft.Terminal.Settings.Model.Command command);
+
+        Microsoft.Terminal.Settings.Model.Command Command { get; };
+    }
+}
diff --git a/src/cascadia/TerminalApp/AppActionHandlers.cpp b/src/cascadia/TerminalApp/AppActionHandlers.cpp
@@ -536,7 +536,7 @@ namespace winrt::TerminalApp::implementation
                                             const ActionEventArgs& args)
     {
         // Tab search is always in-order.
-        _UpdatePaletteWithInOrderTabs();
+        CommandPalette().SetTabs(_tabs, true);
 
         auto opt = _GetFocusedTabIndex();
         uint32_t startIdx = opt.value_or(0);

diff --git a/src/cascadia/TerminalApp/CommandLinePaletteItem.cpp b/src/cascadia/TerminalApp/CommandLinePaletteItem.cpp
@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+#include "pch.h"
+#include "CommandLinePaletteItem.h"
+#include <LibraryResources.h>
+
+#include "CommandLinePaletteItem.g.cpp"
+
+using namespace winrt;
+using namespace winrt::TerminalApp;
+using namespace winrt::Windows::UI::Core;
+using namespace winrt::Windows::UI::Xaml;
+using namespace winrt::Windows::System;
+using namespace winrt::Windows::Foundation;
+using namespace winrt::Windows::Foundation::Collections;
+using namespace winrt::Microsoft::Terminal::Settings::Model;
+
+namespace winrt::TerminalApp::implementation
+{
+    CommandLinePaletteItem::CommandLinePaletteItem(winrt::hstring const& commandLine) :
+        _CommandLine(commandLine)
+    {
+        Name(commandLine);
+    }
+}
diff --git a/src/cascadia/TerminalApp/CommandLinePaletteItem.h b/src/cascadia/TerminalApp/CommandLinePaletteItem.h
@@ -0,0 +1,24 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+#pragma once
+
+#include "PaletteItem.h"
+#include "CommandLinePaletteItem.g.h"
+#include "inc/cppwinrt_utils.h"
+
+namespace winrt::TerminalApp::implementation
+{
+    struct CommandLinePaletteItem : CommandLinePaletteItemT<CommandLinePaletteItem, PaletteItem>
+    {
+        CommandLinePaletteItem() = default;
+        CommandLinePaletteItem(winrt::hstring const& commandLine);
+
+        GETSET_PROPERTY(winrt::hstring, CommandLine);
+    };
+}
+
+namespace winrt::TerminalApp::factory_implementation
+{
+    BASIC_FACTORY(CommandLinePaletteItem);
+}
diff --git a/src/cascadia/TerminalApp/CommandLinePaletteItem.idl b/src/cascadia/TerminalApp/CommandLinePaletteItem.idl
@@ -0,0 +1,12 @@
+import "PaletteItem.idl";
+import "TabBase.idl";
+
+namespace TerminalApp
+{
+    [default_interface] runtimeclass CommandLinePaletteItem : PaletteItem
+    {
+        CommandLinePaletteItem(String commandLine);
+
+        String CommandLine { get; };
+    }
+}