Fix incorrect doxygen comment for srd_decoder_list().

[libsigrokdecode.git] / log.c

diff --git a/log.c b/log.c
index 49a18eb8eb925ec7f6b4b65a6b980ea860f8ff81..9d0bc73d5fb18891d12222c0d4e15f922d998533 100644 (file)
--- a/log.c
+++ b/log.c
@@ -18,8 +18,8 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "sigrokdecode-internal.h"
+#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode.h"
 #include <stdarg.h>
 #include <stdio.h>
 
@@ -38,20 +38,20 @@
  */
 
 /* 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 *cb_data, int loglevel, const char *format,
                    va_list args);
 
 /* Pointer to the currently selected log callback. Default: srd_logv(). */
-static srd_log_callback_t srd_log_callback = srd_logv;
+static srd_log_callback srd_log_cb = srd_logv;
 
 /*
  * 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_callback_data = NULL;
+static void *srd_log_cb_data = NULL;
 
 /* Log domain (a short string that is used as prefix for all messages). */
 /** @cond PRIVATE */
@@ -85,7 +85,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);
 
@@ -101,7 +101,7 @@ SRD_API int srd_log_loglevel_set(int loglevel)
  */
 SRD_API int srd_log_loglevel_get(void)
 {
-       return srd_loglevel;
+       return cur_loglevel;
 }
 
 /**
@@ -127,7 +127,6 @@ SRD_API int srd_log_logdomain_set(const char *logdomain)
                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);
@@ -163,9 +162,9 @@ SRD_API char *srd_log_logdomain_get(void)
  *
  * @return SRD_OK upon success, SRD_ERR_ARG upon invalid arguments.
  *
- * @since 0.1.0
+ * @since 0.3.0
  */
-SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data)
+SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data)
 {
        if (!cb) {
                srd_err("log: %s: cb was NULL", __func__);
@@ -174,8 +173,8 @@ SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data)
 
        /* Note: 'cb_data' is allowed to be NULL. */
 
-       srd_log_callback = cb;
-       srd_log_callback_data = cb_data;
+       srd_log_cb = cb;
+       srd_log_cb_data = cb_data;
 
        return SRD_OK;
 }
@@ -183,7 +182,7 @@ SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data)
 /**
  * Set the libsigrokdecode log callback to the default built-in one.
  *
- * Additionally, the internal 'srd_log_callback_data' pointer is set to NULL.
+ * Additionally, the internal 'srd_log_cb_data' pointer is set to NULL.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *
@@ -195,8 +194,8 @@ 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 callback is buggy/broken.
         */
-       srd_log_callback = srd_logv;
-       srd_log_callback_data = NULL;
+       srd_log_cb = srd_logv;
+       srd_log_cb_data = NULL;
 
        return SRD_OK;
 }
@@ -210,8 +209,8 @@ static int srd_logv(void *cb_data, int loglevel, const char *format,
        (void)cb_data;
 
        /* Only output messages of at least the selected loglevel(s). */
-       if (loglevel > srd_loglevel)
-               return SRD_OK; /* TODO? */
+       if (loglevel > cur_loglevel)
+               return SRD_OK;
 
        if (srd_log_domain[0] != '\0')
                fprintf(stderr, "%s", srd_log_domain);
@@ -228,7 +227,7 @@ SRD_PRIV int srd_log(int loglevel, const char *format, ...)
        va_list args;
 
        va_start(args, format);
-       ret = srd_log_callback(srd_log_callback_data, loglevel, format, args);
+       ret = srd_log_cb(srd_log_cb_data, loglevel, format, args);
        va_end(args);
 
        return ret;
@@ -241,8 +240,7 @@ SRD_PRIV int srd_spew(const char *format, ...)
        va_list args;
 
        va_start(args, format);
-       ret = srd_log_callback(srd_log_callback_data, SRD_LOG_SPEW,
-                              format, args);
+       ret = srd_log_cb(srd_log_cb_data, SRD_LOG_SPEW, format, args);
        va_end(args);
 
        return ret;
@@ -255,8 +253,7 @@ SRD_PRIV int srd_dbg(const char *format, ...)
        va_list args;
 
        va_start(args, format);
-       ret = srd_log_callback(srd_log_callback_data, SRD_LOG_DBG,
-                              format, args);
+       ret = srd_log_cb(srd_log_cb_data, SRD_LOG_DBG, format, args);
        va_end(args);
 
        return ret;
@@ -269,8 +266,7 @@ SRD_PRIV int srd_info(const char *format, ...)
        va_list args;
 
        va_start(args, format);
-       ret = srd_log_callback(srd_log_callback_data, SRD_LOG_INFO,
-                              format, args);
+       ret = srd_log_cb(srd_log_cb_data, SRD_LOG_INFO, format, args);
        va_end(args);
 
        return ret;
@@ -283,8 +279,7 @@ SRD_PRIV int srd_warn(const char *format, ...)
        va_list args;
 
        va_start(args, format);
-       ret = srd_log_callback(srd_log_callback_data, SRD_LOG_WARN,
-                              format, args);
+       ret = srd_log_cb(srd_log_cb_data, SRD_LOG_WARN, format, args);
        va_end(args);
 
        return ret;
@@ -297,8 +292,7 @@ SRD_PRIV int srd_err(const char *format, ...)
        va_list args;
 
        va_start(args, format);
-       ret = srd_log_callback(srd_log_callback_data, SRD_LOG_ERR,
-                              format, args);
+       ret = srd_log_cb(srd_log_cb_data, SRD_LOG_ERR, format, args);
        va_end(args);
 
        return ret;