src/qml/qml/qqmlopenmetaobject.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qqmlopenmetaobject_p.h"
  43 #include <private/qqmlpropertycache_p.h>
  44 #include <private/qqmldata_p.h>
  45 #include <private/qmetaobjectbuilder_p.h>
  46 #include <qdebug.h>
  47
  48 QT_BEGIN_NAMESPACE
  49
  50
  51 class QQmlOpenMetaObjectTypePrivate
  52 {
  53 public:
  54     QQmlOpenMetaObjectTypePrivate() : mem(0), cache(0), engine(0) {}
  55
  56     void init(const QMetaObject *metaObj);
  57
  58     int propertyOffset;
  59     int signalOffset;
  60     QHash<QByteArray, int> names;
  61     QMetaObjectBuilder mob;
  62     QMetaObject *mem;
  63     QQmlPropertyCache *cache;
  64     QQmlEngine *engine;
  65     QSet<QQmlOpenMetaObject*> referers;
  66 };
  67
  68 QQmlOpenMetaObjectType::QQmlOpenMetaObjectType(const QMetaObject *base, QQmlEngine *engine)
  69     : QQmlCleanup(engine), d(new QQmlOpenMetaObjectTypePrivate)
  70 {
  71     d->engine = engine;
  72     d->init(base);
  73 }
  74
  75 QQmlOpenMetaObjectType::~QQmlOpenMetaObjectType()
  76 {
  77     if (d->mem)
  78         free(d->mem);
  79     if (d->cache)
  80         d->cache->release();
  81     delete d;
  82 }
  83
  84 void QQmlOpenMetaObjectType::clear()
  85 {
  86     d->engine = 0;
  87 }
  88
  89 int QQmlOpenMetaObjectType::propertyOffset() const
  90 {
  91     return d->propertyOffset;
  92 }
  93
  94 int QQmlOpenMetaObjectType::signalOffset() const
  95 {
  96     return d->signalOffset;
  97 }
  98
  99 int QQmlOpenMetaObjectType::propertyCount() const
 100 {
 101     return d->names.count();
 102 }
 103
 104 QByteArray QQmlOpenMetaObjectType::propertyName(int idx) const
 105 {
 106     Q_ASSERT(idx >= 0 && idx < d->names.count());
 107
 108     return d->mob.property(idx).name();
 109 }
 110
 111 QMetaObject *QQmlOpenMetaObjectType::metaObject() const
 112 {
 113     return d->mem;
 114 }
 115
 116 int QQmlOpenMetaObjectType::createProperty(const QByteArray &name)
 117 {
 118     int id = d->mob.propertyCount();
 119     d->mob.addSignal("__" + QByteArray::number(id) + "()");
 120     QMetaPropertyBuilder build = d->mob.addProperty(name, "QVariant", id);
 121     propertyCreated(id, build);
 122     free(d->mem);
 123     d->mem = d->mob.toMetaObject();
 124     d->names.insert(name, id);
 125     QSet<QQmlOpenMetaObject*>::iterator it = d->referers.begin();
 126     while (it != d->referers.end()) {
 127         QQmlOpenMetaObject *omo = *it;
 128         *static_cast<QMetaObject *>(omo) = *d->mem;
 129         if (d->cache)
 130             d->cache->update(d->engine, omo);
 131         ++it;
 132     }
 133
 134     return d->propertyOffset + id;
 135 }
 136
 137 void QQmlOpenMetaObjectType::propertyCreated(int id, QMetaPropertyBuilder &builder)
 138 {
 139     if (d->referers.count())
 140         (*d->referers.begin())->propertyCreated(id, builder);
 141 }
 142
 143 void QQmlOpenMetaObjectTypePrivate::init(const QMetaObject *metaObj)
 144 {
 145     if (!mem) {
 146         mob.setSuperClass(metaObj);
 147         mob.setClassName(metaObj->className());
 148         mob.setFlags(QMetaObjectBuilder::DynamicMetaObject);
 149
 150         mem = mob.toMetaObject();
 151
 152         propertyOffset = mem->propertyOffset();
 153         signalOffset = mem->methodOffset();
 154     }
 155 }
 156
 157 //----------------------------------------------------------------------------
 158
 159 class QQmlOpenMetaObjectPrivate
 160 {
 161 public:
 162     QQmlOpenMetaObjectPrivate(QQmlOpenMetaObject *_q)
 163         : q(_q), parent(0), type(0), cacheProperties(false) {}
 164
 165     inline QPair<QVariant, bool> &getDataRef(int idx) {
 166         while (data.count() <= idx)
 167             data << QPair<QVariant, bool>(QVariant(), false);
 168         return data[idx];
 169     }
 170
 171     inline QVariant &getData(int idx) {
 172         QPair<QVariant, bool> &prop = getDataRef(idx);
 173         if (!prop.second) {
 174             prop.first = q->initialValue(idx);
 175             prop.second = true;
 176         }
 177         return prop.first;
 178     }
 179
 180     inline bool hasData(int idx) const {
 181         if (idx >= data.count())
 182             return false;
 183         return data[idx].second;
 184     }
 185
 186     bool autoCreate;
 187     QQmlOpenMetaObject *q;
 188     QAbstractDynamicMetaObject *parent;
 189     QList<QPair<QVariant, bool> > data;
 190     QObject *object;
 191     QQmlOpenMetaObjectType *type;
 192     bool cacheProperties;
 193 };
 194
 195 QQmlOpenMetaObject::QQmlOpenMetaObject(QObject *obj, const QMetaObject *base, bool automatic)
 196 : d(new QQmlOpenMetaObjectPrivate(this))
 197 {
 198     d->autoCreate = automatic;
 199     d->object = obj;
 200
 201     d->type = new QQmlOpenMetaObjectType(base ? base : obj->metaObject(), 0);
 202     d->type->d->referers.insert(this);
 203
 204     QObjectPrivate *op = QObjectPrivate::get(obj);
 205     d->parent = static_cast<QAbstractDynamicMetaObject *>(op->metaObject);
 206     *static_cast<QMetaObject *>(this) = *d->type->d->mem;
 207     op->metaObject = this;
 208 }
 209
 210 QQmlOpenMetaObject::QQmlOpenMetaObject(QObject *obj, QQmlOpenMetaObjectType *type, bool automatic)
 211 : d(new QQmlOpenMetaObjectPrivate(this))
 212 {
 213     d->autoCreate = automatic;
 214     d->object = obj;
 215
 216     d->type = type;
 217     d->type->addref();
 218     d->type->d->referers.insert(this);
 219
 220     QObjectPrivate *op = QObjectPrivate::get(obj);
 221     d->parent = static_cast<QAbstractDynamicMetaObject *>(op->metaObject);
 222     *static_cast<QMetaObject *>(this) = *d->type->d->mem;
 223     op->metaObject = this;
 224 }
 225
 226 QQmlOpenMetaObject::~QQmlOpenMetaObject()
 227 {
 228     if (d->parent)
 229         delete d->parent;
 230     d->type->d->referers.remove(this);
 231     d->type->release();
 232     delete d;
 233 }
 234
 235 QQmlOpenMetaObjectType *QQmlOpenMetaObject::type() const
 236 {
 237     return d->type;
 238 }
 239
 240 int QQmlOpenMetaObject::metaCall(QMetaObject::Call c, int id, void **a)
 241 {
 242     if (( c == QMetaObject::ReadProperty || c == QMetaObject::WriteProperty)
 243             && id >= d->type->d->propertyOffset) {
 244         int propId = id - d->type->d->propertyOffset;
 245         if (c == QMetaObject::ReadProperty) {
 246             propertyRead(propId);
 247             *reinterpret_cast<QVariant *>(a[0]) = d->getData(propId);
 248         } else if (c == QMetaObject::WriteProperty) {
 249             if (propId <= d->data.count() || d->data[propId].first != *reinterpret_cast<QVariant *>(a[0]))  {
 250                 propertyWrite(propId);
 251                 QPair<QVariant, bool> &prop = d->getDataRef(propId);
 252                 prop.first = propertyWriteValue(propId, *reinterpret_cast<QVariant *>(a[0]));
 253                 prop.second = true;
 254                 propertyWritten(propId);
 255                 activate(d->object, d->type->d->signalOffset + propId, 0);
 256             }
 257         }
 258         return -1;
 259     } else {
 260         if (d->parent)
 261             return d->parent->metaCall(c, id, a);
 262         else
 263             return d->object->qt_metacall(c, id, a);
 264     }
 265 }
 266
 267 QAbstractDynamicMetaObject *QQmlOpenMetaObject::parent() const
 268 {
 269     return d->parent;
 270 }
 271
 272 QVariant QQmlOpenMetaObject::value(int id) const
 273 {
 274     return d->getData(id);
 275 }
 276
 277 void QQmlOpenMetaObject::setValue(int id, const QVariant &value)
 278 {
 279     QPair<QVariant, bool> &prop = d->getDataRef(id);
 280     prop.first = propertyWriteValue(id, value);
 281     prop.second = true;
 282     activate(d->object, id + d->type->d->signalOffset, 0);
 283 }
 284
 285 QVariant QQmlOpenMetaObject::value(const QByteArray &name) const
 286 {
 287     QHash<QByteArray, int>::ConstIterator iter = d->type->d->names.find(name);
 288     if (iter == d->type->d->names.end())
 289         return QVariant();
 290
 291     return d->getData(*iter);
 292 }
 293
 294 QVariant &QQmlOpenMetaObject::operator[](const QByteArray &name)
 295 {
 296     QHash<QByteArray, int>::ConstIterator iter = d->type->d->names.find(name);
 297     Q_ASSERT(iter != d->type->d->names.end());
 298
 299     return d->getData(*iter);
 300 }
 301
 302 QVariant &QQmlOpenMetaObject::operator[](int id)
 303 {
 304     return d->getData(id);
 305 }
 306
 307 bool QQmlOpenMetaObject::setValue(const QByteArray &name, const QVariant &val)
 308 {
 309     QHash<QByteArray, int>::ConstIterator iter = d->type->d->names.find(name);
 310
 311     int id = -1;
 312     if (iter == d->type->d->names.end()) {
 313         id = createProperty(name.constData(), "") - d->type->d->propertyOffset;
 314     } else {
 315         id = *iter;
 316     }
 317
 318     if (id >= 0) {
 319         QVariant &dataVal = d->getData(id);
 320         if (dataVal == val)
 321             return false;
 322
 323         dataVal = val;
 324         activate(d->object, id + d->type->d->signalOffset, 0);
 325         return true;
 326     }
 327
 328     return false;
 329 }
 330
 331 // returns true if this value has been initialized by a call to either value() or setValue()
 332 bool QQmlOpenMetaObject::hasValue(int id) const
 333 {
 334     return d->hasData(id);
 335 }
 336
 337 void QQmlOpenMetaObject::setCached(bool c)
 338 {
 339     if (c == d->cacheProperties || !d->type->d->engine)
 340         return;
 341
 342     d->cacheProperties = c;
 343
 344     QQmlData *qmldata = QQmlData::get(d->object, true);
 345     if (d->cacheProperties) {
 346         if (!d->type->d->cache)
 347             d->type->d->cache = new QQmlPropertyCache(d->type->d->engine, this);
 348         qmldata->propertyCache = d->type->d->cache;
 349         d->type->d->cache->addref();
 350     } else {
 351         if (d->type->d->cache)
 352             d->type->d->cache->release();
 353         qmldata->propertyCache = 0;
 354     }
 355 }
 356
 357
 358 int QQmlOpenMetaObject::createProperty(const char *name, const char *)
 359 {
 360     if (d->autoCreate)
 361         return d->type->createProperty(name);
 362     else
 363         return -1;
 364 }
 365
 366 void QQmlOpenMetaObject::propertyRead(int)
 367 {
 368 }
 369
 370 void QQmlOpenMetaObject::propertyWrite(int)
 371 {
 372 }
 373
 374 QVariant QQmlOpenMetaObject::propertyWriteValue(int, const QVariant &value)
 375 {
 376     return value;
 377 }
 378
 379 void QQmlOpenMetaObject::propertyWritten(int)
 380 {
 381 }
 382
 383 void QQmlOpenMetaObject::propertyCreated(int, QMetaPropertyBuilder &)
 384 {
 385 }
 386
 387 QVariant QQmlOpenMetaObject::initialValue(int)
 388 {
 389     return QVariant();
 390 }
 391
 392 int QQmlOpenMetaObject::count() const
 393 {
 394     return d->type->d->names.count();
 395 }
 396
 397 QByteArray QQmlOpenMetaObject::name(int idx) const
 398 {
 399     Q_ASSERT(idx >= 0 && idx < d->type->d->names.count());
 400
 401     return d->type->d->mob.property(idx).name();
 402 }
 403
 404 QObject *QQmlOpenMetaObject::object() const
 405 {
 406     return d->object;
 407 }
 408
 409 QT_END_NAMESPACE