2 * This file is part of the sigrok 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
24 #include "sigrok-internal.h"
26 /* Currently selected libsigrok loglevel. Default: SR_LOG_WARN. */
27 static int sr_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */
29 /* Function prototype. */
30 static int sr_logv(void *data, int loglevel, const char *format, va_list args);
32 /* Pointer to the currently selected log handler. Default: sr_logv(). */
33 static sr_log_handler_t sr_log_handler = sr_logv;
36 * Pointer to private data that can be passed to the log handler.
37 * This can be used (for example) by C++ GUIs to pass a "this" pointer.
39 static void *sr_log_handler_data = NULL;
41 /* Log domain (a short string that is used as prefix for all messages). */
42 #define LOGDOMAIN_MAXLEN 30
43 #define LOGDOMAIN_DEFAULT "sr: "
44 static char sr_log_domain[LOGDOMAIN_MAXLEN + 1] = LOGDOMAIN_DEFAULT;
47 * Set the libsigrok loglevel.
49 * This influences the amount of log messages (debug messages, error messages,
50 * and so on) libsigrok will output. Using SR_LOG_NONE disables all messages.
52 * Note that this function itself will also output log messages. After the
53 * loglevel has changed, it will output a debug message with SR_LOG_DBG for
54 * example. Whether this message is shown depends on the (new) loglevel.
56 * @param loglevel The loglevel to set (SR_LOG_NONE, SR_LOG_ERR, SR_LOG_WARN,
57 * SR_LOG_INFO, SR_LOG_DBG, or SR_LOG_SPEW).
59 * @return SR_OK upon success, SR_ERR_ARG upon invalid loglevel.
61 SR_API int sr_log_loglevel_set(int loglevel)
63 if (loglevel < SR_LOG_NONE || loglevel > SR_LOG_SPEW) {
64 sr_err("Invalid loglevel %d.", loglevel);
68 sr_loglevel = loglevel;
70 sr_dbg("libsigrok loglevel set to %d.", loglevel);
76 * Get the libsigrok loglevel.
78 * @return The currently configured libsigrok loglevel.
80 SR_API int sr_log_loglevel_get(void)
86 * Set the libsigrok logdomain string.
88 * @param logdomain The string to use as logdomain for libsigrok log
89 * messages from now on. Must not be NULL. The maximum
90 * length of the string is 30 characters (this does not
91 * include the trailing NUL-byte). Longer strings are
93 * In order to not use a logdomain, pass an empty string.
94 * The function makes its own copy of the input string, i.e.
95 * the caller does not need to keep it around.
97 * @return SR_OK upon success, SR_ERR_ARG upon invalid logdomain.
99 SR_API int sr_log_logdomain_set(const char *logdomain)
102 sr_err("log: %s: logdomain was NULL", __func__);
106 /* TODO: Error handling. */
107 snprintf((char *)&sr_log_domain, LOGDOMAIN_MAXLEN, "%s", logdomain);
109 sr_dbg("Log domain set to '%s'.", (const char *)&sr_log_domain);
115 * Get the currently configured libsigrok logdomain.
117 * @return A copy of the currently configured libsigrok logdomain
118 * string. The caller is responsible for g_free()ing the string when
119 * it is no longer needed.
121 SR_API char *sr_log_logdomain_get(void)
123 return g_strdup((const char *)&sr_log_domain);
127 * Set the libsigrok log handler to the specified function.
129 * @param handler Function pointer to the log handler function to use.
131 * @param data Pointer to private data to be passed on. This can be used by
132 * the caller to pass arbitrary data to the log functions. This
133 * pointer is only stored or passed on by libsigrok, and
134 * is never used or interpreted in any way. The pointer is allowed
135 * to be NULL if the caller doesn't need/want to pass any data.
137 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
139 SR_API int sr_log_handler_set(sr_log_handler_t handler, void *data)
142 sr_err("log: %s: handler was NULL", __func__);
146 /* Note: 'data' is allowed to be NULL. */
148 sr_log_handler = handler;
149 sr_log_handler_data = data;
155 * Set the libsigrok log handler to the default built-in one.
157 * Additionally, the internal 'sr_log_handler_data' pointer is set to NULL.
159 * @return SR_OK upon success, a negative error code otherwise.
161 SR_API int sr_log_handler_set_default(void)
164 * Note: No log output in this function, as it should safely work
165 * even if the currently set log handler is buggy/broken.
167 sr_log_handler = sr_logv;
168 sr_log_handler_data = NULL;
173 static int sr_logv(void *data, int loglevel, const char *format, va_list args)
177 /* This specific log handler doesn't need the void pointer data. */
180 /* Only output messages of at least the selected loglevel(s). */
181 if (loglevel > sr_loglevel)
182 return SR_OK; /* TODO? */
184 if (sr_log_domain[0] != '\0')
185 fprintf(stderr, "%s", sr_log_domain);
186 ret = vfprintf(stderr, format, args);
187 fprintf(stderr, "\n");
192 SR_PRIV int sr_log(int loglevel, const char *format, ...)
197 va_start(args, format);
198 ret = sr_log_handler(sr_log_handler_data, loglevel, format, args);
204 SR_PRIV int sr_spew(const char *format, ...)
209 va_start(args, format);
210 ret = sr_log_handler(sr_log_handler_data, SR_LOG_SPEW, format, args);
216 SR_PRIV int sr_dbg(const char *format, ...)
221 va_start(args, format);
222 ret = sr_log_handler(sr_log_handler_data, SR_LOG_DBG, format, args);
228 SR_PRIV int sr_info(const char *format, ...)
233 va_start(args, format);
234 ret = sr_log_handler(sr_log_handler_data, SR_LOG_INFO, format, args);
240 SR_PRIV int sr_warn(const char *format, ...)
245 va_start(args, format);
246 ret = sr_log_handler(sr_log_handler_data, SR_LOG_WARN, format, args);
252 SR_PRIV int sr_err(const char *format, ...)
257 va_start(args, format);
258 ret = sr_log_handler(sr_log_handler_data, SR_LOG_ERR, format, args);