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, 209 insertions, 0 deletions

diff --git a/src/qmlmodels/qqmllistmodel_p.h b/src/qmlmodels/qqmllistmodel_p.h
new file mode 100644
index 0000000000..4aabd790a5
--- /dev/null
+++ b/src/qmlmodels/qqmllistmodel_p.h
@@ -0,0 +1,209 @@
+/****************************************************************************
+**
+** 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_H
+#define QQMLLISTMODEL_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 <private/qtqmlmodelsglobal_p.h>
+#include <private/qqmlcustomparser_p.h>
+
+#include <QtCore/QObject>
+#include <QtCore/QStringList>
+#include <QtCore/QHash>
+#include <QtCore/QList>
+#include <QtCore/QVariant>
+#include <QtCore/qabstractitemmodel.h>
+
+#include <private/qv4engine_p.h>
+#include <private/qpodvector_p.h>
+
+QT_REQUIRE_CONFIG(qml_list_model);
+
+QT_BEGIN_NAMESPACE
+
+
+class QQmlListModelWorkerAgent;
+class ListModel;
+class ListLayout;
+
+namespace QV4 {
+struct ModelObject;
+}
+
+class Q_QMLMODELS_PRIVATE_EXPORT QQmlListModel : public QAbstractListModel
+{
+    Q_OBJECT
+    Q_PROPERTY(int count READ count NOTIFY countChanged)
+    Q_PROPERTY(bool dynamicRoles READ dynamicRoles WRITE setDynamicRoles)
+    Q_PROPERTY(QObject *agent READ agent CONSTANT REVISION(14))
+
+public:
+    QQmlListModel(QObject *parent=nullptr);
+    ~QQmlListModel();
+
+    QModelIndex index(int row, int column, const QModelIndex &parent) const override;
+    int rowCount(const QModelIndex &parent) const override;
+    QVariant data(const QModelIndex &index, int role) const override;
+    bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;
+    QHash<int,QByteArray> roleNames() const override;
+
+    QVariant data(int index, int role) const;
+    int count() const;
+
+    Q_INVOKABLE void clear();
+    Q_INVOKABLE void remove(QQmlV4Function *args);
+    Q_INVOKABLE void append(QQmlV4Function *args);
+    Q_INVOKABLE void insert(QQmlV4Function *args);
+    Q_INVOKABLE QJSValue get(int index) const;
+    Q_INVOKABLE void set(int index, const QJSValue &value);
+    Q_INVOKABLE void setProperty(int index, const QString& property, const QVariant& value);
+    Q_INVOKABLE void move(int from, int to, int count);
+    Q_INVOKABLE void sync();
+
+    QQmlListModelWorkerAgent *agent();
+
+    bool dynamicRoles() const { return m_dynamicRoles; }
+    void setDynamicRoles(bool enableDynamicRoles);
+
+Q_SIGNALS:
+    void countChanged();
+
+private:
+    friend class QQmlListModelParser;
+    friend class QQmlListModelWorkerAgent;
+    friend class ModelObject;
+    friend struct QV4::ModelObject;
+    friend class ModelNodeMetaObject;
+    friend class ListModel;
+    friend class ListElement;
+    friend class DynamicRoleModelNode;
+    friend class DynamicRoleModelNodeMetaObject;
+    friend struct StringOrTranslation;
+
+    // Constructs a flat list model for a worker agent
+    QQmlListModel(QQmlListModel *orig, QQmlListModelWorkerAgent *agent);
+    QQmlListModel(const QQmlListModel *owner, ListModel *data, QV4::ExecutionEngine *engine, QObject *parent=nullptr);
+
+    QV4::ExecutionEngine *engine() const;
+
+    inline bool canMove(int from, int to, int n) const { return !(from+n > count() || to+n > count() || from < 0 || to < 0 || n < 0); }
+
+    mutable QQmlListModelWorkerAgent *m_agent;
+    mutable QV4::ExecutionEngine *m_engine;
+    QQmlRefPointer<QV4::CompiledData::CompilationUnit> m_compilationUnit;
+    bool m_mainThread;
+    bool m_primary;
+
+    bool m_dynamicRoles;
+
+    ListLayout *m_layout;
+    ListModel *m_listModel;
+
+    QVector<class DynamicRoleModelNode *> m_modelObjects;
+    QVector<QString> m_roles;
+
+    struct ElementSync
+    {
+        DynamicRoleModelNode *src = nullptr;
+        DynamicRoleModelNode *target = nullptr;
+        int srcIndex = -1;
+        int targetIndex = -1;
+        QVector<int> changedRoles;
+    };
+
+    static bool sync(QQmlListModel *src, QQmlListModel *target);
+    static QQmlListModel *createWithOwner(QQmlListModel *newOwner);
+
+    void emitItemsChanged(int index, int count, const QVector<int> &roles);
+    void emitItemsAboutToBeInserted(int index, int count);
+    void emitItemsInserted();
+
+    void removeElements(int index, int removeCount);
+};
+
+// ### FIXME
+class QQmlListElement : public QObject
+{
+Q_OBJECT
+};
+
+class QQmlListModelParser : public QQmlCustomParser
+{
+public:
+    enum PropertyType {
+        Invalid,
+        Boolean,
+        Number,
+        String,
+        Script
+    };
+
+
+    QQmlListModelParser() : QQmlCustomParser(QQmlCustomParser::AcceptsSignalHandlers) {}
+
+    void verifyBindings(const QQmlRefPointer<QV4::CompiledData::CompilationUnit> &compilationUnit, const QList<const QV4::CompiledData::Binding *> &bindings) override;
+    void applyBindings(QObject *obj, const QQmlRefPointer<QV4::CompiledData::CompilationUnit> &compilationUnit, const QList<const QV4::CompiledData::Binding *> &bindings) override;
+
+private:
+    bool verifyProperty(const QQmlRefPointer<QV4::CompiledData::CompilationUnit> &compilationUnit, const QV4::CompiledData::Binding *binding);
+    // returns true if a role was set
+    bool applyProperty(const QQmlRefPointer<QV4::CompiledData::CompilationUnit> &compilationUnit, const QV4::CompiledData::Binding *binding, ListModel *model, int outterElementIndex);
+
+    static bool definesEmptyList(const QString &);
+
+    QString listElementTypeName;
+};
+
+QT_END_NAMESPACE
+
+QML_DECLARE_TYPE(QQmlListModel)
+QML_DECLARE_TYPE(QQmlListElement)
+
+#endif // QQMLLISTMODEL_H