Move MouseInput from TermAdapter to TermInput (#4848)

## Summary of the Pull Request Move the contents and functionality of MouseInput from TerminalAdapter to TerminalInput. ## References #545 - VT Mouse Mode (Terminal) #376 - VT Mouse Mode (ConPty) ## Detailed Description of the Pull Request / Additional comments Pretty straightforward. The MouseInput class was a bit large though so I split it up into a few files. This should make TerminalInput a bit easier to manage. - `mouseInputState`: enable some of the modes for mouse input. All saved to `_mouseInputState`. - `mouseInput`: basically just `HandleMouse()` and any helper functions ## Validation Steps Performed Tests should still pass.
microsoft · Mar 12, 2020 · 23f7420 · 23f7420
1 parent 64ac0d2
commit 23f7420
Show file tree

Hide file tree

Showing 18 changed files with 299 additions and 354 deletions.
diff --git a/src/host/consoleInformation.cpp b/src/host/consoleInformation.cpp
@@ -35,7 +35,6 @@ CONSOLE_INFORMATION::CONSOLE_INFORMATION() :
     // OutputCPInfo initialized below
     _cookedReadData(nullptr),
     ConsoleIme{},
-    terminalMouseInput(HandleTerminalKeyEventCallback),
     _vtIo(),
     _blinker{},
     renderData{}
@@ -180,18 +179,6 @@ void CONSOLE_INFORMATION::SetCookedReadData(COOKED_READ_DATA* readData) noexcept
     _cookedReadData = readData;
 }
 
-// Routine Description:
-// - Handler for inserting key sequences into the buffer when the terminal emulation layer
-//   has determined a key can be converted appropriately into a sequence of inputs
-// Arguments:
-// - events - the input events to write to the input buffer
-// Return Value:
-// - <none>
-void CONSOLE_INFORMATION::HandleTerminalKeyEventCallback(_Inout_ std::deque<std::unique_ptr<IInputEvent>>& events)
-{
-    ServiceLocator::LocateGlobals().getConsoleInformation().pInputBuffer->Write(events);
-}
-
 // Method Description:
 // - Return the active screen buffer of the console.
 // Arguments:

diff --git a/src/host/getset.cpp b/src/host/getset.cpp
@@ -1616,7 +1616,7 @@ void DoSrvPrivateTabClear(const bool fClearAll)
 void DoSrvPrivateEnableVT200MouseMode(const bool fEnable)
 {
     CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
-    gci.terminalMouseInput.EnableDefaultTracking(fEnable);
+    gci.GetActiveInputBuffer()->GetTerminalInput().EnableDefaultTracking(fEnable);
 }
 
 // Routine Description:
@@ -1628,7 +1628,7 @@ void DoSrvPrivateEnableVT200MouseMode(const bool fEnable)
 void DoSrvPrivateEnableUTF8ExtendedMouseMode(const bool fEnable)
 {
     CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
-    gci.terminalMouseInput.SetUtf8ExtendedMode(fEnable);
+    gci.GetActiveInputBuffer()->GetTerminalInput().SetUtf8ExtendedMode(fEnable);
 }
 
 // Routine Description:
@@ -1640,7 +1640,7 @@ void DoSrvPrivateEnableUTF8ExtendedMouseMode(const bool fEnable)
 void DoSrvPrivateEnableSGRExtendedMouseMode(const bool fEnable)
 {
     CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
-    gci.terminalMouseInput.SetSGRExtendedMode(fEnable);
+    gci.GetActiveInputBuffer()->GetTerminalInput().SetSGRExtendedMode(fEnable);
 }
 
 // Routine Description:
@@ -1652,7 +1652,7 @@ void DoSrvPrivateEnableSGRExtendedMouseMode(const bool fEnable)
 void DoSrvPrivateEnableButtonEventMouseMode(const bool fEnable)
 {
     CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
-    gci.terminalMouseInput.EnableButtonEventTracking(fEnable);
+    gci.GetActiveInputBuffer()->GetTerminalInput().EnableButtonEventTracking(fEnable);
 }
 
 // Routine Description:
