Consolidate the interfaces for setting VT input modes

src/cascadia/TerminalCore/ITerminalApi.hpp

@@ -3,6 +3,7 @@
 #pragma once
 
 #include "../../terminal/adapter/DispatchTypes.hpp"
+#include "../../terminal/input/terminalInput.hpp"
 #include "../../buffer/out/TextAttribute.hpp"
 #include "../../types/inc/Viewport.hpp"
 
@@ -47,16 +48,9 @@ namespace Microsoft::Terminal::Core
         virtual bool SetDefaultForeground(const DWORD color) noexcept = 0;
         virtual bool SetDefaultBackground(const DWORD color) noexcept = 0;
 
-        virtual bool EnableWin32InputMode(const bool win32InputMode) noexcept = 0;
-        virtual bool SetCursorKeysMode(const bool applicationMode) noexcept = 0;
-        virtual bool SetKeypadMode(const bool applicationMode) noexcept = 0;
+        virtual bool SetInputMode(const ::Microsoft::Console::VirtualTerminal::TerminalInput::Mode mode, const bool enabled) noexcept = 0;
+
         virtual bool SetScreenMode(const bool reverseMode) noexcept = 0;
-        virtual bool EnableVT200MouseMode(const bool enabled) noexcept = 0;
-        virtual bool EnableUTF8ExtendedMouseMode(const bool enabled) noexcept = 0;
-        virtual bool EnableSGRExtendedMouseMode(const bool enabled) noexcept = 0;
-        virtual bool EnableButtonEventMouseMode(const bool enabled) noexcept = 0;
-        virtual bool EnableAnyEventMouseMode(const bool enabled) noexcept = 0;
-        virtual bool EnableAlternateScrollMode(const bool enabled) noexcept = 0;
         virtual bool EnableXtermBracketedPasteMode(const bool enabled) noexcept = 0;
         virtual bool IsXtermBracketedPasteModeEnabled() const = 0;
 

src/cascadia/TerminalCore/Terminal.hpp

@@ -112,16 +112,9 @@ class Microsoft::Terminal::Core::Terminal final :
     bool SetDefaultForeground(const COLORREF color) noexcept override;
     bool SetDefaultBackground(const COLORREF color) noexcept override;
 
-    bool EnableWin32InputMode(const bool win32InputMode) noexcept override;
-    bool SetCursorKeysMode(const bool applicationMode) noexcept override;
-    bool SetKeypadMode(const bool applicationMode) noexcept override;
+    bool SetInputMode(const ::Microsoft::Console::VirtualTerminal::TerminalInput::Mode mode, const bool enabled) noexcept override;
+
     bool SetScreenMode(const bool reverseMode) noexcept override;
-    bool EnableVT200MouseMode(const bool enabled) noexcept override;
-    bool EnableUTF8ExtendedMouseMode(const bool enabled) noexcept override;
-    bool EnableSGRExtendedMouseMode(const bool enabled) noexcept override;
-    bool EnableButtonEventMouseMode(const bool enabled) noexcept override;
-    bool EnableAnyEventMouseMode(const bool enabled) noexcept override;
-    bool EnableAlternateScrollMode(const bool enabled) noexcept override;
     bool EnableXtermBracketedPasteMode(const bool enabled) noexcept override;
     bool IsXtermBracketedPasteModeEnabled() const noexcept override;
 

src/cascadia/TerminalCore/TerminalApi.cpp

@@ -482,23 +482,13 @@ til::color Terminal::GetDefaultBackground() const noexcept
     return _defaultBg;
 }
 
-bool Terminal::EnableWin32InputMode(const bool win32InputMode) noexcept
-{
-    _terminalInput->ChangeWin32InputMode(win32InputMode);
-    return true;
-}
-
-bool Terminal::SetCursorKeysMode(const bool applicationMode) noexcept
-{
-    _terminalInput->ChangeCursorKeysMode(applicationMode);
-    return true;
-}
-
-bool Terminal::SetKeypadMode(const bool applicationMode) noexcept
+bool Terminal::SetInputMode(const TerminalInput::Mode mode, const bool enabled) noexcept
+try
 {
-    _terminalInput->ChangeKeypadMode(applicationMode);
+    _terminalInput->SetInputMode(mode, enabled);
     return true;
 }
+CATCH_RETURN_FALSE()
 
 bool Terminal::SetScreenMode(const bool reverseMode) noexcept
 try
