src/declarative/qml/qdeclarativeinfo.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qdeclarativeinfo.h"
  43
  44 #include "qdeclarativedata_p.h"
  45 #include "qdeclarativecontext.h"
  46 #include "qdeclarativecontext_p.h"
  47 #include "qdeclarativemetatype_p.h"
  48 #include "qdeclarativeengine_p.h"
  49
  50 #include <QCoreApplication>
  51
  52 QT_BEGIN_NAMESPACE
  53
  54 /*!
  55     \fn QDeclarativeInfo qmlInfo(const QObject *object)
  56     \relates QDeclarativeEngine
  57
  58     Prints warning messages that include the file and line number for the
  59     specified QML \a object.
  60
  61     When QML types display warning messages, it improves traceability
  62     if they include the QML file and line number on which the
  63     particular instance was instantiated.
  64
  65     To include the file and line number, an object must be passed.  If
  66     the file and line number is not available for that instance
  67     (either it was not instantiated by the QML engine or location
  68     information is disabled), "unknown location" will be used instead.
  69
  70     For example,
  71
  72     \code
  73     qmlInfo(object) << tr("component property is a write-once property");
  74     \endcode
  75
  76     prints
  77
  78     \code
  79     QML MyCustomType (unknown location): component property is a write-once property
  80     \endcode
  81 */
  82
  83 class QDeclarativeInfoPrivate
  84 {
  85 public:
  86     QDeclarativeInfoPrivate() : ref (1), object(0) {}
  87
  88     int ref;
  89     const QObject *object;
  90     QString buffer;
  91     QList<QDeclarativeError> errors;
  92 };
  93
  94 QDeclarativeInfo::QDeclarativeInfo(QDeclarativeInfoPrivate *p)
  95 : QDebug(&p->buffer), d(p)
  96 {
  97     nospace();
  98 }
  99
 100 QDeclarativeInfo::QDeclarativeInfo(const QDeclarativeInfo &other)
 101 : QDebug(other), d(other.d)
 102 {
 103     d->ref++;
 104 }
 105
 106 QDeclarativeInfo::~QDeclarativeInfo()
 107 {
 108     if (0 == --d->ref) {
 109         QList<QDeclarativeError> errors = d->errors;
 110
 111         QDeclarativeEngine *engine = 0;
 112
 113         if (!d->buffer.isEmpty()) {
 114             QDeclarativeError error;
 115
 116             QObject *object = const_cast<QObject *>(d->object);
 117
 118             if (object) {
 119                 engine = qmlEngine(d->object);
 120                 QString typeName;
 121                 QDeclarativeType *type = QDeclarativeMetaType::qmlType(object->metaObject());
 122                 if (type) {
 123                     typeName = type->qmlTypeName();
 124                     int lastSlash = typeName.lastIndexOf(QLatin1Char('/'));
 125                     if (lastSlash != -1)
 126                         typeName = typeName.mid(lastSlash+1);
 127                 } else {
 128                     typeName = QString::fromUtf8(object->metaObject()->className());
 129                     int marker = typeName.indexOf(QLatin1String("_QMLTYPE_"));
 130                     if (marker != -1)
 131                         typeName = typeName.left(marker);
 132
 133                     marker = typeName.indexOf(QLatin1String("_QML_"));
 134                     if (marker != -1) {
 135                         typeName = typeName.left(marker);
 136                         typeName += QLatin1Char('*');
 137                         type = QDeclarativeMetaType::qmlType(QMetaType::type(typeName.toLatin1()));
 138                         if (type) {
 139                             typeName = type->qmlTypeName();
 140                             int lastSlash = typeName.lastIndexOf(QLatin1Char('/'));
 141                             if (lastSlash != -1)
 142                                 typeName = typeName.mid(lastSlash+1);
 143                         }
 144                     }
 145                 }
 146
 147                 d->buffer.prepend(QLatin1String("QML ") + typeName + QLatin1String(": "));
 148
 149                 QDeclarativeData *ddata = QDeclarativeData::get(object, false);
 150                 if (ddata && ddata->outerContext && !ddata->outerContext->url.isEmpty()) {
 151                     error.setUrl(ddata->outerContext->url);
 152                     error.setLine(ddata->lineNumber);
 153                     error.setColumn(ddata->columnNumber);
 154                 }
 155             }
 156
 157             error.setDescription(d->buffer);
 158
 159             errors.prepend(error);
 160         }
 161
 162         QDeclarativeEnginePrivate::warning(engine, errors);
 163
 164         delete d;
 165     }
 166 }
 167
 168 QDeclarativeInfo qmlInfo(const QObject *me)
 169 {
 170     QDeclarativeInfoPrivate *d = new QDeclarativeInfoPrivate;
 171     d->object = me;
 172     return QDeclarativeInfo(d);
 173 }
 174
 175 QDeclarativeInfo qmlInfo(const QObject *me, const QDeclarativeError &error)
 176 {
 177     QDeclarativeInfoPrivate *d = new QDeclarativeInfoPrivate;
 178     d->object = me;
 179     d->errors << error;
 180     return QDeclarativeInfo(d);
 181 }
 182
 183 QDeclarativeInfo qmlInfo(const QObject *me, const QList<QDeclarativeError> &errors)
 184 {
 185     QDeclarativeInfoPrivate *d = new QDeclarativeInfoPrivate;
 186     d->object = me;
 187     d->errors = errors;
 188     return QDeclarativeInfo(d);
 189 }
 190
 191
 192 QT_END_NAMESPACE