Add Suggestions UI & experimental shell completions support

src/cascadia/TerminalApp/CommandPalette.cpp

@@ -225,24 +225,15 @@ namespace winrt::TerminalApp::implementation
     void CommandPalette::_selectedCommandChanged(const IInspectable& /*sender*/,
                                                  const Windows::UI::Xaml::RoutedEventArgs& /*args*/)
     {
-        const auto currentlyVisible{ Visibility() == Visibility::Visible };
-
         const auto selectedCommand = _filteredActionsView().SelectedItem();
         const auto filteredCommand{ selectedCommand.try_as<winrt::TerminalApp::FilteredCommand>() };
         if (_currentMode == CommandPaletteMode::TabSwitchMode)
         {
             _switchToTab(filteredCommand);
         }
-        else if (_currentMode == CommandPaletteMode::ActionMode &&
-                 currentlyVisible)
+        else if (_currentMode == CommandPaletteMode::ActionMode && filteredCommand != nullptr)
         {
-            // If we don't have a selected command, then end any previews we
-            // might currently be showing.
-            if (filteredCommand == nullptr)
-            {
-                _PreviewActionHandlers(*this, nullptr);
-            }
-            else if (const auto actionPaletteItem{ filteredCommand.Item().try_as<winrt::TerminalApp::ActionPaletteItem>() })
+            if (const auto actionPaletteItem{ filteredCommand.Item().try_as<winrt::TerminalApp::ActionPaletteItem>() })
             {
                 _PreviewActionHandlers(*this, actionPaletteItem.Command());
             }
@@ -1092,9 +1083,7 @@ namespace winrt::TerminalApp::implementation
         {
             std::copy(begin(commandsToFilter), end(commandsToFilter), std::back_inserter(actions));
         }
-        else if (_currentMode == CommandPaletteMode::TabSearchMode ||
-                 _currentMode == CommandPaletteMode::ActionMode ||
-                 _currentMode == CommandPaletteMode::CommandlineMode)
+        else if (_currentMode == CommandPaletteMode::TabSearchMode || _currentMode == CommandPaletteMode::ActionMode || _currentMode == CommandPaletteMode::CommandlineMode)
         {
             for (const auto& action : commandsToFilter)
             {

src/cascadia/TerminalApp/SuggestionsControl.idl

@@ -29,7 +29,6 @@ namespace TerminalApp
         String SearchBoxPlaceholderText { get; };
         String ControlName { get; };
         String ParentCommandName { get; };
-        String ParsedCommandLineText { get; };
 
         Windows.UI.Xaml.FrameworkElement SelectedItem { get; };
 

src/cascadia/TerminalApp/SuggestionsControl.xaml

@@ -23,9 +23,6 @@
 
     <UserControl.Resources>
         <ResourceDictionary>
-            <!--  This creates an instance of our CommandKeyChordVisibilityConverter we can reference below  -->
-            <local:EmptyStringVisibilityConverter x:Key="CommandKeyChordVisibilityConverter" />
-            <local:EmptyStringVisibilityConverter x:Key="ParsedCommandLineTextVisibilityConverter" />
             <local:EmptyStringVisibilityConverter x:Key="ParentCommandVisibilityConverter" />
             <model:IconPathConverter x:Key="IconSourceConverter" />
 
@@ -144,18 +141,6 @@
                         <Setter Property="Foreground" Value="{ThemeResource SystemControlForegroundBaseMediumBrush}" />
                     </Style>
 
-                    <!--  ParsedCommandLineText styles  -->
-                    <Style x:Key="ParsedCommandLineBorderStyle"
-                           TargetType="Border">
-                        <Setter Property="BorderThickness" Value="1" />
-                        <Setter Property="CornerRadius" Value="{ThemeResource ControlCornerRadius}" />
-                        <Setter Property="Background" Value="{ThemeResource CardBackgroundFillColorDefaultBrush}" />
-                        <Setter Property="BorderBrush" Value="{ThemeResource CardStrokeColorDefaultBrush}" />
-                    </Style>
-                    <Style x:Key="ParsedCommandLineTextBlockStyle"
-                           TargetType="TextBlock">
-                        <Setter Property="Foreground" Value="{ThemeResource SystemControlForegroundBaseMediumBrush}" />
-                    </Style>
                 </ResourceDictionary>
                 <ResourceDictionary x:Key="Light">
 
@@ -172,18 +157,6 @@
                         <Setter Property="Foreground" Value="{ThemeResource SystemControlForegroundBaseMediumBrush}" />
                     </Style>
 
-                    <!--  ParsedCommandLineText styles  -->
-                    <Style x:Key="ParsedCommandLineBorderStyle"
-                           TargetType="Border">
-                        <Setter Property="BorderThickness" Value="1" />
-                        <Setter Property="CornerRadius" Value="{ThemeResource ControlCornerRadius}" />
-                        <Setter Property="Background" Value="{ThemeResource CardBackgroundFillColorDefaultBrush}" />
-                        <Setter Property="BorderBrush" Value="{ThemeResource CardStrokeColorDefaultBrush}" />
-                    </Style>
-                    <Style x:Key="ParsedCommandLineTextBlockStyle"
-                           TargetType="TextBlock">
-                        <Setter Property="Foreground" Value="{ThemeResource SystemControlForegroundBaseMediumBrush}" />
-                    </Style>
                 </ResourceDictionary>
                 <ResourceDictionary x:Key="HighContrast">
 
@@ -193,11 +166,6 @@
                     <Style x:Key="KeyChordTextBlockStyle"
                            TargetType="TextBlock" />
 
-                    <!--  ParsedCommandLineText styles (use XAML defaults for High Contrast theme)  -->
-                    <Style x:Key="ParsedCommandLineBorderStyle"
-                           TargetType="Border" />
-                    <Style x:Key="ParsedCommandLineTextBlockStyle"
-                           TargetType="TextBlock" />
                 </ResourceDictionary>
             </ResourceDictionary.ThemeDictionaries>
         </ResourceDictionary>
@@ -279,21 +247,6 @@
                            Text="{x:Bind ParentCommandName, Mode=OneWay}" />
             </StackPanel>
 
-            <Border Grid.Row="1"
-                    Margin="8,0,8,8"
-                    Padding="16,12"
-                    HorizontalAlignment="Stretch"
-                    VerticalAlignment="Center"
-                    Style="{ThemeResource ParsedCommandLineBorderStyle}"
-                    Visibility="{x:Bind ParsedCommandLineText, Mode=OneWay, Converter={StaticResource ParsedCommandLineTextVisibilityConverter}}">
-
-                <ScrollViewer MaxHeight="200"
-                              VerticalScrollBarVisibility="Auto">
-                    <TextBlock FontStyle="Italic"
-                               Text="{x:Bind ParsedCommandLineText, Mode=OneWay}"
-                               TextWrapping="Wrap" />
-                </ScrollViewer>
-            </Border>
 
             <Border x:Name="_noMatchesText"
                     Grid.Row="3"

src/cascadia/TerminalApp/TerminalPage.cpp

@@ -1659,7 +1659,11 @@ namespace winrt::TerminalApp::implementation
 
         term.ShowWindowChanged({ get_weak(), &TerminalPage::_ShowWindowChangedHandler });
 
-        term.MenuChanged({ get_weak(), &TerminalPage::_ControlMenuChangedHandler });
+        // Don't even register for the event if the feature is compiled off.
+        if constexpr (!Feature_ShellCompletions::IsEnabled())
+        {
+            term.CompletionsChanged({ get_weak(), &TerminalPage::_ControlCompletionsChangedHandler });
+        }
 
         term.ContextMenu().Opening({ this, &TerminalPage::_ContextMenuOpened });
         term.SelectionContextMenu().Opening({ this, &TerminalPage::_SelectionMenuOpened });
@@ -2825,9 +2829,8 @@ namespace winrt::TerminalApp::implementation
     // Arguments:
     // - sender (not used)
     // - args: the arguments specifying how to set the display status to ShowWindow for our window handle
-    winrt::fire_and_forget TerminalPage::_ShowWindowChangedHandler(const IInspectable /*sender*/, const Microsoft::Terminal::Control::ShowWindowArgs args)
+    void TerminalPage::_ShowWindowChangedHandler(const IInspectable /*sender*/, const Microsoft::Terminal::Control::ShowWindowArgs args)
     {
-        co_await resume_foreground(Dispatcher());
         _ShowWindowChangedHandlers(*this, args);
     }
 
@@ -4688,14 +4691,14 @@ namespace winrt::TerminalApp::implementation
         _updateThemeColors();
     }
 
-    winrt::fire_and_forget TerminalPage::_ControlMenuChangedHandler(const IInspectable /*sender*/,
-                                                                    const MenuChangedEventArgs args)
+    winrt::fire_and_forget TerminalPage::_ControlCompletionsChangedHandler(const IInspectable sender,
+                                                                           const CompletionsChangedEventArgs args)
     {
         // This will come in on a background (not-UI, not output) thread.
-        if constexpr (!Feature_ShellCompletions::IsEnabled())
-        {
-            co_return;
-        }
+
+        // This won't even get hit if the velocity flag is disabled - we gate
+        // registering for the event based off of
+        // Feature_ShellCompletions::IsEnabled back in _RegisterTerminalEvents
 
         // User must explicitly opt-in on Preview builds
         if (!_settings.GlobalSettings().EnableShellCompletionMenu())
@@ -4710,20 +4713,22 @@ namespace winrt::TerminalApp::implementation
                                                                            args.ReplacementLength());
 
             auto weakThis{ get_weak() };
-            Dispatcher().RunAsync(CoreDispatcherPriority::Normal, [weakThis, commandsCollection]() {
+            Dispatcher().RunAsync(CoreDispatcherPriority::Normal, [weakThis, commandsCollection, sender]() {
                 // On the UI thread...
                 if (const auto& page{ weakThis.get() })
                 {
                     // Open the Suggestions UI with the commands from the control
-                    page->_OpenSuggestions(commandsCollection, SuggestionsMode::Menu);
+                    page->_OpenSuggestions(sender.try_as<TermControl>(), commandsCollection, SuggestionsMode::Menu);
                 }
             });
         }
         CATCH_LOG();
     }
 
-    void TerminalPage::_OpenSuggestions(IVector<Command> commandsCollection,
-                                        winrt::TerminalApp::SuggestionsMode mode)
+    void TerminalPage::_OpenSuggestions(
+        const TermControl& sender,
+        IVector<Command> commandsCollection,
+        winrt::TerminalApp::SuggestionsMode mode)
     {
         // ON THE UI THREAD
         assert(Dispatcher().HasThreadAccess());
@@ -4741,7 +4746,7 @@ namespace winrt::TerminalApp::implementation
             return;
         }
 
-        const auto& control{ _GetActiveControl() };
+        const auto& control{ sender ? sender : _GetActiveControl() };
         if (!control)
         {
             return;

src/cascadia/TerminalApp/TerminalPage.h

@@ -518,10 +518,10 @@ namespace winrt::TerminalApp::implementation
         void _updateAllTabCloseButtons(const winrt::TerminalApp::TabBase& focusedTab);
         void _updatePaneResources(const winrt::Windows::UI::Xaml::ElementTheme& requestedTheme);
 
-        winrt::fire_and_forget _ControlMenuChangedHandler(const winrt::Windows::Foundation::IInspectable sender, const winrt::Microsoft::Terminal::Control::MenuChangedEventArgs args);
-        void _OpenSuggestions(Windows::Foundation::Collections::IVector<winrt::Microsoft::Terminal::Settings::Model::Command> commandsCollection, winrt::TerminalApp::SuggestionsMode mode);
+        winrt::fire_and_forget _ControlCompletionsChangedHandler(const winrt::Windows::Foundation::IInspectable sender, const winrt::Microsoft::Terminal::Control::CompletionsChangedEventArgs args);
+        void _OpenSuggestions(const Microsoft::Terminal::Control::TermControl& sender, Windows::Foundation::Collections::IVector<winrt::Microsoft::Terminal::Settings::Model::Command> commandsCollection, winrt::TerminalApp::SuggestionsMode mode);
 
-        winrt::fire_and_forget _ShowWindowChangedHandler(const IInspectable sender, const winrt::Microsoft::Terminal::Control::ShowWindowArgs args);
+        void _ShowWindowChangedHandler(const IInspectable sender, const winrt::Microsoft::Terminal::Control::ShowWindowArgs args);
 
         winrt::fire_and_forget _windowPropertyChanged(const IInspectable& sender, const winrt::Windows::UI::Xaml::Data::PropertyChangedEventArgs& args);
 

src/cascadia/TerminalControl/ControlCore.cpp

@@ -119,8 +119,8 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         auto pfnPlayMidiNote = std::bind(&ControlCore::_terminalPlayMidiNote, this, std::placeholders::_1, std::placeholders::_2, std::placeholders::_3);
         _terminal->SetPlayMidiNoteCallback(pfnPlayMidiNote);
 
-        auto pfnMenuChanged = std::bind(&ControlCore::_terminalMenuChanged, this, std::placeholders::_1, std::placeholders::_2);
-        _terminal->MenuChangedCallback(pfnMenuChanged);
+        auto pfnCompletionsChanged = [=](auto&& menuJson, auto&& replaceLength) { _terminalCompletionsChanged(menuJson, replaceLength); };
+        _terminal->CompletionsChangedCallback(pfnCompletionsChanged);
 
         // MSFT 33353327: Initialize the renderer in the ctor instead of Initialize().
         // We need the renderer to be ready to accept new engines before the SwapChainPanel is ready to go.
@@ -1452,9 +1452,9 @@ namespace winrt::Microsoft::Terminal::Control::implementation
 
         if (_inUnitTests)
             [[unlikely]]
-        {
-            _ScrollPositionChangedHandlers(*this, update);
-        }
+            {
+                _ScrollPositionChangedHandlers(*this, update);
+            }
         else
         {
             const auto shared = _shared.lock_shared();
@@ -2232,15 +2232,15 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         }
     }
 
-    winrt::fire_and_forget ControlCore::_terminalMenuChanged(std::wstring_view menuJson,
-                                                             unsigned int replaceLength)
+    winrt::fire_and_forget ControlCore::_terminalCompletionsChanged(std::wstring_view menuJson,
+                                                                    unsigned int replaceLength)
     {
-        auto args = winrt::make_self<MenuChangedEventArgs>(winrt::hstring{ menuJson },
-                                                           replaceLength);
+        auto args = winrt::make_self<CompletionsChangedEventArgs>(winrt::hstring{ menuJson },
+                                                                  replaceLength);
 
         co_await winrt::resume_background();
 
-        _MenuChangedHandlers(*this, *args);
+        _CompletionsChangedHandlers(*this, *args);
     }
     void ControlCore::_selectSpan(til::point_span s)
     {

src/cascadia/TerminalControl/ControlCore.h

@@ -258,7 +258,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         TYPED_EVENT(ShowWindowChanged,         IInspectable, Control::ShowWindowArgs);
         TYPED_EVENT(UpdateSelectionMarkers,    IInspectable, Control::UpdateSelectionMarkersEventArgs);
         TYPED_EVENT(OpenHyperlink,             IInspectable, Control::OpenHyperlinkEventArgs);
-        TYPED_EVENT(MenuChanged,               IInspectable, Control::MenuChangedEventArgs);
+        TYPED_EVENT(CompletionsChanged,        IInspectable, Control::CompletionsChangedEventArgs);
 
         TYPED_EVENT(CloseTerminalRequested,    IInspectable, IInspectable);
         TYPED_EVENT(RestartTerminalRequested,    IInspectable, IInspectable);
@@ -350,7 +350,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
                                    const int velocity,
                                    const std::chrono::microseconds duration);
 
-        winrt::fire_and_forget _terminalMenuChanged(std::wstring_view menuJson, unsigned int replaceLength);
+        winrt::fire_and_forget _terminalCompletionsChanged(std::wstring_view menuJson, unsigned int replaceLength);
 
 #pragma endregion
 

src/cascadia/TerminalControl/ControlCore.idl

@@ -176,7 +176,7 @@ namespace Microsoft.Terminal.Control
 
         event Windows.Foundation.TypedEventHandler<Object, Object> Attached;
 
-        event Windows.Foundation.TypedEventHandler<Object, MenuChangedEventArgs> MenuChanged;
+        event Windows.Foundation.TypedEventHandler<Object, CompletionsChangedEventArgs> CompletionsChanged;
 
     };
 }

src/cascadia/TerminalControl/EventArgs.cpp

@@ -15,7 +15,7 @@
 #include "FoundResultsArgs.g.cpp"
 #include "ShowWindowArgs.g.cpp"
 #include "UpdateSelectionMarkersEventArgs.g.cpp"
-#include "MenuChangedEventArgs.g.cpp"
+#include "CompletionsChangedEventArgs.g.cpp"
 #include "KeySentEventArgs.g.cpp"
 #include "CharSentEventArgs.g.cpp"
 #include "StringSentEventArgs.g.cpp"

src/cascadia/TerminalControl/EventArgs.h

@@ -15,7 +15,7 @@
 #include "FoundResultsArgs.g.h"
 #include "ShowWindowArgs.g.h"
 #include "UpdateSelectionMarkersEventArgs.g.h"
-#include "MenuChangedEventArgs.g.h"
+#include "CompletionsChangedEventArgs.g.h"
 #include "KeySentEventArgs.g.h"
 #include "CharSentEventArgs.g.h"
 #include "StringSentEventArgs.g.h"
@@ -184,10 +184,10 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         WINRT_PROPERTY(bool, ClearMarkers, false);
     };
 
