2 * This file is part of the libsigrok project.
4 * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
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.
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.
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
23 #include "libsigrok.h"
24 #define NO_LOG_WRAPPERS
25 #include "libsigrok-internal.h"
30 * Controlling the libsigrok message logging functionality.
34 * @defgroup grp_logging Logging
36 * Controlling the libsigrok message logging functionality.
41 /* Currently selected libsigrok loglevel. Default: SR_LOG_WARN. */
42 static int sr_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */
44 /* Function prototype. */
45 static int sr_logv(void *cb_data, int loglevel, const char *format,
48 /* Pointer to the currently selected log callback. Default: sr_logv(). */
49 static sr_log_callback_t sr_log_callback = sr_logv;
52 * Pointer to private data that can be passed to the log callback.
53 * This can be used (for example) by C++ GUIs to pass a "this" pointer.
55 static void *sr_log_callback_data = NULL;
57 /* Log domain (a short string that is used as prefix for all messages). */
59 #define LOGDOMAIN_MAXLEN 30
60 #define LOGDOMAIN_DEFAULT "sr: "
62 static char sr_log_domain[LOGDOMAIN_MAXLEN + 1] = LOGDOMAIN_DEFAULT;
65 * Set the libsigrok loglevel.
67 * This influences the amount of log messages (debug messages, error messages,
68 * and so on) libsigrok will output. Using SR_LOG_NONE disables all messages.
70 * Note that this function itself will also output log messages. After the
71 * loglevel has changed, it will output a debug message with SR_LOG_DBG for
72 * example. Whether this message is shown depends on the (new) loglevel.
74 * @param loglevel The loglevel to set (SR_LOG_NONE, SR_LOG_ERR, SR_LOG_WARN,
75 * SR_LOG_INFO, SR_LOG_DBG, or SR_LOG_SPEW).
77 * @return SR_OK upon success, SR_ERR_ARG upon invalid loglevel.
81 SR_API int sr_log_loglevel_set(int loglevel)
83 if (loglevel < SR_LOG_NONE || loglevel > SR_LOG_SPEW) {
84 sr_err("Invalid loglevel %d.", loglevel);
88 sr_loglevel = loglevel;
90 sr_dbg("libsigrok loglevel set to %d.", loglevel);
96 * Get the libsigrok loglevel.
98 * @return The currently configured libsigrok loglevel.
102 SR_API int sr_log_loglevel_get(void)
108 * Set the libsigrok logdomain string.
110 * @param logdomain The string to use as logdomain for libsigrok 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.
119 * @return SR_OK upon success, SR_ERR_ARG upon invalid logdomain.
123 SR_API int sr_log_logdomain_set(const char *logdomain)
126 sr_err("log: %s: logdomain was NULL", __func__);
130 /* TODO: Error handling. */
131 snprintf((char *)&sr_log_domain, LOGDOMAIN_MAXLEN, "%s", logdomain);
133 sr_dbg("Log domain set to '%s'.", (const char *)&sr_log_domain);
139 * Get the currently configured libsigrok logdomain.
141 * @return A copy of the currently configured libsigrok logdomain
142 * string. The caller is responsible for g_free()ing the string when
143 * it is no longer needed.
147 SR_API char *sr_log_logdomain_get(void)
149 return g_strdup((const char *)&sr_log_domain);
153 * Set the libsigrok log callback to the specified function.
155 * @param cb Function pointer to the log callback function to use.
157 * @param cb_data Pointer to private data to be passed on. This can be used by
158 * the caller to pass arbitrary data to the log functions. This
159 * pointer is only stored or passed on by libsigrok, and is
160 * never used or interpreted in any way. The pointer is allowed
161 * to be NULL if the caller doesn't need/want to pass any data.
163 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
167 SR_API int sr_log_callback_set(sr_log_callback_t cb, void *cb_data)
170 sr_err("log: %s: cb was NULL", __func__);
174 /* Note: 'cb_data' is allowed to be NULL. */
176 sr_log_callback = cb;
177 sr_log_callback_data = cb_data;
183 * Set the libsigrok log callback to the default built-in one.
185 * Additionally, the internal 'sr_log_callback_data' pointer is set to NULL.
187 * @return SR_OK upon success, a negative error code otherwise.
191 SR_API int sr_log_callback_set_default(void)
194 * Note: No log output in this function, as it should safely work
195 * even if the currently set log callback is buggy/broken.
197 sr_log_callback = sr_logv;
198 sr_log_callback_data = NULL;
203 static int sr_logv(void *cb_data, int loglevel, const char *format, va_list args)
207 /* This specific log callback doesn't need the void pointer data. */
210 /* Only output messages of at least the selected loglevel(s). */
211 if (loglevel > sr_loglevel)
212 return SR_OK; /* TODO? */
214 if (sr_log_domain[0] != '\0')
215 fprintf(stderr, "%s", sr_log_domain);
216 ret = vfprintf(stderr, format, args);
217 fprintf(stderr, "\n");
223 SR_PRIV int sr_log(int loglevel, const char *format, ...)
228 va_start(args, format);
229 ret = sr_log_callback(sr_log_callback_data, loglevel, format, args);
236 SR_PRIV int sr_spew(const char *format, ...)
241 va_start(args, format);
242 ret = sr_log_callback(sr_log_callback_data, SR_LOG_SPEW, format, args);
249 SR_PRIV int sr_dbg(const char *format, ...)
254 va_start(args, format);
255 ret = sr_log_callback(sr_log_callback_data, SR_LOG_DBG, format, args);
262 SR_PRIV int sr_info(const char *format, ...)
267 va_start(args, format);
268 ret = sr_log_callback(sr_log_callback_data, SR_LOG_INFO, format, args);
275 SR_PRIV int sr_warn(const char *format, ...)
280 va_start(args, format);
281 ret = sr_log_callback(sr_log_callback_data, SR_LOG_WARN, format, args);
288 SR_PRIV int sr_err(const char *format, ...)
293 va_start(args, format);
294 ret = sr_log_callback(sr_log_callback_data, SR_LOG_ERR, format, args);