dtkLogger.h 6.66 KB
Newer Older
1
2
3
/* dtkLogger.h --- 
 * 
 * Author: Julien Wintz
4
5
 * Created: Wed Feb 13 12:18:35 2013 (+0100)
 * Version: 
6
7
8
 * Last-Updated: mar. févr.  4 15:15:10 2014 (+0100)
 *           By: Nicolas Niclausse
 *     Update #: 153
9
10
 */

11
/* Change Log:
12
13
14
 * 
 */

15
#pragma once
16
17

#include <QtCore>
18
#include <QtDebug>
19

20
#include "dtkLogger_p.h"
21

22
23
24
// ///////////////////////////////////////////////////////////////////
// Logging rules
// ///////////////////////////////////////////////////////////////////
25

26
27
void dtkSetLoggingRules(const QByteArray &rules);
void dtkSetLoggingRulesFile(const QString &path);
28

29
30
31
// ///////////////////////////////////////////////////////////////////
// Example logging rules file
// ///////////////////////////////////////////////////////////////////
32

33
34
35
36
37
38
// default.*=true
// default.critical=false
// default.warning=true
// default.debug=false
//  *.Category.*=true
// My.Category.B=false
39

40
41
42
// ///////////////////////////////////////////////////////////////////
// qDebug overload
// ///////////////////////////////////////////////////////////////////
43

44
45
46
#if defined(qDebug)
#  undef qDebug
#endif
Julien Wintz's avatar
Julien Wintz committed
47

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

52
53
54
// ///////////////////////////////////////////////////////////////////
// qWarning overload
// ///////////////////////////////////////////////////////////////////
55

56
57
58
#if defined(qWarning)
#  undef qWarning
#endif
59

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

64
65
66
// ///////////////////////////////////////////////////////////////////
// qCritical overload
// ///////////////////////////////////////////////////////////////////
67

68
69
#if defined(qCritical)
#  undef qCritical
70
#endif
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

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

// ///////////////////////////////////////////////////////////////////
// Helper macro
// ///////////////////////////////////////////////////////////////////

#define DTK_LOG_CATEGORY(categorytype, categoryname)			\
    namespace {								\
        static dtkLoggingCategory categorytype(categoryname);		\
    }

// ///////////////////////////////////////////////////////////////////
// dtkDebug
// ///////////////////////////////////////////////////////////////////

89
90
91
#define dtkDebug                                                           \
    for (bool enabled = dtkLoggingCategory::defaultCategory().isEnabled(QtDebugMsg); enabled; enabled = false)    \
        QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, dtkLoggingCategory::defaultCategory().categoryName()).debug
92
93
94
95
96

// ///////////////////////////////////////////////////////////////////
// dtkWarning
// ///////////////////////////////////////////////////////////////////

97
#define dtkWarn \
98
99
    for (bool enabled = dtkLoggingCategory::defaultCategory().isEnabled(QtWarningMsg); enabled; enabled = false)  \
        QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, dtkLoggingCategory::defaultCategory().categoryName()).warning
100
101
102
103
104

// ///////////////////////////////////////////////////////////////////
// dtkCritical
// ///////////////////////////////////////////////////////////////////

105
106
107
#define dtkCritical						             \
    for (bool enabled = dtkLoggingCategory::defaultCategory().isEnabled(QtCriticalMsg); enabled; enabled = false) \
        QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, dtkLoggingCategory::defaultCategory().categoryName()).critical
108
109
110
111
112

// ///////////////////////////////////////////////////////////////////
// dtkTrace
// ///////////////////////////////////////////////////////////////////

113
114
115
#define dtkTrace						             \
    for (bool enabled = dtkLoggingCategory::defaultCategory().isEnabled(QtDebugMsg); enabled; enabled = false) \
        QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, dtkLoggingCategory::defaultCategory().categoryName()).debug
116
117
118
119
120

// ///////////////////////////////////////////////////////////////////
// dtkInfo
// ///////////////////////////////////////////////////////////////////

121
122
123
#define dtkInfo						             \
        for (bool enabled = dtkLoggingCategory::defaultCategory().isEnabled(QtDebugMsg); enabled; enabled = false) \
        QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, dtkLoggingCategory::defaultCategory().categoryName()).debug
124
125
126
127
128

// ///////////////////////////////////////////////////////////////////
// dtkError
// ///////////////////////////////////////////////////////////////////

129
130
131
#define dtkError						             \
    for (bool enabled = dtkLoggingCategory::defaultCategory().isEnabled(QtFatalMsg); enabled; enabled = false) \
        QMessageLogger(__FILE__, __LINE__, Q_FUNC_INFO, dtkLoggingCategory::defaultCategory().categoryName()).critical
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

/****************************************************************************
**
** 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.
**
** 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.
**
****************************************************************************/