@@ -511,42 +501,6 @@ try
 }
 CATCH_RETURN_FALSE()
 
-bool Terminal::EnableVT200MouseMode(const bool enabled) noexcept
-{
-    _terminalInput->EnableDefaultTracking(enabled);
-    return true;
-}
-
-bool Terminal::EnableUTF8ExtendedMouseMode(const bool enabled) noexcept
-{
-    _terminalInput->SetUtf8ExtendedMode(enabled);
-    return true;
-}
-
-bool Terminal::EnableSGRExtendedMouseMode(const bool enabled) noexcept
-{
-    _terminalInput->SetSGRExtendedMode(enabled);
-    return true;
-}
-
-bool Terminal::EnableButtonEventMouseMode(const bool enabled) noexcept
-{
-    _terminalInput->EnableButtonEventTracking(enabled);
-    return true;
-}
-
-bool Terminal::EnableAnyEventMouseMode(const bool enabled) noexcept
-{
-    _terminalInput->EnableAnyEventTracking(enabled);
-    return true;
-}
-
-bool Terminal::EnableAlternateScrollMode(const bool enabled) noexcept
-{
-    _terminalInput->EnableAlternateScroll(enabled);
-    return true;
-}
-
 bool Terminal::EnableXtermBracketedPasteMode(const bool enabled) noexcept
 {
     _bracketedPasteMode = enabled;

src/cascadia/TerminalCore/TerminalDispatch.cpp

@@ -321,9 +321,9 @@ CATCH_LOG_RETURN_FALSE()
 // - applicationMode - set to true to enable Application Mode Input, false for Numeric Mode Input.
 // Return Value:
 // - True if handled successfully. False otherwise.
-bool TerminalDispatch::SetKeypadMode(const bool fApplicationMode) noexcept
+bool TerminalDispatch::SetKeypadMode(const bool applicationMode) noexcept
 {
-    _terminalApi.SetKeypadMode(fApplicationMode);
+    _terminalApi.SetInputMode(TerminalInput::Mode::Keypad, applicationMode);
     return true;
 }
 
@@ -334,7 +334,7 @@ bool TerminalDispatch::SetKeypadMode(const bool fApplicationMode) noexcept
 // - True if handled successfully. False otherwise.
 bool TerminalDispatch::SetCursorKeysMode(const bool applicationMode) noexcept
 {
-    _terminalApi.SetCursorKeysMode(applicationMode);
+    _terminalApi.SetInputMode(TerminalInput::Mode::CursorKey, applicationMode);
     return true;
 }
 
@@ -359,7 +359,7 @@ bool TerminalDispatch::SetScreenMode(const bool reverseMode) noexcept
 // - True if handled successfully. False otherwise.
 bool TerminalDispatch::EnableWin32InputMode(const bool win32Mode) noexcept
 {
-    _terminalApi.EnableWin32InputMode(win32Mode);
+    _terminalApi.SetInputMode(TerminalInput::Mode::Win32, win32Mode);
     return true;
 }
 
@@ -371,7 +371,7 @@ bool TerminalDispatch::EnableWin32InputMode(const bool win32Mode) noexcept
 // True if handled successfully. False otherwise.
 bool TerminalDispatch::EnableVT200MouseMode(const bool enabled) noexcept
 {
-    _terminalApi.EnableVT200MouseMode(enabled);
+    _terminalApi.SetInputMode(TerminalInput::Mode::DefaultMouseTracking, enabled);
     return true;
 }
 
@@ -384,7 +384,7 @@ bool TerminalDispatch::EnableVT200MouseMode(const bool enabled) noexcept
 // True if handled successfully. False otherwise.
 bool TerminalDispatch::EnableUTF8ExtendedMouseMode(const bool enabled) noexcept
 {
-    _terminalApi.EnableUTF8ExtendedMouseMode(enabled);
+    _terminalApi.SetInputMode(TerminalInput::Mode::Utf8MouseEncoding, enabled);
     return true;
 }
 
@@ -397,7 +397,7 @@ bool TerminalDispatch::EnableUTF8ExtendedMouseMode(const bool enabled) noexcept
 // True if handled successfully. False otherwise.
 bool TerminalDispatch::EnableSGRExtendedMouseMode(const bool enabled) noexcept
 {
-    _terminalApi.EnableSGRExtendedMouseMode(enabled);
+    _terminalApi.SetInputMode(TerminalInput::Mode::SgrMouseEncoding, enabled);
     return true;
 }
 
@@ -409,7 +409,7 @@ bool TerminalDispatch::EnableSGRExtendedMouseMode(const bool enabled) noexcept
 // True if handled successfully. False otherwise.
 bool TerminalDispatch::EnableButtonEventMouseMode(const bool enabled) noexcept
 {
-    _terminalApi.EnableButtonEventMouseMode(enabled);
+    _terminalApi.SetInputMode(TerminalInput::Mode::ButtonEventMouseTracking, enabled);
     return true;
 }
 
@@ -422,7 +422,7 @@ bool TerminalDispatch::EnableButtonEventMouseMode(const bool enabled) noexcept
 // True if handled successfully. False otherwise.
 bool TerminalDispatch::EnableAnyEventMouseMode(const bool enabled) noexcept
 {
-    _terminalApi.EnableAnyEventMouseMode(enabled);
+    _terminalApi.SetInputMode(TerminalInput::Mode::AnyEventMouseTracking, enabled);
     return true;
 }
 
@@ -435,7 +435,7 @@ bool TerminalDispatch::EnableAnyEventMouseMode(const bool enabled) noexcept
 // True if handled successfully. False otherwise.
 bool TerminalDispatch::EnableAlternateScroll(const bool enabled) noexcept
 {
-    _terminalApi.EnableAlternateScrollMode(enabled);
+    _terminalApi.SetInputMode(TerminalInput::Mode::AlternateScroll, enabled);
     return true;
 }
 

src/host/getset.cpp

@@ -1248,55 +1248,6 @@ void ApiRoutines::GetConsoleDisplayModeImpl(ULONG& flags) noexcept
     CATCH_RETURN();
 }
 
