[Conpty] Pass through request for mouse mode to the Terminal

src/host/VtIo.cpp

@@ -213,6 +213,7 @@ bool VtIo::IsUsingVt() const
         {
             g.pRender->AddRenderEngine(_pVtRenderEngine.get());
             g.getConsoleInformation().GetActiveOutputBuffer().SetTerminalConnection(_pVtRenderEngine.get());
+            g.getConsoleInformation().GetActiveInputBuffer()->SetTerminalConnection(_pVtRenderEngine.get());
         }
         CATCH_RETURN();
     }

src/host/getset.cpp

@@ -334,6 +334,8 @@ void ApiRoutines::GetNumberOfConsoleMouseButtonsImpl(ULONG& buttons) noexcept
         LockConsole();
         auto Unlock = wil::scope_exit([&] { UnlockConsole(); });
 
+        const auto oldQuickEditMode{ WI_IsFlagSet(gci.Flags, ENABLE_QUICK_EDIT_MODE) };
+
         if (WI_IsAnyFlagSet(mode, PRIVATE_MODES))
         {
             WI_SetFlag(gci.Flags, CONSOLE_USE_PRIVATE_FLAGS);
@@ -357,6 +359,31 @@ void ApiRoutines::GetNumberOfConsoleMouseButtonsImpl(ULONG& buttons) noexcept
             WI_ClearFlag(gci.Flags, CONSOLE_USE_PRIVATE_FLAGS);
         }
 
+        const auto oldMouseMode{ WI_IsFlagSet(context.InputMode, ENABLE_MOUSE_INPUT) };
+        const auto newMouseMode{ WI_IsFlagSet(mode, ENABLE_MOUSE_INPUT) };
+        const auto newQuickEditMode{ WI_IsFlagSet(gci.Flags, ENABLE_QUICK_EDIT_MODE) };
+
+        // Whether we ask the terminal for mouse input is decided by 2 flags, ENABLE_MOUSE_INPUT
+        // and ENABLE_QUICK_EDIT_MODE
+        // If ENABLE_MOUSE_INPUT is set and ENABLE_QUICK_EDIT_MODE is not set, then we need
+        // to ask the terminal to send us mouse events - in all other cases, terminal should
+        // stop sending us mouse events
+        if ((oldMouseMode != newMouseMode) ||
+            (oldQuickEditMode != newQuickEditMode))
+        {
+            // At least one of ENABLE_MOUSE_INPUT or ENABLE_QUICK_EDIT_MODE changed, but we
+            // only want to send the VT if the end result (whether we want mouse input or not)
+            // changed, so check for that
+            if ((newMouseMode && !newQuickEditMode))
+            {
+                gci.GetActiveInputBuffer()->PassThroughWin32MouseRequest(true);
+            }
+            else if (oldMouseMode && !oldQuickEditMode)
+            {
+                gci.GetActiveInputBuffer()->PassThroughWin32MouseRequest(false);
+            }
+        }
+
         context.InputMode = mode;
         WI_ClearAllFlags(context.InputMode, PRIVATE_MODES);
 

src/host/inputBuffer.cpp

@@ -15,6 +15,7 @@
 
 using Microsoft::Console::Interactivity::ServiceLocator;
 using Microsoft::Console::VirtualTerminal::TerminalInput;
+using namespace Microsoft::Console;
 
 // Routine Description:
 // - This method creates an input buffer.
@@ -25,6 +26,7 @@ using Microsoft::Console::VirtualTerminal::TerminalInput;
 InputBuffer::InputBuffer() :
     InputMode{ INPUT_BUFFER_DEFAULT_INPUT_MODE },
     WaitQueue{},
+    _pTtyConnection(nullptr),
     _termInput(std::bind(&InputBuffer::_HandleTerminalInputCallback, this, std::placeholders::_1))
 {
     // The _termInput's constructor takes a reference to this object's _HandleTerminalInputCallback.
@@ -218,6 +220,28 @@ void InputBuffer::FlushAllButKeys()
     _storage.erase(newEnd, _storage.end());
 }
 
+void InputBuffer::SetTerminalConnection(_In_ ITerminalOutputConnection* const pTtyConnection)
+{
+    this->_pTtyConnection = pTtyConnection;
+}
+
+void InputBuffer::PassThroughWin32MouseRequest(bool enable)
+{
+    if (_pTtyConnection)
+    {
+        if (enable)
+        {
+            LOG_IF_FAILED(_pTtyConnection->WriteTerminalW(L"\x1b[?1003h"));
+            LOG_IF_FAILED(_pTtyConnection->WriteTerminalW(L"\x1b[?1006h"));
+        }
+        else
+        {
+            LOG_IF_FAILED(_pTtyConnection->WriteTerminalW(L"\x1b[?1003l"));
+            LOG_IF_FAILED(_pTtyConnection->WriteTerminalW(L"\x1b[?1006l"));
+        }
+    }
+}
+
 // Routine Description:
 // - This routine reads from the input buffer.
 // - It can convert returned data to through the currently set Input CP, it can optionally return a wait condition

src/host/inputBuffer.hpp

@@ -26,6 +26,8 @@ Revision History:
 #include "../server/ObjectHeader.h"
 #include "../terminal/input/terminalInput.hpp"
 
+#include "../inc/ITerminalOutputConnection.hpp"
+
 #include <deque>
 
 class InputBuffer final : public ConsoleObjectHeader
@@ -75,12 +77,15 @@ class InputBuffer final : public ConsoleObjectHeader
 
     bool IsInVirtualTerminalInputMode() const;
     Microsoft::Console::VirtualTerminal::TerminalInput& GetTerminalInput();
+    void SetTerminalConnection(_In_ Microsoft::Console::ITerminalOutputConnection* const pTtyConnection);
+    void PassThroughWin32MouseRequest(bool enable);
 
 private:
     std::deque<std::unique_ptr<IInputEvent>> _storage;
     std::unique_ptr<IInputEvent> _readPartialByteSequence;
     std::unique_ptr<IInputEvent> _writePartialByteSequence;
     Microsoft::Console::VirtualTerminal::TerminalInput _termInput;
+    Microsoft::Console::ITerminalOutputConnection* _pTtyConnection;
 
     // This flag is used in _HandleTerminalInputCallback
     // If the InputBuffer leads to a _HandleTerminalInputCallback call,