summaryrefslogtreecommitdiffstats log msg author committer range
path: root/src/corelib/io/qdebug.cpp
blob: 2b5dac8801d114fff6d8c0b71d5a5de2b5f388af (plain)
 ```1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 ``` ``````/**************************************************************************** ** ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/ ** ** This file is part of the QtCore module of the Qt Toolkit. ** ** \$QT_BEGIN_LICENSE:LGPL\$ ** GNU Lesser General Public License Usage ** 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. ** ** 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. ** ** Other Usage ** Alternatively, this file may be used in accordance with the terms and ** conditions contained in a signed written agreement between you and Nokia. ** ** ** ** ** ** ** \$QT_END_LICENSE\$ ** ****************************************************************************/ #ifdef QT_NO_DEBUG #undef QT_NO_DEBUG #endif #ifdef qDebug #undef qDebug #endif #include "qdebug.h" // This file is needed to force compilation of QDebug into the kernel library. /*! \class QDebug \brief The QDebug class provides an output stream for debugging information. QDebug is used whenever the developer needs to write out debugging or tracing information to a device, file, string or console. \section1 Basic Use In the common case, it is useful to call the qDebug() function to obtain a default QDebug object to use for writing debugging information. \snippet qdebug/qdebugsnippet.cpp 1 This constructs a QDebug object using the constructor that accepts a QtMsgType value of QtDebugMsg. Similarly, the qWarning(), qCritical() and qFatal() functions also return QDebug objects for the corresponding message types. The class also provides several constructors for other situations, including a constructor that accepts a QFile or any other QIODevice subclass that is 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 Writing Custom Types to a Stream Many standard types can be written to QDebug objects, and Qt provides support for most Qt value types. To add support for custom types, you need to implement a streaming operator, as in the following example: \snippet qdebug/qdebugsnippet.cpp 0 This is described in the \l{Debugging Techniques} and \l{Creating Custom Qt Types#Making the Type Printable}{Creating Custom Qt Types} documents. */ /*! \fn QDebug::QDebug(QIODevice *device) Constructs a debug stream that writes to the given \a device. */ /*! \fn QDebug::QDebug(QString *string) Constructs a debug stream that writes to the given \a string. */ /*! \fn QDebug::QDebug(QtMsgType type) Constructs a debug stream that writes to the handler for the message type specified by \a type. */ /*! \fn QDebug::QDebug(const QDebug &other) Constructs a copy of the \a other debug stream. */ /*! \fn QDebug &QDebug::operator=(const QDebug &other) Assigns the \a other debug stream to this stream and returns a reference to this stream. */ /*! \fn QDebug::~QDebug() Flushes any pending data to be written and destroys the debug stream. */ /*! \fn QDebug::swap(QDebug &other) \since 5.0 Swaps this debug stream instance with \a other. This function is very fast and never fails. */ /*! \fn QDebug &QDebug::space() Writes a space character to the debug stream and returns a reference to the stream. The stream remembers that automatic insertion of spaces is enabled for future writes. \sa nospace(), maybeSpace() */ /*! \fn QDebug &QDebug::nospace() Disables automatic insertion of spaces and returns a reference to the stream. \sa space(), maybeSpace() */ /*! \fn QDebug &QDebug::maybeSpace() Writes a space character to the debug stream, depending on the current setting for automatic insertion of spaces, and returns a reference to the stream. \sa space(), nospace() */ /*! \fn QDebug &QDebug::operator<<(QChar t) Writes the character, \a t, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(bool t) Writes the boolean value, \a t, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(char t) Writes the character, \a t, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(signed short i) Writes the signed short integer, \a i, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(unsigned short i) Writes then unsigned short integer, \a i, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(signed int i) Writes the signed integer, \a i, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(unsigned int i) Writes then unsigned integer, \a i, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(signed long l) Writes the signed long integer, \a l, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(unsigned long l) Writes then unsigned long integer, \a l, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(qint64 i) Writes the signed 64-bit integer, \a i, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(quint64 i) Writes then unsigned 64-bit integer, \a i, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(float f) Writes the 32-bit floating point number, \a f, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(double f) Writes the 64-bit floating point number, \a f, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(const char *s) Writes the '\\0'-terminated string, \a s, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(const QString &s) Writes the string, \a s, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(const QStringRef &s) Writes the string reference, \a s, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(QLatin1String s) Writes the Latin1-encoded string, \a s, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(const QByteArray &b) Writes the byte array, \a b, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(const void *p) Writes a pointer, \a p, to the stream and returns a reference to the stream. */ /*! \fn QDebug &QDebug::operator<<(QTextStreamFunction f) \internal */ /*! \fn QDebug &QDebug::operator<<(QTextStreamManipulator m) \internal */ ``````