Add the ability to toggle a pane's split direction (#10713)

<!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? -->
## Summary of the Pull Request
Add the ability to toggle a pane's split direction
- Switch from horizontal to vertical split (and vice versa)
- Propogate new borders through to children.

<!-- Other than the issue solved, is this relevant to any other issues/existing PRs? --> 
## References
#10665 

<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist
* [x] Closes #10665
* [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA
* [ ] Tests added/passed
* [ ] Documentation updated. If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/terminal) and link it here: #xxx
* [x] Schema updated.
* [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx

<!-- Provide a more detailed description of the PR, other things fixed or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments

<!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed
Ran terminal, created multiple panes in different orientations, ran command through command palate and verified that they displayed properly in the new orientation.

doc/cascadia/profiles.schema.json

@@ -271,6 +271,7 @@
         "toggleFocusMode",
         "toggleFullscreen",
         "togglePaneZoom",
+        "toggleSplitOrientation",
         "toggleReadOnlyMode",
         "toggleShaderEffects",
         "wt",

src/cascadia/TerminalApp/AppActionHandlers.cpp

@@ -161,6 +161,13 @@ namespace winrt::TerminalApp::implementation
         }
     }
 
+    void TerminalPage::_HandleToggleSplitOrientation(const IInspectable& /*sender*/,
+                                                     const ActionEventArgs& args)
+    {
+        _ToggleSplitOrientation();
+        args.Handled(true);
+    }
+
     void TerminalPage::_HandleTogglePaneZoom(const IInspectable& /*sender*/,
                                              const ActionEventArgs& args)
     {

src/cascadia/TerminalApp/Pane.cpp

@@ -1449,8 +1449,26 @@ void Pane::_UpdateBorders()
     _border.BorderThickness(ThicknessHelper::FromLengths(left, top, right, bottom));
 }
 
+// Method Description:
+// - Find the borders for the leaf pane, or the shared borders for child panes.
+// Arguments:
+// - <none>
+// Return Value:
+// - <none>
+Borders Pane::_GetCommonBorders()
+{
+    if (_IsLeaf())
+    {
+        return _borders;
+    }
+
+    return _firstChild->_GetCommonBorders() & _secondChild->_GetCommonBorders();
+}
+
 // Method Description:
 // - Sets the row/column of our child UI elements, to match our current split type.
+// - In case the split definition or parent borders were changed, this recursively
+//   updates the children as well.
 // Arguments:
 // - <none>
 // Return Value:
@@ -1466,9 +1484,8 @@ void Pane::_ApplySplitDefinitions()
         _secondChild->_borders = _borders | Borders::Left;
         _borders = Borders::None;
 
-        _UpdateBorders();
-        _firstChild->_UpdateBorders();
-        _secondChild->_UpdateBorders();
+        _firstChild->_ApplySplitDefinitions();
+        _secondChild->_ApplySplitDefinitions();
     }
     else if (_splitState == SplitState::Horizontal)
     {
@@ -1479,10 +1496,10 @@ void Pane::_ApplySplitDefinitions()
         _secondChild->_borders = _borders | Borders::Top;
         _borders = Borders::None;
 
-        _UpdateBorders();
-        _firstChild->_UpdateBorders();
-        _secondChild->_UpdateBorders();
+        _firstChild->_ApplySplitDefinitions();
+        _secondChild->_ApplySplitDefinitions();
     }
+    _UpdateBorders();
 }
 
 // Method Description:
@@ -1743,6 +1760,43 @@ std::pair<std::shared_ptr<Pane>, std::shared_ptr<Pane>> Pane::Split(SplitState s
     return _Split(splitType, splitSize, profile, control);
 }
 
+// Method Description:
+// - Toggle the split orientation of the currently focused pane
+// Arguments:
+// - <none>
+// Return Value:
+// - true if a split was changed
+bool Pane::ToggleSplitOrientation()
+{
+    // If we are a leaf there is no split to toggle.
+    if (_IsLeaf())
+    {
+        return false;
+    }
+
+    // Check if either our first or second child is the currently focused leaf.
+    // If they are then switch the split orientation on the current pane.
+    const bool firstIsFocused = _firstChild->_IsLeaf() && _firstChild->_lastActive;
+    const bool secondIsFocused = _secondChild->_IsLeaf() && _secondChild->_lastActive;
+    if (firstIsFocused || secondIsFocused)
+    {
+        // Switch the split orientation
+        _splitState = _splitState == SplitState::Horizontal ? SplitState::Vertical : SplitState::Horizontal;
+
+        // then update the borders and positioning on ourselves and our children.
+        _borders = _GetCommonBorders();
+        // Since we changed if we are using rows/columns, make sure we remove the old definitions
+        _root.ColumnDefinitions().Clear();
+        _root.RowDefinitions().Clear();
+        _CreateRowColDefinitions();
+        _ApplySplitDefinitions();
+
+        return true;
+    }
+
+    return _firstChild->ToggleSplitOrientation() || _secondChild->ToggleSplitOrientation();
+}
+
 // Method Description:
 // - Converts an "automatic" split type into either Vertical or Horizontal,
 //   based upon the current dimensions of the Pane.

