Add support for the DSR-OS operating status report

src/terminal/adapter/DispatchTypes.hpp

@@ -75,6 +75,7 @@ namespace Microsoft::Console::VirtualTerminal::DispatchTypes
 
     enum class AnsiStatusType : unsigned int
     {
+        OS_OperatingStatus = 5,
         CPR_CursorPositionReport = 6,
     };
 

src/terminal/adapter/ITermDispatch.hpp

@@ -90,7 +90,7 @@ class Microsoft::Console::VirtualTerminal::ITermDispatch
 
     virtual bool ResetPrivateModes(const std::basic_string_view<DispatchTypes::PrivateModeParams> params) = 0; // DECRST
 
-    virtual bool DeviceStatusReport(const DispatchTypes::AnsiStatusType statusType) = 0; // DSR, DSR-CPR
+    virtual bool DeviceStatusReport(const DispatchTypes::AnsiStatusType statusType) = 0; // DSR, DSR-OS, DSR-CPR
     virtual bool DeviceAttributes() = 0; // DA1
 
     virtual bool DesignateCharset(const wchar_t wchCharset) = 0; // SCS

src/terminal/adapter/adaptDispatch.cpp

@@ -685,6 +685,9 @@ bool AdaptDispatch::DeviceStatusReport(const DispatchTypes::AnsiStatusType statu
 
     switch (statusType)
     {
+    case DispatchTypes::AnsiStatusType::OS_OperatingStatus:
+        success = _OperatingStatus();
+        break;
     case DispatchTypes::AnsiStatusType::CPR_CursorPositionReport:
         success = _CursorPositionReport();
         break;
@@ -706,6 +709,18 @@ bool AdaptDispatch::DeviceAttributes()
     return _WriteResponse(L"\x1b[?1;0c");
 }
 
+// Routine Description:
+// - DSR-OS - Reports the operating status back to the input channel
+// Arguments:
+// - <none>
+// Return Value:
+// - True if handled successfully. False otherwise.
+bool AdaptDispatch::_OperatingStatus() const
+{
+    // We always report a good operating condition.
+    return _WriteResponse(L"\x1b[0n");
+}
+
 // Routine Description:
 // - DSR-CPR - Reports the current cursor position within the viewport back to the input channel
 // Arguments:

src/terminal/adapter/adaptDispatch.hpp

@@ -56,7 +56,7 @@ namespace Microsoft::Console::VirtualTerminal
         bool InsertCharacter(const size_t count) override; // ICH
         bool DeleteCharacter(const size_t count) override; // DCH
         bool SetGraphicsRendition(const std::basic_string_view<DispatchTypes::GraphicsOptions> options) override; // SGR
-        bool DeviceStatusReport(const DispatchTypes::AnsiStatusType statusType) override; // DSR, DSR-CPR
+        bool DeviceStatusReport(const DispatchTypes::AnsiStatusType statusType) override; // DSR, DSR-OS, DSR-CPR
         bool DeviceAttributes() override; // DA1
         bool ScrollUp(const size_t distance) override; // SU
         bool ScrollDown(const size_t distance) override; // SD
@@ -145,6 +145,7 @@ namespace Microsoft::Console::VirtualTerminal
 
         bool _DoSetTopBottomScrollingMargins(const size_t topMargin,
                                              const size_t bottomMargin);
+        bool _OperatingStatus() const;
         bool _CursorPositionReport() const;
 
         bool _WriteResponse(const std::wstring_view reply) const;

src/terminal/adapter/termDispatch.hpp

@@ -84,7 +84,7 @@ class Microsoft::Console::VirtualTerminal::TermDispatch : public Microsoft::Cons
 
     bool ResetPrivateModes(const std::basic_string_view<DispatchTypes::PrivateModeParams> /*params*/) noexcept override { return false; } // DECRST
 
-    bool DeviceStatusReport(const DispatchTypes::AnsiStatusType /*statusType*/) noexcept override { return false; } // DSR, DSR-CPR
+    bool DeviceStatusReport(const DispatchTypes::AnsiStatusType /*statusType*/) noexcept override { return false; } // DSR, DSR-OS, DSR-CPR
     bool DeviceAttributes() noexcept override { return false; } // DA1
 
     bool DesignateCharset(const wchar_t /*wchCharset*/) noexcept override { return false; } // SCS

src/terminal/adapter/ut_adapter/adapterTest.cpp

@@ -1778,6 +1778,17 @@ class AdapterTest
         VERIFY_IS_FALSE(_pDispatch.get()->DeviceStatusReport((DispatchTypes::AnsiStatusType)-1));
     }
 
+    TEST_METHOD(DeviceStatus_OperatingStatusTests)
+    {
+        Log::Comment(L"Starting test...");
+
+        Log::Comment(L"Test 1: Verify good operating condition.");
+        _testGetSet->PrepData();
+        VERIFY_IS_TRUE(_pDispatch.get()->DeviceStatusReport(DispatchTypes::AnsiStatusType::OS_OperatingStatus));
+
+        _testGetSet->ValidateInputEvent(L"\x1b[0n");
+    }
+
     TEST_METHOD(DeviceStatus_CursorPositionReportTests)
     {
         Log::Comment(L"Starting test...");

src/terminal/parser/OutputStateMachineEngine.cpp

@@ -1113,6 +1113,10 @@ bool OutputStateMachineEngine::_GetDeviceStatusOperation(const std::basic_string
         switch (param)
         {
         // This looks kinda silly, but I want the parser to reject (success = false) any status types we haven't put here.
+        case (unsigned short)DispatchTypes::AnsiStatusType::OS_OperatingStatus:
+            statusType = DispatchTypes::AnsiStatusType::OS_OperatingStatus;
+            success = true;
+            break;
         case (unsigned short)DispatchTypes::AnsiStatusType::CPR_CursorPositionReport:
             statusType = DispatchTypes::AnsiStatusType::CPR_CursorPositionReport;
             success = true;

src/terminal/parser/ut_parser/OutputEngineTest.cpp

@@ -1745,7 +1745,18 @@ class StateMachineExternalTest final
 
         pDispatch->ClearState();
 
-        Log::Comment(L"Test 2: Check CSR (cursor position command) case 6. Should succeed.");
+        Log::Comment(L"Test 2: Check OS (operating status) case 5. Should succeed.");
+        mach.ProcessCharacter(AsciiChars::ESC);
+        mach.ProcessCharacter(L'[');
+        mach.ProcessCharacter(L'5');
+        mach.ProcessCharacter(L'n');
+
+        VERIFY_IS_TRUE(pDispatch->_deviceStatusReport);
+        VERIFY_ARE_EQUAL(DispatchTypes::AnsiStatusType::OS_OperatingStatus, pDispatch->_statusReportType);
+
+        pDispatch->ClearState();
+
+        Log::Comment(L"Test 3: Check CPR (cursor position report) case 6. Should succeed.");
         mach.ProcessCharacter(AsciiChars::ESC);
         mach.ProcessCharacter(L'[');
         mach.ProcessCharacter(L'6');
@@ -1756,7 +1767,7 @@ class StateMachineExternalTest final
 
         pDispatch->ClearState();
 
-        Log::Comment(L"Test 3: Check unimplemented case 1. Should fail.");
+        Log::Comment(L"Test 4: Check unimplemented case 1. Should fail.");
         mach.ProcessCharacter(AsciiChars::ESC);
         mach.ProcessCharacter(L'[');
         mach.ProcessCharacter(L'1');