66fdc645f7
Set keyword flags on all events so those sharing a provider with telemetry do not fire unless tracing is enabled ## PR Checklist * [x] Closes #10093 * [x] I work here * [x] Tests passed * [x] Documentation added in `til.h` about how keywords work and at the only other site of keywords we define in the Host project tracing files. ## Detailed Description of the Pull Request / Additional comments I initially thought that we would need to split providers here to accomplish this... but @DHowett helped me realize that might be a lot of additional metadata and bloat binary size. So with help from a friend from fundamentals, I realized that we could use Keywords to differentiate here. We can no longer define 0 keywords as that represents an any/all scenario. Every `TraceLoggingWrite` event now needs a keyword. When our events have a keyword, they're not included in any trace. Additionally, when we have an explicit keyword to check that is different from the ones used for the telemetry pipeline, we can ensure that we only do "hard work" to generate debug trace data when an "ALL" type listener like TraceView or Windows Performance Recorder with our profiles is listening to these providers for ALL keyworded events. ## Validation Steps Performed - [x] - Built with full release build config to confirm performance is worse than dev builds BECAUSE of the telemetry event collector camping our provider and triggering full trace event generation on shared providers. - [x] - Built with full release build config to enable statistics collection and validated trace event collection is excluded and trace event short-circuits work with this change. - [x] - Checked that TraceView still sees both telemetry and tracing events - [x] - Checked that WPR with our .wprp profile sees both telemetry and tracing events
733 lines
28 KiB
C++
733 lines
28 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#include "precomp.h"
|
|
#include "UiaTracing.h"
|
|
|
|
// we need to disable a few warnings because
|
|
// the TraceLogging code is out of our control
|
|
#pragma warning(push)
|
|
#pragma warning(disable : 26446 26447 26477 26482 26485 26494 26496)
|
|
TRACELOGGING_DEFINE_PROVIDER(g_UiaProviderTraceProvider,
|
|
"Microsoft.Windows.Console.UIA",
|
|
// tl:{e7ebce59-2161-572d-b263-2f16a6afb9e5}
|
|
(0xe7ebce59, 0x2161, 0x572d, 0xb2, 0x63, 0x2f, 0x16, 0xa6, 0xaf, 0xb9, 0xe5));
|
|
|
|
using namespace Microsoft::Console::Types;
|
|
|
|
// The first valid ID is 1 for each of our traced UIA object types
|
|
// ID assignment is handled between UiaTracing and IUiaTraceable to...
|
|
// - prevent multiple objects with the same ID
|
|
// - only assign IDs if UiaTracing is enabled
|
|
// - ensure objects are only assigned an ID once
|
|
IdType UiaTracing::_utrId = 1;
|
|
IdType UiaTracing::_siupId = 1;
|
|
|
|
// Routine Description:
|
|
// - assign an ID to the UiaTextRange, if it doesn't have one already
|
|
// Arguments:
|
|
// - utr - the UiaTextRange we are assigning an ID to
|
|
// Return Value:
|
|
// - N/A
|
|
void UiaTracing::_assignId(UiaTextRangeBase& utr) noexcept
|
|
{
|
|
auto temp = utr.AssignId(_utrId);
|
|
if (temp)
|
|
{
|
|
++_utrId;
|
|
}
|
|
}
|
|
|
|
// Routine Description:
|
|
// - assign an ID to the ScreenInfoUiaProvider, if it doesn't have one already
|
|
// Arguments:
|
|
// - siup - the ScreenInfoUiaProvider we are assigning an ID to
|
|
// Return Value:
|
|
// - N/A
|
|
void UiaTracing::_assignId(ScreenInfoUiaProviderBase& siup) noexcept
|
|
{
|
|
auto temp = siup.AssignId(_siupId);
|
|
if (temp)
|
|
{
|
|
++_siupId;
|
|
}
|
|
}
|
|
|
|
UiaTracing::UiaTracing() noexcept
|
|
{
|
|
TraceLoggingRegister(g_UiaProviderTraceProvider);
|
|
}
|
|
|
|
UiaTracing::~UiaTracing() noexcept
|
|
{
|
|
TraceLoggingUnregister(g_UiaProviderTraceProvider);
|
|
}
|
|
|
|
inline std::wstring UiaTracing::_getValue(const ScreenInfoUiaProviderBase& siup) noexcept
|
|
{
|
|
std::wstringstream stream;
|
|
stream << "_id: " << siup.GetId();
|
|
return stream.str();
|
|
}
|
|
|
|
inline std::wstring UiaTracing::_getValue(const UiaTextRangeBase& utr) noexcept
|
|
try
|
|
{
|
|
const auto start = utr.GetEndpoint(TextPatternRangeEndpoint_Start);
|
|
const auto end = utr.GetEndpoint(TextPatternRangeEndpoint_End);
|
|
|
|
std::wstringstream stream;
|
|
stream << " _id: " << utr.GetId();
|
|
stream << " _start: { " << start.X << ", " << start.Y << " }";
|
|
stream << " _end: { " << end.X << ", " << end.Y << " }";
|
|
stream << " _degenerate: " << utr.IsDegenerate();
|
|
stream << " _wordDelimiters: " << utr._wordDelimiters;
|
|
stream << " content: " << utr._getTextValue();
|
|
return stream.str();
|
|
}
|
|
catch (...)
|
|
{
|
|
return {};
|
|
}
|
|
|
|
inline std::wstring UiaTracing::_getValue(const TextPatternRangeEndpoint endpoint) noexcept
|
|
{
|
|
switch (endpoint)
|
|
{
|
|
case TextPatternRangeEndpoint_Start:
|
|
return L"Start";
|
|
case TextPatternRangeEndpoint_End:
|
|
return L"End";
|
|
default:
|
|
return L"UNKNOWN VALUE";
|
|
}
|
|
}
|
|
|
|
inline std::wstring UiaTracing::_getValue(const TextUnit unit) noexcept
|
|
{
|
|
switch (unit)
|
|
{
|
|
case TextUnit_Character:
|
|
return L"Character";
|
|
case TextUnit_Format:
|
|
return L"Format";
|
|
case TextUnit_Word:
|
|
return L"Word";
|
|
case TextUnit_Line:
|
|
return L"Line";
|
|
case TextUnit_Paragraph:
|
|
return L"Paragraph";
|
|
case TextUnit_Page:
|
|
return L"Page";
|
|
case TextUnit_Document:
|
|
return L"Document";
|
|
default:
|
|
return L"UNKNOWN VALUE";
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::Constructor(UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
_assignId(result);
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::Constructor",
|
|
TraceLoggingValue(_getValue(result).c_str(), "UiaTextRange"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::Clone(const UiaTextRangeBase& utr, UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
_assignId(result);
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::Clone",
|
|
TraceLoggingValue(_getValue(utr).c_str(), "base"),
|
|
TraceLoggingValue(_getValue(result).c_str(), "clone"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::Compare(const UiaTextRangeBase& utr, const UiaTextRangeBase& other, bool result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::Compare",
|
|
TraceLoggingValue(_getValue(utr).c_str(), "base"),
|
|
TraceLoggingValue(_getValue(other).c_str(), "other"),
|
|
TraceLoggingValue(result, "result"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::CompareEndpoints(const UiaTextRangeBase& utr, const TextPatternRangeEndpoint endpoint, const UiaTextRangeBase& other, TextPatternRangeEndpoint otherEndpoint, int result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::CompareEndpoints",
|
|
TraceLoggingValue(_getValue(utr).c_str(), "base"),
|
|
TraceLoggingValue(_getValue(endpoint).c_str(), "baseEndpoint"),
|
|
TraceLoggingValue(_getValue(other).c_str(), "other"),
|
|
TraceLoggingValue(_getValue(otherEndpoint).c_str(), "otherEndpoint"),
|
|
TraceLoggingValue(result, "result"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::ExpandToEnclosingUnit(TextUnit unit, const UiaTextRangeBase& utr) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::ExpandToEnclosingUnit",
|
|
TraceLoggingValue(_getValue(unit).c_str(), "textUnit"),
|
|
TraceLoggingValue(_getValue(utr).c_str(), "result"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::FindAttribute(const UiaTextRangeBase& utr) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::FindAttribute (UNSUPPORTED)",
|
|
TraceLoggingValue(_getValue(utr).c_str(), "base"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::FindText(const UiaTextRangeBase& base, std::wstring text, bool searchBackward, bool ignoreCase, const UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::FindText",
|
|
TraceLoggingValue(_getValue(base).c_str(), "base"),
|
|
TraceLoggingValue(text.c_str(), "text"),
|
|
TraceLoggingValue(searchBackward, "searchBackward"),
|
|
TraceLoggingValue(ignoreCase, "ignoreCase"),
|
|
TraceLoggingValue(_getValue(result).c_str(), "result"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::GetAttributeValue(const UiaTextRangeBase& base, TEXTATTRIBUTEID id, VARIANT result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::GetAttributeValue",
|
|
TraceLoggingValue(_getValue(base).c_str(), "base"),
|
|
TraceLoggingValue(id, "textAttributeId"),
|
|
TraceLoggingValue(result.vt, "result (type)"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::GetBoundingRectangles(const UiaTextRangeBase& utr) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::GetBoundingRectangles",
|
|
TraceLoggingValue(_getValue(utr).c_str(), "base"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::GetEnclosingElement(const UiaTextRangeBase& utr) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::GetEnclosingElement",
|
|
TraceLoggingValue(_getValue(utr).c_str(), "base"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::GetText(const UiaTextRangeBase& utr, int maxLength, std::wstring result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::GetText",
|
|
TraceLoggingValue(_getValue(utr).c_str(), "base"),
|
|
TraceLoggingValue(maxLength, "maxLength"),
|
|
TraceLoggingValue(result.c_str(), "result"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::Move(TextUnit unit, int count, int resultCount, const UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::Move",
|
|
TraceLoggingValue(_getValue(unit).c_str(), "textUnit"),
|
|
TraceLoggingValue(count, "count"),
|
|
TraceLoggingValue(resultCount, "resultCount"),
|
|
TraceLoggingValue(_getValue(result).c_str(), "result"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::MoveEndpointByUnit(TextPatternRangeEndpoint endpoint, TextUnit unit, int count, int resultCount, const UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::MoveEndpointByUnit",
|
|
TraceLoggingValue(_getValue(endpoint).c_str(), "endpoint"),
|
|
TraceLoggingValue(_getValue(unit).c_str(), "textUnit"),
|
|
TraceLoggingValue(count, "count"),
|
|
TraceLoggingValue(resultCount, "resultCount"),
|
|
TraceLoggingValue(_getValue(result).c_str(), "result"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::MoveEndpointByRange(TextPatternRangeEndpoint endpoint, const UiaTextRangeBase& other, TextPatternRangeEndpoint otherEndpoint, const UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::MoveEndpointByRange",
|
|
TraceLoggingValue(_getValue(endpoint).c_str(), "endpoint"),
|
|
TraceLoggingValue(_getValue(other).c_str(), "other"),
|
|
TraceLoggingValue(_getValue(otherEndpoint).c_str(), "otherEndpoint"),
|
|
TraceLoggingValue(_getValue(result).c_str(), "result"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::Select(const UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::Select",
|
|
TraceLoggingValue(_getValue(result).c_str(), "base"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::AddToSelection(const UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::AddToSelection (UNSUPPORTED)",
|
|
TraceLoggingValue(_getValue(result).c_str(), "base"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::RemoveFromSelection(const UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::RemoveFromSelection (UNSUPPORTED)",
|
|
TraceLoggingValue(_getValue(result).c_str(), "base"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::ScrollIntoView(bool alignToTop, const UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::ScrollIntoView",
|
|
TraceLoggingValue(alignToTop, "alignToTop"),
|
|
TraceLoggingValue(_getValue(result).c_str(), "result"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextRange::GetChildren(const UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"UiaTextRange::AddToSelection (UNSUPPORTED)",
|
|
TraceLoggingValue(_getValue(result).c_str(), "base"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextProvider::Constructor(ScreenInfoUiaProviderBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
_assignId(result);
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"ScreenInfoUiaProvider::Constructor",
|
|
TraceLoggingValue(_getValue(result).c_str(), "ScreenInfoUiaProvider"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextProvider::get_ProviderOptions(const ScreenInfoUiaProviderBase& siup, ProviderOptions options) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
auto getOptions = [options]() {
|
|
switch (options)
|
|
{
|
|
case ProviderOptions_ServerSideProvider:
|
|
return L"ServerSideProvider";
|
|
default:
|
|
return L"UNKNOWN VALUE";
|
|
}
|
|
};
|
|
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"ScreenInfoUiaProvider::get_ProviderOptions",
|
|
TraceLoggingValue(_getValue(siup).c_str(), "base"),
|
|
TraceLoggingValue(getOptions(), "providerOptions"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextProvider::GetPatternProvider(const ScreenInfoUiaProviderBase& siup, PATTERNID patternId) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
auto getPattern = [patternId]() {
|
|
switch (patternId)
|
|
{
|
|
case UIA_TextPatternId:
|
|
return L"TextPattern";
|
|
default:
|
|
return L"UNKNOWN VALUE";
|
|
}
|
|
};
|
|
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"ScreenInfoUiaProvider::get_ProviderOptions",
|
|
TraceLoggingValue(_getValue(siup).c_str(), "base"),
|
|
TraceLoggingValue(getPattern(), "patternId"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextProvider::GetPropertyValue(const ScreenInfoUiaProviderBase& siup, PROPERTYID propertyId) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
auto getProperty = [propertyId]() {
|
|
switch (propertyId)
|
|
{
|
|
case UIA_ControlTypePropertyId:
|
|
return L"ControlTypePropertyId";
|
|
case UIA_NamePropertyId:
|
|
return L"NamePropertyId";
|
|
case UIA_AutomationIdPropertyId:
|
|
return L"AutomationIdPropertyId";
|
|
case UIA_IsControlElementPropertyId:
|
|
return L"IsControlElementPropertyId";
|
|
case UIA_IsContentElementPropertyId:
|
|
return L"IsContentElementPropertyId";
|
|
case UIA_IsKeyboardFocusablePropertyId:
|
|
return L"IsKeyboardFocusablePropertyId";
|
|
case UIA_HasKeyboardFocusPropertyId:
|
|
return L"HasKeyboardFocusPropertyId";
|
|
case UIA_ProviderDescriptionPropertyId:
|
|
return L"ProviderDescriptionPropertyId";
|
|
case UIA_IsEnabledPropertyId:
|
|
return L"IsEnabledPropertyId";
|
|
default:
|
|
return L"UNKNOWN VALUE";
|
|
}
|
|
};
|
|
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"ScreenInfoUiaProvider::GetPropertyValue",
|
|
TraceLoggingValue(_getValue(siup).c_str(), "base"),
|
|
TraceLoggingValue(getProperty(), "propertyId"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextProvider::get_HostRawElementProvider(const ScreenInfoUiaProviderBase& siup) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"ScreenInfoUiaProvider::get_HostRawElementProvider (UNSUPPORTED)",
|
|
TraceLoggingValue(_getValue(siup).c_str(), "base"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextProvider::GetRuntimeId(const ScreenInfoUiaProviderBase& siup) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"ScreenInfoUiaProvider::GetRuntimeId",
|
|
TraceLoggingValue(_getValue(siup).c_str(), "base"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextProvider::GetEmbeddedFragmentRoots(const ScreenInfoUiaProviderBase& siup) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"ScreenInfoUiaProvider::GetEmbeddedFragmentRoots (UNSUPPORTED)",
|
|
TraceLoggingValue(_getValue(siup).c_str(), "base"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextProvider::SetFocus(const ScreenInfoUiaProviderBase& siup) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"ScreenInfoUiaProvider::SetFocus",
|
|
TraceLoggingValue(_getValue(siup).c_str(), "base"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextProvider::GetSelection(const ScreenInfoUiaProviderBase& siup, const UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"ScreenInfoUiaProvider::GetSelection",
|
|
TraceLoggingValue(_getValue(siup).c_str(), "base"),
|
|
TraceLoggingValue(_getValue(result).c_str(), "result (utr)"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextProvider::GetVisibleRanges(const ScreenInfoUiaProviderBase& siup, const UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"ScreenInfoUiaProvider::GetVisibleRanges",
|
|
TraceLoggingValue(_getValue(siup).c_str(), "base"),
|
|
TraceLoggingValue(_getValue(result).c_str(), "result (utr)"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextProvider::RangeFromChild(const ScreenInfoUiaProviderBase& siup, const UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"ScreenInfoUiaProvider::GetVisibleRanges",
|
|
TraceLoggingValue(_getValue(siup).c_str(), "base"),
|
|
TraceLoggingValue(_getValue(result).c_str(), "result (utr)"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextProvider::RangeFromPoint(const ScreenInfoUiaProviderBase& siup, UiaPoint point, const UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
auto getPoint = [point]() {
|
|
std::wstringstream stream;
|
|
stream << "{ " << point.x << ", " << point.y << " }";
|
|
return stream.str();
|
|
};
|
|
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"ScreenInfoUiaProvider::RangeFromPoint",
|
|
TraceLoggingValue(_getValue(siup).c_str(), "base"),
|
|
TraceLoggingValue(getPoint().c_str(), "uiaPoint"),
|
|
TraceLoggingValue(_getValue(result).c_str(), "result (utr)"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextProvider::get_DocumentRange(const ScreenInfoUiaProviderBase& siup, const UiaTextRangeBase& result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"ScreenInfoUiaProvider::GetVisibleRanges",
|
|
TraceLoggingValue(_getValue(siup).c_str(), "base"),
|
|
TraceLoggingValue(_getValue(result).c_str(), "result (utr)"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::TextProvider::get_SupportedTextSelection(const ScreenInfoUiaProviderBase& siup, SupportedTextSelection result) noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
auto getResult = [result]() {
|
|
switch (result)
|
|
{
|
|
case SupportedTextSelection_Single:
|
|
return L"Single";
|
|
default:
|
|
return L"UNKNOWN VALUE";
|
|
}
|
|
};
|
|
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"ScreenInfoUiaProvider::get_SupportedTextSelection",
|
|
TraceLoggingValue(_getValue(siup).c_str(), "base"),
|
|
TraceLoggingValue(getResult(), "result"),
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::Signal::SelectionChanged() noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"Signal::SelectionChanged",
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::Signal::TextChanged() noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"Signal::TextChanged",
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
void UiaTracing::Signal::CursorChanged() noexcept
|
|
{
|
|
EnsureRegistration();
|
|
if (TraceLoggingProviderEnabled(g_UiaProviderTraceProvider, WINEVENT_LEVEL_VERBOSE, TIL_KEYWORD_TRACE))
|
|
{
|
|
TraceLoggingWrite(
|
|
g_UiaProviderTraceProvider,
|
|
"Signal::CursorChanged",
|
|
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
|
|
TraceLoggingKeyword(TIL_KEYWORD_TRACE));
|
|
}
|
|
}
|
|
|
|
#pragma warning(pop)
|