/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtCore module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include "qmetatype.h"

#include "qobjectdefs.h"

#include "qdatetime.h"

#include "qbytearray.h"

#include "qreadwritelock.h"

#include "qstring.h"

#include "qstringlist.h"

#include "qvector.h"

#include "qlocale.h"

#ifdef QT_BOOTSTRAPPED

# ifndef QT_NO_GEOM_VARIANT

#  define QT_NO_GEOM_VARIANT

# endif

#else

#  include "qbitarray.h"

#  include "qurl.h"

#  include "qvariant.h"

#endif

#ifndef QT_NO_GEOM_VARIANT

# include "qsize.h"

# include "qpoint.h"

# include "qrect.h"

# include "qline.h"

#endif

QT_BEGIN_NAMESPACE

#define NS(x) QT_PREPEND_NAMESPACE(x)

/*!

    \macro Q_DECLARE_METATYPE(Type)

    \relates QMetaType

    This macro makes the type \a Type known to QMetaType as long as it

    provides a public default constructor, a public copy constructor and

    a public destructor.

    It is needed to use the type \a Type as a custom type in QVariant.

    Ideally, this macro should be placed below the declaration of

    the class or struct. If that is not possible, it can be put in

    a private header file which has to be included every time that

    type is used in a QVariant.

    Adding a Q_DECLARE_METATYPE() makes the type known to all template

    based functions, including QVariant. Note that if you intend to

    use the type in \e queued signal and slot connections or in

    QObject's property system, you also have to call

    qRegisterMetaType() since the names are resolved at runtime.

    This example shows a typical use case of Q_DECLARE_METATYPE():

    \snippet doc/src/snippets/code/src_corelib_kernel_qmetatype.cpp 0

    If \c MyStruct is in a namespace, the Q_DECLARE_METATYPE() macro

    has to be outside the namespace:

    \snippet doc/src/snippets/code/src_corelib_kernel_qmetatype.cpp 1

    Since \c{MyStruct} is now known to QMetaType, it can be used in QVariant:

    \snippet doc/src/snippets/code/src_corelib_kernel_qmetatype.cpp 2

    \sa qRegisterMetaType()

*/

/*!

    \enum QMetaType::Type

    These are the built-in types supported by QMetaType:

    \value Void \c void

    \value Bool \c bool

    \value Int \c int

    \value UInt \c{unsigned int}

    \value Double \c double

    \value QChar QChar

    \value QString QString

    \value QByteArray QByteArray

    \value VoidStar \c{void *}

    \value Long \c{long}

    \value LongLong LongLong

    \value Short \c{short}

    \value Char \c{char}

    \value ULong \c{unsigned long}

    \value ULongLong ULongLong

    \value UShort \c{unsigned short}

    \value UChar \c{unsigned char}

    \value Float \c float

    \value QObjectStar QObject *

    \value QWidgetStar QWidget *

    \value QColorGroup QColorGroup

    \value QCursor QCursor

    \value QDate QDate

    \value QSize QSize

    \value QTime QTime

    \value QVariantList QVariantList

    \value QPolygon QPolygon

    \value QColor QColor

    \value QSizeF QSizeF

    \value QRectF QRectF

    \value QLine QLine

    \value QTextLength QTextLength

    \value QStringList QStringList

    \value QVariantMap QVariantMap

    \value QVariantHash QVariantHash

    \value QIcon QIcon

    \value QPen QPen

    \value QLineF QLineF

    \value QTextFormat QTextFormat

    \value QRect QRect

    \value QPoint QPoint

    \value QUrl QUrl

    \value QRegExp QRegExp

    \value QDateTime QDateTime

    \value QPointF QPointF

    \value QPalette QPalette

    \value QFont QFont

    \value QBrush QBrush

    \value QRegion QRegion

    \value QBitArray QBitArray

    \value QImage QImage

    \value QKeySequence QKeySequence

    \value QSizePolicy QSizePolicy

    \value QPixmap QPixmap

    \value QLocale QLocale

    \value QBitmap QBitmap

    \value QMatrix QMatrix

    \value QTransform QTransform

    \value QMatrix4x4 QMatrix4x4

    \value QVector2D QVector2D

    \value QVector3D QVector3D

    \value QVector4D QVector4D

    \value QQuaternion QQuaternion

    \value User  Base value for user types

    \omitvalue FirstCoreExtType

    \omitvalue FirstGuiType

    \omitvalue LastCoreExtType

    \omitvalue LastCoreType

    \omitvalue LastGuiType

    \omitvalue QReal

    Additional types can be registered using Q_DECLARE_METATYPE().

    \sa type(), typeName()

*/

