Add support for "Tasks" in the Suggestions UI

doc/cascadia/profiles.schema.json

@@ -85,6 +85,32 @@
         }
       ]
     },
+    "BuiltinSuggestionSource": {
+      "enum": [
+        "commandHistory",
+        "tasks",
+        "all"
+      ],
+      "type": "string"
+    },
+    "SuggestionSource": {
+      "default": "all",
+      "description": "Either a single suggestion source, or an array of sources to concatenate. Built-in sources include `commandHistory`, `directoryHistory`, and `tasks`. The special value `all` indicates all suggestion sources should be included",
+      "$comment": "`tasks` and `local` are sources that would be added by the Tasks feature, as a follow-up",
+      "oneOf": [
+        {
+          "type": [ "string", "null", "BuiltinSuggestionSource" ]
+        },
+        {
+          "type": "array",
+          "items": { "type": "BuiltinSuggestionSource" }
+        },
+        {
+          "type": "array",
+          "items": { "type": "string" }
+        }
+      ]
+    },
     "AppearanceConfig": {
       "properties": {
         "colorScheme": {
@@ -398,6 +424,7 @@
         "sendInput",
         "setColorScheme",
         "setTabColor",
+        "showSuggestions",
         "splitPane",
         "switchToTab",
         "tabSearch",
@@ -1767,6 +1794,30 @@
         }
       ]
     },
+    "ShowSuggestionsAction": {
+      "description": "Arguments corresponding to a Open Suggestions Action",
+      "allOf": [
+        {
+          "$ref": "#/$defs/ShortcutAction"
+        },
+        {
+          "properties": {
+            "action": {
+              "type": "string",
+              "const": "showSuggestions"
+            },
+            "source": {
+              "$ref": "#/$defs/SuggestionSource",
+              "description": "Which suggestion sources to filter."
+            },
+            "useCommandline": {
+              "default": false,
+              "description": "When set to `true`, the current commandline the user has typed will pre-populate the filter of the Suggestions UI. This requires that the user has enabled shell integration in their shell's config. When set to false, the filter will start empty."
+            }
+          }
+        }
+      ]
+    },
     "ShowCloseButton": {
       "enum": [
         "always",
@@ -2037,6 +2088,9 @@
             {
               "$ref": "#/$defs/SearchWebAction"
             },
+            {
+              "$ref": "#/$defs/ShowSuggestionsAction"
+            },
             {
               "type": "null"
             }

src/buffer/out/textBuffer.cpp

@@ -2985,6 +2985,22 @@ void TextBuffer::_trimMarksOutsideBuffer()
                  _marks.end());
 }
 
