diff options
Diffstat (limited to 'src/qmldom/qqmldomstringdumper.cpp')
| -rw-r--r-- | src/qmldom/qqmldomstringdumper.cpp | 238 |
1 files changed, 238 insertions, 0 deletions
diff --git a/src/qmldom/qqmldomstringdumper.cpp b/src/qmldom/qqmldomstringdumper.cpp new file mode 100644 index 0000000000..1788d79d3d --- /dev/null +++ b/src/qmldom/qqmldomstringdumper.cpp @@ -0,0 +1,238 @@ +/**************************************************************************** +** +** Copyright (C) 2020 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the QtQml module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 3 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL3 included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 3 requirements +** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 2.0 or (at your option) the GNU General +** Public license version 3 or any later version approved by the KDE Free +** Qt Foundation. The licenses are as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-2.0.html and +** https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +**/ +#include "qqmldomstringdumper_p.h" +#include <QtCore/QDebug> + +QT_BEGIN_NAMESPACE + +namespace QQmlJS { +namespace Dom { + +/*! + * \internal + * \tn QQmlJS::Dom::Sink + * \brief A Sink is a function that accepts a QStringView as input + * + * A Sink it the core element of a text based stream oriented output. + * It is simply a function accepting a QStringView as input. + */ + +/*! + * \internal + * \tn QQmlJS::Dom::sinkInt + * \brief writes an integer to a sink without any axtra heap allocation + * \param sink where to write + * \param i the integer to write out + * + * mainly for debugging/fatal errors + */ + +/*! + * \internal + * \class QQmlJS::Dom::Dumper + * \brief Helper class to accept eithe a string or a dumper (a function that writes to a sink) + * + * Using a Dumper as input parameter one always obtains a dumper (i.e. a + * std::function<void(std::function<void(QStringView)>)> , but can pass in any + * object accepted by QStringView, and it is automatically converted to a dumper. + */ + +/*! + * \internal + * \brief Converts a dumper to a string + * \param writer The dumper convert to a string + */ +QString dumperToString(Dumper writer) +{ + QString s; + QTextStream d(&s); + writer([&d](QStringView s){ d << s; }); + d.flush(); + return s; +} + +/*! + * \internal + * \brief dumps a string as quoted string (escaping things like quotes or newlines) + * \param sink The sink to write the quoted string to + * \param s The string to sink + * \param options If quotes should be outputted around the string (defaults to yes) + */ +void sinkEscaped(Sink sink, QStringView s, EscapeOptions options) { + if (options == EscapeOptions::OuterQuotes) + sink(u"\""); + int it0=0; + for (int it = 0; it < s.length();++it) { + QChar c=s[it]; + bool noslash = c != QLatin1Char('\\'); + bool noquote = c != QLatin1Char('"'); + bool nonewline = c != QLatin1Char('\n'); + bool noreturn = c != QLatin1Char('\r'); + if (noslash && noquote && nonewline && noreturn) + continue; + sink(s.mid(it0, it - it0)); + it0 = it + 1; + if (!noslash) + sink(u"\\\\"); + else if (!noquote) + sink(u"\\\""); + else if (!nonewline) + sink(u"\\n"); + else if (!noreturn) + sink(u"\\r"); + else + Q_ASSERT(0); + } + sink(s.mid(it0, s.length() - it0)); + if (options == EscapeOptions::OuterQuotes) + sink(u"\""); +} + +/*! + * \internal + * \brief Dumps a string describing the given error level (ErrorLevel::Error -> Error,...) + * \param s the sink to write to + * \param level the level to describe + */ +void dumpErrorLevel(Sink s, ErrorLevel level) +{ + switch (level) { + case ErrorLevel::Debug: + s(u"Debug"); + break; + case ErrorLevel::Info: + s(u"Info"); + break; + case ErrorLevel::Hint: + s(u"Hint"); + break; + case ErrorLevel::MaybeWarning: + s(u"MaybeWarn"); + break; + case ErrorLevel::Warning: + s(u"Warning"); + break; + case ErrorLevel::MaybeError: + s(u"MaybeErr"); + break; + case ErrorLevel::Error: + s(u"Error"); + break; + case ErrorLevel::Fatal: + s(u"Fatal"); + break; + } + +} + +void dumperToQDebug(Dumper dumper, QDebug debug) +{ + QDebug & d = debug.noquote().nospace(); + dumper([&d](QStringView s){ + d << s; + }); +} + +/*! + * \internal + * \brief writes the dumper to the QDebug object corrsponding to the given error level + * \param level the error level of the message + * \param dumper the dumper that writes a message + */ +void dumperToQDebug(Dumper dumper, ErrorLevel level) +{ + QDebug d = qDebug().noquote().nospace(); + switch (level) { + case ErrorLevel::Debug: + break; + case ErrorLevel::Info: + case ErrorLevel::Hint: + d = qInfo().noquote().nospace(); + break; + case ErrorLevel::MaybeWarning: + case ErrorLevel::Warning: + d = qWarning().noquote().nospace(); + break; + case ErrorLevel::MaybeError: + case ErrorLevel::Error: + case ErrorLevel::Fatal: // should be handled differently (avoid allocations...), we try to catch them before ending up here + d = qCritical().noquote().nospace(); + break; + } + dumper([&d](QStringView s){ + d << s; + }); +} + +/*! + * \internal + * \brief sinks the requested amount of spaces + */ +void sinkIndent(Sink s, int indent) +{ + if (indent > 0) { + QStringView spaces = u" "; + while (indent > spaces.length()) { + s(spaces); + indent -= spaces.length(); + } + s(spaces.left(indent)); + } +} + +/*! + * \internal + * \brief sinks a neline and indents by the given amount + */ +void sinkNewline(Sink s, int indent) +{ + s(u"\n"); + if (indent > 0) + sinkIndent(s, indent); +} + +/*! + * \internal + * \fn QQmlJS::Dom::devNull + * \brief A sink that ignores whatever it receives + */ + +} // end namespace Dom +} // end namespace QQmlJS + +QT_END_NAMESPACE |