-// Routine Description:
-// - A private API call for changing the cursor keys input mode between normal and application mode.
-//     The cursor keys are the arrows, plus Home and End.
-// Parameters:
-// - fApplicationMode - set to true to enable Application Mode Input, false for Numeric Mode Input.
-// Return value:
-// - True if handled successfully. False otherwise.
-[[nodiscard]] NTSTATUS DoSrvPrivateSetCursorKeysMode(_In_ bool fApplicationMode)
-{
-    CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
-    if (gci.pInputBuffer == nullptr)
-    {
-        return STATUS_UNSUCCESSFUL;
-    }
-    gci.pInputBuffer->GetTerminalInput().ChangeCursorKeysMode(fApplicationMode);
-    return STATUS_SUCCESS;
-}
-
-// Routine Description:
-// - A private API call for changing the keypad input mode between numeric and application mode.
-//     This controls what the keys on the numpad translate to.
-// Parameters:
-// - fApplicationMode - set to true to enable Application Mode Input, false for Numeric Mode Input.
-// Return value:
-// - True if handled successfully. False otherwise.
-[[nodiscard]] NTSTATUS DoSrvPrivateSetKeypadMode(_In_ bool fApplicationMode)
-{
-    CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
-    if (gci.pInputBuffer == nullptr)
-    {
-        return STATUS_UNSUCCESSFUL;
-    }
-    gci.pInputBuffer->GetTerminalInput().ChangeKeypadMode(fApplicationMode);
-    return STATUS_SUCCESS;
-}
-
-// Function Description:
-// - A private API call which enables/disables sending full input records
-//   encoded as a string of characters to the client application.
-// Parameters:
-// - win32InputMode - set to true to enable win32-input-mode, false to disable.
-// Return value:
-// - <none>
-void DoSrvPrivateEnableWin32InputMode(const bool win32InputMode)
-{
-    CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
-    gci.pInputBuffer->GetTerminalInput().ChangeWin32InputMode(win32InputMode);
-}
-
 // Routine Description:
 // - A private API call for changing the screen mode between normal and reverse.
 //    When in reverse screen mode, the background and foreground colors are switched.
@@ -1525,78 +1476,6 @@ void DoSrvPrivateUseMainScreenBuffer(SCREEN_INFORMATION& screenInfo)
     screenInfo.GetActiveBuffer().UseMainScreenBuffer();
 }
 
