80da24ecf8
We were using std::basic_string_view as a stand-in for std::span so that
we could change over all at once when C++20 dropped with full span
support. That day's not here yet, but as of 54a7fce3e we're using GSL 3,
whose span is C++20-compliant.
This commit replaces every instance of basic_string_view that was not
referring to an actual string with a span of the appropriate type.
I moved the `const` qualifier into span's `T` because while
`basic_string_view.at()` returns `const T&`, `span.at()` returns `T&`
(without the const). I wanted to maintain the invariant that members of
the span were immutable.
* Mechanical Changes
* `sv.at(x)` -> `gsl::at(sp, x)`
* `sv.c{begin,end}` -> `sp.{begin,end}` (span's iterators are const)
I had to replace a `std::basic_string<>` with a `std::vector<>` in
ConImeInfo, and I chose to replace a manual array walk in
ScreenInfoUiaProviderBase with a ranged-for. Please review those
specifically.
This will almost certainly cause a code size regression in Windows
because I'm blowing out all the PGO counts. Whoops.
Related: #3956, #975.
236 lines
11 KiB
C++
236 lines
11 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- VtRenderer.hpp
|
|
|
|
Abstract:
|
|
- This is the definition of the VT specific implementation of the renderer.
|
|
|
|
Author(s):
|
|
- Michael Niksa (MiNiksa) 24-Jul-2017
|
|
- Mike Griese (migrie) 01-Sept-2017
|
|
--*/
|
|
|
|
#pragma once
|
|
|
|
#include "../inc/RenderEngineBase.hpp"
|
|
#include "../../inc/ITerminalOutputConnection.hpp"
|
|
#include "../../inc/ITerminalOwner.hpp"
|
|
#include "../../types/inc/Viewport.hpp"
|
|
#include "tracing.hpp"
|
|
#include <string>
|
|
#include <functional>
|
|
|
|
// fwdecl unittest classes
|
|
#ifdef UNIT_TESTING
|
|
namespace TerminalCoreUnitTests
|
|
{
|
|
class ConptyRoundtripTests;
|
|
};
|
|
#endif
|
|
|
|
namespace Microsoft::Console::Render
|
|
{
|
|
class VtEngine : public RenderEngineBase, public Microsoft::Console::ITerminalOutputConnection
|
|
{
|
|
public:
|
|
// See _PaintUtf8BufferLine for explanation of this value.
|
|
static const size_t ERASE_CHARACTER_STRING_LENGTH = 8;
|
|
static const COORD INVALID_COORDS;
|
|
|
|
VtEngine(_In_ wil::unique_hfile hPipe,
|
|
const Microsoft::Console::Types::Viewport initialViewport);
|
|
|
|
virtual ~VtEngine() override = default;
|
|
|
|
[[nodiscard]] HRESULT InvalidateSelection(const std::vector<SMALL_RECT>& rectangles) noexcept override;
|
|
[[nodiscard]] virtual HRESULT InvalidateScroll(const COORD* const pcoordDelta) noexcept = 0;
|
|
[[nodiscard]] HRESULT InvalidateSystem(const RECT* const prcDirtyClient) noexcept override;
|
|
[[nodiscard]] HRESULT Invalidate(const SMALL_RECT* const psrRegion) noexcept override;
|
|
[[nodiscard]] HRESULT InvalidateCursor(const COORD* const pcoordCursor) noexcept override;
|
|
[[nodiscard]] HRESULT InvalidateAll() noexcept override;
|
|
[[nodiscard]] HRESULT InvalidateCircling(_Out_ bool* const pForcePaint) noexcept override;
|
|
[[nodiscard]] HRESULT PrepareForTeardown(_Out_ bool* const pForcePaint) noexcept override;
|
|
|
|
[[nodiscard]] virtual HRESULT StartPaint() noexcept override;
|
|
[[nodiscard]] virtual HRESULT EndPaint() noexcept override;
|
|
[[nodiscard]] virtual HRESULT Present() noexcept override;
|
|
|
|
[[nodiscard]] virtual HRESULT ScrollFrame() noexcept = 0;
|
|
|
|
[[nodiscard]] HRESULT PaintBackground() noexcept override;
|
|
[[nodiscard]] virtual HRESULT PaintBufferLine(gsl::span<const Cluster> const clusters,
|
|
const COORD coord,
|
|
const bool trimLeft,
|
|
const bool lineWrapped) noexcept override;
|
|
[[nodiscard]] HRESULT PaintBufferGridLines(const GridLines lines,
|
|
const COLORREF color,
|
|
const size_t cchLine,
|
|
const COORD coordTarget) noexcept override;
|
|
[[nodiscard]] HRESULT PaintSelection(const SMALL_RECT rect) noexcept override;
|
|
|
|
[[nodiscard]] virtual HRESULT PaintCursor(const CursorOptions& options) noexcept override;
|
|
|
|
[[nodiscard]] virtual HRESULT UpdateDrawingBrushes(const TextAttribute& textAttributes,
|
|
const gsl::not_null<IRenderData*> pData,
|
|
const bool isSettingDefaultBrushes) noexcept = 0;
|
|
[[nodiscard]] HRESULT UpdateFont(const FontInfoDesired& pfiFontInfoDesired,
|
|
_Out_ FontInfo& pfiFontInfo) noexcept override;
|
|
[[nodiscard]] HRESULT UpdateDpi(const int iDpi) noexcept override;
|
|
[[nodiscard]] HRESULT UpdateViewport(const SMALL_RECT srNewViewport) noexcept override;
|
|
|
|
[[nodiscard]] HRESULT GetProposedFont(const FontInfoDesired& FontDesired,
|
|
_Out_ FontInfo& Font,
|
|
const int iDpi) noexcept override;
|
|
|
|
std::vector<til::rectangle> GetDirtyArea() override;
|
|
[[nodiscard]] HRESULT GetFontSize(_Out_ COORD* const pFontSize) noexcept override;
|
|
[[nodiscard]] HRESULT IsGlyphWideByFont(const std::wstring_view glyph, _Out_ bool* const pResult) noexcept override;
|
|
|
|
[[nodiscard]] HRESULT SuppressResizeRepaint() noexcept;
|
|
|
|
[[nodiscard]] HRESULT RequestCursor() noexcept;
|
|
[[nodiscard]] HRESULT InheritCursor(const COORD coordCursor) noexcept;
|
|
|
|
[[nodiscard]] HRESULT WriteTerminalUtf8(const std::string_view str) noexcept;
|
|
|
|
[[nodiscard]] virtual HRESULT WriteTerminalW(const std::wstring_view str) noexcept = 0;
|
|
|
|
void SetTerminalOwner(Microsoft::Console::ITerminalOwner* const terminalOwner);
|
|
void BeginResizeRequest();
|
|
void EndResizeRequest();
|
|
|
|
void SetResizeQuirk(const bool resizeQuirk);
|
|
|
|
[[nodiscard]] virtual HRESULT ManuallyClearScrollback() noexcept;
|
|
|
|
[[nodiscard]] HRESULT RequestWin32Input() noexcept;
|
|
|
|
protected:
|
|
wil::unique_hfile _hFile;
|
|
std::string _buffer;
|
|
|
|
std::string _formatBuffer;
|
|
|
|
TextAttribute _lastTextAttributes;
|
|
|
|
Microsoft::Console::Types::Viewport _lastViewport;
|
|
|
|
til::bitmap _invalidMap;
|
|
|
|
COORD _lastText;
|
|
til::point _scrollDelta;
|
|
|
|
bool _quickReturn;
|
|
bool _clearedAllThisFrame;
|
|
bool _cursorMoved;
|
|
bool _resized;
|
|
|
|
bool _suppressResizeRepaint;
|
|
|
|
SHORT _virtualTop;
|
|
bool _circled;
|
|
bool _firstPaint;
|
|
bool _skipCursor;
|
|
bool _newBottomLine;
|
|
COORD _deferredCursorPos;
|
|
|
|
bool _pipeBroken;
|
|
HRESULT _exitResult;
|
|
Microsoft::Console::ITerminalOwner* _terminalOwner;
|
|
|
|
Microsoft::Console::VirtualTerminal::RenderTracing _trace;
|
|
bool _inResizeRequest{ false };
|
|
|
|
std::optional<short> _wrappedRow{ std::nullopt };
|
|
|
|
bool _delayedEolWrap{ false };
|
|
|
|
bool _resizeQuirk{ false };
|
|
std::optional<TextColor> _newBottomLineBG{ std::nullopt };
|
|
|
|
[[nodiscard]] HRESULT _Write(std::string_view const str) noexcept;
|
|
[[nodiscard]] HRESULT _WriteFormattedString(const std::string* const pFormat, ...) noexcept;
|
|
[[nodiscard]] HRESULT _Flush() noexcept;
|
|
|
|
void _OrRect(_Inout_ SMALL_RECT* const pRectExisting, const SMALL_RECT* const pRectToOr) const;
|
|
bool _AllIsInvalid() const;
|
|
|
|
[[nodiscard]] HRESULT _StopCursorBlinking() noexcept;
|
|
[[nodiscard]] HRESULT _StartCursorBlinking() noexcept;
|
|
[[nodiscard]] HRESULT _HideCursor() noexcept;
|
|
[[nodiscard]] HRESULT _ShowCursor() noexcept;
|
|
[[nodiscard]] HRESULT _EraseLine() noexcept;
|
|
[[nodiscard]] HRESULT _InsertDeleteLine(const short sLines, const bool fInsertLine) noexcept;
|
|
[[nodiscard]] HRESULT _DeleteLine(const short sLines) noexcept;
|
|
[[nodiscard]] HRESULT _InsertLine(const short sLines) noexcept;
|
|
[[nodiscard]] HRESULT _CursorForward(const short chars) noexcept;
|
|
[[nodiscard]] HRESULT _EraseCharacter(const short chars) noexcept;
|
|
[[nodiscard]] HRESULT _CursorPosition(const COORD coord) noexcept;
|
|
[[nodiscard]] HRESULT _CursorHome() noexcept;
|
|
[[nodiscard]] HRESULT _ClearScreen() noexcept;
|
|
[[nodiscard]] HRESULT _ClearScrollback() noexcept;
|
|
[[nodiscard]] HRESULT _ChangeTitle(const std::string& title) noexcept;
|
|
[[nodiscard]] HRESULT _SetGraphicsRendition16Color(const WORD wAttr,
|
|
const bool fIsForeground) noexcept;
|
|
[[nodiscard]] HRESULT _SetGraphicsRendition256Color(const WORD index,
|
|
const bool fIsForeground) noexcept;
|
|
[[nodiscard]] HRESULT _SetGraphicsRenditionRGBColor(const COLORREF color,
|
|
const bool fIsForeground) noexcept;
|
|
[[nodiscard]] HRESULT _SetGraphicsRenditionDefaultColor(const bool fIsForeground) noexcept;
|
|
|
|
[[nodiscard]] HRESULT _SetGraphicsDefault() noexcept;
|
|
|
|
[[nodiscard]] HRESULT _ResizeWindow(const short sWidth, const short sHeight) noexcept;
|
|
|
|
[[nodiscard]] HRESULT _SetBold(const bool isBold) noexcept;
|
|
[[nodiscard]] HRESULT _SetFaint(const bool isFaint) noexcept;
|
|
[[nodiscard]] HRESULT _SetUnderline(const bool isUnderlined) noexcept;
|
|
[[nodiscard]] HRESULT _SetOverline(const bool isUnderlined) noexcept;
|
|
[[nodiscard]] HRESULT _SetItalics(const bool isItalic) noexcept;
|
|
[[nodiscard]] HRESULT _SetBlinking(const bool isBlinking) noexcept;
|
|
[[nodiscard]] HRESULT _SetInvisible(const bool isInvisible) noexcept;
|
|
[[nodiscard]] HRESULT _SetCrossedOut(const bool isCrossedOut) noexcept;
|
|
[[nodiscard]] HRESULT _SetReverseVideo(const bool isReversed) noexcept;
|
|
|
|
[[nodiscard]] HRESULT _RequestCursor() noexcept;
|
|
|
|
[[nodiscard]] HRESULT _RequestWin32Input() noexcept;
|
|
|
|
[[nodiscard]] virtual HRESULT _MoveCursor(const COORD coord) noexcept = 0;
|
|
[[nodiscard]] HRESULT _RgbUpdateDrawingBrushes(const TextAttribute& textAttributes) noexcept;
|
|
[[nodiscard]] HRESULT _16ColorUpdateDrawingBrushes(const TextAttribute& textAttributes) noexcept;
|
|
|
|
bool _WillWriteSingleChar() const;
|
|
|
|
// buffer space for these two functions to build their lines
|
|
// so they don't have to alloc/free in a tight loop
|
|
std::wstring _bufferLine;
|
|
[[nodiscard]] HRESULT _PaintUtf8BufferLine(gsl::span<const Cluster> const clusters,
|
|
const COORD coord,
|
|
const bool lineWrapped) noexcept;
|
|
|
|
[[nodiscard]] HRESULT _PaintAsciiBufferLine(gsl::span<const Cluster> const clusters,
|
|
const COORD coord) noexcept;
|
|
|
|
[[nodiscard]] HRESULT _WriteTerminalUtf8(const std::wstring_view str) noexcept;
|
|
[[nodiscard]] HRESULT _WriteTerminalAscii(const std::wstring_view str) noexcept;
|
|
|
|
[[nodiscard]] virtual HRESULT _DoUpdateTitle(const std::wstring& newTitle) noexcept override;
|
|
|
|
/////////////////////////// Unit Testing Helpers ///////////////////////////
|
|
#ifdef UNIT_TESTING
|
|
std::function<bool(const char* const, size_t const)> _pfnTestCallback;
|
|
bool _usingTestCallback;
|
|
|
|
friend class VtRendererTest;
|
|
friend class ConptyOutputTests;
|
|
friend class TerminalCoreUnitTests::ConptyRoundtripTests;
|
|
#endif
|
|
|
|
void SetTestCallback(_In_ std::function<bool(const char* const, size_t const)> pfn);
|
|
};
|
|
}
|