qqmlerror.cpp

Go to the documentation of this file.

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
#include "qqmlerror.h"
#include "qqmlfile.h"
#include <private/qqmljsdiagnosticmessage_p.h>
 
#include <QtCore/qdebug.h>
#include <QtCore/qfile.h>
#include <QtCore/qstringlist.h>
#include <QtCore/qvector.h>
 
#include <QtCore/qobject.h>
#include <QtCore/qpointer.h>
 
QT_BEGIN_NAMESPACE
 
class QQmlErrorPrivate
{
public:
    QUrl url;
    QPointer<QObject> object;
    QString message;
    QtMsgType type = QtWarningMsg;
    int line = -1;
    int column = -1;
 
    friend bool operator==(const QQmlErrorPrivate &a, const QQmlErrorPrivate &b)
    {
        return a.url == b.url && a.object == b.object && a.message == b.message
                && a.type == b.type && a.line == b.line && a.column == b.column;
    }
};
 
QQmlError::QQmlError()
: d(nullptr)
{
}
 
QQmlError::QQmlError(const QQmlError &other)
: d(nullptr)
{
    *this = other;
}
 
QQmlError &QQmlError::operator=(const QQmlError &other)
{
    if (!other.d) {
        delete d;
        d = nullptr;
    } else {
        if (!d)
            d = new QQmlErrorPrivate;
        d->url = other.d->url;
        d->message = other.d->message;
        d->line = other.d->line;
        d->column = other.d->column;
        d->object = other.d->object;
        d->type = other.d->type;
    }
    return *this;
}
 
QQmlError::~QQmlError()
{
    delete d; d = nullptr;
}
 
bool QQmlError::isValid() const
{
    return d != nullptr;
}
 
QUrl QQmlError::url() const
{
    if (d)
        return d->url;
    return QUrl();
}
 
void QQmlError::setUrl(const QUrl &url)
{
    if (!d)
        d = new QQmlErrorPrivate;
    d->url = url;
}
 
QString QQmlError::description() const
{
    if (d)
        return d->message;
    return QString();
}
 
void QQmlError::setDescription(const QString &description)
{
    if (!d)
        d = new QQmlErrorPrivate;
    d->message = description;
}
 
int QQmlError::line() const
{
    if (d)
        return d->line;
    return -1;
}
 
void QQmlError::setLine(int line)
{
    if (!d)
        d = new QQmlErrorPrivate;
    d->line = line;
}
 
int QQmlError::column() const
{
    if (d)
        return d->column;
    return -1;
}
 
void QQmlError::setColumn(int column)
{
    if (!d)
        d = new QQmlErrorPrivate;
    d->column = column;
}
 
QObject *QQmlError::object() const
{
    if (d)
        return d->object;
    return nullptr;
}
 
void QQmlError::setObject(QObject *object)
{
    if (!d)
        d = new QQmlErrorPrivate;
    d->object = object;
}
 
QtMsgType QQmlError::messageType() const
{
    if (d)
        return d->type;
    return QtMsgType::QtWarningMsg;
}
 
void QQmlError::setMessageType(QtMsgType messageType)
{
    if (!d)
        d = new QQmlErrorPrivate;
    d->type = messageType;
}
 
QString QQmlError::toString() const
{
    QString rv;
 
    QUrl u(url());
    int l(line());
 
    if (u.isEmpty() || (u.isLocalFile() && u.path().isEmpty()))
        rv += QLatin1String("<Unknown File>");
    else
        rv += u.toString();
 
    if (l != -1) {
        rv += QLatin1Char(':') + QString::number(l);
 
        int c(column());
        if (c != -1)
            rv += QLatin1Char(':') + QString::number(c);
    }
 
    rv += QLatin1String(": ") + description();
 
    return rv;
}
 
bool operator==(const QQmlError &a, const QQmlError &b)
{
    return a.d == b.d || (a.d && b.d && *a.d == *b.d);
}
 
QDebug operator<<(QDebug debug, const QQmlError &error)
{
    debug << qPrintable(error.toString());
 
    QUrl url = error.url();
 
    if (error.line() > 0 && (url.scheme() == QLatin1String("file") || url.scheme() == QLatin1String("qrc"))) {
        QString file = QQmlFile::urlToLocalFileOrQrc(url);
        QFile f(file);
        if (f.open(QIODevice::ReadOnly)) {
            QByteArray data = f.readAll();
            QTextStream stream(data, QIODevice::ReadOnly);
            const QString code = stream.readAll();
            const auto lines = QStringView{code}.split(QLatin1Char('\n'));
 
            if (lines.size() >= error.line()) {
                const QStringView &line = lines.at(error.line() - 1);
                debug << "\n    " << line.toLocal8Bit().constData();
 
                if(error.column() > 0) {
                    int column = qMax(0, error.column() - 1);
                    column = qMin(column, line.size());
 
                    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