-// Routine Description:
-// - A private API call for enabling VT200 style mouse mode.
-// Parameters:
-// - fEnable - true to enable default tracking mode, false to disable mouse mode.
-// Return value:
-// - None
-void DoSrvPrivateEnableVT200MouseMode(const bool fEnable)
-{
-    CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
-    gci.GetActiveInputBuffer()->GetTerminalInput().EnableDefaultTracking(fEnable);
-}
-
-// Routine Description:
-// - A private API call for enabling utf8 style mouse mode.
-// Parameters:
-// - fEnable - true to enable, false to disable.
-// Return value:
-// - None
-void DoSrvPrivateEnableUTF8ExtendedMouseMode(const bool fEnable)
-{
-    CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
-    gci.GetActiveInputBuffer()->GetTerminalInput().SetUtf8ExtendedMode(fEnable);
-}
-
-// Routine Description:
-// - A private API call for enabling SGR style mouse mode.
-// Parameters:
-// - fEnable - true to enable, false to disable.
-// Return value:
-// - None
-void DoSrvPrivateEnableSGRExtendedMouseMode(const bool fEnable)
-{
-    CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
-    gci.GetActiveInputBuffer()->GetTerminalInput().SetSGRExtendedMode(fEnable);
-}
-
-// Routine Description:
-// - A private API call for enabling button-event mouse mode.
-// Parameters:
-// - fEnable - true to enable button-event mode, false to disable mouse mode.
-// Return value:
-// - None
-void DoSrvPrivateEnableButtonEventMouseMode(const bool fEnable)
-{
-    CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
-    gci.GetActiveInputBuffer()->GetTerminalInput().EnableButtonEventTracking(fEnable);
-}
-
-// Routine Description:
-// - A private API call for enabling any-event mouse mode.
-// Parameters:
-// - fEnable - true to enable any-event mode, false to disable mouse mode.
-// Return value:
-// - None
-void DoSrvPrivateEnableAnyEventMouseMode(const bool fEnable)
-{
-    CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
-    gci.GetActiveInputBuffer()->GetTerminalInput().EnableAnyEventTracking(fEnable);
-}
-
-// Routine Description:
-// - A private API call for enabling alternate scroll mode
-// Parameters:
-// - fEnable - true to enable alternate scroll mode, false to disable.
-// Return value:
-// None
-void DoSrvPrivateEnableAlternateScroll(const bool fEnable)
-{
-    CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
-    gci.GetActiveInputBuffer()->GetTerminalInput().EnableAlternateScroll(fEnable);
-}
-
 // Routine Description:
 // - A private API call for performing a VT-style erase all operation on the buffer.
 //      See SCREEN_INFORMATION::VtEraseAll's description for details.

src/host/getset.h

@@ -18,10 +18,6 @@ Revision History:
 #include "../inc/conattrs.hpp"
 class SCREEN_INFORMATION;
 
-[[nodiscard]] NTSTATUS DoSrvPrivateSetCursorKeysMode(_In_ bool fApplicationMode);
-[[nodiscard]] NTSTATUS DoSrvPrivateSetKeypadMode(_In_ bool fApplicationMode);
-void DoSrvPrivateEnableWin32InputMode(const bool win32InputMode);
-
 [[nodiscard]] NTSTATUS DoSrvPrivateSetScreenMode(const bool reverseMode);
 [[nodiscard]] NTSTATUS DoSrvPrivateSetAutoWrapMode(const bool wrapAtEOL);
 
@@ -35,13 +31,6 @@ void DoSrvPrivateAllowCursorBlinking(SCREEN_INFORMATION& screenInfo, const bool
 [[nodiscard]] NTSTATUS DoSrvPrivateUseAlternateScreenBuffer(SCREEN_INFORMATION& screenInfo);
 void DoSrvPrivateUseMainScreenBuffer(SCREEN_INFORMATION& screenInfo);
 
-void DoSrvPrivateEnableVT200MouseMode(const bool fEnable);
-void DoSrvPrivateEnableUTF8ExtendedMouseMode(const bool fEnable);
-void DoSrvPrivateEnableSGRExtendedMouseMode(const bool fEnable);
-void DoSrvPrivateEnableButtonEventMouseMode(const bool fEnable);
-void DoSrvPrivateEnableAnyEventMouseMode(const bool fEnable);
-void DoSrvPrivateEnableAlternateScroll(const bool fEnable);
-
 [[nodiscard]] HRESULT DoSrvPrivateEraseAll(SCREEN_INFORMATION& screenInfo);
 [[nodiscard]] HRESULT DoSrvPrivateClearBuffer(SCREEN_INFORMATION& screenInfo);