Merge lp:~veebers/autopilot-qt/non-visual-components-take2 into lp:autopilot-qt

[Christopher Lee]

Re-introduce non-visual introspection of components.

Re-introduce code to introspect non-visual components, the tests and some optimisations too that make it all possible.

Unmerged revisions

83. By Christopher Lee on 2014-04-04

Re-introduce backed out non-visual code, optimisations and tests.

=== modified file 'driver/dbus_object.cpp'
--- driver/dbus_object.cpp	2014-03-12 13:26:27 +0000
+++ driver/dbus_object.cpp	2014-04-04 01:00:19 +0000
@@ -303,4 +303,3 @@
 
     QDBusConnection::sessionBus().send(msg);
 }
-

=== modified file 'driver/introspection.cpp'
--- driver/introspection.cpp	2014-03-12 13:26:27 +0000
+++ driver/introspection.cpp	2014-04-04 01:00:19 +0000
@@ -46,7 +46,8 @@
 QVariant IntrospectNode(QObject* obj);
 QString GetNodeName(QObject* obj);
 QStringList GetNodeChildNames(QObject* obj);
-void AddCustomProperties(QObject* obj, QVariantMap& properties);
+QVariant GetGlobalRect(QObject* obj);
+QVariant GetChildrenNames(QObject* obj);
 
 QList<NodeIntrospectionData> Introspect(QString const& query_string)
 {
@@ -58,7 +59,6 @@
     }
 
     return state;
-
 }
 
 
@@ -128,7 +128,7 @@
             QMetaProperty prop = meta->property(i);
             if (!prop.isValid())
             {
-                qDebug() << "Property at index" << i << "Is not valid!";
+                qDebug() << "Property at index" << i << "is not valid!";
                 continue;
             }
             QVariant object_property = PackProperty(prop.read(obj));
@@ -150,18 +150,59 @@
         meta = meta->superClass();
     } while(meta);
 
-    AddCustomProperties(obj, object_properties);
+    QVariant global_rect_property = GetNodeProperty(obj, "globalRect");
+    if(global_rect_property.isValid())
+        object_properties["globalRect"] = global_rect_property;
 
     // add the 'Children' pseudo-property:
+    QVariant children_property = GetNodeProperty(obj, "Children");
+    if(children_property.isValid())
+        object_properties["Children"] = children_property;
+
+    return object_properties;
+}
+
+QVariant GetNodeProperty(QObject* obj, const std::string& property_name)
+{
+    if(property_name == "globalRect")
+        return GetGlobalRect(obj);
+
+    if(property_name == "Children")
+        return GetChildrenNames(obj);
+
+    QVariant dynamic_property = obj->property(property_name.c_str());
+    if (dynamic_property.isValid())
+    {
+        return PackProperty(dynamic_property);
+    }
+    else
+    {
+        const QMetaObject* meta = obj->metaObject();
+        int property_index = meta->indexOfProperty(property_name.c_str());
+        if(property_index != -1)
+        {
+            QMetaProperty prop = meta->property(property_index);
+            if(prop.isValid())
+                return PackProperty(prop.read(obj));
+            else
+                qDebug() << "Property " << QString::fromStdString(property_name)
+                         << " is not valid.";
+        }
+    }
+
+    return QVariant();
+}
+
+QVariant GetChildrenNames(QObject* obj)
+{
     QStringList children = GetNodeChildNames(obj);
     if (!children.empty())
-        object_properties["Children"] = PackProperty(children);
-
-    return object_properties;
+        return PackProperty(children);
+    else
+        return QVariant();
 }
 
-
-void AddCustomProperties(QObject* obj, QVariantMap &properties)
+QVariant GetGlobalRect(QObject* obj)
 {
     // Add any custom properties we need to the given QObject.
     // Add GlobalRect support for QWidget-derived classes
@@ -170,7 +211,7 @@
     {
         QRect r = w->rect();
         r = QRect(w->mapToGlobal(r.topLeft()), r.size());
-        properties["globalRect"] = PackProperty(r);
+        return PackProperty(r);
     }
     // ...and support for QGraphicsItem-derived classes.
     else if (QGraphicsItem *i = qobject_cast<QGraphicsItem*>(obj))
@@ -184,19 +225,28 @@
         QRect global_rect = QRect(
                     view->mapToGlobal(scene_rect.topLeft()),
                     scene_rect.size());
-        properties["globalRect"] = PackProperty(global_rect);
+        return PackProperty(global_rect);
     }
 #ifdef QT5_SUPPORT
     // ... and support for QQuickItems (aka. Qt5 Declarative items)
     else if (QQuickItem *i = qobject_cast<QQuickItem*>(obj))
     {
         QQuickWindow *view = i->window();
-        QRectF bounding_rect = i->boundingRect();
-        bounding_rect = i->mapRectToScene(bounding_rect);
-        QRect global_rect = QRect(view->mapToGlobal(bounding_rect.toRect().topLeft()), bounding_rect.size().toSize());
-        properties["globalRect"] = PackProperty(global_rect);
+        if(view)
+        {
+            QRectF bounding_rect = i->boundingRect();
+            bounding_rect = i->mapRectToScene(bounding_rect);
+            QRect global_rect = QRect(
+                view->mapToGlobal(bounding_rect.toRect().topLeft()), bounding_rect.size().toSize()
+                );
+
+            return PackProperty(global_rect);
+        }
     }
 #endif
