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
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/**
* This file is part of TelepathyQt
*
* @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_TP_QT_HEADER
#include "debug.h"
#include "debug-internal.h"
#include "config-version.h"
/**
* \defgroup debug Common debug support
*
* TelepathyQt has an internal mechanism for displaying debugging output. It
* uses the Qt 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 = nullptr;
}
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-qt"), QLatin1String(PACKAGE_VERSION), type, msg);
} else {
switch (type) {
case QtDebugMsg:
qDebug() << "tp-qt " PACKAGE_VERSION " DEBUG:" << qPrintable(msg);
break;
case QtWarningMsg:
qWarning() << "tp-qt " 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
|
