Skip to content

clean up getTextFromIAccessible #13127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
feerrenrut merged 13 commits into from
Jan 28, 2022
Merged

clean up getTextFromIAccessible #13127

Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
ed4837d
Use constant for OBJ_REPLACEMENT_CHAR
feerrenrut Nov 29, 2021
6b62468
Check pacc2 for null
feerrenrut Nov 29, 2021
f834b91
Use CComQIPtr for paccText
feerrenrut Nov 29, 2021
089acda
Make recursive call args explicit.
feerrenrut Nov 29, 2021
cf1e819
Use CComQIPtr for pacc2Child
feerrenrut Nov 29, 2021
36e2fd9
Add a helper to getAccessibleChildren
feerrenrut Nov 29, 2021
cf3fba8
use CComBSTR for bstrText
feerrenrut Dec 2, 2021
a2c8034
CComQIPtr for paccHypertext
feerrenrut Dec 2, 2021
8b875f0
intialisation and condition ordering
feerrenrut Dec 2, 2021
5f4fc93
use CCom for paccHyperlink and pacc2Child
feerrenrut Dec 3, 2021
fec80cb
use standard string comparison
feerrenrut Dec 3, 2021
21cf41a
split name&description collection to a separate function.
feerrenrut Dec 3, 2021
51165f2
No need to specify IID for CComQIPtr
feerrenrut Jan 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
147 changes: 76 additions & 71 deletions nvdaHelper/remote/textFromIAccessible.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,53 @@ This license can be found at:

#include "textFromIAccessible.h"
#include <string>
#include <vector>
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
#include <atlcomcli.h>
#include <ia2.h>
#include <common/ia2utils.h>

using namespace std;
auto constexpr OBJ_REPLACEMENT_CHAR = L'\xfffc';


bool isEmpty(CComBSTR& val) {
if (!val) {
return true;
}
for (int i = 0; val[i] != L'\0'; ++i) {
if (val[i] != OBJ_REPLACEMENT_CHAR && !iswspace(val[i])) {
return false;
}
}
return true;
}

bool appendNameDescription(CComPtr<IAccessible> pacc, wstring& textBuf) {
bool gotText = false;
CComVariant varChild;
varChild.vt = VT_I4;
varChild.lVal = 0;

CComBSTR val;
pacc->get_accName(varChild, &val);
bool valEmpty = isEmpty(val);
if (!valEmpty) {
gotText = true;
textBuf.append(val);
textBuf.append(L" ");
Comment thread
feerrenrut marked this conversation as resolved.
}

val = nullptr;
pacc->get_accDescription(varChild, &val);
valEmpty = isEmpty(val);
if (!valEmpty) {
gotText = true;
textBuf.append(val);
}
return gotText;
}


