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
51 lines
1.4 KiB
C++
51 lines
1.4 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- IUiaData.hpp
|
|
|
|
Abstract:
|
|
- This serves as the interface defining all information needed for the UI Automation Tree and the Renderer
|
|
|
|
Author(s):
|
|
- Carlos Zamora (CaZamor) Aug-2019
|
|
--*/
|
|
|
|
#pragma once
|
|
|
|
#include "inc/viewport.hpp"
|
|
|
|
class TextBuffer;
|
|
|
|
namespace Microsoft::Console::Types
|
|
{
|
|
class IBaseData
|
|
{
|
|
public:
|
|
virtual ~IBaseData() = 0;
|
|
|
|
protected:
|
|
IBaseData() = default;
|
|
IBaseData(const IBaseData&) = default;
|
|
IBaseData(IBaseData&&) = default;
|
|
IBaseData& operator=(const IBaseData&) = default;
|
|
IBaseData& operator=(IBaseData&&) = default;
|
|
|
|
public:
|
|
virtual Microsoft::Console::Types::Viewport GetViewport() noexcept = 0;
|
|
virtual COORD GetTextBufferEndPosition() const noexcept = 0;
|
|
virtual const TextBuffer& GetTextBuffer() noexcept = 0;
|
|
virtual const FontInfo& GetFontInfo() noexcept = 0;
|
|
virtual std::pair<COLORREF, COLORREF> GetAttributeColors(const TextAttribute& attr) const noexcept = 0;
|
|
|
|
virtual std::vector<Microsoft::Console::Types::Viewport> GetSelectionRects() noexcept = 0;
|
|
|
|
virtual void LockConsole() noexcept = 0;
|
|
virtual void UnlockConsole() noexcept = 0;
|
|
};
|
|
|
|
// See docs/virtual-dtors.md for an explanation of why this is weird.
|
|
inline IBaseData::~IBaseData() {}
|
|
}
|