src/declarative/qml/qdeclarativeerror.cpp
branchGCC_SURGE
changeset 31 5daf16870df6
parent 30 5dc02b23752f
child 37 758a864f9613
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/declarative/qml/qdeclarativeerror.cpp	Thu Jul 22 16:41:55 2010 +0100
@@ -0,0 +1,283 @@
+/****************************************************************************
+**
+** 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 QtDeclarative 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 "qdeclarativeerror.h"
+
+#include <QtCore/qdebug.h>
+#include <QtCore/qfile.h>
+#include <QtCore/qstringlist.h>
+
+QT_BEGIN_NAMESPACE
+
+/*!
+    \class QDeclarativeError
+    \since 4.7
+    \brief The QDeclarativeError class encapsulates a QML error.
+
+    QDeclarativeError includes a textual description of the error, as well
+    as location information (the file, line, and column). The toString()
+    method creates a single-line, human-readable string containing all of
+    this information, for example:
+    \code
+    file:///home/user/test.qml:7:8: Invalid property assignment: double expected
+    \endcode
+
+    You can use qDebug() or qWarning() to output errors to the console. This method
+    will attempt to open the file indicated by the error
+    and include additional contextual information.
+    \code
+    file:///home/user/test.qml:7:8: Invalid property assignment: double expected
+            y: "hello"
+               ^
+    \endcode
+
+    \sa QDeclarativeView::errors(), QDeclarativeComponent::errors()
+*/
+class QDeclarativeErrorPrivate
+{
+public:
+    QDeclarativeErrorPrivate();
+
+    QUrl url;
+    QString description;
+    int line;
+    int column;
+};
+
+QDeclarativeErrorPrivate::QDeclarativeErrorPrivate()
+: line(-1), column(-1)
+{
+}
+
+/*!
+    Creates an empty error object.
+*/
+QDeclarativeError::QDeclarativeError()
+: d(0)
+{
+}
+
+/*!
+    Creates a copy of \a other.
+*/
+QDeclarativeError::QDeclarativeError(const QDeclarativeError &other)
+: d(0)
+{
+    *this = other;
+}
+
+/*!
+    Assigns \a other to this error object.
+*/
+QDeclarativeError &QDeclarativeError::operator=(const QDeclarativeError &other)
+{
+    if (!other.d) {
+        delete d;
+        d = 0;
+    } else {
+        if (!d) d = new QDeclarativeErrorPrivate;
+        d->url = other.d->url;
+        d->description = other.d->description;
+        d->line = other.d->line;
+        d->column = other.d->column;
+    }
+    return *this;
+}
+
+/*!
+    \internal 
+*/
+QDeclarativeError::~QDeclarativeError()
+{
+    delete d; d = 0;
+}
+
+/*!
+    Returns true if this error is valid, otherwise false.
+*/
+bool QDeclarativeError::isValid() const
+{
+    return d != 0;
+}
+
+/*!
+    Returns the url for the file that caused this error.
+*/
+QUrl QDeclarativeError::url() const
+{
+    if (d) return d->url;
+    else return QUrl();
+}
+
+/*!
+    Sets the \a url for the file that caused this error.
+*/
+void QDeclarativeError::setUrl(const QUrl &url)
+{
+    if (!d) d = new QDeclarativeErrorPrivate;
+    d->url = url;
+}
+
+/*!
+    Returns the error description.
+*/
+QString QDeclarativeError::description() const
+{
+    if (d) return d->description;
+    else return QString();
+}
+
+/*!
+    Sets the error \a description.
+*/
+void QDeclarativeError::setDescription(const QString &description)
+{
+    if (!d) d = new QDeclarativeErrorPrivate;
+    d->description = description;
+}
+
+/*!
+    Returns the error line number.
+*/
+int QDeclarativeError::line() const
+{
+    if (d) return d->line;
+    else return -1;
+}
+
+/*!
+    Sets the error \a line number.
+*/
+void QDeclarativeError::setLine(int line)
+{
+    if (!d) d = new QDeclarativeErrorPrivate;
+    d->line = line;
+}
+
+/*!
+    Returns the error column number.
+*/
+int QDeclarativeError::column() const
+{
+    if (d) return d->column;
+    else return -1;
+}
+
+/*!
+    Sets the error \a column number.
+*/
+void QDeclarativeError::setColumn(int column)
+{
+    if (!d) d = new QDeclarativeErrorPrivate;
+    d->column = column;
+}
+
+/*!
+    Returns the error as a human readable string.
+*/
+QString QDeclarativeError::toString() const
+{
+    QString rv;
+    if (url().isEmpty()) {
+        rv = QLatin1String("<Unknown File>");
+    } else if (line() != -1) {
+        rv = url().toString() + QLatin1Char(':') + QString::number(line());
+        if(column() != -1) 
+            rv += QLatin1Char(':') + QString::number(column());
+    } else {
+        rv = url().toString();
+    }
+
+    rv += QLatin1String(": ") + description();
+
+    return rv;
+}
+
+/*!
+    \relates QDeclarativeError
+    \fn QDebug operator<<(QDebug debug, const QDeclarativeError &error)
+
+    Outputs a human readable version of \a error to \a debug.
+*/
+
+QDebug operator<<(QDebug debug, const QDeclarativeError &error)
+{
+    debug << qPrintable(error.toString());
+
+    QUrl url = error.url();
+
+    if (error.line() > 0 && url.scheme() == QLatin1String("file")) {
+        QString file = url.toLocalFile();
+        QFile f(file);
+        if (f.open(QIODevice::ReadOnly)) {
+            QByteArray data = f.readAll();
+            QTextStream stream(data, QIODevice::ReadOnly);
+            stream.setCodec("UTF-8");
+            const QString code = stream.readAll();
+            const QStringList lines = code.split(QLatin1Char('\n'));
+
+            if (lines.count() >= error.line()) {
+                const QString &line = lines.at(error.line() - 1);
+                debug << "\n    " << qPrintable(line);
+
+                if(error.column() > 0) {
+                    int column = qMax(0, error.column() - 1);
+                    column = qMin(column, line.length()); 
+
+                    QByteArray ind;
+                    ind.reserve(column);
+                    for (int i = 0; i < column; ++i) {
+                        const QChar ch = line.at(i);
+                        if (ch.isSpace())
+                            ind.append(ch.unicode());
+                        else
+                            ind.append(' ');
+                    }
+                    ind.append('^');
+                    debug << "\n    " << ind.constData();
+                }
+            }
+        }
+    }
+    return debug;
+}
+
+QT_END_NAMESPACE