Add support for tmux control mode (#3656)

Address comments round 1

1 typo fix
2 add the feature for tmux control
3 add the configuration for tmux control
4 change to use present menu/ui/action for tmux control
5 disable draging the tmux control tab
6 close backend panes/windows if close panes/tabs locally
7 fix the bug that cannot input after split the pane

Author: joexue

src/cascadia/TerminalApp/AppActionHandlers.cpp

@@ -273,6 +273,15 @@ namespace winrt::TerminalApp::implementation
         }
         else if (const auto& realArgs = args.ActionArgs().try_as<SplitPaneArgs>())
         {
+            if constexpr (Feature_TmuxControl::IsEnabled())
+            {
+                //Tmux control takes over
+                if (_tmuxControl && _tmuxControl->ActiveTabIsTmuxControl())
+                {
+                    return _tmuxControl->SplitActivePane(realArgs.SplitDirection());
+                }
+            }
+
             if (_shouldBailForInvalidProfileIndex(_settings, realArgs.ContentArgs()))
             {
                 args.Handled(false);

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

@@ -986,4 +986,7 @@
   <data name="InvalidRegex" xml:space="preserve">
     <value>An invalid regular expression was found.</value>
   </data>
-</root>
+  <data name="NewTmuxControlTab.Text" xml:space="preserve">
+    <value>Tmux Control Tab</value>
+  </data>
+</root>

src/cascadia/TerminalApp/TabRowControl.xaml

@@ -132,38 +132,6 @@
                         </ResourceDictionary>
                     </mux:SplitButton.Resources>
                 </mux:SplitButton>
-                <mux:SplitButton x:Name="NewTmuxTabButton"
-                                 x:Uid="NewTmuxTabSplitButton"
-                                 Height="24"
-                                 Margin="0,4"
-                                 Padding="0"
-                                 HorizontalAlignment="Left"
-                                 VerticalAlignment="Stretch"
-                                 AllowDrop="False"
-                                 AutomationProperties.AccessibilityView="Control"
-                                 BorderThickness="0"
-                                 Content="&#xE710;"
-                                 FontFamily="{ThemeResource SymbolThemeFontFamily}"
-                                 FontSize="12"
-                                 Visibility="Collapsed">
-                    <mux:SplitButton.Flyout>
-                        <MenuFlyout x:Name="SplitMenu" Placement="BottomEdgeAlignedLeft">
-                            <MenuFlyoutItem Text="Horizontal Split">
-                                <MenuFlyoutItem.Icon>
-                                    <FontIcon Glyph="&#xE784;">
-                                    </FontIcon>
-                                </MenuFlyoutItem.Icon>
-                            </MenuFlyoutItem>
-                            <MenuFlyoutItem Text="Vertical Split">
-                                <MenuFlyoutItem.Icon>
-                                    <FontIcon Glyph="&#xE76F;">
-                                    </FontIcon>
-                                </MenuFlyoutItem.Icon>
-                            </MenuFlyoutItem>
-                        </MenuFlyout>
-                    </mux:SplitButton.Flyout>
-
-                </mux:SplitButton>
             </Grid>
         </mux:TabView.TabStripFooter>
 

src/cascadia/TerminalApp/TerminalPage.cpp

@@ -106,7 +106,10 @@ namespace winrt::TerminalApp::implementation
         }
         _hostingHwnd = hwnd;
 
-        _tmuxControl = std::make_unique<TmuxControl>(*this);
+        if constexpr (Feature_TmuxControl::IsEnabled())
+        {
+            _tmuxControl = std::make_unique<TmuxControl>(*this);
+        }
         return S_OK;
     }
 
@@ -241,6 +244,15 @@ namespace winrt::TerminalApp::implementation
         _newTabButton.Click([weakThis{ get_weak() }](auto&&, auto&&) {
             if (auto page{ weakThis.get() })
             {
+                if constexpr (Feature_TmuxControl::IsEnabled())
+                {
+                    //Tmux control takes over
+                    if (page->_tmuxControl && page->_tmuxControl->ActiveTabIsTmuxControl())
+                    {
+                        return;
+                    }
+                }
+
                 page->_OpenNewTerminalViaDropdown(NewTerminalArgs());
             }
         });