src/cascadia/TerminalApp/Pane.h

@@ -69,6 +69,7 @@ class Pane : public std::enable_shared_from_this<Pane>
                                                                   const float splitSize,
                                                                   const GUID& profile,
                                                                   const winrt::Microsoft::Terminal::Control::TermControl& control);
+    bool ToggleSplitOrientation();
     float CalcSnappedDimension(const bool widthOrHeight, const float dimension) const;
     std::optional<winrt::Microsoft::Terminal::Settings::Model::SplitState> PreCalculateAutoSplit(const std::shared_ptr<Pane> target,
                                                                                                  const winrt::Windows::Foundation::Size parentSize) const;
@@ -146,6 +147,7 @@ class Pane : public std::enable_shared_from_this<Pane>
     void _ApplySplitDefinitions();
     void _SetupEntranceAnimation();
     void _UpdateBorders();
+    Borders _GetCommonBorders();
 
     bool _Resize(const winrt::Microsoft::Terminal::Settings::Model::ResizeDirection& direction);
 

src/cascadia/TerminalApp/TerminalPage.cpp

@@ -1316,6 +1316,21 @@ namespace winrt::TerminalApp::implementation
         CATCH_LOG();
     }
 
+    // Method Description:
+    // - Switches the split orientation of the currently focused pane.
+    // Arguments:
+    // - <none>
+    // Return Value:
+    // - <none>
+    void TerminalPage::_ToggleSplitOrientation()
+    {
+        if (const auto terminalTab{ _GetFocusedTabImpl() })
+        {
+            _UnZoomIfNeeded();
+            terminalTab->ToggleSplitOrientation();
+        }
+    }
+
     // Method Description:
     // - Attempt to move a separator between panes, as to resize each child on
     //   either size of the separator. See Pane::ResizePane for details.

src/cascadia/TerminalApp/TerminalPage.h

@@ -255,6 +255,7 @@ namespace winrt::TerminalApp::implementation
                         const float splitSize = 0.5f,
                         const Microsoft::Terminal::Settings::Model::NewTerminalArgs& newTerminalArgs = nullptr);
         void _ResizePane(const Microsoft::Terminal::Settings::Model::ResizeDirection& direction);
+        void _ToggleSplitOrientation();
 
         void _ScrollPage(ScrollDirection scrollDirection);
         void _ScrollToBufferEdge(ScrollDirection scrollDirection);

src/cascadia/TerminalApp/TerminalTab.cpp

@@ -440,6 +440,17 @@ namespace winrt::TerminalApp::implementation
         _UpdateActivePane(second);
     }
 
+    // Method Description:
+    // - Find the currently active pane, and then switch the split direction of
+    //   its parent. E.g. switch from Horizontal to Vertical.
+    // Return Value:
+
+    // - <none>
+    void TerminalTab::ToggleSplitOrientation()
+    {
+        _rootPane->ToggleSplitOrientation();
+    }
+
     // Method Description:
     // - See Pane::CalcSnappedDimension
     float TerminalTab::CalcSnappedDimension(const bool widthOrHeight, const float dimension) const
@@ -1222,6 +1233,7 @@ namespace winrt::TerminalApp::implementation
             EnterZoom();
         }
     }
+
     void TerminalTab::EnterZoom()
     {
         _zoomedPane = _activePane;

src/cascadia/TerminalApp/TerminalTab.h

@@ -38,6 +38,7 @@ namespace winrt::TerminalApp::implementation
                        const GUID& profile,
                        winrt::Microsoft::Terminal::Control::TermControl& control);
 
+        void ToggleSplitOrientation();
         winrt::fire_and_forget UpdateIcon(const winrt::hstring iconPath);
         winrt::fire_and_forget HideIcon(const bool hide);
 

src/cascadia/TerminalSettingsModel/ActionAndArgs.cpp

@@ -49,6 +49,7 @@ static constexpr std::string_view ToggleCommandPaletteKey{ "commandPalette" };
 static constexpr std::string_view ToggleFocusModeKey{ "toggleFocusMode" };
 static constexpr std::string_view ToggleFullscreenKey{ "toggleFullscreen" };
 static constexpr std::string_view TogglePaneZoomKey{ "togglePaneZoom" };
