src/declarative/qml/qdeclarativepropertycache_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 QtDeclarative 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 QDECLARATIVEPROPERTYCACHE_P_H
  43 #define QDECLARATIVEPROPERTYCACHE_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 <private/qdeclarativerefcount_p.h>
  57 #include "qdeclarativecleanup_p.h"
  58 #include "qdeclarativenotifier_p.h"
  59
  60 #include <private/qhashedstring_p.h>
  61 #include <QtCore/qvarlengtharray.h>
  62 #include <QtCore/qvector.h>
  63
  64 QT_BEGIN_NAMESPACE
  65
  66 class QV8Engine;
  67 class QMetaProperty;
  68 class QV8QObjectWrapper;
  69 class QDeclarativeEngine;
  70 class QDeclarativePropertyData;
  71 class QDeclarativeAccessors;
  72 class QDeclarativePropertyCacheMethodArguments;
  73
  74 // We have this somewhat awful split between RawData and Data so that RawData can be
  75 // used in unions.  In normal code, you should always use Data which initializes RawData
  76 // to an invalid state on construction.
  77 class QDeclarativePropertyRawData
  78 {
  79 public:
  80     enum Flag {
  81         NoFlags           = 0x00000000,
  82         ValueTypeFlagMask = 0x0000FFFF, // Flags in valueTypeFlags must fit in this mask
  83
  84         // Can apply to all properties, except IsFunction
  85         IsConstant         = 0x00000001, // Has CONST flag
  86         IsWritable         = 0x00000002, // Has WRITE function
  87         IsResettable       = 0x00000004, // Has RESET function
  88         IsAlias            = 0x00000008, // Is a QML alias to another property
  89         IsFinal            = 0x00000010, // Has FINAL flag
  90         IsDirect           = 0x00000020, // Exists on a C++ QMetaObject
  91         HasAccessors       = 0x00000040, // Has property accessors
  92
  93         // These are mutualy exclusive
  94         IsFunction         = 0x00000080, // Is an invokable
  95         IsQObjectDerived   = 0x00000100, // Property type is a QObject* derived type
  96         IsEnumType         = 0x00000200, // Property type is an enum
  97         IsQList            = 0x00000400, // Property type is a QML list
  98         IsQmlBinding       = 0x00000800, // Property type is a QDeclarativeBinding*
  99         IsQJSValue         = 0x00001000, // Property type is a QScriptValue
 100         IsV8Handle         = 0x00002000, // Property type is a QDeclarativeV8Handle
 101         IsVMEProperty      = 0x00004000, // Property type is a "var" property of VMEMO
 102         IsValueTypeVirtual = 0x00008000, // Property is a value type "virtual" property
 103         IsQVariant         = 0x00010000, // Property is a QVariant
 104
 105         // Apply only to IsFunctions
 106         IsVMEFunction      = 0x00020000, // Function was added by QML
 107         HasArguments       = 0x00040000, // Function takes arguments
 108         IsSignal           = 0x00080000, // Function is a signal
 109         IsVMESignal        = 0x00100000, // Signal was added by QML
 110         IsV8Function       = 0x00200000, // Function takes QDeclarativeV8Function* args
 111         IsSignalHandler    = 0x00400000, // Function is a signal handler
 112         IsOverload         = 0x00800000, // Function is an overload of another function
 113
 114         // Internal QDeclarativePropertyCache flags
 115         NotFullyResolved   = 0x01000000  // True if the type data is to be lazily resolved
 116     };
 117     Q_DECLARE_FLAGS(Flags, Flag)
 118
 119     Flags getFlags() const { return Flag(flags); }
 120     void setFlags(Flags f) { flags = f; }
 121
 122     bool isValid() const { return coreIndex != -1; }
 123
 124     bool isConstant() const { return flags & IsConstant; }
 125     bool isWritable() const { return flags & IsWritable; }
 126     bool isResettable() const { return flags & IsResettable; }
 127     bool isAlias() const { return flags & IsAlias; }
 128     bool isFinal() const { return flags & IsFinal; }
 129     bool isDirect() const { return flags & IsDirect; }
 130     bool hasAccessors() const { return flags & HasAccessors; }
 131     bool isFunction() const { return flags & IsFunction; }
 132     bool isQObject() const { return flags & IsQObjectDerived; }
 133     bool isEnum() const { return flags & IsEnumType; }
 134     bool isQList() const { return flags & IsQList; }
 135     bool isQmlBinding() const { return flags & IsQmlBinding; }
 136     bool isQJSValue() const { return flags & IsQJSValue; }
 137     bool isV8Handle() const { return flags & IsV8Handle; }
 138     bool isVMEProperty() const { return flags & IsVMEProperty; }
 139     bool isValueTypeVirtual() const { return flags & IsValueTypeVirtual; }
 140     bool isQVariant() const { return flags & IsQVariant; }
 141     bool isVMEFunction() const { return flags & IsVMEFunction; }
 142     bool hasArguments() const { return flags & HasArguments; }
 143     bool isSignal() const { return flags & IsSignal; }
 144     bool isVMESignal() const { return flags & IsVMESignal; }
 145     bool isV8Function() const { return flags & IsV8Function; }
 146     bool isSignalHandler() const { return flags & IsSignalHandler; }
 147     bool isOverload() const { return flags & IsOverload; }
 148
 149     bool hasOverride() const { return !(flags & IsValueTypeVirtual) &&
 150                                       !(flags & HasAccessors) &&
 151                                       overrideIndex >= 0; }
 152
 153     // Returns -1 if not a value type virtual property
 154     inline int getValueTypeCoreIndex() const;
 155
 156     union {
 157         int propType;             // When !NotFullyResolved
 158         const char *propTypeName; // When NotFullyResolved
 159     };
 160     int coreIndex;
 161     union {
 162         int notifyIndex;  // When !IsFunction
 163         void *arguments;  // When IsFunction && HasArguments
 164     };
 165
 166     union {
 167         struct { // When !HasAccessors
 168             qint16 revision;
 169             qint16 metaObjectOffset;
 170
 171             union {
 172                 struct { // When IsValueTypeVirtual
 173                     quint16 valueTypeFlags; // flags of the access property on the value type proxy
 174                                             // object
 175                     quint8 valueTypePropType; // The QVariant::Type of access property on the value
 176                                               // type proxy object
 177                     quint8 valueTypeCoreIndex; // The prop index of the access property on the value
 178                                                // type proxy object
 179                 };
 180
 181                 struct { // When !IsValueTypeVirtual
 182                     uint overrideIndexIsProperty : 1;
 183                     signed int overrideIndex : 31;
 184                 };
 185             };
 186         };
 187         struct { // When HasAccessors
 188             QDeclarativeAccessors *accessors;
 189             intptr_t accessorData;
 190         };
 191     };
 192
 193 private:
 194     friend class QDeclarativePropertyData;
 195     friend class QDeclarativePropertyCache;
 196     quint32 flags;
 197 };
 198 Q_DECLARE_OPERATORS_FOR_FLAGS(QDeclarativePropertyRawData::Flags);
 199
 200 class QDeclarativePropertyData : public QDeclarativePropertyRawData
 201 {
 202 public:
 203     inline QDeclarativePropertyData();
 204     inline QDeclarativePropertyData(const QDeclarativePropertyRawData &);
 205
 206     inline bool operator==(const QDeclarativePropertyRawData &);
 207
 208     static Flags flagsForProperty(const QMetaProperty &, QDeclarativeEngine *engine = 0);
 209     void load(const QMetaProperty &, QDeclarativeEngine *engine = 0);
 210     void load(const QMetaMethod &);
 211     QString name(QObject *);
 212     QString name(const QMetaObject *);
 213
 214 private:
 215     friend class QDeclarativePropertyCache;
 216     void lazyLoad(const QMetaProperty &, QDeclarativeEngine *engine = 0);
 217     void lazyLoad(const QMetaMethod &);
 218     bool notFullyResolved() const { return flags & NotFullyResolved; }
 219 };
 220
 221 class Q_DECLARATIVE_EXPORT QDeclarativePropertyCache : public QDeclarativeRefCount, public QDeclarativeCleanup
 222 {
 223 public:
 224     QDeclarativePropertyCache(QDeclarativeEngine *);
 225     QDeclarativePropertyCache(QDeclarativeEngine *, const QMetaObject *);
 226     virtual ~QDeclarativePropertyCache();
 227
 228     void update(QDeclarativeEngine *, const QMetaObject *);
 229
 230     QDeclarativePropertyCache *copy();
 231
 232     QDeclarativePropertyCache *copyAndAppend(QDeclarativeEngine *, const QMetaObject *,
 233                 QDeclarativePropertyData::Flag propertyFlags = QDeclarativePropertyData::NoFlags,
 234                 QDeclarativePropertyData::Flag methodFlags = QDeclarativePropertyData::NoFlags,
 235                 QDeclarativePropertyData::Flag signalFlags = QDeclarativePropertyData::NoFlags);
 236     QDeclarativePropertyCache *copyAndAppend(QDeclarativeEngine *, const QMetaObject *, int revision,
 237                 QDeclarativePropertyData::Flag propertyFlags = QDeclarativePropertyData::NoFlags,
 238                 QDeclarativePropertyData::Flag methodFlags = QDeclarativePropertyData::NoFlags,
 239                 QDeclarativePropertyData::Flag signalFlags = QDeclarativePropertyData::NoFlags);
 240
 241     void append(QDeclarativeEngine *, const QMetaObject *,
 242                 QDeclarativePropertyData::Flag propertyFlags = QDeclarativePropertyData::NoFlags,
 243                 QDeclarativePropertyData::Flag methodFlags = QDeclarativePropertyData::NoFlags,
 244                 QDeclarativePropertyData::Flag signalFlags = QDeclarativePropertyData::NoFlags);
 245     void append(QDeclarativeEngine *, const QMetaObject *, int revision,
 246                 QDeclarativePropertyData::Flag propertyFlags = QDeclarativePropertyData::NoFlags,
 247                 QDeclarativePropertyData::Flag methodFlags = QDeclarativePropertyData::NoFlags,
 248                 QDeclarativePropertyData::Flag signalFlags = QDeclarativePropertyData::NoFlags);
 249
 250     inline QDeclarativePropertyData *property(const QHashedV8String &) const;
 251     QDeclarativePropertyData *property(const QHashedStringRef &) const;
 252     QDeclarativePropertyData *property(const QHashedCStringRef &) const;
 253     QDeclarativePropertyData *property(const QString &) const;
 254     QDeclarativePropertyData *property(int) const;
 255     QDeclarativePropertyData *method(int) const;
 256     QStringList propertyNames() const;
 257
 258     inline QDeclarativePropertyData *overrideData(QDeclarativePropertyData *) const;
 259     inline bool isAllowedInRevision(QDeclarativePropertyData *) const;
 260
 261     inline QDeclarativeEngine *qmlEngine() const;
 262     static QDeclarativePropertyData *property(QDeclarativeEngine *, QObject *, const QString &,
 263                                               QDeclarativePropertyData &);
 264     static QDeclarativePropertyData *property(QDeclarativeEngine *, QObject *, const QHashedV8String &,
 265                                               QDeclarativePropertyData &);
 266     static int *methodParameterTypes(QObject *, int index, QVarLengthArray<int, 9> &dummy,
 267                                      QByteArray *unknownTypeError);
 268
 269     static bool isDynamicMetaObject(const QMetaObject *);
 270 protected:
 271     virtual void destroy();
 272     virtual void clear();
 273
 274 private:
 275     friend class QDeclarativeEnginePrivate;
 276     friend class QV8QObjectWrapper;
 277
 278     inline QDeclarativePropertyCache *copy(int reserve);
 279
 280     // Implemented in v8/qv8qobjectwrapper.cpp
 281     v8::Local<v8::Object> newQObject(QObject *, QV8Engine *);
 282
 283     typedef QVector<QDeclarativePropertyData> IndexCache;
 284     typedef QStringHash<QDeclarativePropertyData *> StringCache;
 285     typedef QVector<int> AllowedRevisionCache;
 286
 287     void resolve(QDeclarativePropertyData *) const;
 288     void updateRecur(QDeclarativeEngine *, const QMetaObject *);
 289
 290     QDeclarativeEngine *engine;
 291
 292     QDeclarativePropertyCache *parent;
 293     int propertyIndexCacheStart;
 294     int methodIndexCacheStart;
 295     int signalHanderIndexCacheStart;
 296
 297     IndexCache propertyIndexCache;
 298     IndexCache methodIndexCache;
 299     IndexCache signalHandlerIndexCache;
 300     StringCache stringCache;
 301     AllowedRevisionCache allowedRevisionCache;
 302     v8::Persistent<v8::Function> constructor;
 303
 304     const QMetaObject *metaObject;
 305     QDeclarativePropertyCacheMethodArguments *argumentsCache;
 306 };
 307
 308 QDeclarativePropertyData::QDeclarativePropertyData()
 309 {
 310     propType = 0;
 311     coreIndex = -1;
 312     notifyIndex = -1;
 313     overrideIndexIsProperty = false;
 314     overrideIndex = -1;
 315     revision = 0;
 316     metaObjectOffset = -1;
 317     flags = 0;
 318 }
 319
 320 QDeclarativePropertyData::QDeclarativePropertyData(const QDeclarativePropertyRawData &d)
 321 {
 322     *(static_cast<QDeclarativePropertyRawData *>(this)) = d;
 323 }
 324
 325 bool QDeclarativePropertyData::operator==(const QDeclarativePropertyRawData &other)
 326 {
 327     return flags == other.flags &&
 328            propType == other.propType &&
 329            coreIndex == other.coreIndex &&
 330            notifyIndex == other.notifyIndex &&
 331            revision == other.revision &&
 332            (!isValueTypeVirtual() ||
 333             (valueTypeCoreIndex == other.valueTypeCoreIndex &&
 334              valueTypePropType == other.valueTypePropType));
 335 }
 336
 337 int QDeclarativePropertyRawData::getValueTypeCoreIndex() const
 338 {
 339     return isValueTypeVirtual()?valueTypeCoreIndex:-1;
 340 }
 341
 342 QDeclarativePropertyData *
 343 QDeclarativePropertyCache::overrideData(QDeclarativePropertyData *data) const
 344 {
 345     if (!data->hasOverride())
 346         return 0;
 347
 348     if (data->overrideIndexIsProperty)
 349         return property(data->overrideIndex);
 350     else
 351         return method(data->overrideIndex);
 352 }
 353
 354 bool QDeclarativePropertyCache::isAllowedInRevision(QDeclarativePropertyData *data) const
 355 {
 356     return (data->hasAccessors() || data->metaObjectOffset == -1 && data->revision == 0) ||
 357            (allowedRevisionCache[data->metaObjectOffset] >= data->revision);
 358 }
 359
 360 QDeclarativeEngine *QDeclarativePropertyCache::qmlEngine() const
 361 {
 362     return engine;
 363 }
 364
 365 QDeclarativePropertyData *QDeclarativePropertyCache::property(const QHashedV8String &str) const
 366 {
 367     QDeclarativePropertyData **rv = stringCache.value(str);
 368     if (rv && (*rv)->notFullyResolved()) resolve(*rv);
 369     return rv?*rv:0;
 370 }
 371
 372 QT_END_NAMESPACE
 373
 374 #endif // QDECLARATIVEPROPERTYCACHE_P_H