From 15086363ef788759051b13eb9ef86544a05051da Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Wed, 5 Feb 2014 14:52:16 +0100 Subject: [PATCH] Add support for qCDebug and friends Add support for qCDebug and categorized logging to Qt Creator. For Qt 5.2 and newer we can just rely on the same feature in Qt. For older Qt versions we declare a dummy class that has a hard- coded configuration. Change-Id: I4954616100c0a100675904ab25479ad84166227b Reviewed-by: Fawzi Mohamed --- src/libs/utils/logging.h | 129 +++++++++++++++++++++++++++++++++++ src/libs/utils/utils-lib.pri | 3 +- src/libs/utils/utils.qbs | 1 + 3 files changed, 132 insertions(+), 1 deletion(-) create mode 100644 src/libs/utils/logging.h diff --git a/src/libs/utils/logging.h b/src/libs/utils/logging.h new file mode 100644 index 00000000000..b4373153b16 --- /dev/null +++ b/src/libs/utils/logging.h @@ -0,0 +1,129 @@ +/**************************************************************************** +** +** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of Qt Creator. +** +** 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 +** 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. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +****************************************************************************/ + +#ifndef LOGGING_H + +#include + +#if QT_VERSION < 0x052000 + +// +// Qt < 5.2 didn't feature categorized logging: +// Just enable qCWarning, qCCritical, but disable qCDebug +// +class QLoggingCategory +{ + Q_DISABLE_COPY(QLoggingCategory) +public: + explicit QLoggingCategory(const char *category) : name(category) {} + ~QLoggingCategory(); + + bool isDebugEnabled() const { return false; } + bool isWarningEnabled() const { return true; } + bool isCriticalEnabled() const { return true; } + + const char *categoryName() const { return name; } + + QLoggingCategory &operator()() { return *this; } + +private: + const char *name; +}; + +#define Q_DECLARE_LOGGING_CATEGORY(name) \ + extern QLoggingCategory &name(); + +// relies on QLoggingCategory(QString) being thread safe! +#define Q_LOGGING_CATEGORY(name, string) \ + QLoggingCategory &name() \ + { \ + static QLoggingCategory category(string); \ + return category; \ + } + +# ifdef QT_VERSION > 0x050000 + +// +// Qt 5.0, 5.1 do have already support for categories in QMessageLogger +// + +#define qCDebug(category, ...) \ + for (bool q_category_enabled = category().isDebugEnabled(); q_category_enabled; q_category_enabled = false) \ + QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, category().categoryName()).debug(__VA_ARGS__) +#define qCWarning(category, ...) \ + for (bool q_category_enabled = category().isWarningEnabled(); q_category_enabled; q_category_enabled = false) \ + QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, category().categoryName()).warning(__VA_ARGS__) +#define qCCritical(category, ...) \ + for (bool q_category_enabled = category().isCriticalEnabled(); q_category_enabled; q_category_enabled = false) \ + QMessageLogger(__FILE__, __LINE__, Q_FUNC_QT_VERSION < 0x053000INFO, category().categoryName()).critical(__VA_ARGS__) + +# else + +// +// Qt 4: just map to qDebug etc +// + +#define qCDebug(category, ...) \ + for (bool q_category_enabled = category().isDebugEnabled(); q_category_enabled; q_category_enabled = false) \ + qDebug(__VA_ARGS__) +#define qCWarning(category, ...) \ + for (bool q_category_enabled = category().isWarningEnabled(); q_category_enabled; q_category_enabled = false) \ + qWarning(__VA_ARGS__) +#define qCCritical(category, ...) \ + for (bool q_category_enabled = category().isCriticalEnabled(); q_category_enabled; q_category_enabled = false) \ + qCritical(__VA_ARGS__) + + +# endif // QT_VERSION > 0x050000 + +#else // QT_VERSION >= 0x052000 + +#include + +#ifdef QT_VERSION < 0x053000 + +// printf style for qCDebug was only added in Qt 5.3 + +#undef qCDebug +#undef qCWarning +#undef qCCritical + +#define qCDebug(category, ...) \ + for (bool q_category_enabled = category().isDebugEnabled(); q_category_enabled; q_category_enabled = false) \ + QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, category().categoryName()).debug(__VA_ARGS__) +#define qCWarning(category, ...) \ + for (bool q_category_enabled = category().isWarningEnabled(); q_category_enabled; q_category_enabled = false) \ + QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, category().categoryName()).warning(__VA_ARGS__) +#define qCCritical(category, ...) \ + for (bool q_category_enabled = category().isCriticalEnabled(); q_category_enabled; q_category_enabled = false) \ + QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, category().categoryName()).critical(__VA_ARGS__) + +#endif // QT_VERSION < 0x053000 + +#endif // LOGGING_H diff --git a/src/libs/utils/utils-lib.pri b/src/libs/utils/utils-lib.pri index 319e2be935e..297241a3d36 100644 --- a/src/libs/utils/utils-lib.pri +++ b/src/libs/utils/utils-lib.pri @@ -184,7 +184,8 @@ HEADERS += \ $$PWD/function.h \ $$PWD/ansiescapecodehandler.h \ $$PWD/execmenu.h \ - $$PWD/completinglineedit.h + $$PWD/completinglineedit.h \ + $$PWD/logging.h FORMS += $$PWD/filewizardpage.ui \ $$PWD/projectintropage.ui \ diff --git a/src/libs/utils/utils.qbs b/src/libs/utils/utils.qbs index 5fc781e7d80..2a415a3f238 100644 --- a/src/libs/utils/utils.qbs +++ b/src/libs/utils/utils.qbs @@ -110,6 +110,7 @@ QtcLibrary { "linecolumnlabel.cpp", "linecolumnlabel.h", "listutils.h", + "logging.h", "multitask.h", "navigationtreeview.cpp", "navigationtreeview.h",