+std::wstring_view TextBuffer::CurrentCommand() const
+{
+    if (_marks.size() == 0)
+    {
+        return L"";
+    }
+
+    const auto& curr{ _marks.back() };
+    const auto& start{ curr.end };
+    const auto& end{ GetCursor().GetPosition() };
+
+    const auto line = start.y;
+    const auto& row = GetRowByOffset(line);
+    return row.GetText(start.x, end.x);
+}
+
 void TextBuffer::SetCurrentPromptEnd(const til::point pos) noexcept
 {
     if (_marks.empty())

src/buffer/out/textBuffer.hpp

@@ -276,6 +276,7 @@ class TextBuffer final
     void SetCurrentPromptEnd(const til::point pos) noexcept;
     void SetCurrentCommandEnd(const til::point pos) noexcept;
     void SetCurrentOutputEnd(const til::point pos, ::MarkCategory category) noexcept;
+    std::wstring_view CurrentCommand() const;
 
 private:
     void _reserve(til::size screenBufferSize, const TextAttribute& defaultAttributes);

src/cascadia/TerminalApp/AppActionHandlers.cpp

@@ -1264,23 +1264,62 @@ namespace winrt::TerminalApp::implementation
         {
             if (const auto& realArgs = args.ActionArgs().try_as<SuggestionsArgs>())
             {
-                auto source = realArgs.Source();
-
-                switch (source)
-                {
-                case SuggestionsSource::CommandHistory:
+                const auto source = realArgs.Source();
+                const auto commandsCollection = winrt::single_threaded_vector<Command>();
+                Control::CommandHistoryContext context{ nullptr };
+                winrt::hstring currentCommandline = L"";
+
+                // If the user wanted to use the current commandline to filter results,
+                //    OR they wanted command history (or some other source that
+                //       requires context from the control)
+                // then get that here.
+                const bool shouldGetContext = realArgs.UseCommandline() ||
+                                              WI_IsFlagSet(source, SuggestionsSource::CommandHistory);
+                if (shouldGetContext)
                 {
                     if (const auto& control{ _GetActiveControl() })
                     {
-                        const auto context = control.CommandHistory();
-                        _OpenSuggestions(control,
-                                         Command::HistoryToCommands(context.History(), context.CurrentCommandline(), false),
-                                         SuggestionsMode::Palette);
+                        context = control.CommandHistory();
+                        if (context)
+                        {
+                            currentCommandline = context.CurrentCommandline();
+                        }
                     }
-                    args.Handled(true);
                 }
-                break;
+
+                // Aggregate all the commands from the different sources that
+                // the user selected.
+
+                // Tasks are all the sendInput commands the user has saved in
+                // their settings file. Ask the ActionMap for those.
+                if (WI_IsFlagSet(source, SuggestionsSource::Tasks))
+                {
+                    const auto tasks = _settings.GlobalSettings().ActionMap().FilterToSendInput(currentCommandline);
+                    for (const auto& t : tasks)
+                    {
+                        commandsCollection.Append(t);
+                    }
                 }
+
+                // Command History comes from the commands in the buffer,
+                // assuming the user has enabled shell integration. Get those
+                // from the active control.
+                if (WI_IsFlagSet(source, SuggestionsSource::CommandHistory) &&
+                    context != nullptr)
+                {
+                    const auto recentCommands = Command::HistoryToCommands(context.History(), currentCommandline, false);
+                    for (const auto& t : recentCommands)
+                    {
+                        commandsCollection.Append(t);
+                    }
+                }
+
+                // Open the palette with all these commands in it.
+                _OpenSuggestions(_GetActiveControl(),
+                                 commandsCollection,
+                                 SuggestionsMode::Palette,
+                                 currentCommandline);
+                args.Handled(true);
             }
         }
     }

src/cascadia/TerminalApp/SuggestionsControl.cpp

@@ -1051,6 +1051,7 @@ namespace winrt::TerminalApp::implementation
 
     void SuggestionsControl::Open(TerminalApp::SuggestionsMode mode,
                                   const Windows::Foundation::Collections::IVector<Microsoft::Terminal::Settings::Model::Command>& commands,
+                                  winrt::hstring filter,
                                   Windows::Foundation::Point anchor,
                                   Windows::Foundation::Size space,
                                   float characterHeight)
@@ -1101,5 +1102,8 @@ namespace winrt::TerminalApp::implementation
             newMargin.Top = (_anchor.Y - actualSize.height);
         }
         Margin(newMargin);
+
+        _searchBox().Text(filter);
     }
+
 }

src/cascadia/TerminalApp/SuggestionsControl.h

@@ -42,6 +42,7 @@ namespace winrt::TerminalApp::implementation
 
         void Open(TerminalApp::SuggestionsMode mode,
                   const Windows::Foundation::Collections::IVector<Microsoft::Terminal::Settings::Model::Command>& commands,
+                  winrt::hstring filterText,
                   Windows::Foundation::Point anchor,
                   Windows::Foundation::Size space,
                   float characterHeight);

src/cascadia/TerminalApp/SuggestionsControl.idl

@@ -40,7 +40,7 @@ namespace TerminalApp
         void SetActionMap(Microsoft.Terminal.Settings.Model.IActionMapView actionMap);
         void SelectNextItem(Boolean moveDown);
 
