srd: maxim_ds28ea00: Cosmetics, cleanups.

[libsigrokdecode.git] / log.c

diff --git a/log.c b/log.c
index 97fde915bfc3c412527a2541026be52dfdb41aa3..81e9251ba06a9d4d8a74cfe6130b4e13efc2c454 100644 (file)
--- a/log.c
+++ b/log.c
@@ -27,16 +27,17 @@
 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_log_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_log_handler_data = NULL;
+static void *srd_log_callback_data = NULL;
 
 /* Log domain (a short string that is used as prefix for all messages). */
 #define LOGDOMAIN_MAXLEN 30
@@ -56,6 +57,7 @@ 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.
  */
 SRD_API int srd_log_loglevel_set(int loglevel)
@@ -93,6 +95,7 @@ SRD_API int srd_log_loglevel_get(void)
  *                  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.
  */
 SRD_API int srd_log_logdomain_set(const char *logdomain)
@@ -123,57 +126,60 @@ SRD_API char *srd_log_logdomain_get(void)
 }
 
 /**
- * Set the libsigrokdecode log handler to the specified function.
+ * 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.
  *
- * @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 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.
  */
-SRD_API int srd_log_handler_set(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_log_handler = handler;
-       srd_log_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_log_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.
  */
-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_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)
@@ -193,7 +199,7 @@ SRD_PRIV int srd_log(int loglevel, const char *format, ...)
        va_list args;
 
        va_start(args, format);
-       ret = srd_log_handler(srd_log_handler_data, loglevel, format, args);
+       ret = srd_log_callback(srd_log_callback_data, loglevel, format, args);
        va_end(args);
 
        return ret;
@@ -205,7 +211,8 @@ SRD_PRIV int srd_spew(const char *format, ...)
        va_list args;
 
        va_start(args, format);
-       ret = srd_log_handler(srd_log_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;
@@ -217,7 +224,8 @@ SRD_PRIV int srd_dbg(const char *format, ...)
        va_list args;
 
        va_start(args, format);
-       ret = srd_log_handler(srd_log_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;
@@ -229,7 +237,8 @@ SRD_PRIV int srd_info(const char *format, ...)
        va_list args;
 
        va_start(args, format);
-       ret = srd_log_handler(srd_log_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;
@@ -241,7 +250,8 @@ SRD_PRIV int srd_warn(const char *format, ...)
        va_list args;
 
        va_start(args, format);
-       ret = srd_log_handler(srd_log_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;
@@ -253,7 +263,8 @@ SRD_PRIV int srd_err(const char *format, ...)
        va_list args;
 
        va_start(args, format);
-       ret = srd_log_handler(srd_log_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;