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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
/**
* @file debug.h Debug API
* @ingroup core
*/
/* purple
*
* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef _PURPLE_DEBUG_H_
#define _PURPLE_DEBUG_H_
#include <glib.h>
#include <stdarg.h>
/**
* Debug levels.
*/
typedef enum
{
PURPLE_DEBUG_ALL = 0, /**< All debug levels. */
PURPLE_DEBUG_MISC, /**< General chatter. */
PURPLE_DEBUG_INFO, /**< General operation Information. */
PURPLE_DEBUG_WARNING, /**< Warnings. */
PURPLE_DEBUG_ERROR, /**< Errors. */
PURPLE_DEBUG_FATAL /**< Fatal errors. */
} PurpleDebugLevel;
/**
* Debug UI operations.
*/
typedef struct
{
void (*print)(PurpleDebugLevel level, const char *category,
const char *arg_s);
gboolean (*is_enabled)(PurpleDebugLevel level,
const char *category);
void (*_purple_reserved1)(void);
void (*_purple_reserved2)(void);
void (*_purple_reserved3)(void);
void (*_purple_reserved4)(void);
} PurpleDebugUiOps;
#ifdef __cplusplus
extern "C" {
#endif
/**************************************************************************/
/** @name Debug API */
/**************************************************************************/
/**
* Outputs debug information.
*
* @param level The debug level.
* @param category The category (or @c NULL).
* @param format The format string.
*/
void purple_debug(PurpleDebugLevel level, const char *category,
const char *format, ...) G_GNUC_PRINTF(3, 4);
/**
* Outputs misc. level debug information.
*
* This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_MISC as
* the level.
*
* @param category The category (or @c NULL).
* @param format The format string.
*
* @see purple_debug()
*/
void purple_debug_misc(const char *category, const char *format, ...) G_GNUC_PRINTF(2, 3);
/**
* Outputs info level debug information.
*
* This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_INFO as
* the level.
*
* @param category The category (or @c NULL).
* @param format The format string.
*
* @see purple_debug()
*/
void purple_debug_info(const char *category, const char *format, ...) G_GNUC_PRINTF(2, 3);
/**
* Outputs warning level debug information.
*
* This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_WARNING as
* the level.
*
* @param category The category (or @c NULL).
* @param format The format string.
*
* @see purple_debug()
*/
void purple_debug_warning(const char *category, const char *format, ...) G_GNUC_PRINTF(2, 3);
/**
* Outputs error level debug information.
*
* This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_ERROR as
* the level.
*
* @param category The category (or @c NULL).
* @param format The format string.
*
* @see purple_debug()
*/
void purple_debug_error(const char *category, const char *format, ...) G_GNUC_PRINTF(2, 3);
/**
* Outputs fatal error level debug information.
*
* This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_ERROR as
* the level.
*
* @param category The category (or @c NULL).
* @param format The format string.
*
* @see purple_debug()
*/
void purple_debug_fatal(const char *category, const char *format, ...) G_GNUC_PRINTF(2, 3);
/**
* Enable or disable printing debug output to the console.
*
* @param enabled TRUE to enable debug output or FALSE to disable it.
*/
void purple_debug_set_enabled(gboolean enabled);
/**
* Check if console debug output is enabled.
*
* @return TRUE if debugging is enabled, FALSE if it is not.
*/
gboolean purple_debug_is_enabled(void);
/**
* Enable or disable verbose debugging. This ordinarily should only be called
* by #purple_debug_init, but there are cases where this can be useful for
* plugins.
*
* @param verbose TRUE to enable verbose debugging or FALSE to disable it.
*
* @since 2.6.0
*/
void purple_debug_set_verbose(gboolean verbose);
/**
* Check if verbose logging is enabled.
*
* @return TRUE if verbose debugging is enabled, FALSE if it is not.
*
* @since 2.6.0
*/
gboolean purple_debug_is_verbose(void);
/**
* Enable or disable unsafe debugging. This ordinarily should only be called
* by #purple_debug_init, but there are cases where this can be useful for
* plugins.
*
* @param unsafe TRUE to enable debug logging of messages that could
* potentially contain passwords and other sensitive information.
* FALSE to disable it.
*
* @since 2.6.0
*/
void purple_debug_set_unsafe(gboolean unsafe);
/**
* Check if unsafe debugging is enabled. Defaults to FALSE.
*
* @return TRUE if the debug logging of all messages is enabled, FALSE
* if messages that could potentially contain passwords and other
* sensitive information are not logged.
*
* @since 2.6.0
*/
gboolean purple_debug_is_unsafe(void);
/*@}*/
/**************************************************************************/
/** @name UI Registration Functions */
/**************************************************************************/
/*@{*/
/**
* Sets the UI operations structure to be used when outputting debug
* information.
*
* @param ops The UI operations structure.
*/
void purple_debug_set_ui_ops(PurpleDebugUiOps *ops);
/**
* Returns the UI operations structure used when outputting debug
* information.
*
* @return The UI operations structure in use.
*/
PurpleDebugUiOps *purple_debug_get_ui_ops(void);
/*@}*/
/**************************************************************************/
/** @name Debug Subsystem */
/**************************************************************************/
/*@{*/
/**
* Initializes the debug subsystem.
*/
void purple_debug_init(void);
/*@}*/
#ifdef __cplusplus
}
#endif
#endif /* _PURPLE_DEBUG_H_ */
|
