src/qml/qml/qqmlopenmetaobject.cpp

   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 #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::createProperty(const QByteArray &name)
 100 {
 101     int id = d->mob.propertyCount();
 102     d->mob.addSignal("__" + QByteArray::number(id) + "()");
 103     QMetaPropertyBuilder build = d->mob.addProperty(name, "QVariant", id);
 104     propertyCreated(id, build);
 105     free(d->mem);
 106     d->mem = d->mob.toMetaObject();
 107     d->names.insert(name, id);
 108     QSet<QQmlOpenMetaObject*>::iterator it = d->referers.begin();
 109     while (it != d->referers.end()) {
 110         QQmlOpenMetaObject *omo = *it;
 111         *static_cast<QMetaObject *>(omo) = *d->mem;
 112         if (d->cache)
 113             d->cache->update(d->engine, omo);
 114         ++it;
 115     }
 116
 117     return d->propertyOffset + id;
 118 }
 119
 120 void QQmlOpenMetaObjectType::propertyCreated(int id, QMetaPropertyBuilder &builder)
 121 {
 122     if (d->referers.count())
 123         (*d->referers.begin())->propertyCreated(id, builder);
 124 }
 125
 126 void QQmlOpenMetaObjectTypePrivate::init(const QMetaObject *metaObj)
 127 {
 128     if (!mem) {
 129         mob.setSuperClass(metaObj);
 130         mob.setClassName(metaObj->className());
 131         mob.setFlags(QMetaObjectBuilder::DynamicMetaObject);
 132
 133         mem = mob.toMetaObject();
 134
 135         propertyOffset = mem->propertyOffset();
 136         signalOffset = mem->methodOffset();
 137     }
 138 }
 139
 140 //----------------------------------------------------------------------------
 141
 142 class QQmlOpenMetaObjectPrivate
 143 {
 144 public:
 145     QQmlOpenMetaObjectPrivate(QQmlOpenMetaObject *_q)
 146         : q(_q), parent(0), type(0), cacheProperties(false) {}
 147
 148     inline QPair<QVariant, bool> &getDataRef(int idx) {
 149         while (data.count() <= idx)
 150             data << QPair<QVariant, bool>(QVariant(), false);
 151         return data[idx];
 152     }
 153
 154     inline QVariant &getData(int idx) {
 155         QPair<QVariant, bool> &prop = getDataRef(idx);
 156         if (!prop.second) {
 157             prop.first = q->initialValue(idx);
 158             prop.second = true;
 159         }
 160         return prop.first;
 161     }
 162
 163     inline bool hasData(int idx) const {
 164         if (idx >= data.count())
 165             return false;
 166         return data[idx].second;
 167     }
 168
 169     bool autoCreate;
 170     QQmlOpenMetaObject *q;
 171     QAbstractDynamicMetaObject *parent;
 172     QList<QPair<QVariant, bool> > data;
 173     QObject *object;
 174     QQmlOpenMetaObjectType *type;
 175     bool cacheProperties;
 176 };
 177
 178 QQmlOpenMetaObject::QQmlOpenMetaObject(QObject *obj, const QMetaObject *base, bool automatic)
 179 : d(new QQmlOpenMetaObjectPrivate(this))
 180 {
 181     d->autoCreate = automatic;
 182     d->object = obj;
 183
 184     d->type = new QQmlOpenMetaObjectType(base ? base : obj->metaObject(), 0);
 185     d->type->d->referers.insert(this);
 186
 187     QObjectPrivate *op = QObjectPrivate::get(obj);
 188     d->parent = static_cast<QAbstractDynamicMetaObject *>(op->metaObject);
 189     *static_cast<QMetaObject *>(this) = *d->type->d->mem;
 190     op->metaObject = this;
 191 }
 192
 193 QQmlOpenMetaObject::QQmlOpenMetaObject(QObject *obj, QQmlOpenMetaObjectType *type, bool automatic)
 194 : d(new QQmlOpenMetaObjectPrivate(this))
 195 {
 196     d->autoCreate = automatic;
 197     d->object = obj;
 198
 199     d->type = type;
 200     d->type->addref();
 201     d->type->d->referers.insert(this);
 202
 203     QObjectPrivate *op = QObjectPrivate::get(obj);
 204     d->parent = static_cast<QAbstractDynamicMetaObject *>(op->metaObject);
 205     *static_cast<QMetaObject *>(this) = *d->type->d->mem;
 206     op->metaObject = this;
 207 }
 208
 209 QQmlOpenMetaObject::~QQmlOpenMetaObject()
 210 {
 211     if (d->parent)
 212         delete d->parent;
 213     d->type->d->referers.remove(this);
 214     d->type->release();
 215     delete d;
 216 }
 217
 218 QQmlOpenMetaObjectType *QQmlOpenMetaObject::type() const
 219 {
 220     return d->type;
 221 }
 222
 223 int QQmlOpenMetaObject::metaCall(QMetaObject::Call c, int id, void **a)
 224 {
 225     if (( c == QMetaObject::ReadProperty || c == QMetaObject::WriteProperty)
 226             && id >= d->type->d->propertyOffset) {
 227         int propId = id - d->type->d->propertyOffset;
 228         if (c == QMetaObject::ReadProperty) {
 229             propertyRead(propId);
 230             *reinterpret_cast<QVariant *>(a[0]) = d->getData(propId);
 231         } else if (c == QMetaObject::WriteProperty) {
 232             if (propId <= d->data.count() || d->data[propId].first != *reinterpret_cast<QVariant *>(a[0]))  {
 233                 propertyWrite(propId);
 234                 QPair<QVariant, bool> &prop = d->getDataRef(propId);
 235                 prop.first = propertyWriteValue(propId, *reinterpret_cast<QVariant *>(a[0]));
 236                 prop.second = true;
 237                 propertyWritten(propId);
 238                 activate(d->object, d->type->d->signalOffset + propId, 0);
 239             }
 240         }
 241         return -1;
 242     } else {
 243         if (d->parent)
 244             return d->parent->metaCall(c, id, a);
 245         else
 246             return d->object->qt_metacall(c, id, a);
 247     }
 248 }
 249
 250 QAbstractDynamicMetaObject *QQmlOpenMetaObject::parent() const
 251 {
 252     return d->parent;
 253 }
 254
 255 QVariant QQmlOpenMetaObject::value(int id) const
 256 {
 257     return d->getData(id);
 258 }
 259
 260 void QQmlOpenMetaObject::setValue(int id, const QVariant &value)
 261 {
 262     QPair<QVariant, bool> &prop = d->getDataRef(id);
 263     prop.first = propertyWriteValue(id, value);
 264     prop.second = true;
 265     activate(d->object, id + d->type->d->signalOffset, 0);
 266 }
 267
 268 QVariant QQmlOpenMetaObject::value(const QByteArray &name) const
 269 {
 270     QHash<QByteArray, int>::ConstIterator iter = d->type->d->names.find(name);
 271     if (iter == d->type->d->names.end())
 272         return QVariant();
 273
 274     return d->getData(*iter);
 275 }
 276
 277 QVariant &QQmlOpenMetaObject::operator[](const QByteArray &name)
 278 {
 279     QHash<QByteArray, int>::ConstIterator iter = d->type->d->names.find(name);
 280     Q_ASSERT(iter != d->type->d->names.end());
 281
 282     return d->getData(*iter);
 283 }
 284
 285 QVariant &QQmlOpenMetaObject::operator[](int id)
 286 {
 287     return d->getData(id);
 288 }
 289
 290 bool QQmlOpenMetaObject::setValue(const QByteArray &name, const QVariant &val)
 291 {
 292     QHash<QByteArray, int>::ConstIterator iter = d->type->d->names.find(name);
 293
 294     int id = -1;
 295     if (iter == d->type->d->names.end()) {
 296         id = createProperty(name.constData(), "") - d->type->d->propertyOffset;
 297     } else {
 298         id = *iter;
 299     }
 300
 301     if (id >= 0) {
 302         QVariant &dataVal = d->getData(id);
 303         if (dataVal == val)
 304             return false;
 305
 306         dataVal = val;
 307         activate(d->object, id + d->type->d->signalOffset, 0);
 308         return true;
 309     }
 310
 311     return false;
 312 }
 313
 314 // returns true if this value has been initialized by a call to either value() or setValue()
 315 bool QQmlOpenMetaObject::hasValue(int id) const
 316 {
 317     return d->hasData(id);
 318 }
 319
 320 void QQmlOpenMetaObject::setCached(bool c)
 321 {
 322     if (c == d->cacheProperties || !d->type->d->engine)
 323         return;
 324
 325     d->cacheProperties = c;
 326
 327     QQmlData *qmldata = QQmlData::get(d->object, true);
 328     if (d->cacheProperties) {
 329         if (!d->type->d->cache)
 330             d->type->d->cache = new QQmlPropertyCache(d->type->d->engine, this);
 331         qmldata->propertyCache = d->type->d->cache;
 332         d->type->d->cache->addref();
 333     } else {
 334         if (d->type->d->cache)
 335             d->type->d->cache->release();
 336         qmldata->propertyCache = 0;
 337     }
 338 }
 339
 340
 341 int QQmlOpenMetaObject::createProperty(const char *name, const char *)
 342 {
 343     if (d->autoCreate)
 344         return d->type->createProperty(name);
 345     else
 346         return -1;
 347 }
 348
 349 void QQmlOpenMetaObject::propertyRead(int)
 350 {
 351 }
 352
 353 void QQmlOpenMetaObject::propertyWrite(int)
 354 {
 355 }
 356
 357 QVariant QQmlOpenMetaObject::propertyWriteValue(int, const QVariant &value)
 358 {
 359     return value;
 360 }
 361
 362 void QQmlOpenMetaObject::propertyWritten(int)
 363 {
 364 }
 365
 366 void QQmlOpenMetaObject::propertyCreated(int, QMetaPropertyBuilder &)
 367 {
 368 }
 369
 370 QVariant QQmlOpenMetaObject::initialValue(int)
 371 {
 372     return QVariant();
 373 }
 374
 375 int QQmlOpenMetaObject::count() const
 376 {
 377     return d->type->d->names.count();
 378 }
 379
 380 QByteArray QQmlOpenMetaObject::name(int idx) const
 381 {
 382     Q_ASSERT(idx >= 0 && idx < d->type->d->names.count());
 383
 384     return d->type->d->mob.property(idx).name();
 385 }
 386
 387 QObject *QQmlOpenMetaObject::object() const
 388 {
 389     return d->object;
 390 }
 391
 392 QT_END_NAMESPACE