diff options
Diffstat (limited to 'qt4/TelepathyQt4/debug.cpp')
| -rw-r--r-- | qt4/TelepathyQt4/debug.cpp | 187 |
1 files changed, 187 insertions, 0 deletions
diff --git a/qt4/TelepathyQt4/debug.cpp b/qt4/TelepathyQt4/debug.cpp new file mode 100644 index 000000000..f8e37171f --- /dev/null +++ b/qt4/TelepathyQt4/debug.cpp @@ -0,0 +1,187 @@ +/** + * This file is part of TelepathyQt4 + * + * @copyright Copyright (C) 2008-2009 Collabora Ltd. <http://www.collabora.co.uk/> + * @copyright Copyright (C) 2008-2009 Nokia Corporation + * @license LGPL 2.1 + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#define IN_TELEPATHY_QT4_HEADER +#include "debug.h" +#include "debug-internal.h" + +#include "config-version.h" + +/** + * \defgroup debug Common debug support + * + * TelepathyQt4 has an internal mechanism for displaying debugging output. It + * uses the Qt4 debugging subsystem, so if you want to redirect the messages, + * use qInstallMsgHandler() from <QtGlobal>. + * + * Debugging output is divided into two categories: normal debug output and + * warning messages. Normal debug output results in the normal operation of the + * library, warning messages are output only when something goes wrong. Each + * category can be invidually enabled. + */ + +namespace Tp +{ + +/** + * \fn void enableDebug(bool enable) + * \ingroup debug + * + * Enable or disable normal debug output from the library. If the library is not + * compiled with debug support enabled, this has no effect; no output is + * produced in any case. + * + * The default is <code>false</code> ie. no debug output. + * + * \param enable Whether debug output should be enabled or not. + */ + +/** + * \fn void enableWarnings(bool enable) + * \ingroup debug + * + * Enable or disable warning output from the library. If the library is not + * compiled with debug support enabled, this has no effect; no output is + * produced in any case. + * + * The default is <code>true</code> ie. warning output enabled. + * + * \param enable Whether warnings should be enabled or not. + */ + +/** + * \typedef DebugCallback + * \ingroup debug + * + * \code + * typedef QDebug (*DebugCallback)(const QString &libraryName, + * const QString &libraryVersion, + * QtMsgType type, + * const QString &msg) + * \endcode + */ + +/** + * \fn void setDebugCallback(DebugCallback cb) + * \ingroup debug + * + * Set the callback method that will handle the debug output. + * + * If \p cb is NULL this method will set the defaultDebugCallback instead. + * The default callback function will print the output using default Qt debug + * system. + * + * \param cb A function pointer to the callback method or NULL. + * \sa DebugCallback + */ + +#ifdef ENABLE_DEBUG + +namespace +{ +bool debugEnabled = false; +bool warningsEnabled = true; +DebugCallback debugCallback = NULL; +} + +void enableDebug(bool enable) +{ + debugEnabled = enable; +} + +void enableWarnings(bool enable) +{ + warningsEnabled = enable; +} + +void setDebugCallback(DebugCallback cb) +{ + debugCallback = cb; +} + +Debug enabledDebug() +{ + if (debugEnabled) { + return Debug(QtDebugMsg); + } else { + return Debug(); + } +} + +Debug enabledWarning() +{ + if (warningsEnabled) { + return Debug(QtWarningMsg); + } else { + return Debug(); + } +} + +void Debug::invokeDebugCallback() +{ + if (debugCallback) { + debugCallback(QLatin1String("tp-qt4"), QLatin1String(PACKAGE_VERSION), type, msg); + } else { + switch (type) { + case QtDebugMsg: + qDebug() << "tp-qt4 " PACKAGE_VERSION " DEBUG:" << qPrintable(msg); + break; + case QtWarningMsg: + qWarning() << "tp-qt4 " PACKAGE_VERSION " WARN:" << qPrintable(msg); + break; + default: + break; + } + } +} + +#else /* !defined(ENABLE_DEBUG) */ + +void enableDebug(bool enable) +{ +} + +void enableWarnings(bool enable) +{ +} + +void setDebugCallback(DebugCallback cb) +{ +} + +Debug enabledDebug() +{ + return Debug(); +} + +Debug enabledWarning() +{ + return Debug(); +} + +void Debug::invokeDebugCallback() +{ +} + +#endif /* !defined(ENABLE_DEBUG) */ + +} // Tp |