QmlDesigner: Refactor enumeration handling

Change-Id: I0e163147a0303741af52127ece6f6afd0d2aa658
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>

share/qtcreator/qml/qmlpuppet/interfaces/nodeinstanceserverinterface.cpp

@@ -63,6 +63,8 @@
 #include "endpuppetcommand.h"
 #include "debugoutputcommand.h"
 
+#include <enumeration.h>
+
 namespace QmlDesigner {
 
 static bool isRegistered=false;
@@ -181,6 +183,9 @@ void NodeInstanceServerInterface::registerCommands()
 
     qRegisterMetaType<DebugOutputCommand>("DebugOutputCommand");
     qRegisterMetaTypeStreamOperators<DebugOutputCommand>("DebugOutputCommand");
+
+    qRegisterMetaType<Enumeration>("Enumeration");
+    qRegisterMetaTypeStreamOperators<Enumeration>("Enumeration");
 }
 
 }

share/qtcreator/qml/qmlpuppet/qml2puppet/instances/objectnodeinstance.cpp

@@ -29,7 +29,7 @@
 
 #include "objectnodeinstance.h"
 
-
+#include <enumeration.h>
 
 #include <QEvent>
 #include <QQmlContext>
@@ -472,6 +472,9 @@ void ObjectNodeInstance::setPropertyVariant(const PropertyName &name, const QVar
 
     QVariant fixedValue = fixResourcePaths(value);
 
+    if (value.canConvert<Enumeration>())
+        fixedValue = QVariant::fromValue(value.value<Enumeration>().nameToString());
+
     QVariant oldValue = property.read();
     if (oldValue.type() == QVariant::Url) {
         QUrl url = oldValue.toUrl();

share/qtcreator/qml/qmlpuppet/qml2puppet/qml2puppet.pri

@@ -26,6 +26,7 @@ include (instances/instances.pri)
 include (../commands/commands.pri)
 include (../container/container.pri)
 include (../interfaces/interfaces.pri)
+include (../types/types.pri)
 
 QT_BREAKPAD_ROOT_PATH = $$(QT_BREAKPAD_ROOT_PATH)
 !isEmpty(QT_BREAKPAD_ROOT_PATH) {

share/qtcreator/qml/qmlpuppet/qmlpuppet/instances/objectnodeinstance.cpp

@@ -29,7 +29,7 @@
 
 #include "objectnodeinstance.h"
 
-
+#include <enumeration.h>
 
 #include <QEvent>
 #include <QGraphicsScene>
@@ -443,6 +443,9 @@ void ObjectNodeInstance::setPropertyVariant(const PropertyName &name, const QVar
 
     QVariant fixedValue = fixResourcePaths(value);
 
+    if (value.canConvert<Enumeration>())
+        fixedValue = QVariant::fromValue(value.value<Enumeration>().nameToString());
+
     QVariant oldValue = property.read();
     if (oldValue.type() == QVariant::Url) {
         QUrl url = oldValue.toUrl();

share/qtcreator/qml/qmlpuppet/qmlpuppet/qmlpuppet.pri

@@ -16,6 +16,7 @@ include (instances/instances.pri)
 include (../commands/commands.pri)
 include (../container/container.pri)
 include (../interfaces/interfaces.pri)
+include (../types/types.pri)
 
 SOURCES += $$PWD/qmlpuppetmain.cpp
 RESOURCES += $$PWD/../qmlpuppet.qrc

share/qtcreator/qml/qmlpuppet/types/enumeration.cpp

+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/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 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#include "enumeration.h"
+
+#include <QString>
+#include <QList>
+#include <QtDebug>
+
+namespace QmlDesigner {
+
+Enumeration::Enumeration()
+{
+}
+
+Enumeration::Enumeration(const EnumerationName &enumerationName)
+    : m_enumerationName(enumerationName)
+{
+}
+
+Enumeration::Enumeration(const QString &enumerationName)
+    : m_enumerationName(enumerationName.toUtf8())
+{
+}
+
+Enumeration::Enumeration(const QString &scope, const QString &name)
+{
+    QString enumerationString = scope + QStringLiteral(".") + name;
+
+    m_enumerationName = enumerationString.toUtf8();
+}
+
+QmlDesigner::EnumerationName QmlDesigner::Enumeration::scope() const
+{
+    return m_enumerationName.split('.').first();
+}
+
+EnumerationName Enumeration::name() const
+{
+    return m_enumerationName.split('.').last();
+}
+
+EnumerationName Enumeration::toEnumerationName() const
+{
+    return m_enumerationName;
+}
+
+QString Enumeration::toString() const
+{
+    return QString::fromUtf8(m_enumerationName);
+}
+
+QString Enumeration::nameToString()
+{
+    return QString::fromUtf8(name());
+}
+
+QDataStream &operator<<(QDataStream &out, const Enumeration &enumeration)
+{
+    out << enumeration.toEnumerationName();
+
+    return out;
+}
+
+QDataStream &operator>>(QDataStream &in, Enumeration &enumeration)
+{
+    in >> enumeration.m_enumerationName;
+
+    return in;
+}
+
+
+bool operator ==(const Enumeration &first, const Enumeration &second)
+{
+    return first.m_enumerationName == second.m_enumerationName;
+}
+
+bool operator <(const Enumeration &first, const Enumeration &second)
+{
+    return first.m_enumerationName < second.m_enumerationName;
+}
+
+QDebug operator <<(QDebug debug, const Enumeration &enumeration)
+{
+    debug.nospace() << "Enumeration("
+                    << enumeration.toString()
+                    << ")";
+
+    return debug;
+}
+
+
+} // namespace QmlDesigner
+
+
+

share/qtcreator/qml/qmlpuppet/types/enumeration.h

+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/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 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#ifndef QMLDESIGNER_ENUMERATION_H
+#define QMLDESIGNER_ENUMERATION_H
+
+#include <QByteArray>
+#include <QDataStream>
+#include <QMetaType>
+#include <QVariant>
+
+namespace QmlDesigner {
+
+typedef QByteArray EnumerationName;
+
+class Enumeration
+{
+    friend bool operator ==(const Enumeration &first, const Enumeration &second);
+    friend bool operator <(const Enumeration &first, const Enumeration &second);
+    friend QDataStream &operator>>(QDataStream &in, Enumeration &enumeration);
+
+public:
+    Enumeration();
+    Enumeration(const EnumerationName &enumerationName);
+    Enumeration(const QString &enumerationName);
+    Enumeration(const QString &scope, const QString &name);
+
+    EnumerationName scope() const;
+    EnumerationName name() const;
+    EnumerationName toEnumerationName() const;
+    QString toString() const;
+    QString nameToString();
+
+private:
+    EnumerationName m_enumerationName;
+};
+
+QDataStream &operator<<(QDataStream &out, const Enumeration &enumeration);
+QDataStream &operator>>(QDataStream &in, Enumeration &enumeration);
+
+bool operator ==(const Enumeration &first, const Enumeration &second);
+bool operator <(const Enumeration &first, const Enumeration &second);
+
+QDebug operator <<(QDebug debug, const Enumeration &enumeration);
+
+
+} // namespace QmlDesigner
+
+Q_DECLARE_METATYPE(QmlDesigner::Enumeration)
+
+#endif // QMLDESIGNER_ENUMERATION_H

share/qtcreator/qml/qmlpuppet/types/types.pri

+INCLUDEPATH += $$PWD/
+
+HEADERS += $$PWD/enumeration.h
+
+SOURCES +=  $$PWD/enumeration.cpp

share/qtcreator/qmldesigner/propertyEditorQmlSources/HelperWidgets/ComboBox.qml

@@ -37,12 +37,13 @@ Controls.ComboBox {
     property variant backendValue
 
     property color textColor: colorLogic.textColor
+    property string scope: "Qt"
 
     ColorLogic {
         id: colorLogic
         backendValue: comboBox.backendValue
         onValueFromBackendChanged: {
-            comboBox.currentIndex = comboBox.find(comboBox.backendValue.valueToString);
+            comboBox.currentIndex = comboBox.find(comboBox.backendValue.enumeration);
         }
     }
 
@@ -50,8 +51,7 @@ Controls.ComboBox {
         if (backendValue === undefined)
             return;
 
-        if (backendValue.value !== currentText)
-            backendValue.value = currentText;
+            backendValue.setEnumeration(comboBox.scope, comboBox.currentText)
     }
 
     onFocusChanged: {

share/qtcreator/qmldesigner/propertyEditorQmlSources/HelperWidgets/StandardTextSection.qml

@@ -72,6 +72,7 @@ Section {
             visible: showVerticalAlignment
             Layout.fillWidth: true
             backendValue: backendValues.wrapMode
+            scope: "Text"
             model: ["NoWrap", "WordWrap", "WrapAnywhere", "WrapAtWordBoundaryOrAnywhere"]
         }
 

share/qtcreator/qmldesigner/propertyEditorQmlSources/QtQuick/BorderImageSpecifics.qml

@@ -137,6 +137,7 @@ Column {
                     backendValue: backendValues.horizontalTileMode
                     implicitWidth: 180
                     Layout.fillWidth: true
+                    scope: "BorderImage"
                 }
             }
 
@@ -150,6 +151,7 @@ Column {
                     backendValue: backendValues.verticalTileMode
                     implicitWidth: 180
                     Layout.fillWidth: true
+                    scope: "BorderImage"
                 }
 
             }

share/qtcreator/qmldesigner/propertyEditorQmlSources/QtQuick/FlowSpecifics.qml

@@ -49,6 +49,7 @@ Column {
                 ComboBox {
                     model: ["LeftToRight", "TopToBottom"]
                     backendValue: backendValues.flow
+                    scope: "Qt"
                 }
 
                 ExpandingSpacer {
@@ -65,6 +66,7 @@ Column {
                     model: ["LeftToRight", "RightToLeft"]
                     backendValue: backendValues.layoutDirection
                     Layout.fillWidth: true
+                    scope: "Qt"
                 }
 
             }

share/qtcreator/qmldesigner/propertyEditorQmlSources/QtQuick/GridSpecifics.qml

@@ -84,6 +84,7 @@ Column {
                     model: ["LeftToRight", "TopToBottom"]
                     backendValue: backendValues.flow
                     Layout.fillWidth: true
+                    scope: "Qt"
                 }
             }
 
@@ -96,6 +97,7 @@ Column {
                     model: ["LeftToRight", "RightToLeft"]
                     backendValue: backendValues.layoutDirection
                     Layout.fillWidth: true
+                    scope: "Qt"
                 }
 
             }

share/qtcreator/qmldesigner/propertyEditorQmlSources/QtQuick/ImageSpecifics.qml

@@ -66,6 +66,7 @@ Column {
                     backendValue: backendValues.fillMode
                     implicitWidth: 180
                     Layout.fillWidth: true
+                    scope: "Image"
                 }
 
                 ExpandingSpacer {

share/qtcreator/qmldesigner/propertyEditorQmlSources/QtQuick/RowSpecifics.qml

@@ -50,6 +50,7 @@ Column {
                     model: ["LeftToRight", "RightToLeft"]
                     backendValue: backendValues.layoutDirection
                     Layout.fillWidth: true
+                    scope: "Qt"
                 }
             }
 

share/qtcreator/qmldesigner/propertyEditorQmlSources/QtQuick/TextInputSection.qml

@@ -60,6 +60,7 @@ Section {
             visible: showVerticalAlignment
             Layout.fillWidth: true
             backendValue: backendValues.echoMode
+            scope: "TextInput"
             model:  ["Normal", "Password", "PasswordEchoOnEdit", "NoEcho"]
         }
 

src/plugins/qmldesigner/components/propertyeditor/propertyeditorvalue.cpp

@@ -150,7 +150,11 @@ void PropertyEditorValue::setValue(const QVariant &value)
     if (m_value.isValid())
         emit valueChangedQml();
     emit isBoundChanged();
+}
 
+QString PropertyEditorValue::enumeration() const
+{
+    return m_value.value<QmlDesigner::Enumeration>().nameToString();
 }
 
 QString PropertyEditorValue::expression() const
@@ -262,6 +266,13 @@ void PropertyEditorValue::resetValue()
     }
 }
 
+void PropertyEditorValue::setEnumeration(const QString &scope, const QString &name)
+{
+    QmlDesigner::Enumeration newEnumeration(scope, name);
+
+    setValueWithEmit(QVariant::fromValue(newEnumeration));
+}
+
 void PropertyEditorValue::registerDeclarativeTypes()
 {
     qmlRegisterType<PropertyEditorValue>("HelperWidgets",2,0,"PropertyEditorValue");

src/plugins/qmldesigner/components/propertyeditor/propertyeditorvalue.h

@@ -36,6 +36,7 @@
 #include <QQmlPropertyMap>
 #include <QtQml>
 #include <modelnode.h>
+#include <enumeration.h>
 
 class PropertyEditorValue;
 
@@ -78,6 +79,7 @@ class PropertyEditorValue : public QObject
 {
     Q_OBJECT
     Q_PROPERTY(QVariant value READ value WRITE setValueWithEmit NOTIFY valueChangedQml)
+    Q_PROPERTY(QVariant enumeration READ enumeration NOTIFY valueChangedQml)
     Q_PROPERTY(QString expression READ expression WRITE setExpressionWithEmit NOTIFY expressionChanged FINAL)
     Q_PROPERTY(QString valueToString READ valueToString NOTIFY valueChangedQml FINAL)
     Q_PROPERTY(bool isInModel READ isInModel NOTIFY valueChangedQml FINAL)
@@ -96,6 +98,8 @@ public:
     void setValueWithEmit(const QVariant &value);
     void setValue(const QVariant &value);
 
+    QString enumeration() const;
+
     QString expression() const;
     void setExpressionWithEmit(const QString &expression);
     void setExpression(const QString &expression);
@@ -125,6 +129,7 @@ public:
 
 public slots:
     void resetValue();
+    void setEnumeration(const QString &scope, const QString &name);
 
 signals:
     void valueChanged(const QString &name, const QVariant&);

src/plugins/qmldesigner/designercore/designercore-lib.pri

@@ -13,6 +13,7 @@ include (instances/instances.pri)
 include (../../../../share/qtcreator/qml/qmlpuppet/interfaces/interfaces.pri)
 include (../../../../share/qtcreator/qml/qmlpuppet/commands/commands.pri)
 include (../../../../share/qtcreator/qml/qmlpuppet/container/container.pri)
+include (../../../../share/qtcreator/qml/qmlpuppet/types/types.pri)
 
 SOURCES += $$PWD/model/abstractview.cpp \
     $$PWD/model/rewriterview.cpp \

src/plugins/qmldesigner/designercore/include/variantproperty.h

@@ -32,6 +32,7 @@
 
 #include "qmldesignercorelib_global.h"
 #include "abstractproperty.h"
+#include "enumeration.h"
 
 QT_BEGIN_NAMESPACE
 class QTextStream;
@@ -55,7 +56,12 @@ public:
     void setValue(const QVariant &value);
     QVariant value() const;
 
+    void setEnumeration(const EnumerationName &enumerationName);
+    Enumeration enumeration() const;
+    bool holdsEnumeration() const;
+
     void setDynamicTypeNameAndValue(const TypeName &type, const QVariant &value);
+    void setDynamicTypeNameAndEnumeration(const TypeName &type, const EnumerationName &enumerationName);
 
     VariantProperty();
     VariantProperty(const VariantProperty &property, AbstractView *view);