+
+    // Default to returning invalid QVariant
+    return QVariant();
 }
 
 QVariant PackProperty(QVariant const& prop)

=== modified file 'driver/introspection.h'
--- driver/introspection.h	2014-03-12 13:26:27 +0000
+++ driver/introspection.h	2014-04-04 01:00:19 +0000
@@ -26,5 +26,10 @@
 /// given QObject.
 QVariantMap GetNodeProperties(QObject* obj);
 
+/// Return a QVariant containing the requested property
+/// "property_name" or an invalid QVariant if the property is not
+/// found.
+QVariant GetNodeProperty(QObject* obj, const std::string& property_name);
+
 
 #endif

=== modified file 'driver/qtnode.cpp'
--- driver/qtnode.cpp	2014-03-12 13:26:27 +0000
+++ driver/qtnode.cpp	2014-04-04 01:00:19 +0000
@@ -18,22 +18,22 @@
 #include <QDBusArgument>
 
 // Marshall the NodeIntrospectionData data into a D-Bus argument
- QDBusArgument &operator<<(QDBusArgument &argument, const NodeIntrospectionData &node_data)
- {
-     argument.beginStructure();
-     argument << node_data.object_path << node_data.state;
-     argument.endStructure();
-     return argument;
- }
+QDBusArgument &operator<<(QDBusArgument &argument, const NodeIntrospectionData &node_data)
+{
+    argument.beginStructure();
+    argument << node_data.object_path << node_data.state;
+    argument.endStructure();
+    return argument;
+}
 
- // Retrieve the NodeIntrospectionData data from the D-Bus argument
- const QDBusArgument &operator>>(const QDBusArgument &argument, NodeIntrospectionData &node_data)
- {
-     argument.beginStructure();
-     argument >> node_data.object_path >> node_data.state;
-     argument.endStructure();
-     return argument;
- }
+// Retrieve the NodeIntrospectionData data from the D-Bus argument
+const QDBusArgument &operator>>(const QDBusArgument &argument, NodeIntrospectionData &node_data)
+{
+    argument.beginStructure();
+    argument >> node_data.object_path >> node_data.state;
+    argument.endStructure();
+    return argument;
+}
 
 const QByteArray AP_ID_NAME("_autopilot_id");
 
@@ -41,6 +41,7 @@
 : object_(obj)
 , parent_(parent)
 {
+    SetName(obj);
     std::string parent_path = parent ? parent->GetPath() : "";
     full_path_ = parent_path + "/" + GetName();
 }
@@ -48,6 +49,7 @@
 QtNode::QtNode(QObject* obj)
 : object_(obj)
 {
+    SetName(obj);
     full_path_ = "/" + GetName();
 }
 
@@ -65,15 +67,18 @@
     return data;
 }
 
-std::string QtNode::GetName() const
+void QtNode::SetName(const QObject* object)
 {
-    QString name = object_->metaObject()->className();
-
+    QString name = object->metaObject()->className();
     // QML type names get mangled by Qt - they get _QML_N or _QMLTYPE_N appended.
-    //
     if (name.contains('_'))
         name = name.split('_').front();
-    return name.toStdString();
+    node_name_ = name.toStdString();
+}
+
+std::string QtNode::GetName() const
+{
+    return node_name_;
 }
 
 std::string QtNode::GetPath() const