@@ -1206,6 +1218,15 @@ namespace winrt::TerminalApp::implementation
             }
             if (altPressed && !debugTap)
             {
+                // tmux control panes don't share tab with other panes
+                if constexpr (Feature_TmuxControl::IsEnabled())
+                {
+                    if (_tmuxControl && _tmuxControl->ActiveTabIsTmuxControl())
+                    {
+                        return;
+                    }
+                }
+
                 this->_SplitPane(_GetFocusedTabImpl(),
                                  SplitDirection::Automatic,
                                  0.5f,
@@ -2244,6 +2265,15 @@ namespace winrt::TerminalApp::implementation
             return false;
         }
 
+        if constexpr (Feature_TmuxControl::IsEnabled())
+        {
+            //Tmux control tab doesn't support to drag
+            if (_tmuxControl && _tmuxControl->ActiveTabIsTmuxControl())
+            {
+                return false;
+            }
+        }
+
         // If there was a windowId in the action, try to move it to the
         // specified window instead of moving it in our tab row.
         const auto windowId{ args.Window() };
@@ -2306,7 +2336,7 @@ namespace winrt::TerminalApp::implementation
     // for it. The Title change will be propagated upwards through the tab's
     // PropertyChanged event handler.
     void TerminalPage::_activePaneChanged(winrt::TerminalApp::TerminalTab sender,
-                                          Windows::Foundation::IInspectable args)
+                                          Windows::Foundation::IInspectable /*args*/)
     {
         if (const auto tab{ _GetTerminalTabImpl(sender) })
         {
@@ -3191,7 +3221,7 @@ namespace winrt::TerminalApp::implementation
         const auto tabViewItem = eventArgs.Tab();
         if (auto tab{ _GetTabByTabViewItem(tabViewItem) })
         {
-            _HandleCloseTabRequested(tab);
+            tab.try_as<TabBase>()->CloseRequested.raise(nullptr, nullptr);
         }
     }
 
@@ -3357,9 +3387,16 @@ namespace winrt::TerminalApp::implementation
             resultPane->ClearActive();
             original->SetActive();
         }
-        control.SetTmuxControlHandlerProducer([this, control](auto print) {
-            return _tmuxControl->TmuxControlHandlerProducer(control, print);
-        });
+
+        if constexpr (Feature_TmuxControl::IsEnabled())
+        {
+            if (profile.AllowTmuxControl() && _tmuxControl)
+            {
+                control.SetTmuxControlHandlerProducer([this, control](auto print) {
+                    return _tmuxControl->TmuxControlHandlerProducer(control, print);
+                });
+            }
+        }
 
         return resultPane;
     }
@@ -5241,6 +5278,14 @@ namespace winrt::TerminalApp::implementation
     void TerminalPage::_onTabDragStarting(const winrt::Microsoft::UI::Xaml::Controls::TabView&,
                                           const winrt::Microsoft::UI::Xaml::Controls::TabViewTabDragStartingEventArgs& e)
     {
+        if constexpr (Feature_TmuxControl::IsEnabled())
+        {
+            //Tmux control tab doesn't support to drag
+            if (_tmuxControl && _tmuxControl->ActiveTabIsTmuxControl())
+            {
+                return;
+            }
+        }
         // Get the tab impl from this event.
         const auto eventTab = e.Tab();
         const auto tabBase = _GetTabByTabViewItem(eventTab);
@@ -5388,8 +5433,8 @@ namespace winrt::TerminalApp::implementation
         _sendDraggedTabToWindow(winrt::to_hstring(args.TargetWindow()), args.TabIndex(), std::nullopt);
     }
 
-    void TerminalPage::_onTabDroppedOutside(winrt::IInspectable sender,
-                                            winrt::MUX::Controls::TabViewTabDroppedOutsideEventArgs e)
+    void TerminalPage::_onTabDroppedOutside(winrt::IInspectable /*sender*/,
+                                            winrt::MUX::Controls::TabViewTabDroppedOutsideEventArgs /*e*/)
     {
         // Get the current pointer point from the CoreWindow
         const auto& pointerPoint{ CoreWindow::GetForCurrentThread().PointerPosition() };