a11y atspi: Clean up logging a bit

Based on the discussion on logging style in the
Gerrit change for commit
5145d3899d338fbb82a2d314c58eb60a4a5205f8
("a11y atspi: Support AT-SPI table cell interface"),
clean up the logging in AtSpiAdaptor a bit:

* convert uses of qCDebug to qCWarning where the
  log message contained "WARNING"/"warning"
  or it seems worth that severity.

* drop extra prefixes of "Qt AtSpiAdaptor:"
  in the log messages, since the logging
  category is already named "qt.accessibility.atspi"
  and only used here

* more consistently start log messages with
  uppercase letter and drop unnecessary extra spaces

The switch to qCWarning implies that these log
messages are output by default.

Change-Id: I1665a8ee8d64e4eab33a3b15906a7cb7357fd73c
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
This commit is contained in:
Michael Weghorn 2022-10-25 18:08:10 +02:00
parent a4f2298d84
commit f408944598

View File

@ -591,7 +591,7 @@ QString AtSpiAdaptor::introspect(const QString &path) const
QAccessibleInterface * interface = interfaceFromPath(path); QAccessibleInterface * interface = interfaceFromPath(path);
if (!interface) { if (!interface) {
qCDebug(lcAccessibilityAtspi) << "WARNING Qt AtSpiAdaptor: Could not find accessible on path: " << path; qCWarning(lcAccessibilityAtspi) << "Could not find accessible on path:" << path;
return QString(); return QString();
} }
@ -702,7 +702,7 @@ void AtSpiAdaptor::setBitFlag(const QString &flag)
|| right.startsWith("VisibledataChanged"_L1)) { // typo in libatspi || right.startsWith("VisibledataChanged"_L1)) { // typo in libatspi
sendObject_visible_data_changed = 1; sendObject_visible_data_changed = 1;
} else { } else {
qCDebug(lcAccessibilityAtspi) << "WARNING: subscription string not handled:" << flag; qCWarning(lcAccessibilityAtspi) << "Subscription string not handled:" << flag;
} }
} }
break; break;
@ -748,7 +748,7 @@ void AtSpiAdaptor::setBitFlag(const QString &flag)
} else if (right.startsWith("DesktopDestroy"_L1)) { } else if (right.startsWith("DesktopDestroy"_L1)) {
// ignore this one // ignore this one
} else { } else {
qCDebug(lcAccessibilityAtspi) << "WARNING: subscription string not handled:" << flag; qCWarning(lcAccessibilityAtspi) << "Subscription string not handled:" << flag;
} }
} }
break; break;
@ -767,7 +767,7 @@ void AtSpiAdaptor::setBitFlag(const QString &flag)
break; break;
} }
default: default:
qCDebug(lcAccessibilityAtspi) << "WARNING: subscription string not handled:" << flag; qCWarning(lcAccessibilityAtspi) << "Subscription string not handled:" << flag;
} }
} }
@ -965,7 +965,7 @@ void AtSpiAdaptor::notify(QAccessibleEvent *event)
if (sendObject || sendObject_text_changed) { if (sendObject || sendObject_text_changed) {
QAccessibleInterface * iface = event->accessibleInterface(); QAccessibleInterface * iface = event->accessibleInterface();
if (!iface || !iface->textInterface()) { if (!iface || !iface->textInterface()) {
qCDebug(lcAccessibilityAtspi) << "Received text event for invalid interface."; qCWarning(lcAccessibilityAtspi) << "Received text event for invalid interface.";
return; return;
} }
QString path = pathForInterface(iface); QString path = pathForInterface(iface);
@ -1358,11 +1358,11 @@ bool AtSpiAdaptor::handleMessage(const QDBusMessage &message, const QDBusConnect
// get accessible interface // get accessible interface
QAccessibleInterface * accessible = interfaceFromPath(message.path()); QAccessibleInterface * accessible = interfaceFromPath(message.path());
if (!accessible) { if (!accessible) {
qCDebug(lcAccessibilityAtspi) << "WARNING Qt AtSpiAdaptor: Could not find accessible on path: " << message.path(); qCWarning(lcAccessibilityAtspi) << "Could not find accessible on path:" << message.path();
return false; return false;
} }
if (!accessible->isValid()) { if (!accessible->isValid()) {
qCWarning(lcAccessibilityAtspi) << "WARNING Qt AtSpiAdaptor: Accessible invalid: " << accessible << message.path(); qCWarning(lcAccessibilityAtspi) << "Accessible invalid:" << accessible << message.path();
return false; return false;
} }
@ -1411,7 +1411,7 @@ bool AtSpiAdaptor::handleMessage(const QDBusMessage &message, const QDBusConnect
bool AtSpiAdaptor::applicationInterface(QAccessibleInterface *interface, const QString &function, const QDBusMessage &message, const QDBusConnection &connection) bool AtSpiAdaptor::applicationInterface(QAccessibleInterface *interface, const QString &function, const QDBusMessage &message, const QDBusConnection &connection)
{ {
if (message.path() != ATSPI_DBUS_PATH_ROOT ""_L1) { if (message.path() != ATSPI_DBUS_PATH_ROOT ""_L1) {
qCDebug(lcAccessibilityAtspi) << "WARNING Qt AtSpiAdaptor: Could not find application interface for: " << message.path() << interface; qCWarning(lcAccessibilityAtspi) << "Could not find application interface for:" << message.path() << interface;
return false; return false;
} }
@ -1463,7 +1463,7 @@ void AtSpiAdaptor::registerApplication()
const QSpiObjectReference &socket = reply.value(); const QSpiObjectReference &socket = reply.value();
accessibilityRegistry = QSpiObjectReference(socket); accessibilityRegistry = QSpiObjectReference(socket);
} else { } else {
qCDebug(lcAccessibilityAtspi) << "Error in contacting registry: " qCWarning(lcAccessibilityAtspi) << "Error in contacting registry:"
<< reply.error().name() << reply.error().name()
<< reply.error().message(); << reply.error().message();
} }
@ -1580,7 +1580,7 @@ bool AtSpiAdaptor::accessibleInterface(QAccessibleInterface *interface, const QS
sendReply(connection, message, sendReply(connection, message,
QVariant::fromValue(QDBusVariant(accessibleIdForAccessible(interface)))); QVariant::fromValue(QDBusVariant(accessibleIdForAccessible(interface))));
} else { } else {
qCDebug(lcAccessibilityAtspi) << "WARNING: AtSpiAdaptor::accessibleInterface does not implement " << function << message.path(); qCWarning(lcAccessibilityAtspi) << "AtSpiAdaptor::accessibleInterface does not implement" << function << message.path();
return false; return false;
} }
return true; return true;
@ -1667,7 +1667,7 @@ QString AtSpiAdaptor::pathForObject(QObject *object) const
Q_ASSERT(object); Q_ASSERT(object);
if (inheritsQAction(object)) { if (inheritsQAction(object)) {
qCDebug(lcAccessibilityAtspi) << "AtSpiAdaptor::pathForObject: warning: creating path with QAction as object."; qCWarning(lcAccessibilityAtspi) << "AtSpiAdaptor::pathForObject: Creating path with QAction as object.";
} }
QAccessibleInterface *iface = QAccessible::queryAccessibleInterface(object); QAccessibleInterface *iface = QAccessible::queryAccessibleInterface(object);
@ -1796,7 +1796,7 @@ bool AtSpiAdaptor::componentInterface(QAccessibleInterface *interface, const QSt
qCDebug(lcAccessibilityAtspi) << "SetSize is not implemented."; qCDebug(lcAccessibilityAtspi) << "SetSize is not implemented.";
sendReply(connection, message, false); sendReply(connection, message, false);
} else { } else {
qCDebug(lcAccessibilityAtspi) << "WARNING: AtSpiAdaptor::componentInterface does not implement " << function << message.path(); qCWarning(lcAccessibilityAtspi) << "AtSpiAdaptor::componentInterface does not implement" << function << message.path();
return false; return false;
} }
return true; return true;
@ -1858,7 +1858,7 @@ bool AtSpiAdaptor::actionInterface(QAccessibleInterface *interface, const QStrin
else else
sendReply(connection, message, QString()); sendReply(connection, message, QString());
} else { } else {
qCDebug(lcAccessibilityAtspi) << "WARNING: AtSpiAdaptor::actionInterface does not implement " << function << message.path(); qCWarning(lcAccessibilityAtspi) << "AtSpiAdaptor::actionInterface does not implement" << function << message.path();
return false; return false;
} }
return true; return true;
@ -2038,7 +2038,7 @@ bool AtSpiAdaptor::textInterface(QAccessibleInterface *interface, const QString
interface->textInterface()->setSelection(selectionNum, startOffset, endOffset); interface->textInterface()->setSelection(selectionNum, startOffset, endOffset);
sendReply(connection, message, true); sendReply(connection, message, true);
} else { } else {
qCDebug(lcAccessibilityAtspi) << "WARNING: AtSpiAdaptor::textInterface does not implement " << function << message.path(); qCWarning(lcAccessibilityAtspi) << "AtSpiAdaptor::textInterface does not implement" << function << message.path();
return false; return false;
} }
return true; return true;
@ -2278,7 +2278,7 @@ bool AtSpiAdaptor::isValidCoordType(uint coordType)
if (coordType == ATSPI_COORD_TYPE_SCREEN || coordType == ATSPI_COORD_TYPE_WINDOW || coordType == ATSPI_COORD_TYPE_PARENT) if (coordType == ATSPI_COORD_TYPE_SCREEN || coordType == ATSPI_COORD_TYPE_WINDOW || coordType == ATSPI_COORD_TYPE_PARENT)
return true; return true;
qCWarning(lcAccessibilityAtspi) << "unknown value" << coordType << "for AT-SPI coord type"; qCWarning(lcAccessibilityAtspi) << "Unknown value" << coordType << "for AT-SPI coord type";
return false; return false;
} }
@ -2402,7 +2402,7 @@ bool AtSpiAdaptor::editableTextInterface(QAccessibleInterface *interface, const
} else if (function.isEmpty()) { } else if (function.isEmpty()) {
connection.send(message.createReply()); connection.send(message.createReply());
} else { } else {
qCDebug(lcAccessibilityAtspi) << "WARNING: AtSpiAdaptor::editableTextInterface does not implement " << function << message.path(); qCWarning(lcAccessibilityAtspi) << "AtSpiAdaptor::editableTextInterface does not implement" << function << message.path();
return false; return false;
} }
return true; return true;
@ -2433,11 +2433,11 @@ bool AtSpiAdaptor::valueInterface(QAccessibleInterface *interface, const QString
else if (function == "GetMinimumValue"_L1) else if (function == "GetMinimumValue"_L1)
value = valueIface->minimumValue(); value = valueIface->minimumValue();
else { else {
qCDebug(lcAccessibilityAtspi) << "WARNING: AtSpiAdaptor::valueInterface does not implement " << function << message.path(); qCWarning(lcAccessibilityAtspi) << "AtSpiAdaptor::valueInterface does not implement" << function << message.path();
return false; return false;
} }
if (!value.canConvert<double>()) { if (!value.canConvert<double>()) {
qCDebug(lcAccessibilityAtspi) << "AtSpiAdaptor::valueInterface: Could not convert to double: " << function; qCWarning(lcAccessibilityAtspi) << "AtSpiAdaptor::valueInterface: Could not convert to double:" << function;
} }
// explicitly convert to dbus-variant containing one double since atspi expects that // explicitly convert to dbus-variant containing one double since atspi expects that
@ -2452,7 +2452,7 @@ bool AtSpiAdaptor::valueInterface(QAccessibleInterface *interface, const QString
bool AtSpiAdaptor::tableInterface(QAccessibleInterface *interface, const QString &function, const QDBusMessage &message, const QDBusConnection &connection) bool AtSpiAdaptor::tableInterface(QAccessibleInterface *interface, const QString &function, const QDBusMessage &message, const QDBusConnection &connection)
{ {
if (!(interface->tableInterface() || interface->tableCellInterface())) { if (!(interface->tableInterface() || interface->tableCellInterface())) {
qCDebug(lcAccessibilityAtspi) << "WARNING Qt AtSpiAdaptor: Could not find table interface for: " << message.path() << interface; qCWarning(lcAccessibilityAtspi) << "Qt AtSpiAdaptor: Could not find table interface for:" << message.path() << interface;
return false; return false;
} }
@ -2488,7 +2488,7 @@ bool AtSpiAdaptor::tableInterface(QAccessibleInterface *interface, const QString
(column < 0) || (column < 0) ||
(row >= interface->tableInterface()->rowCount()) || (row >= interface->tableInterface()->rowCount()) ||
(column >= interface->tableInterface()->columnCount())) { (column >= interface->tableInterface()->columnCount())) {
qCDebug(lcAccessibilityAtspi) << "WARNING: invalid index for tableInterface GetAccessibleAt (" << row << ", " << column << ')'; qCWarning(lcAccessibilityAtspi) << "Invalid index for tableInterface GetAccessibleAt (" << row << "," << column << ')';
return false; return false;
} }
@ -2497,7 +2497,7 @@ bool AtSpiAdaptor::tableInterface(QAccessibleInterface *interface, const QString
if (cell) { if (cell) {
ref = QSpiObjectReference(connection, QDBusObjectPath(pathForInterface(cell))); ref = QSpiObjectReference(connection, QDBusObjectPath(pathForInterface(cell)));
} else { } else {
qCDebug(lcAccessibilityAtspi) << "WARNING: no cell interface returned for " << interface->object() << row << column; qCWarning(lcAccessibilityAtspi) << "No cell interface returned for" << interface->object() << row << column;
ref = QSpiObjectReference(); ref = QSpiObjectReference();
} }
connection.send(message.createReply(QVariant::fromValue(ref))); connection.send(message.createReply(QVariant::fromValue(ref)));
@ -2507,7 +2507,7 @@ bool AtSpiAdaptor::tableInterface(QAccessibleInterface *interface, const QString
int column = message.arguments().at(1).toInt(); int column = message.arguments().at(1).toInt();
QAccessibleInterface *cell = interface->tableInterface()->cellAt(row, column); QAccessibleInterface *cell = interface->tableInterface()->cellAt(row, column);
if (!cell) { if (!cell) {
qCDebug(lcAccessibilityAtspi) << "WARNING: AtSpiAdaptor::GetIndexAt(" << row << ',' << column << ") did not find a cell. " << interface; qCWarning(lcAccessibilityAtspi) << "AtSpiAdaptor::GetIndexAt(" << row << ',' << column << ") did not find a cell." << interface;
return false; return false;
} }
int index = interface->indexOfChild(cell); int index = interface->indexOfChild(cell);
@ -2527,7 +2527,7 @@ bool AtSpiAdaptor::tableInterface(QAccessibleInterface *interface, const QString
ret = -1; ret = -1;
} else { } else {
if (!cell->tableCellInterface()) { if (!cell->tableCellInterface()) {
qCDebug(lcAccessibilityAtspi) << "WARNING: AtSpiAdaptor::" << function << " No table cell interface: " << cell; qCWarning(lcAccessibilityAtspi).nospace() << "AtSpiAdaptor::" << function << " No table cell interface: " << cell;
return false; return false;
} }
ret = cell->tableCellInterface()->columnIndex(); ret = cell->tableCellInterface()->columnIndex();
@ -2539,14 +2539,14 @@ bool AtSpiAdaptor::tableInterface(QAccessibleInterface *interface, const QString
ret = index % interface->tableInterface()->columnCount(); ret = index % interface->tableInterface()->columnCount();
} else { } else {
if (!cell->tableCellInterface()) { if (!cell->tableCellInterface()) {
qCDebug(lcAccessibilityAtspi) << "WARNING: AtSpiAdaptor::" << function << " No table cell interface: " << cell; qCWarning(lcAccessibilityAtspi).nospace() << "AtSpiAdaptor::" << function << " No table cell interface: " << cell;
return false; return false;
} }
ret = cell->tableCellInterface()->rowIndex(); ret = cell->tableCellInterface()->rowIndex();
} }
} }
} else { } else {
qCDebug(lcAccessibilityAtspi) << "WARNING: AtSpiAdaptor::" << function << " No cell at index: " << index << interface; qCWarning(lcAccessibilityAtspi).nospace() << "AtSpiAdaptor::" << function << " No cell at index: " << index << " " << interface;
return false; return false;
} }
} }
@ -2652,7 +2652,7 @@ bool AtSpiAdaptor::tableInterface(QAccessibleInterface *interface, const QString
int row = message.arguments().at(0).toInt(); int row = message.arguments().at(0).toInt();
connection.send(message.createReply(interface->tableInterface()->unselectRow(row))); connection.send(message.createReply(interface->tableInterface()->unselectRow(row)));
} else { } else {
qCDebug(lcAccessibilityAtspi) << "WARNING: AtSpiAdaptor::tableInterface does not implement " << function << message.path(); qCWarning(lcAccessibilityAtspi) << "AtSpiAdaptor::tableInterface does not implement" << function << message.path();
return false; return false;
} }
return true; return true;