dtkLogger.h 6.36 KB
Newer Older
1
2
3
/* dtkLogger.h --- 
 * 
 * Author: Julien Wintz
4
5
6
7
8
 * Created: Wed Feb 13 12:18:35 2013 (+0100)
 * Version: 
 * Last-Updated: lun. févr.  3 16:41:29 2014 (+0100)
 *           By: Thibaud Kloczko
 *     Update #: 54
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
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

#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
// ///////////////////////////////////////////////////////////////////

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

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

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

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

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

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

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

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

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

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

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

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