X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=log.c;h=b5402f8bb8e21b81961be9f16b5ef9ebb3623827;hp=5693abfaed307ed918d793770f361f905507a7aa;hb=0dba8d303d5788539a5582a48444e8ecb5575b4f;hpb=e09023b9dc8f1d6783a3bf6b05402a88060a795f diff --git a/log.c b/log.c index 5693abf..b5402f8 100644 --- a/log.c +++ b/log.c @@ -1,5 +1,5 @@ /* - * This file is part of the sigrok project. + * This file is part of the libsigrokdecode project. * * Copyright (C) 2011-2012 Uwe Hermann * @@ -14,35 +14,45 @@ * 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, write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + * along with this program; if not, see . */ -#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ -#include "sigrokdecode-internal.h" +#include +#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ +#include "libsigrokdecode.h" #include #include +#include + +/** + * @file + * + * Controlling the libsigrokdecode message logging functionality. + */ + +/** + * @defgroup grp_logging Logging + * + * Controlling the libsigrokdecode message logging functionality. + * + * @{ + */ /* Currently selected libsigrokdecode loglevel. Default: SRD_LOG_WARN. */ -static int srd_loglevel = SRD_LOG_WARN; /* Show errors+warnings per default. */ +static int cur_loglevel = SRD_LOG_WARN; /* Show errors+warnings per default. */ /* Function prototype. */ -static int srd_logv(void *user_data, int loglevel, const char *format, +static int srd_logv(void *cb_data, int loglevel, const char *format, va_list args); -/* Pointer to the currently selected log handler. Default: srd_logv(). */ -static srd_log_handler_t srd_log_handler = srd_logv; +/* Pointer to the currently selected log callback. Default: srd_logv(). */ +static srd_log_callback srd_log_cb = srd_logv; /* - * Pointer to private data that can be passed to the log handler. + * Pointer to private data that can be passed to the log callback. * This can be used (for example) by C++ GUIs to pass a "this" pointer. */ -static void *srd_log_handler_data = NULL; - -/* Log domain (a short string that is used as prefix for all messages). */ -#define LOGDOMAIN_MAXLEN 30 -#define LOGDOMAIN_DEFAULT "srd: " -static char srd_log_domain[LOGDOMAIN_MAXLEN + 1] = LOGDOMAIN_DEFAULT; +static void *srd_log_cb_data = NULL; /** * Set the libsigrokdecode loglevel. @@ -57,7 +67,10 @@ static char srd_log_domain[LOGDOMAIN_MAXLEN + 1] = LOGDOMAIN_DEFAULT; * * @param loglevel The loglevel to set (SRD_LOG_NONE, SRD_LOG_ERR, * SRD_LOG_WARN, SRD_LOG_INFO, SRD_LOG_DBG, or SRD_LOG_SPEW). + * * @return SRD_OK upon success, SRD_ERR_ARG upon invalid loglevel. + * + * @since 0.1.0 */ SRD_API int srd_log_loglevel_set(int loglevel) { @@ -66,7 +79,7 @@ SRD_API int srd_log_loglevel_set(int loglevel) return SRD_ERR_ARG; } - srd_loglevel = loglevel; + cur_loglevel = loglevel; srd_dbg("libsigrokdecode loglevel set to %d.", loglevel); @@ -77,187 +90,121 @@ SRD_API int srd_log_loglevel_set(int loglevel) * Get the libsigrokdecode loglevel. * * @return The currently configured libsigrokdecode loglevel. + * + * @since 0.1.0 */ SRD_API int srd_log_loglevel_get(void) { - return srd_loglevel; + return cur_loglevel; } /** - * Set the libsigrokdecode logdomain string. + * Set the libsigrokdecode log callback to the specified function. + * + * @param cb Function pointer to the log callback function to use. + * Must not be NULL. + * @param cb_data Pointer to private data to be passed on. This can be used + * by the caller to pass arbitrary data to the log functions. + * This pointer is only stored or passed on by libsigrokdecode, + * and is never used or interpreted in any way. The pointer + * is allowed to be NULL if the caller doesn't need/want to + * pass any data. + * + * @return SRD_OK upon success, SRD_ERR_ARG upon invalid arguments. * - * @param logdomain The string to use as logdomain for libsigrokdecode log - * messages from now on. Must not be NULL. The maximum - * length of the string is 30 characters (this does not - * include the trailing NUL-byte). Longer strings are - * silently truncated. - * In order to not use a logdomain, pass an empty string. - * The function makes its own copy of the input string, i.e. - * the caller does not need to keep it around. - * @return SRD_OK upon success, SRD_ERR_ARG upon invalid logdomain. + * @since 0.3.0 */ -SRD_API int srd_log_logdomain_set(const char *logdomain) +SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data) { - if (!logdomain) { - srd_err("log: %s: logdomain was NULL", __func__); + if (!cb) { + srd_err("log: %s: cb was NULL", __func__); return SRD_ERR_ARG; } - /* TODO: Error handling. */ - snprintf((char *)&srd_log_domain, LOGDOMAIN_MAXLEN, "%s", logdomain); + /* Note: 'cb_data' is allowed to be NULL. */ - srd_dbg("Log domain set to '%s'.", (const char *)&srd_log_domain); + srd_log_cb = cb; + srd_log_cb_data = cb_data; return SRD_OK; } /** - * Get the currently configured libsigrokdecode logdomain. + * Get the libsigrokdecode log callback routine and callback data. * - * @return A copy of the currently configured libsigrokdecode logdomain - * string. The caller is responsible for g_free()ing the string when - * it is no longer needed. - */ -SRD_API char *srd_log_logdomain_get(void) -{ - return g_strdup((const char *)&srd_log_domain); -} - -/** - * Set the libsigrokdecode log handler to the specified function. + * @param[out] cb Pointer to a function pointer to receive the log callback + * function. Optional, can be NULL. + * @param[out] cb_data Pointer to a void pointer to receive the log callback's + * additional arguments. Optional, can be NULL. * - * @param handler Function pointer to the log handler function to use. - * Must not be NULL. - * @param user_data Pointer to private data to be passed on. This can be used - * by the caller to pass arbitrary data to the log functions. - * This pointer is only stored or passed on by libsigrokdecode, - * and is never used or interpreted in any way. The pointer - * is allowed to be NULL if the caller doesn't need/want to - * pass any data. - * @return SRD_OK upon success, SRD_ERR_ARG upon invalid arguments. + * @return SRD_OK upon success. + * + * @since 0.6.0 */ -SRD_API int srd_log_handler_set(srd_log_handler_t handler, void *user_data) +SRD_API int srd_log_callback_get(srd_log_callback *cb, void **cb_data) { - if (!handler) { - srd_err("log: %s: handler was NULL", __func__); - return SRD_ERR_ARG; - } - - /* Note: 'user_data' is allowed to be NULL. */ - - srd_log_handler = handler; - srd_log_handler_data = user_data; + if (cb) + *cb = srd_log_cb; + if (cb_data) + *cb_data = srd_log_cb_data; return SRD_OK; } /** - * Set the libsigrokdecode log handler to the default built-in one. + * Set the libsigrokdecode log callback to the default built-in one. + * + * Additionally, the internal 'srd_log_cb_data' pointer is set to NULL. * - * Additionally, the internal 'srd_log_handler_data' pointer is set to NULL. + * @return SRD_OK upon success, a (negative) error code otherwise. * - * @return SRD_OK upon success, a negative error code otherwise. + * @since 0.1.0 */ -SRD_API int srd_log_handler_set_default(void) +SRD_API int srd_log_callback_set_default(void) { /* * Note: No log output in this function, as it should safely work - * even if the currently set log handler is buggy/broken. + * even if the currently set log callback is buggy/broken. */ - srd_log_handler = srd_logv; - srd_log_handler_data = NULL; + srd_log_cb = srd_logv; + srd_log_cb_data = NULL; return SRD_OK; } -static int srd_logv(void *user_data, int loglevel, const char *format, +static int srd_logv(void *cb_data, int loglevel, const char *format, va_list args) { - int ret; + /* This specific log callback doesn't need the void pointer data. */ + (void)cb_data; - /* This specific log handler doesn't need the void pointer data. */ - (void)user_data; + (void)loglevel; - /* Only output messages of at least the selected loglevel(s). */ - if (loglevel > srd_loglevel) - return SRD_OK; /* TODO? */ + if (fputs("srd: ", stderr) < 0 + || g_vfprintf(stderr, format, args) < 0 + || putc('\n', stderr) < 0) + return SRD_ERR; - if (srd_log_domain[0] != '\0') - fprintf(stderr, "%s", srd_log_domain); - ret = vfprintf(stderr, format, args); - fprintf(stderr, "\n"); + fflush(stderr); - return ret; + return SRD_OK; } +/** @private */ SRD_PRIV int srd_log(int loglevel, const char *format, ...) { int ret; va_list args; - va_start(args, format); - ret = srd_log_handler(srd_log_handler_data, loglevel, format, args); - va_end(args); - - return ret; -} - -SRD_PRIV int srd_spew(const char *format, ...) -{ - int ret; - va_list args; - - va_start(args, format); - ret = srd_log_handler(srd_log_handler_data, SRD_LOG_SPEW, format, args); - va_end(args); - - return ret; -} - -SRD_PRIV int srd_dbg(const char *format, ...) -{ - int ret; - va_list args; - - va_start(args, format); - ret = srd_log_handler(srd_log_handler_data, SRD_LOG_DBG, format, args); - va_end(args); - - return ret; -} - -SRD_PRIV int srd_info(const char *format, ...) -{ - int ret; - va_list args; - - va_start(args, format); - ret = srd_log_handler(srd_log_handler_data, SRD_LOG_INFO, format, args); - va_end(args); - - return ret; -} - -SRD_PRIV int srd_warn(const char *format, ...) -{ - int ret; - va_list args; + /* Only output messages of at least the selected loglevel(s). */ + if (loglevel > cur_loglevel) + return SRD_OK; va_start(args, format); - ret = srd_log_handler(srd_log_handler_data, SRD_LOG_WARN, format, args); + ret = srd_log_cb(srd_log_cb_data, loglevel, format, args); va_end(args); return ret; } -SRD_PRIV int srd_err(const char *format, ...) -{ - int ret; - va_list args; - - va_start(args, format); - ret = srd_log_handler(srd_log_handler_data, SRD_LOG_ERR, format, args); - va_end(args); - - return ret; -} +/** @} */