+static constexpr std::string_view ToggleSplitOrientationKey{ "toggleSplitOrientation" };
 static constexpr std::string_view LegacyToggleRetroEffectKey{ "toggleRetroEffect" };
 static constexpr std::string_view ToggleShaderEffectsKey{ "toggleShaderEffects" };
 static constexpr std::string_view MoveTabKey{ "moveTab" };
@@ -349,6 +350,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
                 { ShortcutAction::ToggleFocusMode, RS_(L"ToggleFocusModeCommandKey") },
                 { ShortcutAction::ToggleFullscreen, RS_(L"ToggleFullscreenCommandKey") },
                 { ShortcutAction::TogglePaneZoom, RS_(L"TogglePaneZoomCommandKey") },
+                { ShortcutAction::ToggleSplitOrientation, RS_(L"ToggleSplitOrientationCommandKey") },
                 { ShortcutAction::ToggleShaderEffects, RS_(L"ToggleShaderEffectsCommandKey") },
                 { ShortcutAction::MoveTab, L"" }, // Intentionally omitted, must be generated by GenerateName
                 { ShortcutAction::BreakIntoDebugger, RS_(L"BreakIntoDebuggerCommandKey") },

src/cascadia/TerminalSettingsModel/AllShortcutActions.h

@@ -23,59 +23,60 @@
 // each action. This is _NOT_ something that should be used when any individual
 // case should be customized.
 
