Expose current TextAttributes from the underlying console API

The XTPUSHSGR / XTPOPSGR control sequences require saving a [stack of] text attributes, and not just the legacy attributes, but full RGB colors, etc. This commit makes those attributes available.
jazzdelightsme · Dec 6, 2019 · b396689 · b396689
1 parent 54966c3
commit b396689
Show file tree

Hide file tree

Showing 9 changed files with 104 additions and 14 deletions.
diff --git a/src/buffer/out/textBuffer.cpp b/src/buffer/out/textBuffer.cpp
@@ -777,7 +777,7 @@ const Cursor& TextBuffer::GetCursor() const noexcept
     return _currentAttributes;
 }
 
-void TextBuffer::SetCurrentAttributes(const TextAttribute currentAttributes) noexcept
+void TextBuffer::SetCurrentAttributes(const TextAttribute& currentAttributes) noexcept
 {
     _currentAttributes = currentAttributes;
 }

diff --git a/src/buffer/out/textBuffer.hpp b/src/buffer/out/textBuffer.hpp
@@ -119,7 +119,7 @@ class TextBuffer final
 
     [[nodiscard]] TextAttribute GetCurrentAttributes() const noexcept;
 
-    void SetCurrentAttributes(const TextAttribute currentAttributes) noexcept;
+    void SetCurrentAttributes(const TextAttribute& currentAttributes) noexcept;
 
     void Reset();
 

diff --git a/src/host/getset.cpp b/src/host/getset.cpp
@@ -912,6 +912,13 @@ void DoSrvPrivateSetLegacyAttributes(SCREEN_INFORMATION& screenInfo,
     buffer.SetAttributes(NewAttributes);
 }
 
+void DoSrvPrivateSetAttributes(SCREEN_INFORMATION& screenInfo,
+                               const TextAttribute& Attributes)
+{
+    auto& buffer = screenInfo.GetActiveBuffer();
+    buffer.SetAttributes(Attributes);
+}
+
 void DoSrvPrivateSetDefaultAttributes(SCREEN_INFORMATION& screenInfo,
                                       const bool fForeground,
                                       const bool fBackground)
