]>
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 | ||
f6c7eade MC |
21 | #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ |
22 | #include "libsigrokdecode.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 | |
43c0a640 UH |
56 | /** |
57 | * Set the libsigrokdecode loglevel. | |
58 | * | |
59 | * This influences the amount of log messages (debug messages, error messages, | |
60 | * and so on) libsigrokdecode will output. Using SRD_LOG_NONE disables all | |
61 | * messages. | |
62 | * | |
41106a07 UH |
63 | * Note that this function itself will also output log messages. After the |
64 | * loglevel has changed, it will output a debug message with SRD_LOG_DBG for | |
65 | * example. Whether this message is shown depends on the (new) loglevel. | |
66 | * | |
43c0a640 UH |
67 | * @param loglevel The loglevel to set (SRD_LOG_NONE, SRD_LOG_ERR, |
68 | * SRD_LOG_WARN, SRD_LOG_INFO, SRD_LOG_DBG, or SRD_LOG_SPEW). | |
582c8473 | 69 | * |
a62186e4 | 70 | * @return SRD_OK upon success, SRD_ERR_ARG upon invalid loglevel. |
8c664ca2 UH |
71 | * |
72 | * @since 0.1.0 | |
43c0a640 | 73 | */ |
55c3c5f4 | 74 | SRD_API int srd_log_loglevel_set(int loglevel) |
43c0a640 UH |
75 | { |
76 | if (loglevel < SRD_LOG_NONE || loglevel > SRD_LOG_SPEW) { | |
d906d3f9 | 77 | srd_err("Invalid loglevel %d.", loglevel); |
a62186e4 | 78 | return SRD_ERR_ARG; |
43c0a640 UH |
79 | } |
80 | ||
aa6506b8 | 81 | cur_loglevel = loglevel; |
43c0a640 | 82 | |
7a1712c4 | 83 | srd_dbg("libsigrokdecode loglevel set to %d.", loglevel); |
43c0a640 UH |
84 | |
85 | return SRD_OK; | |
86 | } | |
87 | ||
88 | /** | |
89 | * Get the libsigrokdecode loglevel. | |
90 | * | |
91 | * @return The currently configured libsigrokdecode loglevel. | |
8c664ca2 UH |
92 | * |
93 | * @since 0.1.0 | |
43c0a640 | 94 | */ |
55c3c5f4 | 95 | SRD_API int srd_log_loglevel_get(void) |
43c0a640 | 96 | { |
aa6506b8 | 97 | return cur_loglevel; |
43c0a640 UH |
98 | } |
99 | ||
66e4c27c | 100 | /** |
0082d592 | 101 | * Set the libsigrokdecode log callback to the specified function. |
66e4c27c | 102 | * |
0082d592 UH |
103 | * @param cb Function pointer to the log callback function to use. |
104 | * Must not be NULL. | |
41a5d962 UH |
105 | * @param cb_data Pointer to private data to be passed on. This can be used |
106 | * by the caller to pass arbitrary data to the log functions. | |
107 | * This pointer is only stored or passed on by libsigrokdecode, | |
108 | * and is never used or interpreted in any way. The pointer | |
109 | * is allowed to be NULL if the caller doesn't need/want to | |
110 | * pass any data. | |
582c8473 | 111 | * |
66e4c27c | 112 | * @return SRD_OK upon success, SRD_ERR_ARG upon invalid arguments. |
8c664ca2 | 113 | * |
c57d1013 | 114 | * @since 0.3.0 |
66e4c27c | 115 | */ |
2372b199 | 116 | SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data) |
66e4c27c | 117 | { |
0082d592 UH |
118 | if (!cb) { |
119 | srd_err("log: %s: cb was NULL", __func__); | |
66e4c27c UH |
120 | return SRD_ERR_ARG; |
121 | } | |
122 | ||
41a5d962 | 123 | /* Note: 'cb_data' is allowed to be NULL. */ |
66e4c27c | 124 | |
2372b199 UH |
125 | srd_log_cb = cb; |
126 | srd_log_cb_data = cb_data; | |
66e4c27c UH |
127 | |
128 | return SRD_OK; | |
129 | } | |
130 | ||
131 | /** | |
0082d592 | 132 | * Set the libsigrokdecode log callback to the default built-in one. |
66e4c27c | 133 | * |
2372b199 | 134 | * Additionally, the internal 'srd_log_cb_data' pointer is set to NULL. |
66e4c27c | 135 | * |
582c8473 | 136 | * @return SRD_OK upon success, a (negative) error code otherwise. |
8c664ca2 UH |
137 | * |
138 | * @since 0.1.0 | |
66e4c27c | 139 | */ |
0082d592 | 140 | SRD_API int srd_log_callback_set_default(void) |
66e4c27c UH |
141 | { |
142 | /* | |
143 | * Note: No log output in this function, as it should safely work | |
0082d592 | 144 | * even if the currently set log callback is buggy/broken. |
66e4c27c | 145 | */ |
2372b199 UH |
146 | srd_log_cb = srd_logv; |
147 | srd_log_cb_data = NULL; | |
66e4c27c UH |
148 | |
149 | return SRD_OK; | |
150 | } | |
151 | ||
41a5d962 | 152 | static int srd_logv(void *cb_data, int loglevel, const char *format, |
e09023b9 | 153 | va_list args) |
43c0a640 UH |
154 | { |
155 | int ret; | |
156 | ||
0082d592 | 157 | /* This specific log callback doesn't need the void pointer data. */ |
41a5d962 | 158 | (void)cb_data; |
66e4c27c | 159 | |
43c0a640 | 160 | /* Only output messages of at least the selected loglevel(s). */ |
aa6506b8 | 161 | if (loglevel > cur_loglevel) |
1f2e00d1 | 162 | return SRD_OK; |
43c0a640 | 163 | |
9fb7e7fe | 164 | fputs("srd: ", stderr); |
43c0a640 UH |
165 | ret = vfprintf(stderr, format, args); |
166 | fprintf(stderr, "\n"); | |
167 | ||
168 | return ret; | |
169 | } | |
170 | ||
57790bc8 | 171 | /** @private */ |
55c3c5f4 | 172 | SRD_PRIV int srd_log(int loglevel, const char *format, ...) |
43c0a640 UH |
173 | { |
174 | int ret; | |
175 | va_list args; | |
176 | ||
177 | va_start(args, format); | |
2372b199 | 178 | ret = srd_log_cb(srd_log_cb_data, loglevel, format, args); |
43c0a640 UH |
179 | va_end(args); |
180 | ||
181 | return ret; | |
182 | } | |
183 | ||
57790bc8 | 184 | /** @private */ |
55c3c5f4 | 185 | SRD_PRIV int srd_spew(const char *format, ...) |
43c0a640 UH |
186 | { |
187 | int ret; | |
188 | va_list args; | |
189 | ||
190 | va_start(args, format); | |
2372b199 | 191 | ret = srd_log_cb(srd_log_cb_data, SRD_LOG_SPEW, format, args); |
43c0a640 UH |
192 | va_end(args); |
193 | ||
194 | return ret; | |
195 | } | |
196 | ||
57790bc8 | 197 | /** @private */ |
55c3c5f4 | 198 | SRD_PRIV int srd_dbg(const char *format, ...) |
43c0a640 UH |
199 | { |
200 | int ret; | |
201 | va_list args; | |
202 | ||
203 | va_start(args, format); | |
2372b199 | 204 | ret = srd_log_cb(srd_log_cb_data, SRD_LOG_DBG, format, args); |
43c0a640 UH |
205 | va_end(args); |
206 | ||
207 | return ret; | |
208 | } | |
209 | ||
57790bc8 | 210 | /** @private */ |
55c3c5f4 | 211 | SRD_PRIV int srd_info(const char *format, ...) |
43c0a640 UH |
212 | { |
213 | int ret; | |
214 | va_list args; | |
215 | ||
216 | va_start(args, format); | |
2372b199 | 217 | ret = srd_log_cb(srd_log_cb_data, SRD_LOG_INFO, format, args); |
43c0a640 UH |
218 | va_end(args); |
219 | ||
220 | return ret; | |
221 | } | |
222 | ||
57790bc8 | 223 | /** @private */ |
55c3c5f4 | 224 | SRD_PRIV int srd_warn(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, SRD_LOG_WARN, format, args); |
43c0a640 UH |
231 | va_end(args); |
232 | ||
233 | return ret; | |
234 | } | |
235 | ||
57790bc8 | 236 | /** @private */ |
55c3c5f4 | 237 | SRD_PRIV int srd_err(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_ERR, format, args); |
43c0a640 UH |
244 | va_end(args); |
245 | ||
246 | return ret; | |
247 | } | |
4895418c UH |
248 | |
249 | /** @} */ |