]> sigrok.org Git - libsigrok.git/blobdiff - strutil.c
probe_groups: API changes required to implement probe groups.
[libsigrok.git] / strutil.c
index 0b0703e5e9655e3703ffb6bfa5ed09dd4db07ec6..f6cdb73b73f81836477378ee3baea38979c4282c 100644 (file)
--- a/strutil.c
+++ b/strutil.c
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
  *
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/* Message logging helpers with subsystem-specific prefix string. */
+#define LOG_PREFIX "strutil: "
+#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
+#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
+#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
+#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
+#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
+#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
+
+/**
+ * @file
+ *
+ * Helper functions for handling or converting libsigrok-related strings.
+ */
+
 /**
  * @defgroup grp_strutil String utilities
  *
@@ -33,8 +48,8 @@
  */
 
 /**
- * Convert a numeric value value to its "natural" string representation.
- * in SI units
+ * Convert a numeric value value to its "natural" string representation
+ * in SI units.
  *
  * E.g. a value of 3000000, with units set to "W", would be converted
  * to "3 MW", 20000 to "20 kW", 31500 would become "31.5 kW".
  */
 SR_API char *sr_si_string_u64(uint64_t x, const char *unit)
 {
-       if(unit == NULL)
+       uint8_t i;
+       uint64_t quot, divisor[] = {
+               SR_HZ(1), SR_KHZ(1), SR_MHZ(1), SR_GHZ(1),
+               SR_GHZ(1000), SR_GHZ(1000 * 1000), SR_GHZ(1000 * 1000 * 1000),
+       };
+       const char *p, prefix[] = "\0kMGTPE";
+       char fmt[8], fract[20] = "", *f;
+
+       if (unit == NULL)
                unit = "";
 
-       if ((x >= SR_GHZ(1)) && (x % SR_GHZ(1) == 0)) {
-               return g_strdup_printf("%" PRIu64 " G%s", x / SR_GHZ(1), unit);
-       } else if ((x >= SR_GHZ(1)) && (x % SR_GHZ(1) != 0)) {
-               return g_strdup_printf("%" PRIu64 ".%" PRIu64 " G%s",
-                                      x / SR_GHZ(1), x % SR_GHZ(1), unit);
-       } else if ((x >= SR_MHZ(1)) && (x % SR_MHZ(1) == 0)) {
-               return g_strdup_printf("%" PRIu64 " M%s",
-                                      x / SR_MHZ(1), unit);
-       } else if ((x >= SR_MHZ(1)) && (x % SR_MHZ(1) != 0)) {
-               return g_strdup_printf("%" PRIu64 ".%" PRIu64 " M%s",
-                                   x / SR_MHZ(1), x % SR_MHZ(1), unit);
-       } else if ((x >= SR_KHZ(1)) && (x % SR_KHZ(1) == 0)) {
-               return g_strdup_printf("%" PRIu64 " k%s",
-                                   x / SR_KHZ(1), unit);
-       } else if ((x >= SR_KHZ(1)) && (x % SR_KHZ(1) != 0)) {
-               return g_strdup_printf("%" PRIu64 ".%" PRIu64 " k%s",
-                                   x / SR_KHZ(1), x % SR_KHZ(1), unit);
-       } else {
-               return g_strdup_printf("%" PRIu64 " %s", x, unit);
+       for (i = 0; (quot = x / divisor[i]) >= 1000; i++);
+
+       if (i) {
+               sprintf(fmt, ".%%0%dlu", i * 3);
+               f = fract + sprintf(fract, fmt, x % divisor[i]) - 1;
+
+               while (f >= fract && strchr("0.", *f))
+                       *f-- = 0;
        }
 
-       sr_err("strutil: %s: Error creating SI units string.",
-               __func__);
-       return NULL;
+       p = prefix + i;
+
+       return g_strdup_printf("%" PRIu64 "%s %.1s%s", quot, fract, p, unit);
 }
 
 /**
@@ -114,7 +126,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;
        }
 
@@ -137,34 +149,35 @@ SR_API char *sr_period_string(uint64_t frequency)
 }
 
 /**
- * Convert a numeric frequency value to the "natural" string representation
- * of its voltage value.
+ * Convert a numeric voltage value to the "natural" string representation
+ * of its voltage value. The voltage is specified as a rational number's
+ * numerator and denominator.
  *
  * E.g. a value of 300000 would be converted to "300mV", 2 to "2V".
  *
- * @param voltage The voltage represented as a rational number, with the
- *                denominator a divisor of 1V.
+ * @param v_p The voltage numerator.
+ * @param v_q The voltage denominator.
  *
  * @return A g_try_malloc()ed string representation of the voltage value,
  *         or NULL upon errors. The caller is responsible to g_free() the
  *         memory.
  */
-SR_API char *sr_voltage_string(struct sr_rational *voltage)
+SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q)
 {
-       char *o;
        int r;
+       char *o;
 
        if (!(o = g_try_malloc0(30 + 1))) {
-               sr_err("strutil: %s: o malloc failed", __func__);
+               sr_err("%s: o malloc failed", __func__);
                return NULL;
        }
 
-       if (voltage->q == 1000)
-               r = snprintf(o, 30, "%" PRIu64 "mV", voltage->p);
-       else if (voltage->q == 1)
-               r = snprintf(o, 30, "%" PRIu64 "V", voltage->p);
+       if (v_q == 1000)
+               r = snprintf(o, 30, "%" PRIu64 "mV", v_p);
+       else if (v_q == 1)
+               r = snprintf(o, 30, "%" PRIu64 "V", v_p);
        else
-               r = -1;
+               r = snprintf(o, 30, "%gV", (float)v_p / (float)v_q);
 
        if (r < 0) {
                /* Something went wrong... */
@@ -178,7 +191,9 @@ SR_API char *sr_voltage_string(struct sr_rational *voltage)
 /**
  * Parse a trigger specification string.
  *
- * @param dev The device for which the trigger specification is intended.
+ * @param sdi The device instance for which the trigger specification is
+ *            intended. Must not be NULL. Also, sdi->driver and
+ *            sdi->driver->info_get must not be NULL.
  * @param triggerstring The string containing the trigger specification for
  *        one or more probes of this device. Entries for multiple probes are
  *        comma-separated. Triggers are specified in the form key=value,
@@ -200,6 +215,7 @@ SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
                                     const char *triggerstring)
 {
        GSList *l;
+       GVariant *gvar;
        struct sr_probe *probe;
        int max_probes, probenum, i;
        char **tokens, **triggerlist, *trigger, *tc;
@@ -210,15 +226,16 @@ 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__);
+       if (sdi->driver->config_list(SR_CONF_TRIGGER_TYPE,
+                               &gvar, sdi, NULL) != SR_OK) {
+               sr_err("%s: Device doesn't support any triggers.", __func__);
                return NULL;
        }
+       trigger_types = g_variant_get_string(gvar, NULL);
 
        tokens = g_strsplit(triggerstring, ",", max_probes);
        for (i = 0; tokens[i]; i++) {
@@ -234,7 +251,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;
                }
@@ -242,7 +259,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;
@@ -253,6 +270,7 @@ SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
                }
        }
        g_strfreev(tokens);
+       g_variant_unref(gvar);
 
        if (error) {
                for (i = 0; i < max_probes; i++)
@@ -332,16 +350,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;
@@ -374,26 +393,30 @@ SR_API gboolean sr_parse_boolstring(const char *boolstr)
        return FALSE;
 }
 
-SR_API int sr_parse_period(const char *periodstr, struct sr_rational *r)
+SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
 {
        char *s;
 
-       r->p = strtoull(periodstr, &s, 10);
-       if (r->p == 0 && s == periodstr)
+       *p = strtoull(periodstr, &s, 10);
+       if (*p == 0 && s == periodstr)
                /* No digits found. */
                return SR_ERR_ARG;
 
        if (s && *s) {
                while (*s == ' ')
                        s++;
-               if (!strcmp(s, "ns"))
-                       r->q = 1000000000L;
+               if (!strcmp(s, "fs"))
+                       *q = 1000000000000000ULL;
+               else if (!strcmp(s, "ps"))
+                       *q = 1000000000000ULL;
+               else if (!strcmp(s, "ns"))
+                       *q = 1000000000ULL;
                else if (!strcmp(s, "us"))
-                       r->q = 1000000;
+                       *q = 1000000;
                else if (!strcmp(s, "ms"))
-                       r->q = 1000;
+                       *q = 1000;
                else if (!strcmp(s, "s"))
-                       r->q = 1;
+                       *q = 1;
                else
                        /* Must have a time suffix. */
                        return SR_ERR_ARG;
@@ -403,12 +426,12 @@ SR_API int sr_parse_period(const char *periodstr, struct sr_rational *r)
 }
 
 
-SR_API int sr_parse_voltage(const char *voltstr, struct sr_rational *r)
+SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q)
 {
        char *s;
 
-       r->p = strtoull(voltstr, &s, 10);
-       if (r->p == 0 && s == voltstr)
+       *p = strtoull(voltstr, &s, 10);
+       if (*p == 0 && s == voltstr)
                /* No digits found. */
                return SR_ERR_ARG;
 
@@ -416,9 +439,9 @@ SR_API int sr_parse_voltage(const char *voltstr, struct sr_rational *r)
                while (*s == ' ')
                        s++;
                if (!strcasecmp(s, "mv"))
-                       r->q = 1000L;
+                       *q = 1000L;
                else if (!strcasecmp(s, "v"))
-                       r->q = 1;
+                       *q = 1;
                else
                        /* Must have a base suffix. */
                        return SR_ERR_ARG;