/*!

    \class QMetaType

    \brief The QMetaType class manages named types in the meta-object system.

    \ingroup objectmodel

    \threadsafe

    The class is used as a helper to marshall types in QVariant and

    in queued signals and slots connections. It associates a type

    name to a type so that it can be created and destructed

    dynamically at run-time. Declare new types with Q_DECLARE_METATYPE()

    to make them available to QVariant and other template-based functions.

    Call qRegisterMetaType() to make type available to non-template based

    functions, such as the queued signal and slot connections.

    Any class or struct that has a public default

    constructor, a public copy constructor, and a public destructor

    can be registered.

    The following code allocates and destructs an instance of

    \c{MyClass}:

    \snippet doc/src/snippets/code/src_corelib_kernel_qmetatype.cpp 3

    If we want the stream operators \c operator<<() and \c

    operator>>() to work on QVariant objects that store custom types,

    the custom type must provide \c operator<<() and \c operator>>()

    operators.

    \sa Q_DECLARE_METATYPE(), QVariant::setValue(), QVariant::value(), QVariant::fromValue()

*/

/* Note: these MUST be in the order of the enums */

static const struct { const char * typeName; int type; } types[] = {

    /* All Core types */

    {"void", QMetaType::Void},

    {"bool", QMetaType::Bool},

    {"int", QMetaType::Int},

    {"uint", QMetaType::UInt},

    {"qlonglong", QMetaType::LongLong},

    {"qulonglong", QMetaType::ULongLong},

    {"double", QMetaType::Double},

    {"QChar", QMetaType::QChar},

    {"QVariantMap", QMetaType::QVariantMap},

    {"QVariantList", QMetaType::QVariantList},

    {"QString", QMetaType::QString},

    {"QStringList", QMetaType::QStringList},

    {"QByteArray", QMetaType::QByteArray},

    {"QBitArray", QMetaType::QBitArray},

    {"QDate", QMetaType::QDate},

    {"QTime", QMetaType::QTime},

    {"QDateTime", QMetaType::QDateTime},

    {"QUrl", QMetaType::QUrl},

    {"QLocale", QMetaType::QLocale},

    {"QRect", QMetaType::QRect},

    {"QRectF", QMetaType::QRectF},

    {"QSize", QMetaType::QSize},

    {"QSizeF", QMetaType::QSizeF},

    {"QLine", QMetaType::QLine},

    {"QLineF", QMetaType::QLineF},

    {"QPoint", QMetaType::QPoint},

    {"QPointF", QMetaType::QPointF},

    {"QRegExp", QMetaType::QRegExp},

    {"QVariantHash", QMetaType::QVariantHash},

    /* All GUI types */

    {"QColorGroup", 63},

    {"QFont", QMetaType::QFont},

    {"QPixmap", QMetaType::QPixmap},

    {"QBrush", QMetaType::QBrush},

    {"QColor", QMetaType::QColor},

    {"QPalette", QMetaType::QPalette},

    {"QIcon", QMetaType::QIcon},

    {"QImage", QMetaType::QImage},

    {"QPolygon", QMetaType::QPolygon},

    {"QRegion", QMetaType::QRegion},

    {"QBitmap", QMetaType::QBitmap},

    {"QCursor", QMetaType::QCursor},

    {"QSizePolicy", QMetaType::QSizePolicy},

    {"QKeySequence", QMetaType::QKeySequence},

    {"QPen", QMetaType::QPen},

    {"QTextLength", QMetaType::QTextLength},

    {"QTextFormat", QMetaType::QTextFormat},

    {"QMatrix", QMetaType::QMatrix},

    {"QTransform", QMetaType::QTransform},

    {"QMatrix4x4", QMetaType::QMatrix4x4},

    {"QVector2D", QMetaType::QVector2D},

    {"QVector3D", QMetaType::QVector3D},

    {"QVector4D", QMetaType::QVector4D},

    {"QQuaternion", QMetaType::QQuaternion},

    /* All Metatype builtins */

    {"void*", QMetaType::VoidStar},

    {"long", QMetaType::Long},

    {"short", QMetaType::Short},

    {"char", QMetaType::Char},

    {"ulong", QMetaType::ULong},

    {"ushort", QMetaType::UShort},

    {"uchar", QMetaType::UChar},

    {"float", QMetaType::Float},

    {"QObject*", QMetaType::QObjectStar},

    {"QWidget*", QMetaType::QWidgetStar},

    /* Type aliases - order doesn't matter */

    {"unsigned long", QMetaType::ULong},

    {"unsigned int", QMetaType::UInt},

    {"unsigned short", QMetaType::UShort},

    {"unsigned char", QMetaType::UChar},

    {"long long", QMetaType::LongLong},

    {"unsigned long long", QMetaType::ULongLong},

    {"qint8", QMetaType::Char},

    {"quint8", QMetaType::UChar},

    {"qint16", QMetaType::Short},

    {"quint16", QMetaType::UShort},

    {"qint32", QMetaType::Int},

    {"quint32", QMetaType::UInt},

    {"qint64", QMetaType::LongLong},

    {"quint64", QMetaType::ULongLong},

    {"QList<QVariant>", QMetaType::QVariantList},

    {"QMap<QString,QVariant>", QMetaType::QVariantMap},

    {"QHash<QString,QVariant>", QMetaType::QVariantHash},

    // let QMetaTypeId2 figure out the type at compile time

    {"qreal", QMetaTypeId2<qreal>::MetaType},

    {0, QMetaType::Void}

};

