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
|
/*
* Purple - Internet Messaging Library
* Copyright (C) Pidgin Developers <devel@pidgin.im>
*
* 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, see <https://www.gnu.org/licenses/>.
*/
#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <purple.h> may be included directly"
#endif
#ifndef PURPLE_DEBUG_H
#define PURPLE_DEBUG_H
#include <glib.h>
#include <glib-object.h>
#include <stdarg.h>
G_BEGIN_DECLS
/**
* PurpleDebugLevel:
* @PURPLE_DEBUG_ALL: 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.
*
* Available debug levels.
*/
typedef enum {
PURPLE_DEBUG_ALL = 0,
PURPLE_DEBUG_MISC,
PURPLE_DEBUG_INFO,
PURPLE_DEBUG_WARNING,
PURPLE_DEBUG_ERROR,
PURPLE_DEBUG_FATAL
} PurpleDebugLevel;
#include "purpledebugui.h"
/**
* purple_debug:
* @level: The debug level.
* @category: The category (or %NULL).
* @format: The format string.
* @...: The parameters to insert into the format string.
*
* Outputs debug information.
*/
void purple_debug(PurpleDebugLevel level, const gchar *category, const gchar *format, ...) G_GNUC_PRINTF(3, 4);
/**
* purple_debug_misc:
* @category: The category or %NULL.
* @format: The format string.
* @...: The parameters to insert into the format string.
*
* Outputs misc. level debug information.
*
* This is a wrapper for purple_debug(), and uses #PURPLE_DEBUG_MISC as the
* level.
*
* See purple_debug().
*/
void purple_debug_misc(const gchar *category, const gchar *format, ...) G_GNUC_PRINTF(2, 3);
/**
* purple_debug_info:
* @category: The category (or %NULL).
* @format: The format string.
* @...: The parameters to insert into the format string.
*
* Outputs info level debug information.
*
* This is a wrapper for purple_debug(), and uses #PURPLE_DEBUG_INFO as
* the level.
*
* See purple_debug().
*/
void purple_debug_info(const gchar *category, const gchar *format, ...) G_GNUC_PRINTF(2, 3);
/**
* purple_debug_warning:
* @category: The category or %NULL.
* @format: The format string.
* @...: The parameters to insert into the format string.
*
* Outputs warning level debug information.
*
* This is a wrapper for purple_debug(), and uses #PURPLE_DEBUG_WARNING as the
* level.
*
* See purple_debug().
*/
void purple_debug_warning(const gchar *category, const gchar *format, ...) G_GNUC_PRINTF(2, 3);
/**
* purple_debug_error:
* @category: The category or %NULL.
* @format: The format string.
* @...: The parameters to insert into the format string.
*
* Outputs error level debug information.
*
* This is a wrapper for purple_debug(), and uses #PURPLE_DEBUG_ERROR as the
* level.
*
* See purple_debug().
*/
void purple_debug_error(const gchar *category, const gchar *format, ...) G_GNUC_PRINTF(2, 3);
/**
* purple_debug_fatal:
* @category: The category (or %NULL).
* @format: The format string.
* @...: The parameters to insert into the format string.
*
* Outputs fatal error level debug information.
*
* This is a wrapper for purple_debug(), and uses #PURPLE_DEBUG_ERROR as the
* level.
*
* See purple_debug().
*/
void purple_debug_fatal(const gchar *category, const gchar *format, ...) G_GNUC_PRINTF(2, 3);
/**
* purple_debug_set_verbose:
* @verbose: %TRUE to enable verbose debugging or %FALSE to disable it.
*
* 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.
*/
void purple_debug_set_verbose(gboolean verbose);
/**
* purple_debug_is_verbose:
*
* Check if verbose logging is enabled.
*
* Returns: %TRUE if verbose debugging is enabled, %FALSE if it is not.
*/
gboolean purple_debug_is_verbose(void);
/**
* purple_debug_set_unsafe:
* @unsafe: %TRUE to enable debug logging of messages that could potentially
* contain passwords and other sensitive information. %FALSE to
* disable it.
*
* 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.
*/
void purple_debug_set_unsafe(gboolean unsafe);
/**
* purple_debug_is_unsafe:
*
* Check if unsafe debugging is enabled. Defaults to %FALSE.
*
* Returns: %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.
*/
gboolean purple_debug_is_unsafe(void);
/******************************************************************************
* Debug Subsystem
*****************************************************************************/
/**
* purple_debug_init:
*
* Initializes the debug subsystem.
*/
void purple_debug_init(void);
G_END_DECLS
#endif /* PURPLE_DEBUG_H */
|
