Various subsystems: Use message logging helpers.

[libsigrok.git] / strutil.c

diff --git a/strutil.c b/strutil.c
index 5be26bbc6ed57afac3b20b66a6b66c7fb5fb9ed6..c5e7dce81ffeefc1e503955b8169d4cfc900041a 100644 (file)
--- a/strutil.c
+++ b/strutil.c
@@ -24,6 +24,21 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/* Message logging helpers with driver-specific prefix string. */
+#define DRIVER_LOG_DOMAIN "strutil: "
+#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
+#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+
+/**
+ * @file
+ *
+ * Helper functions for handling or converting libsigrok-related strings.
+ */
+
 /**
  * @defgroup grp_strutil String utilities
  *
@@ -49,7 +64,7 @@
  */
 SR_API char *sr_si_string_u64(uint64_t x, const char *unit)
 {
-       if(unit == NULL)
+       if (unit == NULL)
                unit = "";
 
        if ((x >= SR_GHZ(1)) && (x % SR_GHZ(1) == 0)) {
@@ -73,8 +88,7 @@ SR_API char *sr_si_string_u64(uint64_t x, const char *unit)
                return g_strdup_printf("%" PRIu64 " %s", x, unit);
        }
 
-       sr_err("strutil: %s: Error creating SI units string.",
-               __func__);
+       sr_err("%s: Error creating SI units string.", __func__);
        return NULL;
 }
 
@@ -114,7 +128,7 @@ SR_API char *sr_period_string(uint64_t frequency)
 
        /* Allocate enough for a uint64_t as string + " ms". */
        if (!(o = g_try_malloc0(30 + 1))) {
-               sr_err("strutil: %s: o malloc failed", __func__);
+               sr_err("%s: o malloc failed", __func__);
                return NULL;
        }
 
@@ -155,7 +169,7 @@ SR_API char *sr_voltage_string(struct sr_rational *voltage)
        int r;
 
        if (!(o = g_try_malloc0(30 + 1))) {
-               sr_err("strutil: %s: o malloc failed", __func__);
+               sr_err("%s: o malloc failed", __func__);
                return NULL;
        }
 
@@ -212,13 +226,13 @@ SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
        error = FALSE;
 
        if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) {
-               sr_err("strutil: %s: triggerlist malloc failed", __func__);
+               sr_err("%s: triggerlist malloc failed", __func__);
                return NULL;
        }
 
        if (sdi->driver->info_get(SR_DI_TRIGGER_TYPES,
                        (const void **)&trigger_types, sdi) != SR_OK) {
-               sr_err("strutil: %s: Device doesn't support any triggers.", __func__);
+               sr_err("%s: Device doesn't support any triggers.", __func__);
                return NULL;
        }
 
@@ -236,7 +250,7 @@ SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
                }
 
                if (probenum < 0 || probenum >= max_probes) {
-                       sr_err("strutil: Invalid probe.");
+                       sr_err("Invalid probe.");
                        error = TRUE;
                        break;
                }
@@ -244,7 +258,7 @@ SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
                if ((trigger = strchr(tokens[i], '='))) {
                        for (tc = ++trigger; *tc; tc++) {
                                if (strchr(trigger_types, *tc) == NULL) {
-                                       sr_err("strutil: Unsupported trigger "
+                                       sr_err("Unsupported trigger "
                                               "type '%c'.", *tc);
                                        error = TRUE;
                                        break;
@@ -334,16 +348,17 @@ SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
  * @param timestring A string containing a (decimal) time value.
  * @return The string's time value as uint64_t, in milliseconds.
  *
- * TODO: Error handling.
- * TODO: Add support for "m" (minutes) and others.
- * TODO: picoseconds?
- * TODO: Allow both lower-case and upper-case.
+ * @todo Add support for "m" (minutes) and others.
+ * @todo Add support for picoseconds?
+ * @todo Allow both lower-case and upper-case? If no, document it.
  */
 SR_API uint64_t sr_parse_timestring(const char *timestring)
 {
        uint64_t time_msec;
        char *s;
 
+       /* TODO: Error handling, logging. */
+
        time_msec = strtoull(timestring, &s, 10);
        if (time_msec == 0 && s == timestring)
                return 0;