QmlPuppet: Introduce DesignerCustomObjectData

This class holds the additional data we use to annotate QObject.
At the moment we store the default values and bindings there.
I also moved the code to populate and read the hashes
into that class.

Change-Id: Ib5e4b5291cfd2bf5555a896bf42578d07f2c6253
Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>

share/qtcreator/qml/qmlpuppet/qmlprivategate/designercustomobjectdata.cpp

@@ -0,0 +1,225 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing
+**
+** This file is part of Qt Creator.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company.  For licensing terms and
+** conditions see http://www.qt.io/terms-conditions.  For further information
+** use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, The Qt Company gives you certain additional
+** rights.  These rights are described in The Qt Company LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#include "designercustomobjectdata.h"
+
+#include <qmlprivategate.h>
+
+#include <QQmlContext>
+#include <QQmlEngine>
+
+#include <private/qqmlbinding_p.h>
+
+namespace QmlDesigner {
+
+namespace Internal {
+
+namespace QmlPrivateGate {
+
+QHash<QObject *, DesignerCustomObjectData*> m_objectToDataHash;
+
+DesignerCustomObjectData::DesignerCustomObjectData(QObject *object, QQmlContext *context)
+    : m_object(object)
+    , m_context(context)
+{
+    if (object)
+        populateResetHashes();
+        m_objectToDataHash.insert(object, this);
+        QObject::connect(object, &QObject::destroyed, [=] {
+            m_objectToDataHash.remove(object);
+            delete this;
+        });
+}
+
+void DesignerCustomObjectData::registerData(QObject *object, QQmlContext *context)
+{
+    new DesignerCustomObjectData(object, context);
+}
+
+DesignerCustomObjectData *DesignerCustomObjectData::get(QObject *object)
+{
+    return m_objectToDataHash.value(object);
+}
+
+QVariant DesignerCustomObjectData::getResetValue(QObject *object, const PropertyName &propertyName)
+{
+    DesignerCustomObjectData* data = get(object);
+
+    if (data)
+        return data->getResetValue(propertyName);
+
+    return QVariant();
+}
+
+void DesignerCustomObjectData::doResetProperty(QObject *object, const PropertyName &propertyName)
+{
+    DesignerCustomObjectData* data = get(object);
+
+    if (data)
+        data->doResetProperty(propertyName);
+}
+
+bool DesignerCustomObjectData::hasValidResetBinding(QObject *object, const PropertyName &propertyName)
+{
+    DesignerCustomObjectData* data = get(object);
+
+    if (data)
+        return data->hasValidResetBinding(propertyName);
+
+    return false;
+}
+
+bool DesignerCustomObjectData::hasBindingForProperty(QObject *object, const PropertyName &propertyName, bool *hasChanged)
+{
+    DesignerCustomObjectData* data = get(object);
+
+    if (data)
+        return data->hasBindingForProperty(propertyName, hasChanged);
+
+    return false;
+}
+
+void DesignerCustomObjectData::populateResetHashes()
+{
+    PropertyNameList propertyNameList = QmlPrivateGate::propertyNameListForWritableProperties(object());
+
+    foreach (const PropertyName &propertyName, propertyNameList) {
+        QQmlProperty property(object(), propertyName, QQmlEngine::contextForObject(object()));
+
+        QQmlAbstractBinding::Pointer binding = QQmlAbstractBinding::getPointer(QQmlPropertyPrivate::binding(property));
+        if (binding) {
+            m_resetBindingHash.insert(propertyName, binding);
+        } else if (property.isWritable()) {
+            m_resetValueHash.insert(propertyName, property.read());
+        }
+    }
+
+    m_resetValueHash.insert("Layout.rowSpan", 1);
+    m_resetValueHash.insert("Layout.columnSpan", 1);
+    m_resetValueHash.insert("Layout.fillHeight", false);
+    m_resetValueHash.insert("Layout.fillWidth", false);
+}
+
+QQmlContext *DesignerCustomObjectData::context() const
+{
+    return m_context;
+}
+
+QObject *DesignerCustomObjectData::object() const
+{
+    return m_object;
+}
+
+QVariant DesignerCustomObjectData::getResetValue(const PropertyName &propertyName) const
+{
+    return m_resetValueHash.value(propertyName);
+}
+
+void DesignerCustomObjectData::doResetProperty(const PropertyName &propertyName)
+{
+    QQmlProperty property(object(), propertyName, context());
+
+    if (!property.isValid())
+        return;
+
+    QVariant oldValue = property.read();
+    if (oldValue.type() == QVariant::Url) {
+        QUrl url = oldValue.toUrl();
+        QString path = url.toLocalFile();
+        /* ### TODO
+        if (QFileInfo(path).exists() && nodeInstanceServer())
+            nodeInstanceServer()->removeFilePropertyFromFileSystemWatcher(object(), propertyName, path);
+            */
+    }
+
+
+    QQmlAbstractBinding *binding = QQmlPropertyPrivate::binding(property);
+    if (binding && !(hasValidResetBinding(propertyName) && getResetBinding(propertyName) == binding)) {
+        binding->setEnabled(false, 0);
+        binding->destroy();
+    }
+
+
+    if (hasValidResetBinding(propertyName)) {
+        QQmlAbstractBinding *binding = getResetBinding(propertyName);
+        QQmlPropertyPrivate::setBinding(property, binding, QQmlPropertyPrivate::DontRemoveBinding);
+        binding->update();
+    } else if (property.isResettable()) {
+        property.reset();
+    } else if (property.propertyTypeCategory() == QQmlProperty::List) {
+        QQmlListReference list = qvariant_cast<QQmlListReference>(property.read());
+
+        if (!QmlPrivateGate::hasFullImplementedListInterface(list)) {
+            qWarning() << "Property list interface not fully implemented for Class " << property.property().typeName() << " in property " << property.name() << "!";
+            return;
+        }
+
+        list.clear();
+    } else if (property.isWritable()) {
+        if (property.read() == getResetValue(propertyName))
+            return;
+
+        property.write(getResetValue(propertyName));
+    }
+}
+
+bool DesignerCustomObjectData::hasValidResetBinding(const PropertyName &propertyName) const
+{
+    return m_resetBindingHash.contains(propertyName) &&  m_resetBindingHash.value(propertyName).data();
+}
+
+QQmlAbstractBinding *DesignerCustomObjectData::getResetBinding(const PropertyName &propertyName) const
+{
+    return m_resetBindingHash.value(propertyName).data();
+}
+
+bool DesignerCustomObjectData::hasBindingForProperty(const PropertyName &propertyName, bool *hasChanged) const
+{
+    if (QmlPrivateGate::isPropertyBlackListed(propertyName))
+        return false;
+
+    QQmlProperty property(object(), propertyName, context());
+
+    bool hasBinding = QQmlPropertyPrivate::binding(property);
+
+    if (hasChanged) {
+        *hasChanged = hasBinding != m_hasBindingHash.value(propertyName, false);
+        if (*hasChanged)
+            m_hasBindingHash.insert(propertyName, hasBinding);
+    }
+
+    return QQmlPropertyPrivate::binding(property);
+}
+
+
+} // namespace QmlPrivateGate
+} // namespace Internal
+} // namespace QmlDesigner
+