diff options
Diffstat (limited to 'src/corelib/io/qdebug.cpp')
| -rw-r--r-- | src/corelib/io/qdebug.cpp | 124 |
1 files changed, 104 insertions, 20 deletions
diff --git a/src/corelib/io/qdebug.cpp b/src/corelib/io/qdebug.cpp index 3370cce6d5..c1e0125cb1 100644 --- a/src/corelib/io/qdebug.cpp +++ b/src/corelib/io/qdebug.cpp @@ -1,40 +1,32 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the QtCore module of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ +** $QT_BEGIN_LICENSE:LGPL21$ ** 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 Digia. For licensing terms and -** conditions see http://qt.digia.com/licensing. For further information +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information ** use the contact form at http://qt.digia.com/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 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. +** General Public License version 2.1 or version 3 as published by the Free +** Software Foundation and appearing in the file LICENSE.LGPLv21 and +** LICENSE.LGPLv3 included in the packaging of this file. Please review the +** following information to ensure the GNU Lesser General Public License +** requirements will be met: https://www.gnu.org/licenses/lgpl.html and +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. ** ** In addition, as a special exception, Digia gives you certain additional -** rights. These rights are described in the Digia Qt LGPL Exception +** rights. These rights are described in the Digia Qt LGPL Exception ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. ** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3.0 as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU General Public License version 3.0 requirements will be -** met: http://www.gnu.org/copyleft/gpl.html. -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ @@ -79,6 +71,18 @@ QT_BEGIN_NAMESPACE used to write debugging information to files and other devices. The constructor that accepts a QString is used to write to a string for display or serialization. + \section1 Formatting Options + + QDebug formats output so that it's easily readable. It automatically adds spaces + between arguments, and adds quotes around QString, QByteArray, QChar arguments. + + You can tweak these options through the space(), nospace() and quote(), noquote() + methods. Furthermore, \l{QTextStream manipulators} can be piped into a QDebug + stream. + + QDebugStateSaver limits changes to the formatting to the current scope. + resetFormat() resets the options to the default ones. + \section1 Writing Custom Types to a Stream Many standard types can be written to QDebug objects, and Qt provides support for @@ -128,6 +132,20 @@ QT_BEGIN_NAMESPACE Flushes any pending data to be written and destroys the debug stream. */ +// Has been defined in the header / inlined before Qt 5.4 +QDebug::~QDebug() +{ + if (!--stream->ref) { + if (stream->space && stream->buffer.endsWith(QLatin1Char(' '))) + stream->buffer.chop(1); + if (stream->message_output) { + qt_message_output(stream->type, + stream->context, + stream->buffer); + } + delete stream; + } +} /*! \fn QDebug::swap(QDebug &other) @@ -138,6 +156,21 @@ QT_BEGIN_NAMESPACE */ /*! + Resets the stream formatting options, bringing it back to its original constructed state. + + \sa space(), quote() + \since 5.4 +*/ +QDebug &QDebug::resetFormat() +{ + stream->ts.reset(); + stream->space = true; + if (stream->context.version > 1) + stream->flags = 0; + return *this; +} + +/*! \fn QDebug &QDebug::space() Writes a space character to the debug stream and returns a reference to @@ -188,6 +221,41 @@ QT_BEGIN_NAMESPACE \sa QDebugStateSaver */ + +/*! + \fn QDebug &QDebug::quote() + \since 5.4 + + Enables automatic insertion of quotation characters around QChar, QString and QByteArray + contents and returns a reference to the stream. + + Quoting is enabled by default. + + \sa noquote(), maybeQuote() +*/ + +/*! + \fn QDebug &QDebug::noquote() + \since 5.4 + + Disables automatic insertion of quotation characters around QChar, QString and QByteArray + contents and returns a reference to the stream. + + \sa quote(), maybeQuote() +*/ + +/*! + \fn QDebug &QDebug::maybeQuote(char c) + \since 5.4 + + Writes a character \a c to the debug stream, depending on the + current setting for automatic insertion of quotes, and returns a reference to the stream. + + The default character is a double quote \c{"}. + + \sa quote(), noquote() +*/ + /*! \fn QDebug &QDebug::operator<<(QChar t) @@ -334,7 +402,9 @@ QT_BEGIN_NAMESPACE \brief Convenience class for custom QDebug operators - Saves the settings used by QDebug, and restores them upon destruction. + Saves the settings used by QDebug, and restores them upon destruction, + then calls maybeSpace(), to separate arguments with a space if + autoInsertSpaces() was true at the time of constructing the QDebugStateSaver. The automatic insertion of spaces between writes is one of the settings that QDebugStateSaver stores for the duration of the current block. @@ -352,19 +422,33 @@ public: QDebugStateSaverPrivate(QDebug &dbg) : m_dbg(dbg), m_spaces(dbg.autoInsertSpaces()), + m_flags(0), m_streamParams(dbg.stream->ts.d_ptr->params) { + if (m_dbg.stream->context.version > 1) + m_flags = m_dbg.stream->flags; } void restoreState() { + const bool currentSpaces = m_dbg.autoInsertSpaces(); + if (currentSpaces && !m_spaces) + if (m_dbg.stream->buffer.endsWith(QLatin1Char(' '))) + m_dbg.stream->buffer.chop(1); + m_dbg.setAutoInsertSpaces(m_spaces); m_dbg.stream->ts.d_ptr->params = m_streamParams; + if (m_dbg.stream->context.version > 1) + m_dbg.stream->flags = m_flags; + + if (!currentSpaces && m_spaces) + m_dbg.stream->ts << ' '; } QDebug &m_dbg; // QDebug state const bool m_spaces; + int m_flags; // QTextStream state const QTextStreamPrivate::Params m_streamParams; |