-        void Open(SuggestionsMode mode, IVector<Microsoft.Terminal.Settings.Model.Command> commands, Windows.Foundation.Point anchor, Windows.Foundation.Size space, Single characterHeight);
+        void Open(SuggestionsMode mode, IVector<Microsoft.Terminal.Settings.Model.Command> commands, String filterText, Windows.Foundation.Point anchor, Windows.Foundation.Size space, Single characterHeight);
 
         event Windows.Foundation.TypedEventHandler<SuggestionsControl, Microsoft.Terminal.Settings.Model.Command> DispatchCommandRequested;
         event Windows.Foundation.TypedEventHandler<Object, Microsoft.Terminal.Settings.Model.Command> PreviewAction;

src/cascadia/TerminalApp/TerminalPage.cpp

@@ -4718,7 +4718,7 @@ namespace winrt::TerminalApp::implementation
                 if (const auto& page{ weakThis.get() })
                 {
                     // Open the Suggestions UI with the commands from the control
-                    page->_OpenSuggestions(sender.try_as<TermControl>(), commandsCollection, SuggestionsMode::Menu);
+                    page->_OpenSuggestions(sender.try_as<TermControl>(), commandsCollection, SuggestionsMode::Menu, L"");
                 }
             });
         }
@@ -4728,7 +4728,9 @@ namespace winrt::TerminalApp::implementation
     void TerminalPage::_OpenSuggestions(
         const TermControl& sender,
         IVector<Command> commandsCollection,
-        winrt::TerminalApp::SuggestionsMode mode)
+        winrt::TerminalApp::SuggestionsMode mode,
+        winrt::hstring filterText)
+
     {
         // ON THE UI THREAD
         assert(Dispatcher().HasThreadAccess());
@@ -4761,7 +4763,12 @@ namespace winrt::TerminalApp::implementation
         const auto realCursorPos{ controlTransform.TransformPoint({ cursorPos.X, cursorPos.Y }) }; // == controlTransform + cursorPos
         const Windows::Foundation::Size windowDimensions{ gsl::narrow_cast<float>(ActualWidth()), gsl::narrow_cast<float>(ActualHeight()) };
 
-        sxnUi.Open(mode, commandsCollection, realCursorPos, windowDimensions, characterSize.Height);
+        sxnUi.Open(mode,
+                   commandsCollection,
+                   filterText,
+                   realCursorPos,
+                   windowDimensions,
+                   characterSize.Height);
     }
 
     void TerminalPage::_ContextMenuOpened(const IInspectable& sender,

src/cascadia/TerminalApp/TerminalPage.h

@@ -519,7 +519,8 @@ namespace winrt::TerminalApp::implementation
         void _updatePaneResources(const winrt::Windows::UI::Xaml::ElementTheme& requestedTheme);
 
         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);
+
+        void _OpenSuggestions(const Microsoft::Terminal::Control::TermControl& sender, Windows::Foundation::Collections::IVector<winrt::Microsoft::Terminal::Settings::Model::Command> commandsCollection, winrt::TerminalApp::SuggestionsMode mode, winrt::hstring filterText);
 
         void _ShowWindowChangedHandler(const IInspectable sender, const winrt::Microsoft::Terminal::Control::ShowWindowArgs args);
 

src/cascadia/TerminalControl/ControlCore.cpp

@@ -1958,6 +1958,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         const auto& textBuffer = _terminal->GetTextBuffer();
 
         std::vector<winrt::hstring> commands;
+
         for (const auto& mark : _terminal->GetScrollMarks())
         {
             // The command text is between the `end` (which denotes the end of
@@ -1979,10 +1980,12 @@ namespace winrt::Microsoft::Terminal::Control::implementation
             if (strEnd != std::string::npos)
             {
                 const auto trimmed = commandText.substr(0, strEnd + 1);
+
                 commands.push_back(winrt::hstring{ trimmed });
             }
         }
         auto context = winrt::make_self<CommandHistoryContext>(std::move(commands));
+        context->CurrentCommandline(winrt::hstring{ _terminal->CurrentCommand() });
 
         return *context;
     }

src/cascadia/TerminalCore/Terminal.cpp

@@ -1451,6 +1451,16 @@ til::color Terminal::GetColorForMark(const ScrollMark& mark) const
     }
 }
 
