a0e5085b49
## Summary of the Pull Request This implements `GetAttributeValue` and `FindAttribute` for `UiaTextRangeBase` (the shared `ITextRangeProvider` for Conhost and Windows Terminal). This also updates `UiaTracing` to collect more useful information on these function calls. ## References #7000 - Epic [Text Attribute Identifiers](https://docs.microsoft.com/en-us/windows/win32/winauto/uiauto-textattribute-ids) [ITextRangeProvider::GetAttributeValue](https://docs.microsoft.com/en-us/windows/win32/api/uiautomationcore/nf-uiautomationcore-itextrangeprovider-getattributevalue) [ITextRangeProvider::FindAttribute](https://docs.microsoft.com/en-us/windows/win32/api/uiautomationcore/nf-uiautomationcore-itextrangeprovider-findattribute) ## PR Checklist * [X] Closes #2161 * [X] Tests added/passed ## Detailed Description of the Pull Request / Additional comments - `TextBuffer`: - Exposes a new `TextBufferCellIterator` that takes in an end position. This simplifies the logic drastically as we can now use this iterator to navigate through the text buffer. The iterator can also expose the position in the buffer. - `UiaTextRangeBase`: - Shared logic & helper functions: - Most of the text attributes are stored as `TextAttribute`s in the text buffer. To extract them, we generate an attribute verification function via `_getAttrVerificationFn()`, then use that to verify if a given cell has the desired attribute. - A few attributes are special (i.e. font name, font size, and "is read only"), in that they are (1) acquired differently and (2) consistent across the entire text buffer. These are handled separate from the attribute verification function. - `GetAttributeValue`: Retrieve the attribute verification of the first cell in the range. Then, verify that the entire range has that attribute by iterating through the text range. If a cell does not have that attribute, return the "reserved mixed attribute value". - `FindAttribute`: Iterate through the text range and leverage the attribute verification function to find the first contiguous range with that attribute. Then, make the end exclusive and output a `UiaTextRangeBase`. This function must be able to perform a search backwards, so we abstract the "start" and "end" into `resultFirstAnchor` and `resultSecondAnchor`, then perform post processing to output a valid `UiaTextRangeBase`. - `UiaTracing`: - `GetAttributeValue`: Log uia text range, desired attribute, resulting attribute metadata, and the type of the result. - `FindAttribute`: Log uia text range, desired attribute and attribute metadata, if we were searching backwards, the type of the result, and the resulting text range. - `AttributeType` is a nice way to understand/record if the result was either of the reserved UIA values, a normal result, or an error. - `UiaTextRangeTests`: - `GetAttributeValue`: - verify that we know which attributes we support - test each of the known text attributes (expecting 100% code coverage for `_getAttrVerificationFn()`) - `FindAttribute`: - test each of the known _special_ text attributes - test `IsItalic`. NOTE: I'm explicitly only testing one of the standard text attributes because the logic is largely the same between all of them and they leverage `_getAttrVerificationFn()`. ## Validation Steps Performed - @codeofdusk has been testing this Conhost build - Tests added for Conhost and shared implementation - Windows Terminal changes were manually verified using accessibility insights and NVDA
79 lines
2.6 KiB
C++
79 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 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_view 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;
|
|
|
|
virtual const std::vector<size_t> GetPatternId(const COORD location) const noexcept = 0;
|
|
|
|
protected:
|
|
IRenderData() = default;
|
|
};
|
|
|
|
// See docs/virtual-dtors.md for an explanation of why this is weird.
|
|
inline IRenderData::~IRenderData() {}
|
|
}
|