bool getTextFromIAccessible(
Expand All @@ -29,45 +69,47 @@ bool getTextFromIAccessible(
bool recurse,
bool includeTopLevelText
) {
bool gotText = false;
IAccessibleText* paccText = NULL;
if (pacc2->QueryInterface(IID_IAccessibleText, (void**)&paccText) != S_OK) {
paccText = NULL;
if (!pacc2) {
return false;
}

bool gotText = false;
CComQIPtr<IAccessibleText> paccText(pacc2);

if (!paccText && recurse && !useNewText) {
//no IAccessibleText interface, so try children instead
long childCount = 0;
if (!useNewText && pacc2->get_accChildCount(&childCount) == S_OK && childCount > 0) {
VARIANT* varChildren = new VARIANT[childCount];
AccessibleChildren(pacc2, 0, childCount, varChildren, &childCount);
for (int i = 0; i < childCount; ++i) {
if (varChildren[i].vt == VT_DISPATCH) {
IAccessible2* pacc2Child = NULL;
if (varChildren[i].pdispVal && varChildren[i].pdispVal->QueryInterface(IID_IAccessible2, (void**)&pacc2Child) == S_OK) {
auto[varChildren, accChildRes] = getAccessibleChildren(pacc2, 0, childCount);
for(auto& child : varChildren){
if (child.vt == VT_DISPATCH && child.pdispVal) {
CComQIPtr<IAccessible2> pacc2Child(child.pdispVal);
if (pacc2Child) {
map<wstring, wstring> childAttribsMap;
fetchIA2Attributes(pacc2Child, childAttribsMap);
auto liveItr = childAttribsMap.find(L"live");
if (liveItr == childAttribsMap.end() || liveItr->second.compare(L"off") != 0) {
if (getTextFromIAccessible(textBuf, pacc2Child)) {
gotText = true;
}
gotText |= getTextFromIAccessible(
textBuf,
pacc2Child,
false, // useNewText
true, // recurse
true // includeTopLevelText
);
}
pacc2Child->Release();
}
}
VariantClear(varChildren + i);
}
delete[] varChildren;
}
}
else if (paccText) {
//We can use IAccessibleText because it exists
BSTR bstrText = NULL;
CComBSTR bstrText;
long startOffset = 0;
//If requested, get the text from IAccessibleText::newText rather than just IAccessibleText::text.
if (useNewText) {
IA2TextSegment newSeg = { 0 };
if (paccText->get_newText(&newSeg) == S_OK && newSeg.text) {
IA2TextSegment newSeg {};
if (S_OK == paccText->get_newText(&newSeg) && newSeg.text) {
bstrText = newSeg.text;
startOffset = newSeg.start;
}
Expand All @@ -78,85 +120,48 @@ bool getTextFromIAccessible(
//If we got text, add it to the string provided, however if there are embedded objects in the text, recurse in to these
if (bstrText) {
long textLength = SysStringLen(bstrText);
IAccessibleHypertext* paccHypertext = NULL;
if (!recurse || pacc2->QueryInterface(IID_IAccessibleHypertext, (void**)&paccHypertext) != S_OK) paccHypertext = NULL;
CComQIPtr<IAccessibleHypertext> paccHypertext;
if (recurse) {
paccHypertext = pacc2;
}
for (long index = 0; index < textLength; ++index) {
wchar_t realChar = bstrText[index];
bool charAdded = false;
if (realChar == L'\xfffc') {
long hyperlinkIndex;
if (paccHypertext && paccHypertext->get_hyperlinkIndex(startOffset + index, &hyperlinkIndex) == S_OK) {
IAccessibleHyperlink* paccHyperlink = NULL;
if (paccHypertext->get_hyperlink(hyperlinkIndex, &paccHyperlink) == S_OK) {
IAccessible2* pacc2Child = NULL;
if (paccHyperlink->QueryInterface(IID_IAccessible2, (void**)&pacc2Child) == S_OK) {
if (realChar == OBJ_REPLACEMENT_CHAR) {
const long charIndex = startOffset + index;
long hyperlinkIndex = 0;
if (paccHypertext && paccHypertext->get_hyperlinkIndex(charIndex, &hyperlinkIndex) == S_OK) {
CComPtr<IAccessibleHyperlink> paccHyperlink;
if (S_OK == paccHypertext->get_hyperlink(hyperlinkIndex, &paccHyperlink)) {
CComQIPtr <IAccessible2> pacc2Child(paccHyperlink);
if (pacc2Child) {
map<wstring, wstring> childAttribsMap;
fetchIA2Attributes(pacc2Child, childAttribsMap);
auto liveItr = childAttribsMap.find(L"live");
if (liveItr == childAttribsMap.end() || liveItr->second.compare(L"off") != 0) {
if (liveItr == childAttribsMap.end() || liveItr->second != L"off") {
if (getTextFromIAccessible(textBuf, pacc2Child)) {
gotText = true;
}
}
charAdded = true;
pacc2Child->Release();
}
paccHyperlink->Release();
}
}
}
if (!charAdded && includeTopLevelText) {
textBuf.append(1, realChar);
charAdded = true;
if (realChar != L'\xfffc' && !iswspace(realChar)) {
if (realChar != OBJ_REPLACEMENT_CHAR && !iswspace(realChar)) {
gotText = true;
}
}
}
if (paccHypertext) paccHypertext->Release();
SysFreeString(bstrText);
textBuf.append(1, L' ');
}
paccText->Release();
}
if (!gotText && !useNewText) {
//We got no text from IAccessibleText interface or children, so try name and/or description
BSTR val = NULL;
bool valEmpty = true;
VARIANT varChild;
varChild.vt = VT_I4;
varChild.lVal = 0;
pacc2->get_accName(varChild, &val);
if (val) {
for (int i = 0; val[i] != L'\0'; ++i) {
if (val[i] != L'\xfffc' && !iswspace(val[i])) {
valEmpty = false;
break;
}
}
if (!valEmpty) {
gotText = true;
textBuf.append(val);
textBuf.append(L" ");
}
SysFreeString(val);
val = NULL;
}
valEmpty = true;
pacc2->get_accDescription(varChild, &val);
if (val) {
for (int i = 0; val[i] != L'\0'; ++i) {
if (val[i] != L'\xfffc' && !iswspace(val[i])) {
valEmpty = false;
break;
}
}
if (!valEmpty) {
gotText = true;
textBuf.append(val);
}
SysFreeString(val);
}
gotText = appendNameDescription(pacc2, textBuf);
}
return gotText;
}