@@ -99,13 +104,13 @@
 
 bool QtNode::MatchStringProperty(const std::string& name, const std::string& value) const
 {
-    QVariantMap properties = GetNodeProperties(object_);
+    QVariant property = GetNodeProperty(object_, name);
 
-    QString qname = QString::fromStdString(name);
-    if (! properties.contains(qname))
+    if(!property.isValid())
         return false;
 
-    QVariant object_value = qvariant_cast<QVariantList>(properties[qname]).at(1);
+    // Need the value not the object type id
+    QVariant object_value = qvariant_cast<QVariantList>(property).at(1);
     QVariant check_value(QString::fromStdString(value));
     if (check_value.canConvert(object_value.type()))
     {
@@ -121,13 +126,13 @@
     if (name == "id")
         return value == GetId();
 
-    QVariantMap properties = GetNodeProperties(object_);
+    QVariant property = GetNodeProperty(object_, name);
 
-    QString qname = QString::fromStdString(name);
-    if (! properties.contains(qname))
+    if(!property.isValid())
         return false;
 
-    QVariant object_value = qvariant_cast<QVariantList>(properties[qname]).at(1);
+    // Need the value not the object type id
+    QVariant object_value = qvariant_cast<QVariantList>(property).at(1);
     QVariant check_value(value);
     if (check_value.canConvert(object_value.type()))
     {
@@ -140,13 +145,13 @@
 
 bool QtNode::MatchBooleanProperty(const std::string& name, bool value) const
 {
-    QVariantMap properties = GetNodeProperties(object_);
+    QVariant property = GetNodeProperty(object_, name);
 
-    QString qname = QString::fromStdString(name);
-    if (! properties.contains(qname))
+    if(!property.isValid())
         return false;
 
-    QVariant object_value = qvariant_cast<QVariantList>(properties[qname]).at(1);
+    // Need the value not the object type id
+    QVariant object_value = qvariant_cast<QVariantList>(property).at(1);
     QVariant check_value(value);
 
     if (check_value.canConvert(object_value.type()))

=== modified file 'driver/qtnode.h'
--- driver/qtnode.h	2014-03-12 13:26:27 +0000
+++ driver/qtnode.h	2014-04-04 01:00:19 +0000
@@ -37,7 +37,6 @@
 
     virtual NodeIntrospectionData GetIntrospectionData() const;
 
-
     virtual std::string GetName() const;
     virtual std::string GetPath() const;
     virtual int32_t GetId() const;
@@ -46,8 +45,11 @@
     virtual bool MatchBooleanProperty(const std::string& name, bool value) const;
     virtual xpathselect::NodeVector Children() const;
 private:
+    void SetName(const QObject* object);
+
     QObject *object_;
     std::string full_path_;
+    std::string node_name_;
     Ptr parent_;
 };
 

=== modified file 'driver/qttestability.cpp'
--- driver/qttestability.cpp	2014-02-21 00:41:07 +0000
+++ driver/qttestability.cpp	2014-04-04 01:00:19 +0000
@@ -23,7 +23,7 @@
     qDebug().nospace()
         << "Testability driver loaded. Wire protocol version is "
         << AutopilotAdaptor::WIRE_PROTO_VERSION
-        << ".";
+        << ".(non-visual)";
     qDBusRegisterMetaType<NodeIntrospectionData>();
     qDBusRegisterMetaType<QList<NodeIntrospectionData> >();
 

=== modified file 'tests/unittests/tst_introspection.cpp'
--- tests/unittests/tst_introspection.cpp	2014-03-12 13:26:27 +0000
+++ tests/unittests/tst_introspection.cpp	2014-04-04 01:00:19 +0000
@@ -49,6 +49,8 @@
 
     void test_property_matching();
 
+    void test_get_node_property();
+
 private:
     QMainWindow *m_object;
 };
@@ -511,6 +513,31 @@
     QVERIFY(n.MatchBooleanProperty("visible", true) == true);
 }
 
+void tst_Introspection::test_get_node_property()
+{
+    QVariant property;
+    QVariant unpacked_property;
+
+    property = GetNodeProperty(m_object, "dynamicTestProperty");
+    unpacked_property = qvariant_cast<QVariantList>(property).at(1);
+    QVERIFY(property.isValid() == true);
+    QVERIFY(unpacked_property.isValid() == true);
+    QVERIFY(unpacked_property.toString() == "testValue");
+
+    property = GetNodeProperty(m_object, "myUInt");
+    unpacked_property = qvariant_cast<QVariantList>(property).at(1);
+    QVERIFY(property.isValid() == true);
+    QVERIFY(unpacked_property.isValid() == true);
+    QVERIFY(unpacked_property.toFloat() == 5);
+
+    // Meta Property
+    property = GetNodeProperty(m_object, "fullScreen");
+    unpacked_property = qvariant_cast<QVariantList>(property).at(1);
+    QVERIFY(property.isValid() == true);
+    QVERIFY(unpacked_property.isValid() == true);
+    QVERIFY(unpacked_property.toBool() == false);
+}
+
 QTEST_MAIN(tst_Introspection)
 
 #include "tst_introspection.moc"