src/qml/qml/qquicklistmodelworkeragent_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQUICKLISTMODELWORKERAGENT_P_H
  43 #define QQUICKLISTMODELWORKERAGENT_P_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists purely as an
  50 // implementation detail.  This header file may change from version to
  51 // version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include <qqml.h>
  57
  58 #include <QMutex>
  59 #include <QWaitCondition>
  60
  61 #include <private/qv8engine_p.h>
  62
  63 QT_BEGIN_HEADER
  64
  65 QT_BEGIN_NAMESPACE
  66
  67
  68 class QQuickListModel;
  69
  70 class QQuickListModelWorkerAgent : public QObject
  71 {
  72     Q_OBJECT
  73     Q_PROPERTY(int count READ count)
  74
  75 public:
  76     QQuickListModelWorkerAgent(QQuickListModel *);
  77     ~QQuickListModelWorkerAgent();
  78     void setV8Engine(QV8Engine *eng);
  79
  80     void addref();
  81     void release();
  82
  83     int count() const;
  84
  85     Q_INVOKABLE void clear();
  86     Q_INVOKABLE void remove(QQmlV8Function *args);
  87     Q_INVOKABLE void append(QQmlV8Function *args);
  88     Q_INVOKABLE void insert(QQmlV8Function *args);
  89     Q_INVOKABLE QQmlV8Handle get(int index) const;
  90     Q_INVOKABLE void set(int index, const QQmlV8Handle &);
  91     Q_INVOKABLE void setProperty(int index, const QString& property, const QVariant& value);
  92     Q_INVOKABLE void move(int from, int to, int count);
  93     Q_INVOKABLE void sync();
  94
  95     struct VariantRef
  96     {
  97         VariantRef() : a(0) {}
  98         VariantRef(const VariantRef &r) : a(r.a) { if (a) a->addref(); }
  99         VariantRef(QQuickListModelWorkerAgent *_a) : a(_a) { if (a) a->addref(); }
 100         ~VariantRef() { if (a) a->release(); }
 101
 102         VariantRef &operator=(const VariantRef &o) {
 103             if (o.a) o.a->addref();
 104             if (a) a->release(); a = o.a;
 105             return *this;
 106         }
 107
 108         QQuickListModelWorkerAgent *a;
 109     };
 110     void modelDestroyed();
 111 protected:
 112     virtual bool event(QEvent *);
 113
 114 private:
 115     friend class QQuickWorkerScriptEnginePrivate;
 116     friend class QQuickListModel;
 117
 118     struct Change
 119     {
 120         int modelUid;
 121         enum { Inserted, Removed, Moved, Changed } type;
 122         int index; // Inserted/Removed/Moved/Changed
 123         int count; // Inserted/Removed/Moved/Changed
 124         int to;    // Moved
 125         QVector<int> roles;
 126     };
 127
 128     struct Data
 129     {
 130         QList<Change> changes;
 131
 132         void clearChange(int uid);
 133         void insertChange(int uid, int index, int count);
 134         void removeChange(int uid, int index, int count);
 135         void moveChange(int uid, int index, int count, int to);
 136         void changedChange(int uid, int index, int count, const QVector<int> &roles);
 137     };
 138     Data data;
 139
 140     struct Sync : public QEvent {
 141         Sync() : QEvent(QEvent::User) {}
 142         Data data;
 143         QQuickListModel *list;
 144     };
 145
 146     QAtomicInt m_ref;
 147     QQuickListModel *m_orig;
 148     QQuickListModel *m_copy;
 149     QMutex mutex;
 150     QWaitCondition syncDone;
 151 };
 152
 153 QT_END_NAMESPACE
 154
 155 Q_DECLARE_METATYPE(QQuickListModelWorkerAgent::VariantRef)
 156
 157 QT_END_HEADER
 158
 159 #endif // QQUICKLISTMODELWORKERAGENT_P_H
 160