@@ -1732,7 +1739,7 @@ void DoSrvSetCursorColor(SCREEN_INFORMATION& screenInfo,
 // - pwAttributes - Pointer to space that will receive color attributes data
 // Return Value:
 // - STATUS_SUCCESS if we succeeded or STATUS_INVALID_PARAMETER for bad params (nullptr).
-[[nodiscard]] NTSTATUS DoSrvPrivateGetConsoleScreenBufferAttributes(_In_ const SCREEN_INFORMATION& screenInfo, _Out_ WORD* const pwAttributes)
+[[nodiscard]] NTSTATUS DoSrvPrivateGetConsoleScreenBufferLegacyAttributes(_In_ const SCREEN_INFORMATION& screenInfo, _Out_ WORD* const pwAttributes)
 {
     NTSTATUS Status = STATUS_SUCCESS;
 
@@ -1749,6 +1756,33 @@ void DoSrvSetCursorColor(SCREEN_INFORMATION& screenInfo,
     return Status;
 }
 
+// Routine Description:
+// - A private API call to get only the default text attributes of the screen buffer.
+// - This is used as a performance optimization by the VT adapter in SGR-related code (Set Graphics Rendition)
+//   instead of calling for this information through the public API GetConsoleScreenBufferInfoEx which returns
+//   a lot of extra unnecessary data and takes a lot of extra processing time.
+// Parameters
+// - screenInfo - The screen buffer to retrieve default text attributes information from
+// - pwAttributes - Pointer to space that will receive text attributes data
+// Return Value:
+// - STATUS_SUCCESS if we succeeded or STATUS_INVALID_PARAMETER for bad params (nullptr).
+[[nodiscard]] NTSTATUS DoSrvPrivateGetConsoleScreenBufferAttributes(_In_ const SCREEN_INFORMATION& screenInfo, _Out_ TextAttribute* const pAttributes)
+{
+    NTSTATUS Status = STATUS_SUCCESS;
+
+    if (pAttributes == nullptr)
+    {
+        Status = STATUS_INVALID_PARAMETER;
+    }
+
+    if (NT_SUCCESS(Status))
+    {
+        *pAttributes = screenInfo.GetActiveBuffer().GetAttributes();
+    }
+
+    return Status;
+}
+
 // Routine Description:
 // - A private API call for forcing the renderer to repaint the screen. If the
 //      input screen buffer is not the active one, then just do nothing. We only

diff --git a/src/host/getset.h b/src/host/getset.h
@@ -16,6 +16,7 @@ Revision History:
 
 #pragma once
 #include "../inc/conattrs.hpp"
+#include "../buffer/out/TextAttribute.hpp"
 class SCREEN_INFORMATION;
 
 void DoSrvPrivateSetLegacyAttributes(SCREEN_INFORMATION& screenInfo,
@@ -24,6 +25,9 @@ void DoSrvPrivateSetLegacyAttributes(SCREEN_INFORMATION& screenInfo,
                                      const bool fBackground,
                                      const bool fMeta);
 
+void DoSrvPrivateSetAttributes(SCREEN_INFORMATION& screenInfo,
+                               const TextAttribute& Attributes);
+
 void DoSrvPrivateSetDefaultAttributes(SCREEN_INFORMATION& screenInfo, const bool fForeground, const bool fBackground);
 
 [[nodiscard]] NTSTATUS DoSrvPrivateSetCursorKeysMode(_In_ bool fApplicationMode);
@@ -70,8 +74,10 @@ void DoSrvSetCursorStyle(SCREEN_INFORMATION& screenInfo,
 void DoSrvSetCursorColor(SCREEN_INFORMATION& screenInfo,
                          const COLORREF cursorColor);
 
-[[nodiscard]] NTSTATUS DoSrvPrivateGetConsoleScreenBufferAttributes(const SCREEN_INFORMATION& screenInfo,
-                                                                    _Out_ WORD* const pwAttributes);
+[[nodiscard]] NTSTATUS DoSrvPrivateGetConsoleScreenBufferLegacyAttributes(const SCREEN_INFORMATION& screenInfo,
+                                                                          _Out_ WORD* const pwAttributes);
+[[nodiscard]] NTSTATUS DoSrvPrivateGetConsoleScreenBufferAttributes(_In_ const SCREEN_INFORMATION& screenInfo,
+                                                                    _Out_ TextAttribute* const pAttributes);
 
 void DoSrvPrivateRefreshWindow(const SCREEN_INFORMATION& screenInfo);
 

diff --git a/src/host/outputStream.cpp b/src/host/outputStream.cpp
@@ -239,6 +239,12 @@ BOOL ConhostInternalGetSet::PrivateSetLegacyAttributes(const WORD wAttr,
     return TRUE;
 }
 
+BOOL ConhostInternalGetSet::PrivateSetAttributes(const TextAttribute& attributes)
+{
+    DoSrvPrivateSetAttributes(_io.GetActiveOutputBuffer(), attributes);
+    return TRUE;
+}
+
 // Routine Description:
 // - Sets the current attributes of the screen buffer to use the color table entry specified by
 //     the iXtermTableEntry. Sets either the FG or the BG component of the attributes.
@@ -680,9 +686,21 @@ BOOL ConhostInternalGetSet::SetCursorStyle(const CursorType cursorType)
 // - pwAttributes - Pointer to space to receive color attributes data
 // Return Value:
 // - TRUE if successful. FALSE otherwise.
-BOOL ConhostInternalGetSet::PrivateGetConsoleScreenBufferAttributes(_Out_ WORD* const pwAttributes)
+BOOL ConhostInternalGetSet::PrivateGetConsoleScreenBufferLegacyAttributes(_Out_ WORD* const pwAttributes)
+{
+    return NT_SUCCESS(DoSrvPrivateGetConsoleScreenBufferLegacyAttributes(_io.GetActiveOutputBuffer(), pwAttributes));
+}
+
+// Routine Description:
+// - Retrieves the default text attributes information for the active screen buffer.
+// - Similar to PrivateGetConsoleScreenBufferLegacyAttributes, but gets the full attributes.
+// Arguments:
+// - pAttributes - Pointer to space to receive attributes data
+// Return Value:
+// - TRUE if successful. FALSE otherwise.
+BOOL ConhostInternalGetSet::PrivateGetConsoleScreenBufferAttributes(_Out_ TextAttribute* const pAttributes)
 {
-    return NT_SUCCESS(DoSrvPrivateGetConsoleScreenBufferAttributes(_io.GetActiveOutputBuffer(), pwAttributes));
+    return NT_SUCCESS(DoSrvPrivateGetConsoleScreenBufferAttributes(_io.GetActiveOutputBuffer(), pAttributes));
 }
 
 // Routine Description:

diff --git a/src/host/outputStream.hpp b/src/host/outputStream.hpp
@@ -78,6 +78,8 @@ class ConhostInternalGetSet final : public Microsoft::Console::VirtualTerminal::
                                     const bool fBackground,
                                     const bool fMeta) override;
 
+    BOOL PrivateSetAttributes(const TextAttribute& attributes) override;
+
     BOOL PrivateSetDefaultAttributes(const bool fForeground,
                                      const bool fBackground) override;
 
@@ -136,7 +138,8 @@ class ConhostInternalGetSet final : public Microsoft::Console::VirtualTerminal::
     BOOL PrivateEnableAlternateScroll(const bool fEnabled) override;
     BOOL PrivateEraseAll() override;
 
-    BOOL PrivateGetConsoleScreenBufferAttributes(_Out_ WORD* const pwAttributes) override;
+    BOOL PrivateGetConsoleScreenBufferLegacyAttributes(_Out_ WORD* const pwAttributes) override;
+    BOOL PrivateGetConsoleScreenBufferAttributes(_Out_ TextAttribute* const pAttributes) override;
 
     BOOL PrivatePrependConsoleInput(_Inout_ std::deque<std::unique_ptr<IInputEvent>>& events,
                                     _Out_ size_t& eventsWritten) override;

diff --git a/src/terminal/adapter/adaptDispatchGraphics.cpp b/src/terminal/adapter/adaptDispatchGraphics.cpp
@@ -491,7 +491,7 @@ bool AdaptDispatch::SetGraphicsRendition(_In_reads_(cOptions) const DispatchType
     // OS and wastes time memcpying colors and other data we do not need to
     // resolve this Set Graphics Rendition request.
     WORD attr;
-    bool fSuccess = !!_conApi->PrivateGetConsoleScreenBufferAttributes(&attr);
+    bool fSuccess = !!_conApi->PrivateGetConsoleScreenBufferLegacyAttributes(&attr);
 
     if (fSuccess)
     {

diff --git a/src/terminal/adapter/conGetSet.hpp b/src/terminal/adapter/conGetSet.hpp
@@ -18,6 +18,7 @@ Author(s):
 #include "..\..\types\inc\IInputEvent.hpp"
 #include "..\..\buffer\out\TextAttribute.hpp"
 #include "..\..\inc\conattrs.hpp"
+#include "..\..\buffer\out\TextAttribute.hpp"
 
 #include <deque>
 #include <memory>
@@ -47,6 +48,8 @@ namespace Microsoft::Console::VirtualTerminal
                                                 const bool fBackground,
                                                 const bool fMeta) = 0;
 
+        virtual BOOL PrivateSetAttributes(const TextAttribute& attributes) = 0;
+
         virtual BOOL PrivateSetDefaultAttributes(const bool fForeground, const bool fBackground) = 0;
 
         virtual BOOL SetConsoleXtermTextAttribute(const int iXtermTableEntry,
@@ -92,7 +95,8 @@ namespace Microsoft::Console::VirtualTerminal
         virtual BOOL PrivateEraseAll() = 0;
         virtual BOOL SetCursorStyle(const CursorType cursorType) = 0;
         virtual BOOL SetCursorColor(const COLORREF cursorColor) = 0;
-        virtual BOOL PrivateGetConsoleScreenBufferAttributes(_Out_ WORD* const pwAttributes) = 0;
+        virtual BOOL PrivateGetConsoleScreenBufferLegacyAttributes(_Out_ WORD* const pwAttributes) = 0;
+        virtual BOOL PrivateGetConsoleScreenBufferAttributes(_Out_ TextAttribute* const pAttributes) = 0;
         virtual BOOL PrivatePrependConsoleInput(_Inout_ std::deque<std::unique_ptr<IInputEvent>>& events,
                                                 _Out_ size_t& eventsWritten) = 0;
         virtual BOOL PrivateWriteConsoleControlInput(_In_ KeyEvent key) = 0;

diff --git a/src/terminal/adapter/ut_adapter/adapterTest.cpp b/src/terminal/adapter/ut_adapter/adapterTest.cpp
@@ -285,6 +285,16 @@ class TestGetSet final : public ConGetSet
         return _fPrivateSetLegacyAttributesResult;
     }
 
+    BOOL PrivateSetAttributes(const TextAttribute& attributes) override
+    {
+        Log::Comment(L"PrivateSetAttributes MOCK called...");
+
+        // TODO
+        UNREFERENCED_PARAMETER(attributes);
+
+        return TRUE;
+    }
+
     BOOL SetConsoleXtermTextAttribute(const int iXtermTableEntry, const bool fIsForeground) override
     {
         Log::Comment(L"SetConsoleXtermTextAttribute MOCK called...");
@@ -603,15 +613,28 @@ class TestGetSet final : public ConGetSet
         return _fSetCursorColorResult;
     }
 
-    BOOL PrivateGetConsoleScreenBufferAttributes(_Out_ WORD* const pwAttributes) override
+    BOOL PrivateGetConsoleScreenBufferLegacyAttributes(_Out_ WORD* const pwAttributes) override
     {
-        Log::Comment(L"PrivateGetConsoleScreenBufferAttributes MOCK returning data...");
+        Log::Comment(L"PrivateGetConsoleScreenBufferLegacyAttributes MOCK returning data...");
 
-        if (pwAttributes != nullptr && _fPrivateGetConsoleScreenBufferAttributesResult)
+        if (pwAttributes != nullptr && _fPrivateGetConsoleScreenBufferLegacyAttributesResult)
         {
             *pwAttributes = _wAttribute;
         }
 
+        return _fPrivateGetConsoleScreenBufferLegacyAttributesResult;
+    }
+
+    BOOL PrivateGetConsoleScreenBufferAttributes(_Out_ TextAttribute* const pAttributes) override
+    {
+        Log::Comment(L"PrivateGetConsoleScreenBufferAttributes MOCK returning data...");
+
+        if (pAttributes != nullptr && _fPrivateGetConsoleScreenBufferAttributesResult)
+        {
+            // TODO
+            *pAttributes = TextAttribute();
+        }
+
         return _fPrivateGetConsoleScreenBufferAttributesResult;
     }
 
@@ -785,6 +808,7 @@ class TestGetSet final : public ConGetSet
         _fPrivateWriteConsoleControlInputResult = TRUE;
         _fScrollConsoleScreenBufferWResult = TRUE;
         _fSetConsoleWindowInfoResult = TRUE;
+        _fPrivateGetConsoleScreenBufferLegacyAttributesResult = TRUE;
         _fPrivateGetConsoleScreenBufferAttributesResult = TRUE;
         _fMoveToBottomResult = true;
 
@@ -1119,6 +1143,7 @@ class TestGetSet final : public ConGetSet
     BOOL _fSetConsoleXtermTextAttributeResult = false;
     BOOL _fSetConsoleRGBTextAttributeResult = false;
     BOOL _fPrivateSetLegacyAttributesResult = false;
+    BOOL _fPrivateGetConsoleScreenBufferLegacyAttributesResult = false;
     BOOL _fPrivateGetConsoleScreenBufferAttributesResult = false;
     BOOL _fSetCursorStyleResult = false;
     CursorType _ExpectedCursorStyle;
@@ -1921,7 +1946,7 @@ class AdapterTest
         Log::Comment(L"Test 2: Gracefully fail when getting buffer information fails.");
 
         _testGetSet->PrepData();
-        _testGetSet->_fPrivateGetConsoleScreenBufferAttributesResult = FALSE;
+        _testGetSet->_fPrivateGetConsoleScreenBufferLegacyAttributesResult = FALSE;
 
         VERIFY_IS_FALSE(_pDispatch->SetGraphicsRendition(rgOptions, cOptions));