refactored view xml serialization

Author: Vasyl Vavrychuk

inc/extension_qt/qml_view_executor.h

@@ -102,7 +102,7 @@ class QQmlViewCmdExecutor : public QViewCmdExecutor {
     virtual void GetMute(const ElementId& element, bool*, Error**error) NOT_SUPPORTED_IMPL;
     virtual void SetPlaybackSpeed(const ElementId& element, double, Error**error) NOT_SUPPORTED_IMPL;;
     virtual void GetPlaybackSpeed(const ElementId& element, double*, Error**error) NOT_SUPPORTED_IMPL;;
-    virtual void VisualizerSource(std::string* source, Error** error) NOT_SUPPORTED_IMPL;
+    virtual void VisualizerSource(std::string* source, Error** error);
     virtual void VisualizerShowPoint(Error** error) NOT_SUPPORTED_IMPL;
     virtual void TouchPinchZoom(const ElementId &element, const double &scale, Error** error) NOT_SUPPORTED_IMPL;
     virtual void TouchPinchRotate(const ElementId &element, const int &angle, Error** error) NOT_SUPPORTED_IMPL;
@@ -112,13 +112,10 @@ class QQmlViewCmdExecutor : public QViewCmdExecutor {
 
 protected:
     QDeclarativeView* getView(const ViewId& viewId, Error** error);
-    typedef QHash<QString, QDeclarativeItem*> XMLElementMap;    
 
     QDeclarativeItem* getElement(const ElementId &element, Error** error);
     bool FilterElement(const QDeclarativeItem* item, const std::string& locator, const std::string& query);
     void FindElementsByXpath(QDeclarativeItem* parent, const std::string &query, std::vector<ElementId>* elements, Error **error);
-    void createUIXML(QDeclarativeItem *parent, QIODevice* buff, XMLElementMap& elementsMap, Error** error);
-    void addItemToXML(QDeclarativeItem* parent, XMLElementMap& elementsMap, QXmlStreamWriter* writer);
 
 private:
     DISALLOW_COPY_AND_ASSIGN(QQmlViewCmdExecutor);

inc/extension_qt/widget_view_executor.h

@@ -3,60 +3,8 @@
 
 #include "extension_qt/q_view_executor.h"
 
-#include <QtCore/QDebug>
-#if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
-#include <QtCore/QXmlStreamWriter>
-#else
-#include <QtXml/QXmlStreamWriter>
-#endif
-
 namespace webdriver {
 
-class QWidgetXmlSerializer {
-public:
-    typedef QHash<QString, QWidget*> XMLElementMap;
-
-    QWidgetXmlSerializer(QIODevice* buff);
-
-    void createXml(QWidget* widget);
-
-    const XMLElementMap& getElementsMap() {
-        return elementsMap_;
-    }
-
-    void setSession(Session* session) {
-        session_ = session;
-    }
-
-    void setViewId(ViewId viewId) {
-        viewId_ = viewId;
-    }
-
-    void setDumpAll(bool dumpAll) {
-        dumpAll_ = dumpAll;
-    }
-
-    void setSupportedClasses(const QStringList& classes) {
-        supportedClasses_ = classes;
-    }
-
-    void setStylesheet(const QString& stylesheet) {
-        stylesheet_ = stylesheet;
-    }
-
-private:
-    void addWidget(QWidget* widget);
-    QString getElementName(const QObject* object) const;
-
-    QXmlStreamWriter writer_;
-    XMLElementMap elementsMap_;
-    Session* session_;
-    ViewId viewId_;
-    bool dumpAll_;
-    QStringList supportedClasses_;
-    QString stylesheet_;
-};
-
 class QWidgetViewCmdExecutorCreator : public ViewCmdExecutorCreator  {
 public:
     static const ViewType WIDGET_VIEW_TYPE;
@@ -158,8 +106,6 @@ class QWidgetViewCmdExecutor : public QViewCmdExecutor {
     virtual void IsOnline(bool*, Error** error) NOT_SUPPORTED_IMPL;
 
 protected:
-    typedef QHash<QString, QWidget*> XMLElementMap;    
-
     QWidget* getElement(const ElementId &element, Error** error);
     bool MatchNativeWidget(const QWidget* widget, const std::string& locator, const std::string& query);
     void FindNativeElementsByXpath(QWidget* parent, const std::string &query, std::vector<ElementId>* elements, Error **error);

src/webdriver/extension_qt/common_util.h

@@ -3,17 +3,23 @@
 
 #include <string>
 
+#include <QtCore/QHash>
 #include <QtCore/QtGlobal>
 #include <QtCore/QRect>
 #include <QtCore/QPoint>
 //#include <QtGui/QMouseEvent>
+#if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
+#include <QtCore/QXmlStreamWriter>
+#else
+#include <QtXml/QXmlStreamWriter>
+#endif
 
 #include "webdriver_basic_types.h"
 
 
 namespace webdriver {
 
-class Session;	
+class Session;
 class ViewId;
 
 class QCommonUtil {
@@ -24,10 +30,56 @@ class QCommonUtil {
     static Qt::MouseButton ConvertMouseButtonToQtMouseButton(MouseButton button);
 
 private:
-	QCommonUtil() {};
-    ~QCommonUtil(){}
+    QCommonUtil() {}
+    ~QCommonUtil() {}
 };
 
+template <class Widget>
+class QViewXmlSerializer {
+public:
+    typedef QHash<QString, Widget*> XMLElementMap;
+
+    QViewXmlSerializer(QIODevice* buff)
+        : session_(NULL), dumpAll_(false)
+    {
+        writer_.setDevice(buff);
+        writer_.setAutoFormatting(true);
+    }
+
+    void createXml(Widget* widget) {
+        writer_.writeStartDocument();
+        if (!stylesheet_.isEmpty()) {
+            writer_.writeProcessingInstruction("xml-stylesheet", "href=\"" + stylesheet_ + "\"");
+        }
+        addWidget(widget);
+        writer_.writeEndDocument();
+    }
+
+    const XMLElementMap& getElementsMap() {
+        return elementsMap_;
+    }
+
+    void setDumpAll(bool dumpAll) {
+        dumpAll_ = dumpAll;
+    }
+
+    void setSession(Session* session) {
+        session_ = session;
+    }
+
+    void setStylesheet(const QString& stylesheet) {
+        stylesheet_ = stylesheet;
+    }
+
+protected:
+    virtual void addWidget(Widget* widget) = 0;
+
+    QXmlStreamWriter writer_;
+    XMLElementMap elementsMap_;
+    Session* session_;
+    bool dumpAll_;
+    QString stylesheet_;
+};
 
 }  // namespace webdriver
 

src/webdriver/extension_qt/qml_view_executor.cc

@@ -7,7 +7,6 @@
 #include "value_conversion_util.h"
 #include "webdriver_session.h"
 #include "webdriver_view_factory.h"
-#include "webdriver_util.h"
 #include "common_util.h"
 #include "q_key_converter.h"
 #include "extension_qt/widget_element_handle.h"
@@ -26,15 +25,6 @@
 
 namespace webdriver {
 
-#if 1 
-#define REMOVE_INTERNAL_SUFIXES(qstr)   \
-        qstr.remove(QRegExp(QLatin1String("_QMLTYPE_\\d+"))); \
-        qstr.remove(QRegExp(QLatin1String("_QML_\\d+"))); \
-        if (qstr.startsWith(QLatin1String("QDeclarative"))) qstr = qstr.mid(12);
-#else
-#define REMOVE_INTERNAL_SUFIXES(qstr)
-#endif            
-
 const ViewType QQmlViewCmdExecutorCreator::QML_VIEW_TYPE = 0x13f6;    
 
 QQmlViewCmdExecutorCreator::QQmlViewCmdExecutorCreator()
@@ -118,16 +108,12 @@ void QQmlViewCmdExecutor::GetSource(std::string* source, Error** error) {
         return;
     }
 
-    XMLElementMap elementsMap;
     QByteArray byteArray;
     QBuffer buff(&byteArray);
     buff.open(QIODevice::ReadWrite);
 
-    createUIXML(parentItem, &buff, elementsMap, error);
-
-    if (*error)
-        return;
-
+    QQmlXmlSerializer serializer(&buff);
+    serializer.createXml(parentItem);
     *source = byteArray.data();
 }
 
@@ -589,7 +575,7 @@ void QQmlViewCmdExecutor::GetElementTagName(const ElementId& element, std::strin
         return;
 
     QString className(pItem->metaObject()->className());
-    REMOVE_INTERNAL_SUFIXES(className);
+    QQmlViewUtil::removeInternalSuffixes(className);
 
     *tag_name = className.toStdString();
 }
@@ -787,9 +773,16 @@ void QQmlViewCmdExecutor::ExecuteScript(const std::string& script, const base::L
     *value = static_cast<Value*>(ret_value.release());
 }
 
+void QQmlViewCmdExecutor::VisualizerSource(std::string* source, Error** error)
+{
+    GetSource(source, error);
+    session_->logger().Log(kInfoLogLevel, "VisualizerSource:");
+    session_->logger().Log(kInfoLogLevel, *source);
+}
+
 bool QQmlViewCmdExecutor::FilterElement(const QDeclarativeItem* item, const std::string& locator, const std::string& query) {
     QString className(item->metaObject()->className());
-    REMOVE_INTERNAL_SUFIXES(className);
+    QQmlViewUtil::removeInternalSuffixes(className);
 
     if (locator == LocatorType::kClassName) {
         if (query == className.toStdString())
@@ -814,12 +807,10 @@ bool QQmlViewCmdExecutor::FilterElement(const QDeclarativeItem* item, const std:
 void QQmlViewCmdExecutor::FindElementsByXpath(QDeclarativeItem* parent, const std::string &query, std::vector<ElementId>* elements, Error **error) {
     QByteArray byteArray;
     QBuffer buff(&byteArray);
-
     buff.open(QIODevice::ReadWrite);
-    XMLElementMap elementsMap;
-    createUIXML(parent, &buff, elementsMap, error);
-    if (*error)
-        return;
+
+    QQmlXmlSerializer serializer(&buff);
+    serializer.createXml(parent);
 
     buff.seek(0);
 
@@ -846,6 +837,7 @@ void QQmlViewCmdExecutor::FindElementsByXpath(QDeclarativeItem* parent, const st
                 QString elemId(node.node().attribute("elementId").value());
 
                 if (!elemId.isEmpty()) {
+                    const QQmlXmlSerializer::XMLElementMap& elementsMap = serializer.getElementsMap();
                     if (elementsMap.contains(elemId)) {
                         ElementId elm;
                         session_->AddElement(view_id_, new QElementHandle(elementsMap[elemId]), &elm);
@@ -877,48 +869,4 @@ void QQmlViewCmdExecutor::FindElementsByXpath(QDeclarativeItem* parent, const st
     buff.close();
 }
 
-void QQmlViewCmdExecutor::createUIXML(QDeclarativeItem *parent, QIODevice* buff, XMLElementMap& elementsMap, Error** error) {
-    
-    QXmlStreamWriter* writer = new QXmlStreamWriter();
-
-    writer->setDevice(buff);
-    writer->setAutoFormatting(true);
-    writer->writeStartDocument();
-
-    addItemToXML(parent, elementsMap, writer);
-
-    writer->writeEndDocument();
-
-    delete writer;
-}
-
-void QQmlViewCmdExecutor::addItemToXML(QDeclarativeItem* parent, XMLElementMap& elementsMap, QXmlStreamWriter* writer) {
-    if (NULL == parent) {
-        session_->logger().Log(kWarningLogLevel, "parent item is NULL.");
-        return;
-    }
-
-    QString className(parent->metaObject()->className());
-    REMOVE_INTERNAL_SUFIXES(className);
-    
-    writer->writeStartElement(className);
-
-    if (!parent->objectName().isEmpty())
-        writer->writeAttribute("id", parent->objectName());
-
-    QString elementKey = GenerateRandomID().c_str();
-    elementsMap.insert(elementKey, QPointer<QDeclarativeItem>(parent));
-    writer->writeAttribute("elementId", elementKey);
-
-    QList<QObject*> childs = parent->children();
-    foreach(QObject *child, childs) {
-        QDeclarativeItem* childItem = qobject_cast<QDeclarativeItem*>(child);
-        if (childItem)
-            addItemToXML(childItem, elementsMap, writer);
-    }
-
-    writer->writeEndElement();
-}
-
-
 } //namespace webdriver 

src/webdriver/extension_qt/qml_view_util.cc

@@ -1,10 +1,12 @@
 #include "qml_view_util.h"
 #include "webdriver_session.h"
 #include "webdriver_error.h"
+#include "webdriver_util.h"
 #include "q_content_type_resolver.h"
 
 #include <QtNetwork/QNetworkAccessManager>
 #include <QtCore/QFileInfo>
+#include <QtDeclarative/QDeclarativeItem>
 
 #if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
 #include "extension_qt/qwindow_view_handle.h"
@@ -14,7 +16,6 @@
 #include <QtDeclarative/QDeclarativeView>
 #endif
 
-
 namespace webdriver {
 
 bool QQmlViewUtil::isUrlSupported(const std::string& url) {
@@ -54,6 +55,12 @@ bool QQmlViewUtil::isContentTypeSupported(const std::string& mime) {
     return false;
 }
 
+void QQmlViewUtil::removeInternalSuffixes(QString& str) {
+    str.remove(QRegExp(QLatin1String("_QMLTYPE_\\d+")));
+    str.remove(QRegExp(QLatin1String("_QML_\\d+")));
+    if (str.startsWith(QLatin1String("QDeclarative"))) str = str.mid(12);
+}
+
 #if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
 QWindow* QQmlViewUtil::getQWindowView(Session* session, const ViewId& viewId) {
     ViewHandle* viewHandle =  session->GetViewHandle(viewId);
@@ -92,5 +99,34 @@ QDeclarativeView* QQmlViewUtil::getQMLView(Session* session, const ViewId& viewI
 }
 #endif
 
+#if (QT_VERSION < QT_VERSION_CHECK(5, 0, 0))
+void QQmlXmlSerializer::addWidget(QDeclarativeItem* item) {
+    if (NULL == item) {
+        session_->logger().Log(kWarningLogLevel, "parent item is NULL.");
+        return;
+    }
+
+    QString className(item->metaObject()->className());
+    QQmlViewUtil::removeInternalSuffixes(className);
+
+    writer_.writeStartElement(className);
+
+    if (!item->objectName().isEmpty())
+        writer_.writeAttribute("id", item->objectName());
+
+    QString elementKey = GenerateRandomID().c_str();
+    elementsMap_.insert(elementKey, QPointer<QDeclarativeItem>(item));
+    writer_.writeAttribute("elementId", elementKey);
+
+    QList<QObject*> childs = item->children();
+    foreach(QObject *child, childs) {
+        QDeclarativeItem* childItem = qobject_cast<QDeclarativeItem*>(child);
+        if (childItem)
+            addWidget(childItem);
+    }
+
+    writer_.writeEndElement();
+}
+#endif
 
 } // namespace webdriver