@@ -1664,7 +1664,7 @@ void DoSrvPrivateEnableButtonEventMouseMode(const bool fEnable)
 void DoSrvPrivateEnableAnyEventMouseMode(const bool fEnable)
 {
     CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
-    gci.terminalMouseInput.EnableAnyEventTracking(fEnable);
+    gci.GetActiveInputBuffer()->GetTerminalInput().EnableAnyEventTracking(fEnable);
 }
 
 // Routine Description:
@@ -1676,7 +1676,7 @@ void DoSrvPrivateEnableAnyEventMouseMode(const bool fEnable)
 void DoSrvPrivateEnableAlternateScroll(const bool fEnable)
 {
     CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
-    gci.terminalMouseInput.EnableAlternateScroll(fEnable);
+    gci.GetActiveInputBuffer()->GetTerminalInput().EnableAlternateScroll(fEnable);
 }
 
 // Routine Description:

diff --git a/src/host/inputBuffer.cpp b/src/host/inputBuffer.cpp
@@ -466,6 +466,8 @@ size_t InputBuffer::Prepend(_Inout_ std::deque<std::unique_ptr<IInputEvent>>& in
 {
     try
     {
+        _vtInputShouldSuppress = true;
+        auto resetVtInputSupress = wil::scope_exit([&]() { _vtInputShouldSuppress = false; });
         _HandleConsoleSuspensionEvents(inEvents);
         if (inEvents.empty())
         {
@@ -556,6 +558,8 @@ size_t InputBuffer::Write(_Inout_ std::deque<std::unique_ptr<IInputEvent>>& inEv
 {
     try
     {
+        _vtInputShouldSuppress = true;
+        auto resetVtInputSuppress = wil::scope_exit([&]() { _vtInputShouldSuppress = false; });
         _HandleConsoleSuspensionEvents(inEvents);
         if (inEvents.empty())
         {
@@ -841,8 +845,7 @@ bool InputBuffer::IsInVirtualTerminalInputMode() const
 // - Handler for inserting key sequences into the buffer when the terminal emulation layer
 //   has determined a key can be converted appropriately into a sequence of inputs
 // Arguments:
-// - rgInput - Series of input records to insert into the buffer
-// - cInput - Length of input records array
+// - inEvents - Series of input records to insert into the buffer
 // Return Value:
 // - <none>
 void InputBuffer::_HandleTerminalInputCallback(std::deque<std::unique_ptr<IInputEvent>>& inEvents)
@@ -856,6 +859,12 @@ void InputBuffer::_HandleTerminalInputCallback(std::deque<std::unique_ptr<IInput
             inEvents.pop_front();
             _storage.push_back(std::move(inEvent));
         }
+
+        if (!_vtInputShouldSuppress)
+        {
+            ServiceLocator::LocateGlobals().hInputEvent.SetEvent();
+            WakeUpReadersWaitingForData();
+        }
     }
     catch (...)
     {

diff --git a/src/host/inputBuffer.hpp b/src/host/inputBuffer.hpp
@@ -82,6 +82,12 @@ class InputBuffer final : public ConsoleObjectHeader
     std::unique_ptr<IInputEvent> _writePartialByteSequence;
     Microsoft::Console::VirtualTerminal::TerminalInput _termInput;
 
+    // This flag is used in _HandleTerminalInputCallback
+    // If the InputBuffer leads to a _HandleTerminalInputCallback call,
+    //    we should suppress the wakeup functions.
+    // Otherwise, we should be calling them.
+    bool _vtInputShouldSuppress{ false };
+
     void _ReadBuffer(_Out_ std::deque<std::unique_ptr<IInputEvent>>& outEvents,
                      const size_t readCount,
                      _Out_ size_t& eventsRead,

diff --git a/src/host/screenInfo.cpp b/src/host/screenInfo.cpp
@@ -1890,7 +1890,7 @@ const SCREEN_INFORMATION& SCREEN_INFORMATION::GetMainBuffer() const
         ScreenBufferSizeChange(psiNewAltBuffer->GetBufferSize().Dimensions());
 
         // Tell the VT MouseInput handler that we're in the Alt buffer now
-        gci.terminalMouseInput.UseAlternateScreenBuffer();
+        gci.GetActiveInputBuffer()->GetTerminalInput().UseAlternateScreenBuffer();
     }
     return Status;
 }
@@ -1924,7 +1924,7 @@ void SCREEN_INFORMATION::UseMainScreenBuffer()
         // deleting the alt buffer will give the GetSet back to its main
 
         // Tell the VT MouseInput handler that we're in the main buffer now
-        gci.terminalMouseInput.UseMainScreenBuffer();
+        gci.GetActiveInputBuffer()->GetTerminalInput().UseMainScreenBuffer();
     }
 }
 

diff --git a/src/host/server.h b/src/host/server.h
@@ -21,7 +21,6 @@ Revision History:
 #include "settings.hpp"
 
 #include "conimeinfo.h"
-#include "..\terminal\adapter\MouseInput.hpp"
 #include "VtIo.hpp"
 #include "CursorBlinker.hpp"
 
@@ -107,8 +106,6 @@ class CONSOLE_INFORMATION :
 
     ConsoleImeInfo ConsoleIme;
 
-    Microsoft::Console::VirtualTerminal::MouseInput terminalMouseInput;
-
     void LockConsole();
     bool TryLockConsole();
     void UnlockConsole();
@@ -117,8 +114,6 @@ class CONSOLE_INFORMATION :
 
     Microsoft::Console::VirtualTerminal::VtIo* GetVtIo();
 
-    static void HandleTerminalKeyEventCallback(_Inout_ std::deque<std::unique_ptr<IInputEvent>>& events);
-
     SCREEN_INFORMATION& GetActiveOutputBuffer() override;
     const SCREEN_INFORMATION& GetActiveOutputBuffer() const override;
     bool HasActiveOutputBuffer() const;

diff --git a/src/interactivity/win32/windowio.cpp b/src/interactivity/win32/windowio.cpp
@@ -123,7 +123,7 @@ bool HandleTerminalMouseEvent(const COORD cMousePosition,
     // Virtual terminal input mode
     if (IsInVirtualTerminalInputMode())
     {
-        fWasHandled = gci.terminalMouseInput.HandleMouse(cMousePosition, uiButton, sModifierKeystate, sWheelDelta);
+        fWasHandled = gci.GetActiveInputBuffer()->GetTerminalInput().HandleMouse(cMousePosition, uiButton, sModifierKeystate, sWheelDelta);
     }
 
     return fWasHandled;

diff --git a/src/terminal/adapter/MouseInput.hpp b/src/terminal/adapter/MouseInput.hpp
diff --git a/src/terminal/adapter/lib/adapter.vcxproj b/src/terminal/adapter/lib/adapter.vcxproj
@@ -14,7 +14,6 @@
     <ClCompile Include="..\DispatchCommon.cpp" />
     <ClCompile Include="..\InteractDispatch.cpp" />
     <ClCompile Include="..\adaptDispatchGraphics.cpp" />
-    <ClCompile Include="..\MouseInput.cpp" />
     <ClCompile Include="..\telemetry.cpp" />
     <ClCompile Include="..\terminalOutput.cpp" />
     <ClCompile Include="..\tracing.cpp" />
@@ -29,7 +28,6 @@
     <ClInclude Include="..\DispatchCommon.hpp" />
     <ClInclude Include="..\InteractDispatch.hpp" />
     <ClInclude Include="..\conGetSet.hpp" />
-    <ClInclude Include="..\MouseInput.hpp" />
     <ClInclude Include="..\precomp.h" />
     <ClInclude Include="..\telemetry.hpp" />
     <ClInclude Include="..\terminalOutput.hpp" />

diff --git a/src/terminal/adapter/lib/adapter.vcxproj.filters b/src/terminal/adapter/lib/adapter.vcxproj.filters
@@ -39,9 +39,6 @@
     <ClCompile Include="..\InteractDispatch.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
-    <ClCompile Include="..\MouseInput.cpp">
-      <Filter>Source Files</Filter>
-    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="..\adaptDefaults.hpp">
@@ -65,9 +62,6 @@
     <ClInclude Include="..\tracing.hpp">
       <Filter>Header Files</Filter>
     </ClInclude>
-    <ClInclude Include="..\MouseInput.hpp">
-      <Filter>Header Files</Filter>
-    </ClInclude>
     <ClInclude Include="..\DispatchCommon.hpp">
       <Filter>Header Files</Filter>
     </ClInclude>

diff --git a/src/terminal/adapter/sources.inc b/src/terminal/adapter/sources.inc
@@ -34,7 +34,6 @@ SOURCES= \
     ..\DispatchCommon.cpp \
     ..\InteractDispatch.cpp \
     ..\adaptDispatchGraphics.cpp \
-    ..\MouseInput.cpp \
     ..\terminalOutput.cpp \
     ..\telemetry.cpp \
     ..\tracing.cpp \

diff --git a/src/terminal/adapter/ut_adapter/MouseInputTest.cpp b/src/terminal/adapter/ut_adapter/MouseInputTest.cpp
@@ -5,7 +5,7 @@
 #include <wextestclass.h>
 #include "..\..\inc\consoletaeftemplates.hpp"
 
-#include "MouseInput.hpp"
+#include "..\terminal\input\terminalInput.hpp"
 
 using namespace WEX::Common;
 using namespace WEX::Logging;
@@ -280,7 +280,7 @@ class MouseInputTest
 
         Log::Comment(L"Starting test...");
 
-        std::unique_ptr<MouseInput> mouseInput = std::make_unique<MouseInput>(s_MouseInputTestCallback);
+        std::unique_ptr<TerminalInput> mouseInput = std::make_unique<TerminalInput>(s_MouseInputTestCallback);
 
         unsigned int uiModifierKeystate = 0;
         VERIFY_SUCCEEDED_RETURN(TestData::TryGetValue(L"uiModifierKeystate", uiModifierKeystate));
@@ -359,7 +359,7 @@ class MouseInputTest
 
         Log::Comment(L"Starting test...");
 
-        std::unique_ptr<MouseInput> mouseInput = std::make_unique<MouseInput>(s_MouseInputTestCallback);
+        std::unique_ptr<TerminalInput> mouseInput = std::make_unique<TerminalInput>(s_MouseInputTestCallback);
 
         unsigned int uiModifierKeystate = 0;
         VERIFY_SUCCEEDED_RETURN(TestData::TryGetValue(L"uiModifierKeystate", uiModifierKeystate));
@@ -442,7 +442,7 @@ class MouseInputTest
 
         Log::Comment(L"Starting test...");
 
-        std::unique_ptr<MouseInput> mouseInput = std::make_unique<MouseInput>(s_MouseInputTestCallback);
+        std::unique_ptr<TerminalInput> mouseInput = std::make_unique<TerminalInput>(s_MouseInputTestCallback);
         unsigned int uiModifierKeystate = 0;
         VERIFY_SUCCEEDED_RETURN(TestData::TryGetValue(L"uiModifierKeystate", uiModifierKeystate));
         short sModifierKeystate = (SHORT)uiModifierKeystate;
@@ -520,7 +520,7 @@ class MouseInputTest
 
         Log::Comment(L"Starting test...");
 
-        std::unique_ptr<MouseInput> mouseInput = std::make_unique<MouseInput>(s_MouseInputTestCallback);
+        std::unique_ptr<TerminalInput> mouseInput = std::make_unique<TerminalInput>(s_MouseInputTestCallback);
         unsigned int uiModifierKeystate = 0;
         VERIFY_SUCCEEDED_RETURN(TestData::TryGetValue(L"uiModifierKeystate", uiModifierKeystate));
         short sModifierKeystate = (SHORT)uiModifierKeystate;

diff --git a/src/terminal/input/lib/terminalinput.vcxproj b/src/terminal/input/lib/terminalinput.vcxproj
@@ -6,10 +6,12 @@
     <RootNamespace>adapter</RootNamespace>
     <ProjectName>TerminalInput</ProjectName>
     <TargetName>TerminalInput</TargetName>
-    <ConfigurationType>StaticLibrary</ConfigurationType>
+    <ConfigurationType>StaticLibrary</ConfigurationType>
   </PropertyGroup>
   <Import Project="$(SolutionDir)src\common.build.pre.props" />
   <ItemGroup>
+    <ClCompile Include="..\mouseInput.cpp" />
+    <ClCompile Include="..\mouseInputState.cpp" />
     <ClCompile Include="..\terminalInput.cpp" />
     <ClCompile Include="..\precomp.cpp">
       <PrecompiledHeader>Create</PrecompiledHeader>
@@ -26,4 +28,4 @@
   </ItemGroup>
   <!-- Careful reordering these. Some default props (contained in these files) are order sensitive. -->
   <Import Project="$(SolutionDir)src\common.build.post.props" />
-</Project>
+</Project>