screenInfo.hpp

/*++
Copyright (c) Microsoft Corporation
Licensed under the MIT license.

Module Name:
- screenInfo.hpp

Abstract:
- This module represents the structures and functions required
 for rendering one screen of the console host window.

Author(s):
- Michael Niksa (MiNiksa) 10-Apr-2014
- Paul Campbell (PaulCam) 10-Apr-2014

Revision History:
- From components of output.h/.c and resize.c by Therese Stowell (ThereseS) 1990-1991
--*/

#pragma once

#include"conapi.h"
#include"settings.hpp"
#include"outputStream.hpp"

#include"../buffer/out/OutputCellRect.hpp"
#include"../buffer/out/TextAttribute.hpp"
#include"../buffer/out/textBuffer.hpp"
#include"../buffer/out/textBufferCellIterator.hpp"
#include"../buffer/out/textBufferTextIterator.hpp"

#include"IIoProvider.hpp"
#include"outputStream.hpp"
#include"../terminal/adapter/adaptDispatch.hpp"
#include"../terminal/parser/stateMachine.hpp"
#include"../terminal/parser/OutputStateMachineEngine.hpp"

#include"../server/ObjectHeader.h"

#include"../interactivity/inc/IAccessibilityNotifier.hpp"
#include"../interactivity/inc/IConsoleWindow.hpp"
#include"../interactivity/inc/IWindowMetrics.hpp"

#include"../renderer/inc/FontInfo.hpp"
#include"../renderer/inc/FontInfoDesired.hpp"

#include"../types/inc/Viewport.hpp"
classConversionAreaInfo; // forward decl window. circular reference

