Add support for unregistering of custom meta types.

This patch addresses a specific Qml problem, where the meta types list
will grow indefinitely when unloading and reloading Qml components over
and over (in an failed effort to save memory).

The implementation is not specific to Qml though, but will cater to all
use-cases where registered types may not live until the application's
termination.

Change-Id: Ic0224dcd19aeb559715ef088b22a30509be2456b
Reviewed-by: Simon Hausmann <simon.hausmann@theqtcompany.com>
This commit is contained in:
Robert Griebl 2015-03-24 22:20:48 +01:00
parent 472216da2d
commit 91dfab223a
3 changed files with 106 additions and 6 deletions

View File

@ -872,13 +872,17 @@ static inline int qMetaTypeStaticType(const char *typeName, int length)
\internal
Similar to QMetaType::type(), but only looks in the custom set of
types, and doesn't lock the mutex.
The extra \a firstInvalidIndex parameter is an easy way to avoid
iterating over customTypes() a second time in registerNormalizedType().
*/
static int qMetaTypeCustomType_unlocked(const char *typeName, int length)
static int qMetaTypeCustomType_unlocked(const char *typeName, int length, int *firstInvalidIndex = 0)
{
const QVector<QCustomTypeInfo> * const ct = customTypes();
if (!ct)
return QMetaType::UnknownType;
if (firstInvalidIndex)
*firstInvalidIndex = -1;
for (int v = 0; v < ct->count(); ++v) {
const QCustomTypeInfo &customInfo = ct->at(v);
if ((length == customInfo.typeName.size())
@ -887,6 +891,8 @@ static int qMetaTypeCustomType_unlocked(const char *typeName, int length)
return customInfo.alias;
return v + QMetaType::User;
}
if (firstInvalidIndex && (*firstInvalidIndex < 0) && customInfo.typeName.isEmpty())
*firstInvalidIndex = v;
}
return QMetaType::UnknownType;
}
@ -905,6 +911,39 @@ int QMetaType::registerType(const char *typeName, Deleter deleter,
QtMetaTypePrivate::QMetaTypeFunctionHelper<void>::Construct, 0, TypeFlags(), 0);
}
/*!
\internal
\since 5.5
Unregisters the user type with the given \a typeId and all its aliases.
Returns \c true if the type was unregistered or \c false otherwise.
This function was added for QML to be able to deregister types after
they are unloaded to prevent an infinite increase in custom types for
applications that are unloading/reloading components often.
*/
bool QMetaType::unregisterType(int type)
{
QWriteLocker locker(customTypesLock());
QVector<QCustomTypeInfo> *ct = customTypes();
// check if user type
if ((type < User) || ((type - User) >= ct->size()))
return false;
// only types without Q_DECLARE_METATYPE can be unregistered
if (ct->data()[type - User].flags & WasDeclaredAsMetaType)
return false;
// invalidate type and all its alias entries
for (int v = 0; v < ct->count(); ++v) {
if (((v + User) == type) || (ct->at(v).alias == type))
ct->data()[v].typeName.clear();
}
return true;
}
/*!
\internal
\since 5.0
@ -977,8 +1016,10 @@ int QMetaType::registerNormalizedType(const NS(QByteArray) &normalizedTypeName,
int previousFlags = 0;
if (idx == UnknownType) {
QWriteLocker locker(customTypesLock());
int posInVector = -1;
idx = qMetaTypeCustomType_unlocked(normalizedTypeName.constData(),
normalizedTypeName.size());
normalizedTypeName.size(),
&posInVector);
if (idx == UnknownType) {
QCustomTypeInfo inf;
inf.typeName = normalizedTypeName;
@ -992,8 +1033,13 @@ int QMetaType::registerNormalizedType(const NS(QByteArray) &normalizedTypeName,
inf.size = size;
inf.flags = flags;
inf.metaObject = metaObject;
if (posInVector == -1) {
idx = ct->size() + User;
ct->append(inf);
} else {
idx = posInVector + User;
ct->data()[posInVector] = inf;
}
return idx;
}
@ -1075,14 +1121,19 @@ int QMetaType::registerNormalizedTypedef(const NS(QByteArray) &normalizedTypeNam
if (idx == UnknownType) {
QWriteLocker locker(customTypesLock());
int posInVector = -1;
idx = qMetaTypeCustomType_unlocked(normalizedTypeName.constData(),
normalizedTypeName.size());
normalizedTypeName.size(),
&posInVector);
if (idx == UnknownType) {
QCustomTypeInfo inf;
inf.typeName = normalizedTypeName;
inf.alias = aliasId;
if (posInVector == -1)
ct->append(inf);
else
ct->data()[posInVector] = inf;
return aliasId;
}
}

View File

@ -484,6 +484,7 @@ public:
int size,
QMetaType::TypeFlags flags,
const QMetaObject *metaObject);
static bool unregisterType(int type);
static int registerNormalizedType(const QT_PREPEND_NAMESPACE(QByteArray) &normalizedTypeName, Deleter deleter,
Creator creator,
Destructor destructor,

View File

@ -1254,6 +1254,54 @@ void tst_QMetaType::registerType()
QCOMPARE(qRegisterMetaType<MyFoo>("MyFoo"), fooId);
QCOMPARE(QMetaType::type("MyFoo"), fooId);
// cannot unregister built-in types
QVERIFY(!QMetaType::unregisterType(QMetaType::QString));
QCOMPARE(QMetaType::type("QString"), int(QMetaType::QString));
QCOMPARE(QMetaType::type("MyString"), int(QMetaType::QString));
// cannot unregister declared types
QVERIFY(!QMetaType::unregisterType(fooId));
QCOMPARE(QMetaType::type("TestSpace::Foo"), fooId);
QCOMPARE(QMetaType::type("MyFoo"), fooId);
// test unregistration of dynamic types (used by Qml)
int unregId = QMetaType::registerType("UnregisterMe",
0,
0,
QtMetaTypePrivate::QMetaTypeFunctionHelper<void>::Destruct,
QtMetaTypePrivate::QMetaTypeFunctionHelper<void>::Construct,
0, QMetaType::TypeFlags(), 0);
QCOMPARE(QMetaType::registerTypedef("UnregisterMeTypedef", unregId), unregId);
int unregId2 = QMetaType::registerType("UnregisterMe2",
0,
0,
QtMetaTypePrivate::QMetaTypeFunctionHelper<void>::Destruct,
QtMetaTypePrivate::QMetaTypeFunctionHelper<void>::Construct,
0, QMetaType::TypeFlags(), 0);
QVERIFY(unregId >= int(QMetaType::User));
QCOMPARE(unregId2, unregId + 2);
QVERIFY(QMetaType::unregisterType(unregId));
QCOMPARE(QMetaType::type("UnregisterMe"), 0);
QCOMPARE(QMetaType::type("UnregisterMeTypedef"), 0);
QCOMPARE(QMetaType::type("UnregisterMe2"), unregId2);
QVERIFY(QMetaType::unregisterType(unregId2));
QCOMPARE(QMetaType::type("UnregisterMe2"), 0);
// re-registering should always return the lowest free index
QCOMPARE(QMetaType::registerType("UnregisterMe2",
0,
0,
QtMetaTypePrivate::QMetaTypeFunctionHelper<void>::Destruct,
QtMetaTypePrivate::QMetaTypeFunctionHelper<void>::Construct,
0, QMetaType::TypeFlags(), 0), unregId);
QCOMPARE(QMetaType::registerType("UnregisterMe",
0,
0,
QtMetaTypePrivate::QMetaTypeFunctionHelper<void>::Destruct,
QtMetaTypePrivate::QMetaTypeFunctionHelper<void>::Construct,
0, QMetaType::TypeFlags(), 0), unregId + 1);
}
class IsRegisteredDummyType { };