Move model types into their own library

The model types are not part of the core QML runtime and should only be
loaded if you explicitly import them. We cannot enforce that in Qt5 as
some of them are available from the QtQml import, but we can change it
in Qt6.

Change-Id: I1e49e84d748e352537ec2d4af901c034c91d038f
Reviewed-by: Erik Verbruggen <erik.verbruggen@me.com>

1 files changed, 429 insertions, 0 deletions

diff --git a/src/qmlmodels/qqmllistmodel_p_p.h b/src/qmlmodels/qqmllistmodel_p_p.h
new file mode 100644
index 0000000000..a0d0e9ad89
--- /dev/null
+++ b/src/qmlmodels/qqmllistmodel_p_p.h
@@ -0,0 +1,429 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtQml module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://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 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QQMLLISTMODEL_P_P_H
+#define QQMLLISTMODEL_P_P_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include "qqmllistmodel_p.h"
+#include <private/qtqmlmodelsglobal_p.h>
+#include <private/qqmlengine_p.h>
+#include <private/qqmlopenmetaobject_p.h>
+#include <private/qv4qobjectwrapper_p.h>
+#include <qqml.h>
+
+QT_REQUIRE_CONFIG(qml_list_model);
+
+QT_BEGIN_NAMESPACE
+
+
+class DynamicRoleModelNode;
+
+class DynamicRoleModelNodeMetaObject : public QQmlOpenMetaObject
+{
+public:
+    DynamicRoleModelNodeMetaObject(DynamicRoleModelNode *object);
+    ~DynamicRoleModelNodeMetaObject();
+
+    bool m_enabled;
+
+protected:
+    void propertyWrite(int index) override;
+    void propertyWritten(int index) override;
+
+private:
+    DynamicRoleModelNode *m_owner;
+};
+
+class DynamicRoleModelNode : public QObject
+{
+    Q_OBJECT
+public:
+    DynamicRoleModelNode(QQmlListModel *owner, int uid);
+
+    static DynamicRoleModelNode *create(const QVariantMap &obj, QQmlListModel *owner);
+
+    void updateValues(const QVariantMap &object, QVector<int> &roles);
+
+    QVariant getValue(const QString &name) const
+    {
+        return m_meta->value(name.toUtf8());
+    }
+
+    bool setValue(const QByteArray &name, const QVariant &val)
+    {
+        return m_meta->setValue(name, val);
+    }
+
+    void setNodeUpdatesEnabled(bool enable)
+    {
+        m_meta->m_enabled = enable;
+    }
+
+    int getUid() const
+    {
+        return m_uid;
+    }
+
+    static QVector<int> sync(DynamicRoleModelNode *src, DynamicRoleModelNode *target);
+
+private:
+    QQmlListModel *m_owner;
+    int m_uid;
+    DynamicRoleModelNodeMetaObject *m_meta;
+
+    friend class DynamicRoleModelNodeMetaObject;
+};
+
+class ModelNodeMetaObject : public QQmlOpenMetaObject
+{
+public:
+    ModelNodeMetaObject(QObject *object, QQmlListModel *model, int elementIndex);
+    ~ModelNodeMetaObject();
+
+    QAbstractDynamicMetaObject *toDynamicMetaObject(QObject *object) override;
+
+    static ModelNodeMetaObject *get(QObject *obj);
+
+    bool m_enabled;
+    QQmlListModel *m_model;
+    int m_elementIndex;
+
+    void updateValues();
+    void updateValues(const QVector<int> &roles);
+
+    bool initialized() const { return m_initialized; }
+
+protected:
+    void propertyWritten(int index) override;
+
+private:
+    using QQmlOpenMetaObject::setValue;
+
+    void emitDirectNotifies(const int *changedRoles, int roleCount);
+
+    void initialize();
+    bool m_initialized;
+};
+
+namespace QV4 {
+
+namespace Heap {
+
+struct ModelObject : public QObjectWrapper {
+    void init(QObject *object, QQmlListModel *model)
+    {
+        QObjectWrapper::init(object);
+        m_model = model;
+        QObjectPrivate *op = QObjectPrivate::get(object);
+        m_nodeModelMetaObject = static_cast<ModelNodeMetaObject *>(op->metaObject);
+    }
+    void destroy() { QObjectWrapper::destroy(); }
+    int elementIndex() const { return m_nodeModelMetaObject->m_elementIndex; }
+    QQmlListModel *m_model;
+    ModelNodeMetaObject *m_nodeModelMetaObject;
+};
+
+}
+
+struct ModelObject : public QObjectWrapper
+{
+    V4_OBJECT2(ModelObject, QObjectWrapper)
+    V4_NEEDS_DESTROY
+
+    ListModel *listModel() const { return d()->m_model->m_listModel; }
+
+protected:
+    static bool virtualPut(Managed *m, PropertyKey id, const Value& value, Value *receiver);
+    static ReturnedValue virtualGet(const Managed *m, PropertyKey id, const Value *receiver, bool *hasProperty);
+    static ReturnedValue virtualResolveLookupGetter(const Object *object, ExecutionEngine *engine, Lookup *lookup);
+    static ReturnedValue lookupGetter(Lookup *l, ExecutionEngine *engine, const Value &object);
+    static OwnPropertyKeyIterator *virtualOwnPropertyKeys(const Object *m, Value *target);
+};
+
+} // namespace QV4
+
+class ListLayout
+{
+public:
+    ListLayout() : currentBlock(0), currentBlockOffset(0) {}
+    ListLayout(const ListLayout *other);
+    ~ListLayout();
+
+    class Role
+    {
+    public:
+
+        Role() : type(Invalid), blockIndex(-1), blockOffset(-1), index(-1), subLayout(0) {}
+        explicit Role(const Role *other);
+        ~Role();
+
+        // This enum must be kept in sync with the roleTypeNames variable in qqmllistmodel.cpp
+        enum DataType
+        {
+            Invalid = -1,
+
+            String,
+            Number,
+            Bool,
+            List,
+            QObject,
+            VariantMap,
+            DateTime,
+            Function,
+
+            MaxDataType
+        };
+
+        QString name;
+        DataType type;
+        int blockIndex;
+        int blockOffset;
+        int index;
+        ListLayout *subLayout;
+    };
+
+    const Role *getRoleOrCreate(const QString &key, const QVariant &data);
+    const Role &getRoleOrCreate(QV4::String *key, Role::DataType type);
+    const Role &getRoleOrCreate(const QString &key, Role::DataType type);
+
+    const Role &getExistingRole(int index) const { return *roles.at(index); }
+    const Role *getExistingRole(const QString &key) const;
+    const Role *getExistingRole(QV4::String *key) const;
+
+    int roleCount() const { return roles.count(); }
+
+    static void sync(ListLayout *src, ListLayout *target);
+
+private:
+    const Role &createRole(const QString &key, Role::DataType type);
+
+    int currentBlock;
+    int currentBlockOffset;
+    QVector<Role *> roles;
+    QStringHash<Role *> roleHash;
+};
+
+struct StringOrTranslation
+{
+    explicit StringOrTranslation(const QString &s);
+    explicit StringOrTranslation(const QV4::CompiledData::Binding *binding);
+    ~StringOrTranslation();
+    bool isSet() const { return d.flag(); }
+    bool isTranslation() const { return d.isT2(); }
+    void setString(const QString &s);
+    void setTranslation(const QV4::CompiledData::Binding *binding);
+    QString toString(const QQmlListModel *owner) const;
+    QString asString() const;
+private:
+    void clear();
+    QBiPointer<QStringData, const QV4::CompiledData::Binding> d;
+};
+
+/*!
+\internal
+*/
+class ListElement
+{
+public:
+
+    ListElement();
+    ListElement(int existingUid);
+    ~ListElement();
+
+    static QVector<int> sync(ListElement *src, ListLayout *srcLayout, ListElement *target, ListLayout *targetLayout);
+
+    enum
+    {
+        BLOCK_SIZE = 64 - sizeof(int) - sizeof(ListElement *) - sizeof(ModelNodeMetaObject *)
+    };
+
+private:
+
+    void destroy(ListLayout *layout);
+
+    int setVariantProperty(const ListLayout::Role &role, const QVariant &d);
+
+    int setJsProperty(const ListLayout::Role &role, const QV4::Value &d, QV4::ExecutionEngine *eng);
+
+    int setStringProperty(const ListLayout::Role &role, const QString &s);
+    int setDoubleProperty(const ListLayout::Role &role, double n);
+    int setBoolProperty(const ListLayout::Role &role, bool b);
+    int setListProperty(const ListLayout::Role &role, ListModel *m);
+    int setQObjectProperty(const ListLayout::Role &role, QObject *o);
+    int setVariantMapProperty(const ListLayout::Role &role, QV4::Object *o);
+    int setVariantMapProperty(const ListLayout::Role &role, QVariantMap *m);
+    int setDateTimeProperty(const ListLayout::Role &role, const QDateTime &dt);
+    int setFunctionProperty(const ListLayout::Role &role, const QJSValue &f);
+    int setTranslationProperty(const ListLayout::Role &role, const QV4::CompiledData::Binding *b);
+
+    void setStringPropertyFast(const ListLayout::Role &role, const QString &s);
+    void setDoublePropertyFast(const ListLayout::Role &role, double n);
+    void setBoolPropertyFast(const ListLayout::Role &role, bool b);
+    void setQObjectPropertyFast(const ListLayout::Role &role, QObject *o);
+    void setListPropertyFast(const ListLayout::Role &role, ListModel *m);
+    void setVariantMapFast(const ListLayout::Role &role, QV4::Object *o);
+    void setDateTimePropertyFast(const ListLayout::Role &role, const QDateTime &dt);
+    void setFunctionPropertyFast(const ListLayout::Role &role, const QJSValue &f);
+
+    void clearProperty(const ListLayout::Role &role);
+
+    QVariant getProperty(const ListLayout::Role &role, const QQmlListModel *owner, QV4::ExecutionEngine *eng);
+    ListModel *getListProperty(const ListLayout::Role &role);
+    StringOrTranslation *getStringProperty(const ListLayout::Role &role);
+    QObject *getQObjectProperty(const ListLayout::Role &role);
+    QPointer<QObject> *getGuardProperty(const ListLayout::Role &role);
+    QVariantMap *getVariantMapProperty(const ListLayout::Role &role);
+    QDateTime *getDateTimeProperty(const ListLayout::Role &role);
+    QJSValue *getFunctionProperty(const ListLayout::Role &role);
+
+    inline char *getPropertyMemory(const ListLayout::Role &role);
+
+    int getUid() const { return uid; }
+
+    ModelNodeMetaObject *objectCache();
+
+    char data[BLOCK_SIZE];
+    ListElement *next;
+
+    int uid;
+    QObject *m_objectCache;
+
+    friend class ListModel;
+};
+
+/*!
+\internal
+*/
+class ListModel
+{
+public:
+
+    ListModel(ListLayout *layout, QQmlListModel *modelCache);
+    ~ListModel() {}
+
+    void destroy();
+
+    int setOrCreateProperty(int elementIndex, const QString &key, const QVariant &data);
+    int setExistingProperty(int uid, const QString &key, const QV4::Value &data, QV4::ExecutionEngine *eng);
+
+    QVariant getProperty(int elementIndex, int roleIndex, const QQmlListModel *owner, QV4::ExecutionEngine *eng);
+    ListModel *getListProperty(int elementIndex, const ListLayout::Role &role);
+
+    int roleCount() const
+    {
+        return m_layout->roleCount();
+    }
+
+    const ListLayout::Role &getExistingRole(int index) const
+    {
+        return m_layout->getExistingRole(index);
+    }
+
+    const ListLayout::Role *getExistingRole(QV4::String *key) const
+    {
+        return m_layout->getExistingRole(key);
+    }
+
+    const ListLayout::Role &getOrCreateListRole(const QString &name)
+    {
+        return m_layout->getRoleOrCreate(name, ListLayout::Role::List);
+    }
+
+    int elementCount() const
+    {
+        return elements.count();
+    }
+
+    void set(int elementIndex, QV4::Object *object, QVector<int> *roles);
+    void set(int elementIndex, QV4::Object *object);
+
+    int append(QV4::Object *object);
+    void insert(int elementIndex, QV4::Object *object);
+
+    Q_REQUIRED_RESULT QVector<std::function<void()>> remove(int index, int count);
+
+    int appendElement();
+    void insertElement(int index);
+
+    void move(int from, int to, int n);
+
+    static bool sync(ListModel *src, ListModel *target);
+
+    QObject *getOrCreateModelObject(QQmlListModel *model, int elementIndex);
+
+private:
+    QPODVector<ListElement *, 4> elements;
+    ListLayout *m_layout;
+
+    QQmlListModel *m_modelCache;
+
+    struct ElementSync
+    {
+        ListElement *src = nullptr;
+        ListElement *target = nullptr;
+        int srcIndex = -1;
+        int targetIndex = -1;
+        QVector<int> changedRoles;
+    };
+
+    void newElement(int index);
+
+    void updateCacheIndices(int start = 0, int end = -1);
+
+    friend class ListElement;
+    friend class QQmlListModelWorkerAgent;
+    friend class QQmlListModelParser;
+};
+
+QT_END_NAMESPACE
+
+Q_DECLARE_METATYPE(ListModel *);
+
+#endif // QQUICKLISTMODEL_P_P_H