X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=log.c;h=c89a74bce8506a544e92f61484494be0ba8fd653;hp=6add4470c39ede8d963a8ca69ccc2b603d40b1f4;hb=7a1712c4fd07f64222079acd5ec3fa3348a5cb15;hpb=a62186e44c606a8d4cb45b3d8c3cc9fa6a5038ea diff --git a/log.c b/log.c index 6add447..c89a74b 100644 --- a/log.c +++ b/log.c @@ -1,7 +1,7 @@ /* * This file is part of the sigrok project. * - * Copyright (C) 2011 Uwe Hermann + * Copyright (C) 2011-2012 Uwe Hermann * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -18,13 +18,31 @@ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ -#include -#include #include "sigrokdecode.h" #include "sigrokdecode-internal.h" +#include +#include +/* Currently selected libsigrokdecode loglevel. Default: SRD_LOG_WARN. */ static int srd_loglevel = SRD_LOG_WARN; /* Show errors+warnings per default. */ +/* Function prototype. */ +static int srd_logv(void *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_handler = srd_logv; + +/* + * Pointer to private data that can be passed to the log handler. + * This can be used (for example) by C++ GUIs to pass a "this" pointer. + */ +static void *srd_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; + /** * Set the libsigrokdecode loglevel. * @@ -39,14 +57,13 @@ static int srd_loglevel = SRD_LOG_WARN; /* Show errors+warnings per default. */ int srd_set_loglevel(int loglevel) { if (loglevel < SRD_LOG_NONE || loglevel > SRD_LOG_SPEW) { - srd_err("log: %s: invalid loglevel %d", __func__, loglevel); + srd_err("Invalid loglevel %d.", loglevel); return SRD_ERR_ARG; } srd_loglevel = loglevel; - srd_dbg("log: %s: libsigrokdecode loglevel set to %d", - __func__, loglevel); + srd_dbg("libsigrokdecode loglevel set to %d.", loglevel); return SRD_OK; } @@ -61,14 +78,95 @@ int srd_get_loglevel(void) return srd_loglevel; } -static int srd_logv(int loglevel, const char *format, va_list args) +/** + * TODO. + * + * @param logdomain TODO + * @return TODO. + */ +int srd_log_set_logdomain(const char *logdomain) +{ + if (!logdomain) { + srd_err("log: %s: logdomain was NULL", __func__); + return SRD_ERR_ARG; + } + + /* TODO: Error handling. */ + snprintf((char *)&srd_log_domain, LOGDOMAIN_MAXLEN, "%s", logdomain); + + srd_dbg("log domain set to '%s'", (const char *)&srd_log_domain); + + return SRD_OK; +} + +/** + * TODO. + * + * @return TODO. + */ +char *srd_log_get_logdomain(void) +{ + return g_strdup((char *)srd_log_domain); +} + +/** + * Set the libsigrokdecode log handler to the specified function. + * + * @param handler Function pointer to the log handler function to use. + * Must not be NULL. + * @param data Pointer to private data to be passed on. This can be used by + * the caller 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. + * @return SRD_OK upon success, SRD_ERR_ARG upon invalid arguments. + */ +int srd_log_set_handler(srd_log_handler_t handler, void *data) +{ + if (!handler) { + srd_err("log: %s: handler was NULL", __func__); + return SRD_ERR_ARG; + } + + /* Note: 'data' is allowed to be NULL. */ + + srd_handler = handler; + srd_handler_data = data; + + return SRD_OK; +} + +/** + * Set the libsigrokdecode log handler to the default built-in one. + * + * Additionally, the internal 'srd_handler_data' pointer is set to NULL. + * + * @return SRD_OK upon success, a negative error code otherwise. + */ +int srd_log_set_default_handler(void) +{ + /* + * Note: No log output in this function, as it should safely work + * even if the currently set log handler is buggy/broken. + */ + srd_handler = srd_logv; + srd_handler_data = NULL; + + return SRD_OK; +} + +static int srd_logv(void *data, int loglevel, const char *format, va_list args) { int ret; + /* This specific log handler doesn't need the void pointer data. */ + (void)data; + /* Only output messages of at least the selected loglevel(s). */ if (loglevel > srd_loglevel) return SRD_OK; /* TODO? */ + if (srd_log_domain[0] != '\0') + fprintf(stderr, srd_log_domain); ret = vfprintf(stderr, format, args); fprintf(stderr, "\n"); @@ -81,7 +179,7 @@ int srd_log(int loglevel, const char *format, ...) va_list args; va_start(args, format); - ret = srd_logv(loglevel, format, args); + ret = srd_handler(srd_handler_data, loglevel, format, args); va_end(args); return ret; @@ -93,7 +191,7 @@ int srd_spew(const char *format, ...) va_list args; va_start(args, format); - ret = srd_logv(SRD_LOG_SPEW, format, args); + ret = srd_handler(srd_handler_data, SRD_LOG_SPEW, format, args); va_end(args); return ret; @@ -105,7 +203,7 @@ int srd_dbg(const char *format, ...) va_list args; va_start(args, format); - ret = srd_logv(SRD_LOG_DBG, format, args); + ret = srd_handler(srd_handler_data, SRD_LOG_DBG, format, args); va_end(args); return ret; @@ -117,7 +215,7 @@ int srd_info(const char *format, ...) va_list args; va_start(args, format); - ret = srd_logv(SRD_LOG_INFO, format, args); + ret = srd_handler(srd_handler_data, SRD_LOG_INFO, format, args); va_end(args); return ret; @@ -129,7 +227,7 @@ int srd_warn(const char *format, ...) va_list args; va_start(args, format); - ret = srd_logv(SRD_LOG_WARN, format, args); + ret = srd_handler(srd_handler_data, SRD_LOG_WARN, format, args); va_end(args); return ret; @@ -141,7 +239,7 @@ int srd_err(const char *format, ...) va_list args; va_start(args, format); - ret = srd_logv(SRD_LOG_ERR, format, args); + ret = srd_handler(srd_handler_data, SRD_LOG_ERR, format, args); va_end(args); return ret;