-#define ALL_SHORTCUT_ACTIONS             \
-    ON_ALL_ACTIONS(CopyText)             \
-    ON_ALL_ACTIONS(PasteText)            \
-    ON_ALL_ACTIONS(OpenNewTabDropdown)   \
-    ON_ALL_ACTIONS(DuplicateTab)         \
-    ON_ALL_ACTIONS(NewTab)               \
-    ON_ALL_ACTIONS(CloseWindow)          \
-    ON_ALL_ACTIONS(CloseTab)             \
-    ON_ALL_ACTIONS(ClosePane)            \
-    ON_ALL_ACTIONS(NextTab)              \
-    ON_ALL_ACTIONS(PrevTab)              \
-    ON_ALL_ACTIONS(SendInput)            \
-    ON_ALL_ACTIONS(SplitPane)            \
-    ON_ALL_ACTIONS(TogglePaneZoom)       \
-    ON_ALL_ACTIONS(SwitchToTab)          \
-    ON_ALL_ACTIONS(AdjustFontSize)       \
-    ON_ALL_ACTIONS(ResetFontSize)        \
-    ON_ALL_ACTIONS(ScrollUp)             \
-    ON_ALL_ACTIONS(ScrollDown)           \
-    ON_ALL_ACTIONS(ScrollUpPage)         \
-    ON_ALL_ACTIONS(ScrollDownPage)       \
-    ON_ALL_ACTIONS(ScrollToTop)          \
-    ON_ALL_ACTIONS(ScrollToBottom)       \
-    ON_ALL_ACTIONS(ResizePane)           \
-    ON_ALL_ACTIONS(MoveFocus)            \
-    ON_ALL_ACTIONS(MovePane)             \
-    ON_ALL_ACTIONS(Find)                 \
-    ON_ALL_ACTIONS(ToggleShaderEffects)  \
-    ON_ALL_ACTIONS(ToggleFocusMode)      \
-    ON_ALL_ACTIONS(ToggleFullscreen)     \
-    ON_ALL_ACTIONS(ToggleAlwaysOnTop)    \
-    ON_ALL_ACTIONS(OpenSettings)         \
-    ON_ALL_ACTIONS(SetColorScheme)       \
-    ON_ALL_ACTIONS(SetTabColor)          \
-    ON_ALL_ACTIONS(OpenTabColorPicker)   \
-    ON_ALL_ACTIONS(RenameTab)            \
-    ON_ALL_ACTIONS(OpenTabRenamer)       \
-    ON_ALL_ACTIONS(ExecuteCommandline)   \
-    ON_ALL_ACTIONS(ToggleCommandPalette) \
-    ON_ALL_ACTIONS(CloseOtherTabs)       \
-    ON_ALL_ACTIONS(CloseTabsAfter)       \
-    ON_ALL_ACTIONS(TabSearch)            \
-    ON_ALL_ACTIONS(MoveTab)              \
-    ON_ALL_ACTIONS(BreakIntoDebugger)    \
-    ON_ALL_ACTIONS(TogglePaneReadOnly)   \
-    ON_ALL_ACTIONS(FindMatch)            \
-    ON_ALL_ACTIONS(NewWindow)            \
-    ON_ALL_ACTIONS(IdentifyWindow)       \
-    ON_ALL_ACTIONS(IdentifyWindows)      \
-    ON_ALL_ACTIONS(RenameWindow)         \
-    ON_ALL_ACTIONS(OpenWindowRenamer)    \
-    ON_ALL_ACTIONS(GlobalSummon)         \
-    ON_ALL_ACTIONS(QuakeMode)            \
+#define ALL_SHORTCUT_ACTIONS               \
+    ON_ALL_ACTIONS(CopyText)               \
+    ON_ALL_ACTIONS(PasteText)              \
+    ON_ALL_ACTIONS(OpenNewTabDropdown)     \
+    ON_ALL_ACTIONS(DuplicateTab)           \
+    ON_ALL_ACTIONS(NewTab)                 \
+    ON_ALL_ACTIONS(CloseWindow)            \
+    ON_ALL_ACTIONS(CloseTab)               \
+    ON_ALL_ACTIONS(ClosePane)              \
+    ON_ALL_ACTIONS(NextTab)                \
+    ON_ALL_ACTIONS(PrevTab)                \
+    ON_ALL_ACTIONS(SendInput)              \
+    ON_ALL_ACTIONS(SplitPane)              \
+    ON_ALL_ACTIONS(ToggleSplitOrientation) \
+    ON_ALL_ACTIONS(TogglePaneZoom)         \
+    ON_ALL_ACTIONS(SwitchToTab)            \
+    ON_ALL_ACTIONS(AdjustFontSize)         \
+    ON_ALL_ACTIONS(ResetFontSize)          \
+    ON_ALL_ACTIONS(ScrollUp)               \
+    ON_ALL_ACTIONS(ScrollDown)             \
+    ON_ALL_ACTIONS(ScrollUpPage)           \
+    ON_ALL_ACTIONS(ScrollDownPage)         \
+    ON_ALL_ACTIONS(ScrollToTop)            \
+    ON_ALL_ACTIONS(ScrollToBottom)         \
+    ON_ALL_ACTIONS(ResizePane)             \
+    ON_ALL_ACTIONS(MoveFocus)              \
+    ON_ALL_ACTIONS(MovePane)               \
+    ON_ALL_ACTIONS(Find)                   \
+    ON_ALL_ACTIONS(ToggleShaderEffects)    \
+    ON_ALL_ACTIONS(ToggleFocusMode)        \
+    ON_ALL_ACTIONS(ToggleFullscreen)       \
+    ON_ALL_ACTIONS(ToggleAlwaysOnTop)      \
+    ON_ALL_ACTIONS(OpenSettings)           \
+    ON_ALL_ACTIONS(SetColorScheme)         \
+    ON_ALL_ACTIONS(SetTabColor)            \
+    ON_ALL_ACTIONS(OpenTabColorPicker)     \
+    ON_ALL_ACTIONS(RenameTab)              \
+    ON_ALL_ACTIONS(OpenTabRenamer)         \
+    ON_ALL_ACTIONS(ExecuteCommandline)     \
+    ON_ALL_ACTIONS(ToggleCommandPalette)   \
+    ON_ALL_ACTIONS(CloseOtherTabs)         \
+    ON_ALL_ACTIONS(CloseTabsAfter)         \
+    ON_ALL_ACTIONS(TabSearch)              \
+    ON_ALL_ACTIONS(MoveTab)                \
+    ON_ALL_ACTIONS(BreakIntoDebugger)      \
+    ON_ALL_ACTIONS(TogglePaneReadOnly)     \
+    ON_ALL_ACTIONS(FindMatch)              \
+    ON_ALL_ACTIONS(NewWindow)              \
+    ON_ALL_ACTIONS(IdentifyWindow)         \
+    ON_ALL_ACTIONS(IdentifyWindows)        \
+    ON_ALL_ACTIONS(RenameWindow)           \
+    ON_ALL_ACTIONS(OpenWindowRenamer)      \
+    ON_ALL_ACTIONS(GlobalSummon)           \
+    ON_ALL_ACTIONS(QuakeMode)              \
     ON_ALL_ACTIONS(FocusPane)
 
 #define ALL_SHORTCUT_ACTIONS_WITH_ARGS             \

src/cascadia/TerminalSettingsModel/Resources/en-US/Resources.resw

@@ -387,6 +387,9 @@
   <data name="ToggleFullscreenCommandKey" xml:space="preserve">
     <value>Toggle fullscreen</value>
   </data>
+  <data name="ToggleSplitOrientationCommandKey" xml:space="preserve">
+    <value>Toggle pane split orientation</value>
+  </data>
   <data name="TogglePaneZoomCommandKey" xml:space="preserve">
     <value>Toggle pane zoom</value>
   </data>

src/cascadia/TerminalSettingsModel/defaults.json

@@ -350,6 +350,7 @@
         { "command": { "action": "movePane", "direction": "up" } },
         { "command": { "action": "movePane", "direction": "previous"} },
         { "command": "togglePaneZoom" },
+        { "command": "toggleSplitOrientation" },
         { "command": "toggleReadOnlyMode" },
 
         // Clipboard Integration