fe3f528827
# Summary of the Pull Request This PR will allow the cursor to be double width when on top of a double width character. This required changing `IsCursorDoubleWidth` to check whether the glyph the cursor's on top of is double width. This code is exactly the same as the original PR that addressed this issue in #2932. That one got reverted at some point due to the crashes related to it, but due to a combination of Terminal having come further since that PR and other changes to address use-after-frees, some of the crashes may/may not be relevant now. The ones that seemed to be relevant/repro-able, I attempt to address in this PR. The `IsCursorDoubleWidth` check would fail during the `TextBuffer::Reflow` call inside of `Terminal::UserResize` occasionally, particularly when `newCursor.EndDeferDrawing()` is called. This is because when we tell the newCursor to `EndDefer`, the renderer will attempt to redraw the cursor. As part of this redraw, it'll ask if `IsCursorDoubleWidth`, and if the renderer managed to ask this before `UserResize` swapped out the old buffer with the new one from `Reflow`, the renderer will be asking the old buffer if its out-of-bounds cursor is double width. This was pretty easily repro'd using `cmatrix -u0` and resizing the window like a madman. As a solution, I've moved the Start/End DeferDrawing calls out of `Reflow` and into `UserResize`. This way, I can "clamp" the portion of the code where the newBuffer is getting created and reflowed and swapped into the Terminal buffer, and only allow the renderer to draw once the swap is done. This also means that ConHost's `ResizeWithReflow` needed to change slightly. In addition, I've added a WriteLock to `SetCursorOn`. It was mentioned as a fix for a crash in #2965 (although I can't repro), and I also figured it would be good to try to emulate where ConHost locks with regards to Cursor operations, and this seemed to be one that we were missing. ## PR Checklist * [x] Closes #2713 * [x] CLA signed * [x] Tests added/passed ## Validation Steps Performed Manual validation that the cursor is indeed chonky, added a test case to check that we are correctly saying that the cursor is double width (not too sure if I put it in the right place). Also open to other test case ideas and thoughts on what else I should be careful for since I am quite nervous about what other crashes might occur.
77 lines
2.6 KiB
C++
77 lines
2.6 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- IRenderData.hpp
|
|
|
|
Abstract:
|
|
- This serves as the interface defining all information needed to render to the screen.
|
|
|
|
Author(s):
|
|
- Michael Niksa (MiNiksa) 17-Nov-2015
|
|
--*/
|
|
|
|
#pragma once
|
|
|
|
#include "../../host/conimeinfo.h"
|
|
#include "../../buffer/out/TextAttribute.hpp"
|
|
#include "../../types/IBaseData.h"
|
|
|
|
class Cursor;
|
|
|
|
namespace Microsoft::Console::Render
|
|
{
|
|
struct RenderOverlay final
|
|
{
|
|
// This is where the data is stored
|
|
const TextBuffer& buffer;
|
|
|
|
// This is where the top left of the stored buffer should be overlayed on the screen
|
|
// (relative to the current visible viewport)
|
|
const COORD origin;
|
|
|
|
// This is the area of the buffer that is actually used for overlay.
|
|
// Anything outside of this is considered empty by the overlay and shouldn't be used
|
|
// for painting purposes.
|
|
const Microsoft::Console::Types::Viewport region;
|
|
};
|
|
|
|
class IRenderData : public Microsoft::Console::Types::IBaseData
|
|
{
|
|
public:
|
|
~IRenderData() = 0;
|
|
IRenderData(const IRenderData&) = default;
|
|
IRenderData(IRenderData&&) = default;
|
|
IRenderData& operator=(const IRenderData&) = default;
|
|
IRenderData& operator=(IRenderData&&) = default;
|
|
|
|
virtual const TextAttribute GetDefaultBrushColors() noexcept = 0;
|
|
|
|
virtual const COLORREF GetForegroundColor(const TextAttribute& attr) const noexcept = 0;
|
|
virtual const COLORREF GetBackgroundColor(const TextAttribute& attr) const noexcept = 0;
|
|
|
|
virtual COORD GetCursorPosition() const noexcept = 0;
|
|
virtual bool IsCursorVisible() const noexcept = 0;
|
|
virtual bool IsCursorOn() const noexcept = 0;
|
|
virtual ULONG GetCursorHeight() const noexcept = 0;
|
|
virtual CursorType GetCursorStyle() const noexcept = 0;
|
|
virtual ULONG GetCursorPixelWidth() const noexcept = 0;
|
|
virtual COLORREF GetCursorColor() const noexcept = 0;
|
|
virtual bool IsCursorDoubleWidth() const = 0;
|
|
|
|
virtual bool IsScreenReversed() const noexcept = 0;
|
|
|
|
virtual const std::vector<RenderOverlay> GetOverlays() const noexcept = 0;
|
|
|
|
virtual const bool IsGridLineDrawingAllowed() noexcept = 0;
|
|
virtual const std::wstring GetConsoleTitle() const noexcept = 0;
|
|
|
|
protected:
|
|
IRenderData() = default;
|
|
};
|
|
|
|
// See docs/virtual-dtors.md for an explanation of why this is weird.
|
|
inline IRenderData::~IRenderData() {}
|
|
}
|