+std::wstring_view Terminal::CurrentCommand() const
+{
+    if (_currentPromptState != PromptState::Command)
+    {
+        return L"";
+    }
+
+    return _activeBuffer().CurrentCommand();
+}
+
 void Terminal::ColorSelection(const TextAttribute& attr, winrt::Microsoft::Terminal::Core::MatchMode matchMode)
 {
     for (const auto [start, end] : _GetSelectionSpans())

src/cascadia/TerminalCore/Terminal.hpp

@@ -119,6 +119,8 @@ class Microsoft::Terminal::Core::Terminal final :
                  const til::point& end,
                  const bool fromUi);
 
+    std::wstring_view CurrentCommand() const;
+
 #pragma region ITerminalApi
     // These methods are defined in TerminalApi.cpp
     void ReturnResponse(const std::wstring_view response) override;

src/cascadia/TerminalSettingsModel/ActionArgs.cpp

@@ -709,12 +709,40 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
 
     winrt::hstring SuggestionsArgs::GenerateName() const
     {
-        switch (Source())
+        std::wstringstream ss;
+        ss << RS_(L"SuggestionsCommandKey").c_str();
+
+        if (UseCommandline())
+        {
+            ss << L", useCommandline:true";
+        }
+
+        // All of the source values will leave a trailing ", " that we need to chop later:
+        ss << L", source: ";
+        const auto source = Source();
+        if (source == SuggestionsSource::All)
+        {
+            ss << L"all, ";
+        }
+        else if (source == static_cast<SuggestionsSource>(0))
         {
-        case SuggestionsSource::CommandHistory:
-            return RS_(L"SuggestionsCommandHistoryCommandKey");
+            ss << L"none, ";
+        }
+        else
+        {
+            if (WI_IsFlagSet(source, SuggestionsSource::Tasks))
+            {
+                ss << L"tasks, ";
+            }
+
+            if (WI_IsFlagSet(source, SuggestionsSource::CommandHistory))
+            {
+                ss << L"commandHistory, ";
+            }
         }
-        return RS_(L"SuggestionsCommandKey");
+        // Chop off the last ","
+        auto result = ss.str();
+        return winrt::hstring{ result.substr(0, result.size() - 2) };
     }
 
     winrt::hstring FindMatchArgs::GenerateName() const

src/cascadia/TerminalSettingsModel/ActionArgs.h

@@ -215,8 +215,9 @@ private:                                                                    \
     X(CommandPaletteLaunchMode, LaunchMode, "launchMode", false, CommandPaletteLaunchMode::Action)
 
 ////////////////////////////////////////////////////////////////////////////////
-#define SUGGESTIONS_ARGS(X) \
-    X(SuggestionsSource, Source, "source", false, SuggestionsSource::Tasks)
+#define SUGGESTIONS_ARGS(X)                                                 \
+    X(SuggestionsSource, Source, "source", false, SuggestionsSource::Tasks) \
+    X(bool, UseCommandline, "useCommandline", false, false)
 
 ////////////////////////////////////////////////////////////////////////////////
 #define FIND_MATCH_ARGS(X) \

src/cascadia/TerminalSettingsModel/ActionArgs.idl

@@ -112,11 +112,14 @@ namespace Microsoft.Terminal.Settings.Model
         ToCurrent,
         ToMouse,
     };
+
+    [flags]
     enum SuggestionsSource
     {
-        Tasks,
-        CommandHistory,
-        DirectoryHistory,
+        Tasks = 0x1,
+        CommandHistory = 0x2,
+        DirectoryHistory = 0x4,
+        All = 0xffffffff,
     };
 
     [default_interface] runtimeclass NewTerminalArgs {
@@ -327,8 +330,9 @@ namespace Microsoft.Terminal.Settings.Model
     [default_interface] runtimeclass SuggestionsArgs : IActionArgs
     {
         SuggestionsArgs();
-        SuggestionsArgs(SuggestionsSource source);
+        SuggestionsArgs(SuggestionsSource source, Boolean useCommandline);
         SuggestionsSource Source { get; };
+        Boolean UseCommandline { get; };
     };
 
     [default_interface] runtimeclass FindMatchArgs : IActionArgs