Eliminate more transient allocations: Titles and invalid rectangles and bitmap runs and utf8 conversions

src/host/consoleInformation.cpp

@@ -286,7 +286,7 @@ void CONSOLE_INFORMATION::SetTitle(const std::wstring_view newTitle)
 // - <none>
 void CONSOLE_INFORMATION::SetTitlePrefix(const std::wstring& newTitlePrefix)
 {
-    _TitlePrefix = newTitlePrefix;
+    _TitleAndPrefix = newTitlePrefix + _Title;
 
     auto* const pRender = ServiceLocator::LocateGlobals().pRender;
     if (pRender)
@@ -337,9 +337,9 @@ const std::wstring& CONSOLE_INFORMATION::GetTitle() const noexcept
 // - <none>
 // Return Value:
 // - a new wstring containing the combined prefix and title.
-const std::wstring CONSOLE_INFORMATION::GetTitleAndPrefix() const
+const std::wstring& CONSOLE_INFORMATION::GetTitleAndPrefix() const
 {
-    return _TitlePrefix + _Title;
+    return _TitleAndPrefix;
 }
 
 // Method Description:

src/host/renderData.cpp

@@ -318,7 +318,7 @@ const bool RenderData::IsGridLineDrawingAllowed() noexcept
 // - Retrieves the title information to be displayed in the frame/edge of the window
 // Return Value:
 // - String with title information
-const std::wstring RenderData::GetConsoleTitle() const noexcept
+const std::wstring& RenderData::GetConsoleTitle() const noexcept
 {
     const CONSOLE_INFORMATION& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
     return gci.GetTitleAndPrefix();

src/host/renderData.hpp

@@ -54,7 +54,7 @@ class RenderData final :
 
     const bool IsGridLineDrawingAllowed() noexcept override;
 
-    const std::wstring GetConsoleTitle() const noexcept override;
+    const std::wstring& GetConsoleTitle() const noexcept override;
 
     const std::wstring GetHyperlinkUri(uint16_t id) const noexcept override;
     const std::wstring GetHyperlinkCustomId(uint16_t id) const noexcept override;

src/host/server.h

@@ -135,7 +135,7 @@ class CONSOLE_INFORMATION :
     const std::wstring& GetTitle() const noexcept;
     const std::wstring& GetOriginalTitle() const noexcept;
     const std::wstring& GetLinkTitle() const noexcept;
-    const std::wstring GetTitleAndPrefix() const;
+    const std::wstring& GetTitleAndPrefix() const;
 
     [[nodiscard]] static NTSTATUS AllocateConsole(const std::wstring_view title);
     // MSFT:16886775 : get rid of friends
@@ -152,7 +152,7 @@ class CONSOLE_INFORMATION :
 private:
     CRITICAL_SECTION _csConsoleLock; // serialize input and output using this
     std::wstring _Title;
-    std::wstring _TitlePrefix; // Eg Select, Mark - things that we manually prepend to the title.
+    std::wstring _TitleAndPrefix; // Eg Select, Mark - things that we manually prepend to the title.
     std::wstring _OriginalTitle;
     std::wstring _LinkTitle; // Path to .lnk file
     SCREEN_INFORMATION* pCurrentScreenBuffer;

src/interactivity/onecore/BgfxEngine.cpp

@@ -230,15 +230,21 @@ BgfxEngine::BgfxEngine(PVOID SharedViewBase, LONG DisplayHeight, LONG DisplayWid
     return S_OK;
 }
 
-std::vector<til::rectangle> BgfxEngine::GetDirtyArea()
+[[nodiscard]] HRESULT BgfxEngine::GetDirtyArea(gsl::span<const til::rectangle>& area) noexcept
 {
+
     SMALL_RECT r;
     r.Bottom = _displayHeight > 0 ? (SHORT)(_displayHeight - 1) : 0;
     r.Top = 0;
     r.Left = 0;
     r.Right = _displayWidth > 0 ? (SHORT)(_displayWidth - 1) : 0;
 
-    return { r };
+    _dirtyArea = r;
+
+    _area = { &_dirtyArea,
+              1 };
+
+    return S_OK;
 }
 
 [[nodiscard]] HRESULT BgfxEngine::GetFontSize(_Out_ COORD* const pFontSize) noexcept

src/interactivity/onecore/BgfxEngine.hpp

@@ -67,7 +67,7 @@ namespace Microsoft::Console::Render
 
         [[nodiscard]] HRESULT GetProposedFont(const FontInfoDesired& fiFontInfoDesired, FontInfo& fiFontInfo, int const iDpi) noexcept override;
 
-        std::vector<til::rectangle> GetDirtyArea() override;
+        [[nodiscard]] HRESULT GetDirtyArea(gsl::span<const til::rectangle>& area) noexcept override;
         [[nodiscard]] HRESULT GetFontSize(_Out_ COORD* const pFontSize) noexcept override;
         [[nodiscard]] HRESULT IsGlyphWideByFont(const std::wstring_view glyph, _Out_ bool* const pResult) noexcept override;
 

src/renderer/base/renderer.cpp

@@ -459,7 +459,7 @@ void Renderer::TriggerCircling()
 // - <none>
 void Renderer::TriggerTitleChange()
 {
-    const std::wstring newTitle = _pData->GetConsoleTitle();
+    const auto& newTitle = _pData->GetConsoleTitle();
     for (IRenderEngine* const pEngine : _rgpEngines)
     {
         LOG_IF_FAILED(pEngine->InvalidateTitle(newTitle));
@@ -475,7 +475,7 @@ void Renderer::TriggerTitleChange()
 // - the HRESULT of the underlying engine's UpdateTitle call.
 HRESULT Renderer::_PaintTitle(IRenderEngine* const pEngine)
 {
-    const std::wstring newTitle = _pData->GetConsoleTitle();
+    const auto& newTitle = _pData->GetConsoleTitle();
     return pEngine->UpdateTitle(newTitle);
 }
 
@@ -619,9 +619,10 @@ void Renderer::_PaintBufferOutput(_In_ IRenderEngine* const pEngine)
 
     // This is effectively the number of cells on the visible screen that need to be redrawn.
     // The origin is always 0, 0 because it represents the screen itself, not the underlying buffer.
-    const auto dirtyAreas = pEngine->GetDirtyArea();
+    gsl::span<const til::rectangle> dirtyAreas;
+    LOG_IF_FAILED(pEngine->GetDirtyArea(dirtyAreas));
 
-    for (const auto dirtyRect : dirtyAreas)
+    for (const auto& dirtyRect : dirtyAreas)
     {
         auto dirty = Viewport::FromInclusive(dirtyRect);
 
@@ -1036,7 +1037,10 @@ void Renderer::_PaintOverlay(IRenderEngine& engine,
         // Set it up in a Viewport helper structure and trim it the IME viewport to be within the full console viewport.
         Viewport viewConv = Viewport::FromInclusive(srCaView);
 
-        for (SMALL_RECT srDirty : engine.GetDirtyArea())
+        gsl::span<const til::rectangle> dirtyAreas;
+        LOG_IF_FAILED(engine.GetDirtyArea(dirtyAreas));
+
+        for (SMALL_RECT srDirty : dirtyAreas)
         {
             // Dirty is an inclusive rectangle, but oddly enough the IME was an exclusive one, so correct it.
             srDirty.Bottom++;
@@ -1093,13 +1097,14 @@ void Renderer::_PaintSelection(_In_ IRenderEngine* const pEngine)
 {
     try
     {
-        auto dirtyAreas = pEngine->GetDirtyArea();
+        gsl::span<const til::rectangle> dirtyAreas;
+        LOG_IF_FAILED(pEngine->GetDirtyArea(dirtyAreas));
 
         // Get selection rectangles
         const auto rectangles = _GetSelectionRects();
         for (auto rect : rectangles)
         {
-            for (auto dirtyRect : dirtyAreas)
+            for (auto& dirtyRect : dirtyAreas)
             {
                 // Make a copy as `TrimToViewport` will manipulate it and
                 // can destroy it for the next dirtyRect to test against.

src/renderer/dx/DxRenderer.cpp

@@ -2064,12 +2064,13 @@ float DxEngine::GetScaling() const noexcept
 // Routine Description:
 // - Gets the area that we currently believe is dirty within the character cell grid
 // Arguments:
-// - <none>
+// - area - Rectangle describing dirty area in characters.
 // Return Value:
-// - Rectangle describing dirty area in characters.
-[[nodiscard]] std::vector<til::rectangle> DxEngine::GetDirtyArea()
+// - S_OK
+[[nodiscard]] HRESULT DxEngine::GetDirtyArea(gsl::span<const til::rectangle>& area) noexcept
 {
-    return _invalidMap.runs();
+    area = _invalidMap.runs();
+    return S_OK;
 }
 
 // Routine Description:

src/renderer/dx/DxRenderer.hpp

@@ -111,7 +111,7 @@ namespace Microsoft::Console::Render
 
         [[nodiscard]] HRESULT GetProposedFont(const FontInfoDesired& fiFontInfoDesired, FontInfo& fiFontInfo, int const iDpi) noexcept override;
 
-        [[nodiscard]] std::vector<til::rectangle> GetDirtyArea() override;
+        [[nodiscard]] HRESULT GetDirtyArea(gsl::span<const til::rectangle>& area) noexcept override;
 
         [[nodiscard]] HRESULT GetFontSize(_Out_ COORD* const pFontSize) noexcept override;
         [[nodiscard]] HRESULT IsGlyphWideByFont(const std::wstring_view glyph, _Out_ bool* const pResult) noexcept override;

src/renderer/gdi/gdirenderer.hpp

@@ -66,7 +66,7 @@ namespace Microsoft::Console::Render
                                               _Out_ FontInfo& Font,
                                               const int iDpi) noexcept override;
 
-        [[nodiscard]] std::vector<til::rectangle> GetDirtyArea() override;
+        [[nodiscard]] HRESULT GetDirtyArea(gsl::span<const til::rectangle>& area) noexcept override;
         [[nodiscard]] HRESULT GetFontSize(_Out_ COORD* const pFontSize) noexcept override;
         [[nodiscard]] HRESULT IsGlyphWideByFont(const std::wstring_view glyph, _Out_ bool* const pResult) noexcept override;
 
@@ -82,6 +82,7 @@ namespace Microsoft::Console::Render
 
         bool _fPaintStarted;
 
+        til::rectangle _invalidCharacters;
         PAINTSTRUCT _psInvalidData;
         HDC _hdcMemoryContext;
         bool _isTrueTypeFont;

src/renderer/gdi/math.cpp

@@ -12,18 +12,22 @@ using namespace Microsoft::Console::Render;
 // Routine Description:
 // - Gets the size in characters of the current dirty portion of the frame.
 // Arguments:
-// - <none>
-// Return Value:
-// - The character dimensions of the current dirty area of the frame.
+// - area - The character dimensions of the current dirty area of the frame.
 //      This is an Inclusive rect.
-std::vector<til::rectangle> GdiEngine::GetDirtyArea()
+// Return Value:
+// - S_OK or math failure
+[[nodiscard]] HRESULT GdiEngine::GetDirtyArea(gsl::span<const til::rectangle>& area) noexcept
 {
     RECT rc = _psInvalidData.rcPaint;
 
     SMALL_RECT sr = { 0 };
-    LOG_IF_FAILED(_ScaleByFont(&rc, &sr));
+    RETURN_IF_FAILED(_ScaleByFont(&rc, &sr));
 
-    return { sr };
+    _invalidCharacters = sr;
+
+    area = { &_invalidCharacters, 1 };
+
+    return S_OK;
 }
 
 // Routine Description:

src/renderer/gdi/state.cpp

@@ -31,6 +31,7 @@ GdiEngine::GdiEngine() :
     _lastBg(INVALID_COLOR),
     _lastFontItalic(false),
     _fPaintStarted(false),
+    _invalidCharacters{},
     _hfont(nullptr),
     _hfontItalic(nullptr)
 {

src/renderer/inc/IRenderData.hpp

@@ -64,7 +64,7 @@ namespace Microsoft::Console::Render
         virtual const std::vector<RenderOverlay> GetOverlays() const noexcept = 0;
 
         virtual const bool IsGridLineDrawingAllowed() noexcept = 0;
-        virtual const std::wstring GetConsoleTitle() const noexcept = 0;
+        virtual const std::wstring& GetConsoleTitle() const noexcept = 0;
 
         virtual const std::wstring GetHyperlinkUri(uint16_t id) const noexcept = 0;
         virtual const std::wstring GetHyperlinkCustomId(uint16_t id) const noexcept = 0;

src/renderer/inc/IRenderEngine.hpp

@@ -99,7 +99,7 @@ namespace Microsoft::Console::Render
                                                       _Out_ FontInfo& FontInfo,
                                                       const int iDpi) noexcept = 0;
 
-        virtual std::vector<til::rectangle> GetDirtyArea() = 0;
+        [[nodiscard]] virtual HRESULT GetDirtyArea(gsl::span<const til::rectangle>& area) noexcept = 0;
         [[nodiscard]] virtual HRESULT GetFontSize(_Out_ COORD* const pFontSize) noexcept = 0;
         [[nodiscard]] virtual HRESULT IsGlyphWideByFont(const std::wstring_view glyph, _Out_ bool* const pResult) noexcept = 0;
         [[nodiscard]] virtual HRESULT UpdateTitle(const std::wstring& newTitle) noexcept = 0;

src/renderer/uia/UiaRenderer.cpp

@@ -427,12 +427,17 @@ CATCH_RETURN();
 // - Gets the area that we currently believe is dirty within the character cell grid
 // - Not currently used by UiaEngine.
 // Arguments:
-// - <none>
+// - area - Rectangle describing dirty area in characters.
 // Return Value:
-// - Rectangle describing dirty area in characters.
-[[nodiscard]] std::vector<til::rectangle> UiaEngine::GetDirtyArea()
+// - S_OK.
+[[nodiscard]] HRESULT UiaEngine::GetDirtyArea(gsl::span<const til::rectangle>& area) noexcept
 {
-    return { Viewport::Empty().ToInclusive() };
+    // Magic static is only valid because any instance of this object has the same behavior.
+    // Use member variable instead if this ever changes.
+    const static til::rectangle emptyInclusive{ Viewport::Empty().ToInclusive() };
+    area = { &emptyInclusive,
+             1 };
+    return S_OK;
 }
 
 // Routine Description:

src/renderer/uia/UiaRenderer.hpp

@@ -69,7 +69,7 @@ namespace Microsoft::Console::Render
 
         [[nodiscard]] HRESULT GetProposedFont(const FontInfoDesired& fiFontInfoDesired, FontInfo& fiFontInfo, int const iDpi) noexcept override;
 
-        [[nodiscard]] std::vector<til::rectangle> GetDirtyArea() override;
+        [[nodiscard]] HRESULT GetDirtyArea(gsl::span<const til::rectangle>& area) noexcept override;
         [[nodiscard]] HRESULT GetFontSize(_Out_ COORD* const pFontSize) noexcept override;
         [[nodiscard]] HRESULT IsGlyphWideByFont(const std::wstring_view glyph, _Out_ bool* const pResult) noexcept override;
 

src/renderer/vt/XtermEngine.cpp

@@ -57,7 +57,8 @@ XtermEngine::XtermEngine(_In_ wil::unique_hfile hPipe,
     }
     else
     {
-        const auto dirty = GetDirtyArea();
+        gsl::span<const til::rectangle> dirty;
+        RETURN_IF_FAILED(GetDirtyArea(dirty));
 
         // If we have 0 or 1 dirty pieces in the area, set as appropriate.
         Viewport dirtyView = dirty.empty() ? Viewport::Empty() : Viewport::FromInclusive(til::at(dirty, 0));

src/renderer/vt/math.cpp

@@ -13,13 +13,14 @@ using namespace Microsoft::Console::Types;
 // Routine Description:
 // - Gets the size in characters of the current dirty portion of the frame.
 // Arguments:
-// - <none>
+// - area - The character dimensions of the current dirty area of the frame.
+//          This is an Inclusive rect.
 // Return Value:
-// - The character dimensions of the current dirty area of the frame.
-//      This is an Inclusive rect.
-std::vector<til::rectangle> VtEngine::GetDirtyArea()
+// - S_OK.
+[[nodiscard]] HRESULT VtEngine::GetDirtyArea(gsl::span<const til::rectangle>& area) noexcept
 {
-    return _invalidMap.runs();
+    area = _invalidMap.runs();
+    return S_OK;
 }
 
 // Routine Description:

src/renderer/vt/vtrenderer.hpp

@@ -85,7 +85,7 @@ namespace Microsoft::Console::Render
                                               _Out_ FontInfo& Font,
                                               const int iDpi) noexcept override;
 
-        std::vector<til::rectangle> GetDirtyArea() override;
+        [[nodiscard]] HRESULT GetDirtyArea(gsl::span<const til::rectangle>& area) noexcept override;
         [[nodiscard]] HRESULT GetFontSize(_Out_ COORD* const pFontSize) noexcept override;
         [[nodiscard]] HRESULT IsGlyphWideByFont(const std::wstring_view glyph, _Out_ bool* const pResult) noexcept override;
 

src/renderer/wddmcon/WddmConRenderer.cpp

@@ -353,15 +353,20 @@ bool WddmConEngine::IsInitialized()
     return S_OK;
 }
 
-std::vector<til::rectangle> WddmConEngine::GetDirtyArea()
+[[nodiscard]] HRESULT WddmConEngine::GetDirtyArea(gsl::span<const til::rectangle>& area) noexcept
 {
     SMALL_RECT r;
     r.Bottom = _displayHeight > 0 ? (SHORT)(_displayHeight - 1) : 0;
     r.Top = 0;
     r.Left = 0;
     r.Right = _displayWidth > 0 ? (SHORT)(_displayWidth - 1) : 0;
 
-    return { r };
+    _dirtyArea = r;
+
+    _area = { &_dirtyArea,
+              1 };
+
+    return S_OK;
 }
 
 RECT WddmConEngine::GetDisplaySize()

src/renderer/wddmcon/WddmConRenderer.hpp

@@ -59,7 +59,7 @@ namespace Microsoft::Console::Render
 
         [[nodiscard]] HRESULT GetProposedFont(const FontInfoDesired& fiFontInfoDesired, FontInfo& fiFontInfo, int const iDpi) noexcept override;
 
-        std::vector<til::rectangle> GetDirtyArea() override;
+        [[nodiscard]] HRESULT GetDirtyArea(gsl::span<const til::rectangle>& area) noexcept override;
         [[nodiscard]] HRESULT GetFontSize(_Out_ COORD* const pFontSize) noexcept override;
         [[nodiscard]] HRESULT IsGlyphWideByFont(const std::wstring_view glyph, _Out_ bool* const pResult) noexcept override;
 
@@ -75,6 +75,7 @@ namespace Microsoft::Console::Render
         // Variables
         LONG _displayHeight;
         LONG _displayWidth;
+        til::rectangle _dirtyArea;
 
         PCD_IO_ROW_INFORMATION* _displayState;