struct QMetaTypeGuiHelper

{

    QMetaType::Constructor constr;

    QMetaType::Destructor destr;

#ifndef QT_NO_DATASTREAM

    QMetaType::SaveOperator saveOp;

    QMetaType::LoadOperator loadOp;

#endif

};

Q_CORE_EXPORT const QMetaTypeGuiHelper *qMetaTypeGuiHelper = 0;

class QCustomTypeInfo

{

public:

    QCustomTypeInfo() : typeName(), constr(0), destr(0)

#ifndef QT_NO_DATASTREAM

    , saveOp(0), loadOp(0)

#endif

    {}

    QByteArray typeName;

    QMetaType::Constructor constr;

    QMetaType::Destructor destr;

#ifndef QT_NO_DATASTREAM

    QMetaType::SaveOperator saveOp;

    QMetaType::LoadOperator loadOp;

#endif

};

Q_DECLARE_TYPEINFO(QCustomTypeInfo, Q_MOVABLE_TYPE);

Q_GLOBAL_STATIC(QVector<QCustomTypeInfo>, customTypes)

Q_GLOBAL_STATIC(QReadWriteLock, customTypesLock)

#ifndef QT_NO_DATASTREAM

/*! \internal

*/

void QMetaType::registerStreamOperators(const char *typeName, SaveOperator saveOp,

                                        LoadOperator loadOp)

{

    int idx = type(typeName);

    if (!idx)

        return;

    QVector<QCustomTypeInfo> *ct = customTypes();

    if (!ct)

        return;

    QWriteLocker locker(customTypesLock());

    QCustomTypeInfo &inf = (*ct)[idx - User];

    inf.saveOp = saveOp;

    inf.loadOp = loadOp;

}

#endif // QT_NO_DATASTREAM

/*!

    Returns the type name associated with the given \a type, or 0 if no

    matching type was found. The returned pointer must not be deleted.

    \sa type(), isRegistered(), Type

*/

const char *QMetaType::typeName(int type)

{

    enum { GuiTypeCount = LastGuiType - FirstGuiType };

    if (type >= 0 && type <= LastCoreType) {

        return types[type].typeName;

    } else if (type >= FirstGuiType && type <= LastGuiType) {

        return types[type - FirstGuiType + LastCoreType + 1].typeName;

    } else if (type >= FirstCoreExtType && type <= LastCoreExtType) {

        return types[type - FirstCoreExtType + GuiTypeCount + LastCoreType + 2].typeName;

    } else if (type >= User) {

        const QVector<QCustomTypeInfo> * const ct = customTypes();

        QReadLocker locker(customTypesLock());

        return ct && ct->count() > type - User && !ct->at(type - User).typeName.isEmpty()

                ? ct->at(type - User).typeName.constData()

                : static_cast<const char *>(0);

    }

    return 0;

}

