summaryrefslogtreecommitdiffstats
path: root/src/logger/qlogger.h
blob: 3bdcbe8685fbc875c6fa0b5d259b89e0c75e448d (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
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the logger 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 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.
**
** 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$
**
****************************************************************************/

#ifndef QLOGGER_H
#define QLOGGER_H

#include <QtCore/QObject>
#include <QtCore/QDebug>
#include <QtLogger/qloggerglobal.h>

QT_BEGIN_HEADER
QT_LOGGER_BEGIN_NAMESPACE

class QLoggingCategoryPrivate;
class Q_LOGGER_EXPORT QLoggingCategory {
    Q_DISABLE_COPY(QLoggingCategory)
public:
    explicit QLoggingCategory(const char *category);
    ~QLoggingCategory();
    bool isEnabled(QtMsgType msgtype);
    const char * categoryName();
    static QLoggingCategory& defaultCategory();
private:
    QLoggingCategoryPrivate *d_ptr;
    const char *_categoryName;

    friend class QLoggingPrivate;
};

Q_LOGGER_EXPORT void qSetLoggingRules(const QByteArray &rules);
Q_LOGGER_EXPORT void qSetLoggingRulesFile(const QString &path);

QT_LOGGER_END_NAMESPACE
QT_END_HEADER

QT_LOGGER_USE_NAMESPACE

#if defined(qDebug)
#  undef qDebug
#endif

#define qDebug \
    for (bool enabled = QLoggingCategory::defaultCategory().isEnabled(QtDebugMsg); enabled; enabled = false) \
        QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, QLoggingCategory::defaultCategory().categoryName()).debug

#if defined(qWarning)
#  undef qWarning
#endif

#define qWarning \
    for (bool enabled = QLoggingCategory::defaultCategory().isEnabled(QtWarningMsg); enabled; enabled = false) \
        QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, QLoggingCategory::defaultCategory().categoryName()).warning

#if defined(qCritical)
#  undef qCritical
#endif

#define qCritical \
    for (bool enabled = QLoggingCategory::defaultCategory().isEnabled(QtCriticalMsg); enabled; enabled = false) \
        QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, QLoggingCategory::defaultCategory().categoryName()).critical

//This marco creates the QLoggingCategory object in an empty namespace
//to prevent potential linker problems if someone else uses the same categorytype in another file.
#define QT_LOG_CATEGORY(categorytype, categoryname)                           \
    namespace {                                                               \
        static QLoggingCategory categorytype(categoryname);                   \
    }

#define qCDebug(category) \
    for (bool enabled = category.isEnabled(QtDebugMsg); enabled; enabled = false) \
        QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, category.categoryName()).debug()

#define qCWarning(category) \
    for (bool enabled = category.isEnabled(QtWarningMsg); enabled; enabled = false) \
        QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, category.categoryName()).warning()

#define qCCritical(category) \
    for (bool enabled = category.isEnabled(QtCriticalMsg); enabled; enabled = false) \
        QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, category.categoryName()).critical()

#endif // QLOGGER_H