]>
Commit | Line | Data |
---|---|---|
43c0a640 | 1 | /* |
50bd5d25 | 2 | * This file is part of the libsigrokdecode project. |
43c0a640 | 3 | * |
66e4c27c | 4 | * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de> |
43c0a640 UH |
5 | * |
6 | * This program is free software; you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation; either version 2 of the License, or | |
9 | * (at your option) any later version. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | * GNU General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program; if not, write to the Free Software | |
18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
19 | */ | |
20 | ||
c1f86f02 UH |
21 | #include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ |
22 | #include "libsigrokdecode-internal.h" | |
bc5f5a43 BV |
23 | #include <stdarg.h> |
24 | #include <stdio.h> | |
43c0a640 | 25 | |
54fdeeef UH |
26 | /** |
27 | * @file | |
28 | * | |
29 | * Controlling the libsigrokdecode message logging functionality. | |
30 | */ | |
31 | ||
4895418c UH |
32 | /** |
33 | * @defgroup grp_logging Logging | |
34 | * | |
35 | * Controlling the libsigrokdecode message logging functionality. | |
36 | * | |
37 | * @{ | |
38 | */ | |
39 | ||
66e4c27c | 40 | /* Currently selected libsigrokdecode loglevel. Default: SRD_LOG_WARN. */ |
aa6506b8 | 41 | static int cur_loglevel = SRD_LOG_WARN; /* Show errors+warnings per default. */ |
43c0a640 | 42 | |
66e4c27c | 43 | /* Function prototype. */ |
41a5d962 | 44 | static int srd_logv(void *cb_data, int loglevel, const char *format, |
e09023b9 | 45 | va_list args); |
66e4c27c | 46 | |
0082d592 | 47 | /* Pointer to the currently selected log callback. Default: srd_logv(). */ |
2372b199 | 48 | static srd_log_callback srd_log_cb = srd_logv; |
66e4c27c UH |
49 | |
50 | /* | |
0082d592 | 51 | * Pointer to private data that can be passed to the log callback. |
66e4c27c UH |
52 | * This can be used (for example) by C++ GUIs to pass a "this" pointer. |
53 | */ | |
2372b199 | 54 | static void *srd_log_cb_data = NULL; |
66e4c27c | 55 | |
3a8b2e78 | 56 | /* Log domain (a short string that is used as prefix for all messages). */ |
57790bc8 | 57 | /** @cond PRIVATE */ |
3a8b2e78 UH |
58 | #define LOGDOMAIN_MAXLEN 30 |
59 | #define LOGDOMAIN_DEFAULT "srd: " | |
57790bc8 | 60 | /** @endcond */ |
3a8b2e78 UH |
61 | static char srd_log_domain[LOGDOMAIN_MAXLEN + 1] = LOGDOMAIN_DEFAULT; |
62 | ||
43c0a640 UH |
63 | /** |
64 | * Set the libsigrokdecode loglevel. | |
65 | * | |
66 | * This influences the amount of log messages (debug messages, error messages, | |
67 | * and so on) libsigrokdecode will output. Using SRD_LOG_NONE disables all | |
68 | * messages. | |
69 | * | |
41106a07 UH |
70 | * Note that this function itself will also output log messages. After the |
71 | * loglevel has changed, it will output a debug message with SRD_LOG_DBG for | |
72 | * example. Whether this message is shown depends on the (new) loglevel. | |
73 | * | |
43c0a640 UH |
74 | * @param loglevel The loglevel to set (SRD_LOG_NONE, SRD_LOG_ERR, |
75 | * SRD_LOG_WARN, SRD_LOG_INFO, SRD_LOG_DBG, or SRD_LOG_SPEW). | |
582c8473 | 76 | * |
a62186e4 | 77 | * @return SRD_OK upon success, SRD_ERR_ARG upon invalid loglevel. |
8c664ca2 UH |
78 | * |
79 | * @since 0.1.0 | |
43c0a640 | 80 | */ |
55c3c5f4 | 81 | SRD_API int srd_log_loglevel_set(int loglevel) |
43c0a640 UH |
82 | { |
83 | if (loglevel < SRD_LOG_NONE || loglevel > SRD_LOG_SPEW) { | |
d906d3f9 | 84 | srd_err("Invalid loglevel %d.", loglevel); |
a62186e4 | 85 | return SRD_ERR_ARG; |
43c0a640 UH |
86 | } |
87 | ||
aa6506b8 | 88 | cur_loglevel = loglevel; |
43c0a640 | 89 | |
7a1712c4 | 90 | srd_dbg("libsigrokdecode loglevel set to %d.", loglevel); |
43c0a640 UH |
91 | |
92 | return SRD_OK; | |
93 | } | |
94 | ||
95 | /** | |
96 | * Get the libsigrokdecode loglevel. | |
97 | * | |
98 | * @return The currently configured libsigrokdecode loglevel. | |
8c664ca2 UH |
99 | * |
100 | * @since 0.1.0 | |
43c0a640 | 101 | */ |
55c3c5f4 | 102 | SRD_API int srd_log_loglevel_get(void) |
43c0a640 | 103 | { |
aa6506b8 | 104 | return cur_loglevel; |
43c0a640 UH |
105 | } |
106 | ||
3a8b2e78 | 107 | /** |
41106a07 | 108 | * Set the libsigrokdecode logdomain string. |
3a8b2e78 | 109 | * |
41106a07 UH |
110 | * @param logdomain The string to use as logdomain for libsigrokdecode log |
111 | * messages from now on. Must not be NULL. The maximum | |
112 | * length of the string is 30 characters (this does not | |
113 | * include the trailing NUL-byte). Longer strings are | |
114 | * silently truncated. | |
115 | * In order to not use a logdomain, pass an empty string. | |
116 | * The function makes its own copy of the input string, i.e. | |
117 | * the caller does not need to keep it around. | |
582c8473 | 118 | * |
41106a07 | 119 | * @return SRD_OK upon success, SRD_ERR_ARG upon invalid logdomain. |
8c664ca2 UH |
120 | * |
121 | * @since 0.1.0 | |
3a8b2e78 | 122 | */ |
55c3c5f4 | 123 | SRD_API int srd_log_logdomain_set(const char *logdomain) |
3a8b2e78 UH |
124 | { |
125 | if (!logdomain) { | |
126 | srd_err("log: %s: logdomain was NULL", __func__); | |
127 | return SRD_ERR_ARG; | |
128 | } | |
129 | ||
3a8b2e78 UH |
130 | snprintf((char *)&srd_log_domain, LOGDOMAIN_MAXLEN, "%s", logdomain); |
131 | ||
41106a07 | 132 | srd_dbg("Log domain set to '%s'.", (const char *)&srd_log_domain); |
3a8b2e78 UH |
133 | |
134 | return SRD_OK; | |
135 | } | |
136 | ||
137 | /** | |
41106a07 | 138 | * Get the currently configured libsigrokdecode logdomain. |
3a8b2e78 | 139 | * |
41106a07 UH |
140 | * @return A copy of the currently configured libsigrokdecode logdomain |
141 | * string. The caller is responsible for g_free()ing the string when | |
142 | * it is no longer needed. | |
8c664ca2 UH |
143 | * |
144 | * @since 0.1.0 | |
3a8b2e78 | 145 | */ |
55c3c5f4 | 146 | SRD_API char *srd_log_logdomain_get(void) |
3a8b2e78 | 147 | { |
41106a07 | 148 | return g_strdup((const char *)&srd_log_domain); |
3a8b2e78 UH |
149 | } |
150 | ||
66e4c27c | 151 | /** |
0082d592 | 152 | * Set the libsigrokdecode log callback to the specified function. |
66e4c27c | 153 | * |
0082d592 UH |
154 | * @param cb Function pointer to the log callback function to use. |
155 | * Must not be NULL. | |
41a5d962 UH |
156 | * @param cb_data Pointer to private data to be passed on. This can be used |
157 | * by the caller to pass arbitrary data to the log functions. | |
158 | * This pointer is only stored or passed on by libsigrokdecode, | |
159 | * and is never used or interpreted in any way. The pointer | |
160 | * is allowed to be NULL if the caller doesn't need/want to | |
161 | * pass any data. | |
582c8473 | 162 | * |
66e4c27c | 163 | * @return SRD_OK upon success, SRD_ERR_ARG upon invalid arguments. |
8c664ca2 | 164 | * |
c57d1013 | 165 | * @since 0.3.0 |
66e4c27c | 166 | */ |
2372b199 | 167 | SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data) |
66e4c27c | 168 | { |
0082d592 UH |
169 | if (!cb) { |
170 | srd_err("log: %s: cb was NULL", __func__); | |
66e4c27c UH |
171 | return SRD_ERR_ARG; |
172 | } | |
173 | ||
41a5d962 | 174 | /* Note: 'cb_data' is allowed to be NULL. */ |
66e4c27c | 175 | |
2372b199 UH |
176 | srd_log_cb = cb; |
177 | srd_log_cb_data = cb_data; | |
66e4c27c UH |
178 | |
179 | return SRD_OK; | |
180 | } | |
181 | ||
182 | /** | |
0082d592 | 183 | * Set the libsigrokdecode log callback to the default built-in one. |
66e4c27c | 184 | * |
2372b199 | 185 | * Additionally, the internal 'srd_log_cb_data' pointer is set to NULL. |
66e4c27c | 186 | * |
582c8473 | 187 | * @return SRD_OK upon success, a (negative) error code otherwise. |
8c664ca2 UH |
188 | * |
189 | * @since 0.1.0 | |
66e4c27c | 190 | */ |
0082d592 | 191 | SRD_API int srd_log_callback_set_default(void) |
66e4c27c UH |
192 | { |
193 | /* | |
194 | * Note: No log output in this function, as it should safely work | |
0082d592 | 195 | * even if the currently set log callback is buggy/broken. |
66e4c27c | 196 | */ |
2372b199 UH |
197 | srd_log_cb = srd_logv; |
198 | srd_log_cb_data = NULL; | |
66e4c27c UH |
199 | |
200 | return SRD_OK; | |
201 | } | |
202 | ||
41a5d962 | 203 | static int srd_logv(void *cb_data, int loglevel, const char *format, |
e09023b9 | 204 | va_list args) |
43c0a640 UH |
205 | { |
206 | int ret; | |
207 | ||
0082d592 | 208 | /* This specific log callback doesn't need the void pointer data. */ |
41a5d962 | 209 | (void)cb_data; |
66e4c27c | 210 | |
43c0a640 | 211 | /* Only output messages of at least the selected loglevel(s). */ |
aa6506b8 | 212 | if (loglevel > cur_loglevel) |
1f2e00d1 | 213 | return SRD_OK; |
43c0a640 | 214 | |
3a8b2e78 | 215 | if (srd_log_domain[0] != '\0') |
568112ce | 216 | fprintf(stderr, "%s", srd_log_domain); |
43c0a640 UH |
217 | ret = vfprintf(stderr, format, args); |
218 | fprintf(stderr, "\n"); | |
219 | ||
220 | return ret; | |
221 | } | |
222 | ||
57790bc8 | 223 | /** @private */ |
55c3c5f4 | 224 | SRD_PRIV int srd_log(int loglevel, const char *format, ...) |
43c0a640 UH |
225 | { |
226 | int ret; | |
227 | va_list args; | |
228 | ||
229 | va_start(args, format); | |
2372b199 | 230 | ret = srd_log_cb(srd_log_cb_data, loglevel, format, args); |
43c0a640 UH |
231 | va_end(args); |
232 | ||
233 | return ret; | |
234 | } | |
235 | ||
57790bc8 | 236 | /** @private */ |
55c3c5f4 | 237 | SRD_PRIV int srd_spew(const char *format, ...) |
43c0a640 UH |
238 | { |
239 | int ret; | |
240 | va_list args; | |
241 | ||
242 | va_start(args, format); | |
2372b199 | 243 | ret = srd_log_cb(srd_log_cb_data, SRD_LOG_SPEW, format, args); |
43c0a640 UH |
244 | va_end(args); |
245 | ||
246 | return ret; | |
247 | } | |
248 | ||
57790bc8 | 249 | /** @private */ |
55c3c5f4 | 250 | SRD_PRIV int srd_dbg(const char *format, ...) |
43c0a640 UH |
251 | { |
252 | int ret; | |
253 | va_list args; | |
254 | ||
255 | va_start(args, format); | |
2372b199 | 256 | ret = srd_log_cb(srd_log_cb_data, SRD_LOG_DBG, format, args); |
43c0a640 UH |
257 | va_end(args); |
258 | ||
259 | return ret; | |
260 | } | |
261 | ||
57790bc8 | 262 | /** @private */ |
55c3c5f4 | 263 | SRD_PRIV int srd_info(const char *format, ...) |
43c0a640 UH |
264 | { |
265 | int ret; | |
266 | va_list args; | |
267 | ||
268 | va_start(args, format); | |
2372b199 | 269 | ret = srd_log_cb(srd_log_cb_data, SRD_LOG_INFO, format, args); |
43c0a640 UH |
270 | va_end(args); |
271 | ||
272 | return ret; | |
273 | } | |
274 | ||
57790bc8 | 275 | /** @private */ |
55c3c5f4 | 276 | SRD_PRIV int srd_warn(const char *format, ...) |
43c0a640 UH |
277 | { |
278 | int ret; | |
279 | va_list args; | |
280 | ||
281 | va_start(args, format); | |
2372b199 | 282 | ret = srd_log_cb(srd_log_cb_data, SRD_LOG_WARN, format, args); |
43c0a640 UH |
283 | va_end(args); |
284 | ||
285 | return ret; | |
286 | } | |
287 | ||
57790bc8 | 288 | /** @private */ |
55c3c5f4 | 289 | SRD_PRIV int srd_err(const char *format, ...) |
43c0a640 UH |
290 | { |
291 | int ret; | |
292 | va_list args; | |
293 | ||
294 | va_start(args, format); | |
2372b199 | 295 | ret = srd_log_cb(srd_log_cb_data, SRD_LOG_ERR, format, args); |
43c0a640 UH |
296 | va_end(args); |
297 | ||
298 | return ret; | |
299 | } | |
4895418c UH |
300 | |
301 | /** @} */ |