classSCREEN_INFORMATION : publicConsoleObjectHeader, publicMicrosoft::Console::IIoProvider
{
public:
 [[nodiscard]] static NTSTATUS CreateInstance(_In_ til::size coordWindowSize,
const FontInfo fontInfo,
 _In_ til::size coordScreenBufferSize,
const TextAttribute defaultAttributes,
const TextAttribute popupAttributes,
const UINT uiCursorSize,
 _Outptr_ SCREEN_INFORMATION** const ppScreen);

~SCREEN_INFORMATION();

voidGetScreenBufferInformation(_Out_ til::size* pcoordSize,
 _Out_ til::point* pcoordCursorPosition,
 _Out_ til::inclusive_rect* psrWindow,
 _Out_ PWORD pwAttributes,
 _Out_ til::size* pcoordMaximumWindowSize,
 _Out_ PWORD pwPopupAttributes,
_Out_writes_(COLOR_TABLE_SIZE) LPCOLORREF lpColorTable) const;

voidGetRequiredConsoleSizeInPixels(_Out_ til::size* const pRequiredSize) const;

voidMakeCurrentCursorVisible();

voidClipToScreenBuffer(_Inout_ til::inclusive_rect* const psrClip) const;

 til::size GetMinWindowSizeInCharacters(const til::size coordFontSize = { 1, 1 }) const;
 til::size GetMaxWindowSizeInCharacters(const til::size coordFontSize = { 1, 1 }) const;
 til::size GetLargestWindowSizeInCharacters(const til::size coordFontSize = { 1, 1 }) const;
 til::size GetScrollBarSizesInCharacters() const;

 Microsoft::Console::Types::Viewport GetBufferSize() const;
 Microsoft::Console::Types::Viewport GetTerminalBufferSize() const;

 til::size GetScreenFontSize() const;
voidUpdateFont(const FontInfo* const pfiNewFont);
voidRefreshFontWithRenderer();

 [[nodiscard]] NTSTATUS ResizeScreenBuffer(const til::size coordNewScreenSize, constboolfDoScrollBarUpdate);

boolHasAccessibilityEventing() constnoexcept;
voidNotifyAccessibilityEventing(const til::CoordType sStartX, const til::CoordType sStartY, const til::CoordType sEndX, const til::CoordType sEndY);

structScrollBarState
 {
 til::size maxSize;
 til::rect viewport;
bool isAltBuffer = false;
 };
voidUpdateScrollBars();
 ScrollBarState FetchScrollBarState();

boolIsMaximizedBoth() const;
boolIsMaximizedX() const;
boolIsMaximizedY() const;

const Microsoft::Console::Types::Viewport& GetViewport() constnoexcept;
voidSetViewport(const Microsoft::Console::Types::Viewport& newViewport, constbool updateBottom);
 Microsoft::Console::Types::Viewport GetVirtualViewport() constnoexcept;
 Microsoft::Console::Types::Viewport GetVtPageArea() constnoexcept;

voidProcessResizeWindow(const til::rect* const prcClientNew, const til::rect* const prcClientOld);
voidSetViewportSize(const til::size* const pcoordSize);

// Forwarders to Window if we're the active buffer.
 [[nodiscard]] NTSTATUS SetViewportOrigin(constboolfAbsolute, const til::point coordWindowOrigin, constbool updateBottom);

boolSendNotifyBeep() const;
boolPostUpdateWindowSize() const;

// TODO: MSFT 9355062 these methods should probably be a part of construction/destruction. http://osgvsowi/9355062
staticvoids_InsertScreenBuffer(_In_ SCREEN_INFORMATION* const pScreenInfo);
staticvoids_RemoveScreenBuffer(_In_ SCREEN_INFORMATION* const pScreenInfo);

 TextBufferCellIterator GetCellDataAt(const til::point at) const;
 TextBufferCellIterator GetCellLineDataAt(const til::point at) const;
 TextBufferCellIterator GetCellDataAt(const til::point at, const Microsoft::Console::Types::Viewport limit) const;
 TextBufferTextIterator GetTextDataAt(const til::point at) const;
 TextBufferTextIterator GetTextLineDataAt(const til::point at) const;
 TextBufferTextIterator GetTextDataAt(const til::point at, const Microsoft::Console::Types::Viewport limit) const;

 OutputCellIterator Write(const OutputCellIterator it);

 OutputCellIterator Write(const OutputCellIterator it,
const til::point target,
const std::optional<bool> wrap = true);

 OutputCellIterator WriteRect(const OutputCellIterator it,
const Microsoft::Console::Types::Viewport viewport);

voidWriteRect(const OutputCellRect& data,
const til::point location);

voidClearTextData();

 std::pair<til::point, til::point> GetWordBoundary(const til::point position) const;

 TextBuffer& GetTextBuffer() noexcept;
const TextBuffer& GetTextBuffer() constnoexcept;

#pragma region IIoProvider
 SCREEN_INFORMATION& GetActiveOutputBuffer() override;
const SCREEN_INFORMATION& GetActiveOutputBuffer() constoverride;
 InputBuffer* constGetActiveInputBuffer() constoverride;
#pragma endregion

boolCursorIsDoubleWidth() const;

 DWORD OutputMode;

short WheelDelta;
short HWheelDelta;

private:
 std::unique_ptr<TextBuffer> _textBuffer;

public:
 SCREEN_INFORMATION* Next;
 BYTE WriteConsoleDbcsLeadByte[2];
 BYTE FillOutDbcsLeadChar;

 UINT ScrollScale;

boolIsActiveScreenBuffer() const;

const Microsoft::Console::VirtualTerminal::StateMachine& GetStateMachine() const;
 Microsoft::Console::VirtualTerminal::StateMachine& GetStateMachine();

voidSetCursorInformation(const ULONG Size,
constbool Visible) noexcept;

voidSetCursorType(const CursorType Type, constbool setMain = false) noexcept;

voidSetCursorDBMode(constbool DoubleCursor);
 [[nodiscard]] NTSTATUS SetCursorPosition(const til::point Position, constbool TurnOn);

voidMakeCursorVisible(const til::point CursorPosition);

 [[nodiscard]] NTSTATUS UseAlternateScreenBuffer(const TextAttribute& initAttributes);
voidUseMainScreenBuffer();

 SCREEN_INFORMATION& GetMainBuffer();
const SCREEN_INFORMATION& GetMainBuffer() const;
const SCREEN_INFORMATION* GetAltBuffer() constnoexcept;
 SCREEN_INFORMATION& GetActiveBuffer();
const SCREEN_INFORMATION& GetActiveBuffer() const;

const TextAttribute& GetAttributes() constnoexcept;
const TextAttribute& GetPopupAttributes() constnoexcept;

voidSetAttributes(const TextAttribute& attributes);
voidSetPopupAttributes(const TextAttribute& popupAttributes);
voidSetDefaultAttributes(const TextAttribute& attributes,
const TextAttribute& popupAttributes);

voidUpdateBottom();

 FontInfo& GetCurrentFont() noexcept;
const FontInfo& GetCurrentFont() constnoexcept;

 FontInfoDesired& GetDesiredFont() noexcept;
const FontInfoDesired& GetDesiredFont() constnoexcept;

 [[nodiscard]] NTSTATUS ResizeWithReflow(const til::size coordnewScreenSize);
 [[nodiscard]] NTSTATUS ResizeTraditional(const til::size coordNewScreenSize);

private:
SCREEN_INFORMATION(_In_ Microsoft::Console::Interactivity::IWindowMetrics* pMetrics,
 _In_ Microsoft::Console::Interactivity::IAccessibilityNotifier* pNotifier,
const TextAttribute popupAttributes,
const FontInfo fontInfo);

 Microsoft::Console::Interactivity::IWindowMetrics* _pConsoleWindowMetrics;
 Microsoft::Console::Interactivity::IAccessibilityNotifier* _pAccessibilityNotifier;

 [[nodiscard]] HRESULT _AdjustScreenBufferHelper(const til::rect* const prcClientNew,
const til::size coordBufferOld,
 _Out_ til::size* const pcoordClientNewCharacters);
 [[nodiscard]] HRESULT _AdjustScreenBuffer(const til::rect* const prcClientNew);
void_CalculateViewportSize(const til::rect* const prcClientArea, _Out_ til::size* const pcoordSize);
void_AdjustViewportSize(const til::rect* const prcClientNew, const til::rect* const prcClientOld, const til::size* const pcoordSize);
void_InternalSetViewportSize(const til::size* pcoordSize, constboolfResizeFromTop, constboolfResizeFromLeft);

staticvoids_CalculateScrollbarVisibility(const til::rect* const prcClientArea,
const til::size* const pcoordBufferSize,
const til::size* const pcoordFontSize,
 _Out_ bool* const pfIsHorizontalVisible,
 _Out_ bool* const pfIsVerticalVisible);

 [[nodiscard]] NTSTATUS _InitializeOutputStateMachine();
void_FreeOutputStateMachine();

 [[nodiscard]] NTSTATUS _CreateAltBuffer(const TextAttribute& initAttributes,
 _Out_ SCREEN_INFORMATION** const ppsiNewScreenBuffer);

bool_IsAltBuffer() const;
bool_IsInPtyMode() const;
bool_IsInVTMode() const;

 ConhostInternalGetSet _api;

 std::shared_ptr<Microsoft::Console::VirtualTerminal::StateMachine> _stateMachine;

// Specifies which coordinates of the screen buffer are visible in the
// window client (the "viewport" into the buffer)
 Microsoft::Console::Types::Viewport _viewport;

 SCREEN_INFORMATION* _psiAlternateBuffer; // The VT "Alternate" screen buffer.
 SCREEN_INFORMATION* _psiMainBuffer; // A pointer to the main buffer, if this is the alternate buffer.

 til::rect _rcAltSavedClientNew;
 til::rect _rcAltSavedClientOld;
bool _fAltWindowChanged;

 TextAttribute _PopupAttributes;

 FontInfo _currentFont;
 FontInfoDesired _desiredFont;

// Tracks the last virtual position the viewport was at. This is not
// affected by the user scrolling the viewport, only when API calls cause
// the viewport to move (SetBufferInfo, WriteConsole, etc)
 til::CoordType _virtualBottom;

 std::optional<til::size> _deferredPtyResize{ std::nullopt };

staticvoid_handleDeferredResize(SCREEN_INFORMATION& siMain);

#ifdef UNIT_TESTING
friendclassTextBufferIteratorTests;
friendclassScreenBufferTests;
friendclassCommonState;
#endif
};