Move Pane to Tab (GH7075)

.github/actions/spelling/allow/apis.txt

@@ -79,6 +79,7 @@ localtime
 lround
 LSHIFT
 memicmp
+mptt
 mov
 msappx
 MULTIPLEUSE

doc/cascadia/profiles.schema.json

@@ -239,6 +239,7 @@
         "identifyWindows",
         "moveFocus",
         "movePane",
+        "swapPane",
         "moveTab",
         "newTab",
         "newWindow",
@@ -493,6 +494,23 @@
               "type": "integer",
               "default": 0,
               "description": "Which tab to switch to, with the first being 0"
+          }
+        }
+      }
+    ],
+    "required": [ "index" ]
+  },
+  "MovePaneAction": {
+      "description": "Arguments corresponding to a Move Pane Action",
+      "allOf": [
+        { "$ref": "#/definitions/ShortcutAction" },
+        {
+          "properties": {
+            "action": { "type": "string", "pattern": "movePane" },
+            "index": {
+              "type": "integer",
+              "default": 0,
+              "description": "Which tab to move the pane to, with the first being 0"
             }
           }
         }
@@ -516,13 +534,13 @@
       ],
       "required": [ "direction" ]
     },
-    "MovePaneAction": {
-      "description": "Arguments corresponding to a Move Pane Action",
+    "SwapPaneAction": {
+      "description": "Arguments corresponding to a Swap Pane Action",
       "allOf": [
         { "$ref": "#/definitions/ShortcutAction" },
         {
           "properties": {
-            "action": { "type": "string", "pattern": "movePane" },
+            "action": { "type": "string", "pattern": "swapPane" },
             "direction": {
               "$ref": "#/definitions/FocusDirection",
               "default": "left",
@@ -972,6 +990,7 @@
               { "$ref": "#/definitions/SwitchToTabAction" },
               { "$ref": "#/definitions/MoveFocusAction" },
               { "$ref": "#/definitions/MovePaneAction" },
+              { "$ref": "#/definitions/SwapPaneAction" },
               { "$ref": "#/definitions/ResizePaneAction" },
               { "$ref": "#/definitions/SendInputAction" },
               { "$ref": "#/definitions/SplitPaneAction" },

src/cascadia/TerminalApp/AppActionHandlers.cpp

@@ -143,6 +143,20 @@ namespace winrt::TerminalApp::implementation
         }
     }
 
+    void TerminalPage::_HandleMovePane(const IInspectable& /*sender*/,
+                                       const ActionEventArgs& args)
+    {
+        if (args == nullptr)
+        {
+            args.Handled(false);
+        }
+        else if (const auto& realArgs = args.ActionArgs().try_as<MovePaneArgs>())
+        {
+            auto moved = _MovePane(realArgs.TabIndex());
+            args.Handled(moved);
+        }
+    }
+
     void TerminalPage::_HandleSplitPane(const IInspectable& /*sender*/,
                                         const ActionEventArgs& args)
     {
@@ -323,10 +337,10 @@ namespace winrt::TerminalApp::implementation
         }
     }
 
-    void TerminalPage::_HandleMovePane(const IInspectable& /*sender*/,
+    void TerminalPage::_HandleSwapPane(const IInspectable& /*sender*/,
                                        const ActionEventArgs& args)
     {
-        if (const auto& realArgs = args.ActionArgs().try_as<MovePaneArgs>())
+        if (const auto& realArgs = args.ActionArgs().try_as<SwapPaneArgs>())
         {
             if (realArgs.Direction() == FocusDirection::None)
             {
@@ -335,7 +349,7 @@ namespace winrt::TerminalApp::implementation
             }
             else
             {
-                _MovePane(realArgs.Direction());
+                _SwapPane(realArgs.Direction());
                 args.Handled(true);
             }
         }

src/cascadia/TerminalApp/AppCommandlineArgs.cpp

@@ -193,6 +193,7 @@ void AppCommandlineArgs::_buildParser()
     _buildFocusTabParser();
     _buildMoveFocusParser();
     _buildMovePaneParser();
+    _buildSwapPaneParser();
     _buildFocusPaneParser();
 }
 
@@ -297,6 +298,43 @@ void AppCommandlineArgs::_buildSplitPaneParser()
     setupSubcommand(_newPaneCommand);
     setupSubcommand(_newPaneShort);
 }
+// Method Description:
+// - Adds the `move-pane` subcommand and related options to the commandline parser.
+// - Additionally adds the `mp` subcommand, which is just a shortened version of `move-pane`
+// Arguments:
+// - <none>
+// Return Value:
+// - <none>
+void AppCommandlineArgs::_buildMovePaneParser()
+{
+    _movePaneCommand = _app.add_subcommand("move-pane", RS_A(L"CmdMovePaneDesc"));
+    _movePaneShort = _app.add_subcommand("mp", RS_A(L"CmdMPDesc"));
+
+    auto setupSubcommand = [this](auto* subcommand) {
+        subcommand->add_option("-t,--tab",
+                               _movePaneTabIndex,
+                               RS_A(L"CmdMovePaneTabArgDesc"));
+
+        // When ParseCommand is called, if this subcommand was provided, this
+        // callback function will be triggered on the same thread. We can be sure
+        // that `this` will still be safe - this function just lets us know this
+        // command was parsed.
+        subcommand->callback([&, this]() {
+            // Build the action from the values we've parsed on the commandline.
+            ActionAndArgs movePaneAction{};
+
+            if (_movePaneTabIndex >= 0)
+            {
+                movePaneAction.Action(ShortcutAction::MovePane);
+                MovePaneArgs args{ static_cast<unsigned int>(_movePaneTabIndex) };
+                movePaneAction.Args(args);
+                _startupActions.push_back(movePaneAction);
+            }
+        });
+    };
+    setupSubcommand(_movePaneCommand);
+    setupSubcommand(_movePaneShort);
+}
 
 // Method Description:
 // - Adds the `focus-tab` subcommand and related options to the commandline parser.
@@ -400,16 +438,14 @@ void AppCommandlineArgs::_buildMoveFocusParser()
 }
 
 // Method Description:
-// - Adds the `move-pane` subcommand and related options to the commandline parser.
-// - Additionally adds the `mp` subcommand, which is just a shortened version of `move-pane`
+// - Adds the `swap-pane` subcommand and related options to the commandline parser.
 // Arguments:
 // - <none>
 // Return Value:
 // - <none>
-void AppCommandlineArgs::_buildMovePaneParser()
+void AppCommandlineArgs::_buildSwapPaneParser()
 {
-    _movePaneCommand = _app.add_subcommand("move-pane", RS_A(L"CmdMovePaneDesc"));
-    _movePaneShort = _app.add_subcommand("mp", RS_A(L"CmdMPDesc"));
+    _swapPaneCommand = _app.add_subcommand("swap-pane", RS_A(L"CmdSwapPaneDesc"));
 
     auto setupSubcommand = [this](auto* subcommand) {
         std::map<std::string, FocusDirection> map = {
@@ -420,8 +456,8 @@ void AppCommandlineArgs::_buildMovePaneParser()
         };
 
         auto* directionOpt = subcommand->add_option("direction",
-                                                    _movePaneDirection,
-                                                    RS_A(L"CmdMovePaneDirectionArgDesc"));
+                                                    _swapPaneDirection,
+                                                    RS_A(L"CmdSwapPaneDirectionArgDesc"));
 
         directionOpt->transform(CLI::CheckedTransformer(map, CLI::ignore_case));
         directionOpt->required();
@@ -430,21 +466,20 @@ void AppCommandlineArgs::_buildMovePaneParser()
         // that `this` will still be safe - this function just lets us know this
         // command was parsed.
         subcommand->callback([&, this]() {
-            if (_movePaneDirection != FocusDirection::None)
+            if (_swapPaneDirection != FocusDirection::None)
             {
-                MovePaneArgs args{ _movePaneDirection };
+                SwapPaneArgs args{ _swapPaneDirection };
 
                 ActionAndArgs actionAndArgs{};
-                actionAndArgs.Action(ShortcutAction::MovePane);
+                actionAndArgs.Action(ShortcutAction::SwapPane);
                 actionAndArgs.Args(args);
 
                 _startupActions.push_back(std::move(actionAndArgs));
             }
         });
     };
 
-    setupSubcommand(_movePaneCommand);
-    setupSubcommand(_movePaneShort);
+    setupSubcommand(_swapPaneCommand);
 }
 
 // Method Description:
@@ -625,6 +660,7 @@ bool AppCommandlineArgs::_noCommandsProvided()
              *_moveFocusShort ||
              *_movePaneCommand ||
              *_movePaneShort ||
+             *_swapPaneCommand ||
              *_focusPaneCommand ||
              *_focusPaneShort ||
              *_newPaneShort.subcommand ||
@@ -653,12 +689,13 @@ void AppCommandlineArgs::_resetStateToDefault()
     _splitPaneSize = 0.5f;
     _splitDuplicate = false;
 
+    _movePaneTabIndex = -1;
     _focusTabIndex = -1;
     _focusNextTab = false;
     _focusPrevTab = false;
 
     _moveFocusDirection = FocusDirection::None;
-    _movePaneDirection = FocusDirection::None;
+    _swapPaneDirection = FocusDirection::None;
 
     _focusPaneTarget = -1;
 

src/cascadia/TerminalApp/AppCommandlineArgs.h

@@ -84,6 +84,7 @@ class TerminalApp::AppCommandlineArgs final
     CLI::App* _moveFocusShort;
     CLI::App* _movePaneCommand;
     CLI::App* _movePaneShort;
+    CLI::App* _swapPaneCommand;
     CLI::App* _focusPaneCommand;
     CLI::App* _focusPaneShort;
 
@@ -97,7 +98,7 @@ class TerminalApp::AppCommandlineArgs final
     bool _suppressApplicationTitle{ false };
 
     winrt::Microsoft::Terminal::Settings::Model::FocusDirection _moveFocusDirection{ winrt::Microsoft::Terminal::Settings::Model::FocusDirection::None };
-    winrt::Microsoft::Terminal::Settings::Model::FocusDirection _movePaneDirection{ winrt::Microsoft::Terminal::Settings::Model::FocusDirection::None };
+    winrt::Microsoft::Terminal::Settings::Model::FocusDirection _swapPaneDirection{ winrt::Microsoft::Terminal::Settings::Model::FocusDirection::None };
 
     // _commandline will contain the command line with which we'll be spawning a new terminal
     std::vector<std::string> _commandline;
@@ -107,6 +108,7 @@ class TerminalApp::AppCommandlineArgs final
     bool _splitDuplicate{ false };
     float _splitPaneSize{ 0.5f };
 
+    int _movePaneTabIndex{ -1 };
     int _focusTabIndex{ -1 };
     bool _focusNextTab{ false };
     bool _focusPrevTab{ false };
@@ -132,6 +134,7 @@ class TerminalApp::AppCommandlineArgs final
     void _buildFocusTabParser();
     void _buildMoveFocusParser();
     void _buildMovePaneParser();
+    void _buildSwapPaneParser();
     void _buildFocusPaneParser();
     bool _noCommandsProvided();
     void _resetStateToDefault();