X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=log.c;h=46fa9e5fc5519da2e276d1294930ca2e96bb5c04;hp=c89a74bce8506a544e92f61484494be0ba8fd653;hb=1f2e00d140ac41a3a61888f67fc6f96c4369bea3;hpb=7a1712c4fd07f64222079acd5ec3fa3348a5cb15 diff --git a/log.c b/log.c index c89a74b..46fa9e5 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 * @@ -18,29 +18,46 @@ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ -#include "sigrokdecode.h" -#include "sigrokdecode-internal.h" +#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ +#include "libsigrokdecode-internal.h" #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. */ /* Function prototype. */ -static int srd_logv(void *data, int loglevel, const char *format, va_list args); +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_handler = srd_logv; +/* Pointer to the currently selected log callback. Default: srd_logv(). */ +static srd_log_callback_t srd_log_callback = 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_handler_data = NULL; +static void *srd_log_callback_data = NULL; /* Log domain (a short string that is used as prefix for all messages). */ +/** @cond PRIVATE */ #define LOGDOMAIN_MAXLEN 30 #define LOGDOMAIN_DEFAULT "srd: " +/** @endcond */ static char srd_log_domain[LOGDOMAIN_MAXLEN + 1] = LOGDOMAIN_DEFAULT; /** @@ -50,11 +67,18 @@ static char srd_log_domain[LOGDOMAIN_MAXLEN + 1] = LOGDOMAIN_DEFAULT; * and so on) libsigrokdecode will output. Using SRD_LOG_NONE disables all * messages. * + * Note that this function itself will also output log messages. After the + * loglevel has changed, it will output a debug message with SRD_LOG_DBG for + * example. Whether this message is shown depends on the (new) loglevel. + * * @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 */ -int srd_set_loglevel(int loglevel) +SRD_API int srd_log_loglevel_set(int loglevel) { if (loglevel < SRD_LOG_NONE || loglevel > SRD_LOG_SPEW) { srd_err("Invalid loglevel %d.", loglevel); @@ -72,175 +96,211 @@ int srd_set_loglevel(int loglevel) * Get the libsigrokdecode loglevel. * * @return The currently configured libsigrokdecode loglevel. + * + * @since 0.1.0 */ -int srd_get_loglevel(void) +SRD_API int srd_log_loglevel_get(void) { return srd_loglevel; } /** - * TODO. + * Set the libsigrokdecode logdomain string. + * + * @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. * - * @param logdomain TODO - * @return TODO. + * @return SRD_OK upon success, SRD_ERR_ARG upon invalid logdomain. + * + * @since 0.1.0 */ -int srd_log_set_logdomain(const char *logdomain) +SRD_API int srd_log_logdomain_set(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); + srd_dbg("Log domain set to '%s'.", (const char *)&srd_log_domain); return SRD_OK; } /** - * TODO. + * Get the currently configured libsigrokdecode logdomain. + * + * @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. * - * @return TODO. + * @since 0.1.0 */ -char *srd_log_get_logdomain(void) +SRD_API char *srd_log_logdomain_get(void) { - return g_strdup((char *)srd_log_domain); + return g_strdup((const 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. + * 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. + * + * @since 0.1.0 */ -int srd_log_set_handler(srd_log_handler_t handler, void *data) +SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data) { - if (!handler) { - srd_err("log: %s: handler was NULL", __func__); + if (!cb) { + srd_err("log: %s: cb was NULL", __func__); return SRD_ERR_ARG; } - /* Note: 'data' is allowed to be NULL. */ + /* Note: 'cb_data' is allowed to be NULL. */ - srd_handler = handler; - srd_handler_data = data; + srd_log_callback = cb; + srd_log_callback_data = 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_handler_data' pointer is set to NULL. + * Additionally, the internal 'srd_log_callback_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 */ -int srd_log_set_default_handler(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_handler = srd_logv; - srd_handler_data = NULL; + srd_log_callback = srd_logv; + srd_log_callback_data = NULL; return SRD_OK; } -static int srd_logv(void *data, int loglevel, const char *format, va_list args) +static int srd_logv(void *cb_data, int loglevel, const char *format, + va_list args) { int ret; - /* This specific log handler doesn't need the void pointer data. */ - (void)data; + /* This specific log callback doesn't need the void pointer data. */ + (void)cb_data; /* Only output messages of at least the selected loglevel(s). */ if (loglevel > srd_loglevel) - return SRD_OK; /* TODO? */ + return SRD_OK; if (srd_log_domain[0] != '\0') - fprintf(stderr, srd_log_domain); + fprintf(stderr, "%s", srd_log_domain); ret = vfprintf(stderr, format, args); fprintf(stderr, "\n"); return ret; } -int srd_log(int loglevel, const char *format, ...) +/** @private */ +SRD_PRIV int srd_log(int loglevel, const char *format, ...) { int ret; va_list args; va_start(args, format); - ret = srd_handler(srd_handler_data, loglevel, format, args); + ret = srd_log_callback(srd_log_callback_data, loglevel, format, args); va_end(args); return ret; } -int srd_spew(const char *format, ...) +/** @private */ +SRD_PRIV int srd_spew(const char *format, ...) { int ret; va_list args; va_start(args, format); - ret = srd_handler(srd_handler_data, SRD_LOG_SPEW, format, args); + ret = srd_log_callback(srd_log_callback_data, SRD_LOG_SPEW, + format, args); va_end(args); return ret; } -int srd_dbg(const char *format, ...) +/** @private */ +SRD_PRIV int srd_dbg(const char *format, ...) { int ret; va_list args; va_start(args, format); - ret = srd_handler(srd_handler_data, SRD_LOG_DBG, format, args); + ret = srd_log_callback(srd_log_callback_data, SRD_LOG_DBG, + format, args); va_end(args); return ret; } -int srd_info(const char *format, ...) +/** @private */ +SRD_PRIV int srd_info(const char *format, ...) { int ret; va_list args; va_start(args, format); - ret = srd_handler(srd_handler_data, SRD_LOG_INFO, format, args); + ret = srd_log_callback(srd_log_callback_data, SRD_LOG_INFO, + format, args); va_end(args); return ret; } -int srd_warn(const char *format, ...) +/** @private */ +SRD_PRIV int srd_warn(const char *format, ...) { int ret; va_list args; va_start(args, format); - ret = srd_handler(srd_handler_data, SRD_LOG_WARN, format, args); + ret = srd_log_callback(srd_log_callback_data, SRD_LOG_WARN, + format, args); va_end(args); return ret; } -int srd_err(const char *format, ...) +/** @private */ +SRD_PRIV int srd_err(const char *format, ...) { int ret; va_list args; va_start(args, format); - ret = srd_handler(srd_handler_data, SRD_LOG_ERR, format, args); + ret = srd_log_callback(srd_log_callback_data, SRD_LOG_ERR, + format, args); va_end(args); return ret; } + +/** @} */