1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtQml module of the Qt Toolkit.
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.
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.
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.
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.
40 ****************************************************************************/
42 #ifndef QQMLPROPERTYCACHE_P_H
43 #define QQMLPROPERTYCACHE_P_H
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.
56 #include <private/qqmlrefcount_p.h>
57 #include "qqmlcleanup_p.h"
58 #include "qqmlnotifier_p.h"
60 #include <private/qhashedstring_p.h>
61 #include <QtCore/qvarlengtharray.h>
62 #include <QtCore/qvector.h>
68 class QV8QObjectWrapper;
70 class QQmlPropertyData;
72 class QQmlPropertyCacheMethodArguments;
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 QQmlPropertyRawData
82 ValueTypeFlagMask = 0x0000FFFF, // Flags in valueTypeFlags must fit in this mask
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
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 QQmlBinding*
99 IsQJSValue = 0x00001000, // Property type is a QScriptValue
100 IsV8Handle = 0x00002000, // Property type is a QQmlV8Handle
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
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 QQmlV8Function* args
111 IsSignalHandler = 0x00400000, // Function is a signal handler
112 IsOverload = 0x00800000, // Function is an overload of another function
114 // Internal QQmlPropertyCache flags
115 NotFullyResolved = 0x01000000 // True if the type data is to be lazily resolved
117 Q_DECLARE_FLAGS(Flags, Flag)
119 Flags getFlags() const { return Flag(flags); }
120 void setFlags(Flags f) { flags = f; }
122 bool isValid() const { return coreIndex != -1; }
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; }
149 bool hasOverride() const { return !(flags & IsValueTypeVirtual) &&
150 !(flags & HasAccessors) &&
151 overrideIndex >= 0; }
152 bool hasRevision() const { return !(flags & HasAccessors) && revision != 0; }
154 // Returns -1 if not a value type virtual property
155 inline int getValueTypeCoreIndex() const;
157 // Returns the "encoded" index for use with bindings. Encoding is:
158 // coreIndex | (valueTypeCoreIndex << 24)
159 inline int encodedIndex() const;
162 int propType; // When !NotFullyResolved
163 const char *propTypeName; // When NotFullyResolved
167 int notifyIndex; // When !IsFunction
168 void *arguments; // When IsFunction && HasArguments
172 struct { // When !HasAccessors
174 qint16 metaObjectOffset;
177 struct { // When IsValueTypeVirtual
178 quint16 valueTypeFlags; // flags of the access property on the value type proxy
180 quint8 valueTypePropType; // The QVariant::Type of access property on the value
182 quint8 valueTypeCoreIndex; // The prop index of the access property on the value
186 struct { // When !IsValueTypeVirtual
187 uint overrideIndexIsProperty : 1;
188 signed int overrideIndex : 31;
192 struct { // When HasAccessors
193 QQmlAccessors *accessors;
194 intptr_t accessorData;
199 friend class QQmlPropertyData;
200 friend class QQmlPropertyCache;
203 Q_DECLARE_OPERATORS_FOR_FLAGS(QQmlPropertyRawData::Flags);
205 class QQmlPropertyData : public QQmlPropertyRawData
208 inline QQmlPropertyData();
209 inline QQmlPropertyData(const QQmlPropertyRawData &);
211 inline bool operator==(const QQmlPropertyRawData &);
213 static Flags flagsForProperty(const QMetaProperty &, QQmlEngine *engine = 0);
214 void load(const QMetaProperty &, QQmlEngine *engine = 0);
215 void load(const QMetaMethod &);
216 QString name(QObject *);
217 QString name(const QMetaObject *);
220 friend class QQmlPropertyCache;
221 void lazyLoad(const QMetaProperty &, QQmlEngine *engine = 0);
222 void lazyLoad(const QMetaMethod &);
223 bool notFullyResolved() const { return flags & NotFullyResolved; }
226 class Q_QML_EXPORT QQmlPropertyCache : public QQmlRefCount, public QQmlCleanup
229 QQmlPropertyCache(QQmlEngine *);
230 QQmlPropertyCache(QQmlEngine *, const QMetaObject *);
231 virtual ~QQmlPropertyCache();
233 void update(QQmlEngine *, const QMetaObject *);
235 QQmlPropertyCache *copy();
237 QQmlPropertyCache *copyAndAppend(QQmlEngine *, const QMetaObject *,
238 QQmlPropertyData::Flag propertyFlags = QQmlPropertyData::NoFlags,
239 QQmlPropertyData::Flag methodFlags = QQmlPropertyData::NoFlags,
240 QQmlPropertyData::Flag signalFlags = QQmlPropertyData::NoFlags);
241 QQmlPropertyCache *copyAndAppend(QQmlEngine *, const QMetaObject *, int revision,
242 QQmlPropertyData::Flag propertyFlags = QQmlPropertyData::NoFlags,
243 QQmlPropertyData::Flag methodFlags = QQmlPropertyData::NoFlags,
244 QQmlPropertyData::Flag signalFlags = QQmlPropertyData::NoFlags);
246 void append(QQmlEngine *, const QMetaObject *,
247 QQmlPropertyData::Flag propertyFlags = QQmlPropertyData::NoFlags,
248 QQmlPropertyData::Flag methodFlags = QQmlPropertyData::NoFlags,
249 QQmlPropertyData::Flag signalFlags = QQmlPropertyData::NoFlags);
250 void append(QQmlEngine *, const QMetaObject *, int revision,
251 QQmlPropertyData::Flag propertyFlags = QQmlPropertyData::NoFlags,
252 QQmlPropertyData::Flag methodFlags = QQmlPropertyData::NoFlags,
253 QQmlPropertyData::Flag signalFlags = QQmlPropertyData::NoFlags);
255 inline QQmlPropertyData *property(const QHashedV8String &) const;
256 QQmlPropertyData *property(const QHashedStringRef &) const;
257 QQmlPropertyData *property(const QHashedCStringRef &) const;
258 QQmlPropertyData *property(const QString &) const;
259 QQmlPropertyData *property(int) const;
260 QQmlPropertyData *method(int) const;
261 QStringList propertyNames() const;
263 inline QQmlPropertyData *overrideData(QQmlPropertyData *) const;
264 inline bool isAllowedInRevision(QQmlPropertyData *) const;
266 inline QQmlEngine *qmlEngine() const;
267 static QQmlPropertyData *property(QQmlEngine *, QObject *, const QString &,
269 static QQmlPropertyData *property(QQmlEngine *, QObject *, const QHashedV8String &,
271 static int *methodParameterTypes(QObject *, int index, QVarLengthArray<int, 9> &dummy,
272 QByteArray *unknownTypeError);
274 static bool isDynamicMetaObject(const QMetaObject *);
276 virtual void destroy();
277 virtual void clear();
280 friend class QQmlEnginePrivate;
281 friend class QV8QObjectWrapper;
283 inline QQmlPropertyCache *copy(int reserve);
285 // Implemented in v8/qv8qobjectwrapper.cpp
286 v8::Local<v8::Object> newQObject(QObject *, QV8Engine *);
288 typedef QVector<QQmlPropertyData> IndexCache;
289 typedef QStringHash<QQmlPropertyData *> StringCache;
290 typedef QVector<int> AllowedRevisionCache;
292 void resolve(QQmlPropertyData *) const;
293 void updateRecur(QQmlEngine *, const QMetaObject *);
297 QQmlPropertyCache *parent;
298 int propertyIndexCacheStart;
299 int methodIndexCacheStart;
300 int signalHanderIndexCacheStart;
302 IndexCache propertyIndexCache;
303 IndexCache methodIndexCache;
304 IndexCache signalHandlerIndexCache;
305 StringCache stringCache;
306 AllowedRevisionCache allowedRevisionCache;
307 v8::Persistent<v8::Function> constructor;
309 const QMetaObject *metaObject;
310 QQmlPropertyCacheMethodArguments *argumentsCache;
313 QQmlPropertyData::QQmlPropertyData()
318 overrideIndexIsProperty = false;
321 metaObjectOffset = -1;
325 QQmlPropertyData::QQmlPropertyData(const QQmlPropertyRawData &d)
327 *(static_cast<QQmlPropertyRawData *>(this)) = d;
330 bool QQmlPropertyData::operator==(const QQmlPropertyRawData &other)
332 return flags == other.flags &&
333 propType == other.propType &&
334 coreIndex == other.coreIndex &&
335 notifyIndex == other.notifyIndex &&
336 revision == other.revision &&
337 (!isValueTypeVirtual() ||
338 (valueTypeCoreIndex == other.valueTypeCoreIndex &&
339 valueTypePropType == other.valueTypePropType));
342 int QQmlPropertyRawData::getValueTypeCoreIndex() const
344 return isValueTypeVirtual()?valueTypeCoreIndex:-1;
347 int QQmlPropertyRawData::encodedIndex() const
349 return isValueTypeVirtual()?(coreIndex | (valueTypeCoreIndex << 24)):coreIndex;
353 QQmlPropertyCache::overrideData(QQmlPropertyData *data) const
355 if (!data->hasOverride())
358 if (data->overrideIndexIsProperty)
359 return property(data->overrideIndex);
361 return method(data->overrideIndex);
364 bool QQmlPropertyCache::isAllowedInRevision(QQmlPropertyData *data) const
366 return (data->hasAccessors() || (data->metaObjectOffset == -1 && data->revision == 0)) ||
367 (allowedRevisionCache[data->metaObjectOffset] >= data->revision);
370 QQmlEngine *QQmlPropertyCache::qmlEngine() const
375 QQmlPropertyData *QQmlPropertyCache::property(const QHashedV8String &str) const
377 QQmlPropertyData **rv = stringCache.value(str);
378 if (rv && (*rv)->notFullyResolved()) resolve(*rv);
384 #endif // QQMLPROPERTYCACHE_P_H