-    struct MenuChangedEventArgs : public MenuChangedEventArgsT<MenuChangedEventArgs>
+    struct CompletionsChangedEventArgs : public CompletionsChangedEventArgsT<CompletionsChangedEventArgs>
     {
     public:
-        MenuChangedEventArgs(const winrt::hstring menuJson, const unsigned int replaceLength) :
+        CompletionsChangedEventArgs(const winrt::hstring menuJson, const unsigned int replaceLength) :
             _MenuJson(menuJson),
             _ReplacementLength(replaceLength)
         {

src/cascadia/TerminalControl/EventArgs.idl

@@ -90,7 +90,7 @@ namespace Microsoft.Terminal.Control
         Boolean ClearMarkers { get; };
     }
 
-    runtimeclass MenuChangedEventArgs
+    runtimeclass CompletionsChangedEventArgs
     {
         String MenuJson { get; };
         UInt32 ReplacementLength { get; };

src/cascadia/TerminalControl/TSFInputControl.cpp

@@ -437,5 +437,4 @@ namespace winrt::Microsoft::Terminal::Control::implementation
     void TSFInputControl::_formatUpdatingHandler(CoreTextEditContext sender, const CoreTextFormatUpdatingEventArgs& /*args*/)
     {
     }
-
 }

src/cascadia/TerminalControl/TermControl.cpp

@@ -104,7 +104,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         _revokers.ConnectionStateChanged = _core.ConnectionStateChanged(winrt::auto_revoke, { get_weak(), &TermControl::_bubbleConnectionStateChanged });
         _revokers.ShowWindowChanged = _core.ShowWindowChanged(winrt::auto_revoke, { get_weak(), &TermControl::_bubbleShowWindowChanged });
         _revokers.CloseTerminalRequested = _core.CloseTerminalRequested(winrt::auto_revoke, { get_weak(), &TermControl::_bubbleCloseTerminalRequested });
-        _revokers.MenuChanged = _core.MenuChanged(winrt::auto_revoke, { get_weak(), &TermControl::_bubbleMenuChanged });
+        _revokers.CompletionsChanged = _core.CompletionsChanged(winrt::auto_revoke, { get_weak(), &TermControl::_bubbleCompletionsChanged });
         _revokers.RestartTerminalRequested = _core.RestartTerminalRequested(winrt::auto_revoke, { get_weak(), &TermControl::_bubbleRestartTerminalRequested });
 
         _revokers.PasteFromClipboard = _interactivity.PasteFromClipboard(winrt::auto_revoke, { get_weak(), &TermControl::_bubblePasteFromClipboard });