/*! \internal

    Same as QMetaType::type(), but doesn't lock the mutex.

*/

static int qMetaTypeType_unlocked(const QByteArray &typeName)

{

    int i = 0;

    while (types[i].typeName && strcmp(typeName.constData(), types[i].typeName))

        ++i;

    if (!types[i].type) {

        const QVector<QCustomTypeInfo> * const ct = customTypes();

        if (!ct)

            return 0;

        for (int v = 0; v < ct->count(); ++v) {

            if (ct->at(v).typeName == typeName)

                return v + QMetaType::User;

        }

    }

    return types[i].type;

}

/*! \internal

    Registers a user type for marshalling, with \a typeName, a \a

    destructor, and a \a constructor. Returns the type's handle,

    or -1 if the type could not be registered.

 */

int QMetaType::registerType(const char *typeName, Destructor destructor,

                            Constructor constructor)

{

    QVector<QCustomTypeInfo> *ct = customTypes();

    if (!ct || !typeName || !destructor || !constructor)

        return -1;

#ifdef QT_NO_QOBJECT

    NS(QByteArray) normalizedTypeName = typeName;

#else

    NS(QByteArray) normalizedTypeName = QMetaObject::normalizedType(typeName);

#endif

    QWriteLocker locker(customTypesLock());

    int idx = qMetaTypeType_unlocked(normalizedTypeName);

    if (!idx) {

        QCustomTypeInfo inf;

        inf.typeName = normalizedTypeName;

        inf.constr = constructor;

        inf.destr = destructor;

        idx = ct->size() + User;

        ct->append(inf);

    }

    return idx;

}

/*!

    \since 4.4

    Unregisters a user type, with \a typeName.

    \sa type(), typeName()

 */

void QMetaType::unregisterType(const char *typeName)

{

    QVector<QCustomTypeInfo> *ct = customTypes();

    if (!ct || !typeName)

        return;

#ifdef QT_NO_QOBJECT

    NS(QByteArray) normalizedTypeName = typeName;

#else

    NS(QByteArray) normalizedTypeName = QMetaObject::normalizedType(typeName);

#endif

    QWriteLocker locker(customTypesLock());

    for (int v = 0; v < ct->count(); ++v) {

        if (ct->at(v).typeName == typeName) {

            QCustomTypeInfo &inf = (*ct)[v];

            inf.typeName.clear();

            inf.constr = 0;

            inf.destr = 0;

        }

    }

}

/*!

    Returns true if the datatype with ID \a type is registered;

    otherwise returns false.

    \sa type(), typeName(), Type

*/

bool QMetaType::isRegistered(int type)

{

    if (type >= 0 && type < User) {

        // predefined type

        return true;

    }

    QReadLocker locker(customTypesLock());

    const QVector<QCustomTypeInfo> * const ct = customTypes();

    return ((type >= User) && (ct && ct->count() > type - User) && !ct->at(type - User).typeName.isEmpty());

}

/*!

    Returns a handle to the type called \a typeName, or 0 if there is

    no such type.

    \sa isRegistered(), typeName(), Type

*/

int QMetaType::type(const char *typeName)

{

#ifdef QT_NO_QOBJECT

    const NS(QByteArray) normalizedTypeName = typeName;

#else

    const NS(QByteArray) normalizedTypeName = QMetaObject::normalizedType(typeName);

#endif

    QReadLocker locker(customTypesLock());

    return qMetaTypeType_unlocked(normalizedTypeName);

}

#ifndef QT_NO_DATASTREAM

/*!

    Writes the object pointed to by \a data with the ID \a type to

    the given \a stream. Returns true if the object is saved

    successfully; otherwise returns false.

    The type must have been registered with qRegisterMetaType() and

    qRegisterMetaTypeStreamOperators() beforehand.