]> sigrok.org Git - libsigrok.git/blobdiff - strutil.c
Improve sr_filter_probes error handling and docs.
[libsigrok.git] / strutil.c
index b8eb0f8e4b78c77ac34931f7caa3d2af173a0315..6a9d86226a7ac15d59f285bebfb25b8a42c175d4 100644 (file)
--- a/strutil.c
+++ b/strutil.c
@@ -22,6 +22,7 @@
 #include <stdlib.h>
 #include <string.h>
 #include <sigrok.h>
+#include <sigrok-internal.h>
 
 /**
  * Convert a numeric samplerate value to its "natural" string representation.
@@ -41,11 +42,11 @@ char *sr_samplerate_string(uint64_t samplerate)
        if (!o)
                return NULL;
 
-       if (samplerate >= GHZ(1))
+       if (samplerate >= SR_GHZ(1))
                r = snprintf(o, 30, "%" PRIu64 " GHz", samplerate / 1000000000);
-       else if (samplerate >= MHZ(1))
+       else if (samplerate >= SR_MHZ(1))
                r = snprintf(o, 30, "%" PRIu64 " MHz", samplerate / 1000000);
-       else if (samplerate >= KHZ(1))
+       else if (samplerate >= SR_KHZ(1))
                r = snprintf(o, 30, "%" PRIu64 " kHz", samplerate / 1000);
        else
                r = snprintf(o, 30, "%" PRIu64 " Hz", samplerate);
@@ -60,7 +61,7 @@ char *sr_samplerate_string(uint64_t samplerate)
 }
 
 /**
- * Convert a numeric samplerate value to the "natural" string representation
+ * Convert a numeric frequency value to the "natural" string representation
  * of its period.
  *
  * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms".
@@ -78,11 +79,11 @@ char *sr_period_string(uint64_t frequency)
        if (!o)
                return NULL;
 
-       if (frequency >= GHZ(1))
+       if (frequency >= SR_GHZ(1))
                r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000);
-       else if (frequency >= MHZ(1))
+       else if (frequency >= SR_MHZ(1))
                r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000);
-       else if (frequency >= KHZ(1))
+       else if (frequency >= SR_KHZ(1))
                r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000);
        else
                r = snprintf(o, 30, "%" PRIu64 " s", frequency);
@@ -96,17 +97,30 @@ char *sr_period_string(uint64_t frequency)
        return o;
 }
 
-char **sr_parse_triggerstring(struct sr_device *device, const char *triggerstring)
+/**
+ * TODO
+ *
+ * @param device TODO
+ * @param triggerstring TODO
+ * @return TODO
+ */
+char **sr_parse_triggerstring(struct sr_device *device,
+                             const char *triggerstring)
 {
        GSList *l;
-       struct probe *probe;
+       struct sr_probe *probe;
        int max_probes, probenum, i;
        char **tokens, **triggerlist, *trigger, *tc, *trigger_types;
        gboolean error;
 
        max_probes = g_slist_length(device->probes);
        error = FALSE;
-       triggerlist = g_malloc0(max_probes * sizeof(char *));
+
+       if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) {
+               sr_err("session file: %s: metafile malloc failed", __func__);
+               return NULL;
+       }
+
        tokens = g_strsplit(triggerstring, ",", max_probes);
        trigger_types = device->plugin->get_device_info(0, SR_DI_TRIGGER_TYPES);
        if (trigger_types == NULL)
@@ -117,7 +131,7 @@ char **sr_parse_triggerstring(struct sr_device *device, const char *triggerstrin
                        /* Named probe */
                        probenum = 0;
                        for (l = device->probes; l; l = l->next) {
-                               probe = (struct probe *)l->data;
+                               probe = (struct sr_probe *)l->data;
                                if (probe->enabled
                                    && !strncmp(probe->name, tokens[i],
                                                strlen(probe->name))) {
@@ -130,7 +144,7 @@ char **sr_parse_triggerstring(struct sr_device *device, const char *triggerstrin
                }
 
                if (probenum < 1 || probenum > max_probes) {
-                       printf("Invalid probe.\n");
+                       sr_err("Invalid probe.\n");
                        error = TRUE;
                        break;
                }
@@ -138,7 +152,7 @@ char **sr_parse_triggerstring(struct sr_device *device, const char *triggerstrin
                if ((trigger = strchr(tokens[i], '='))) {
                        for (tc = ++trigger; *tc; tc++) {
                                if (strchr(trigger_types, *tc) == NULL) {
-                                       printf("Unsupported trigger type "
+                                       sr_err("Unsupported trigger type "
                                               "'%c'\n", *tc);
                                        error = TRUE;
                                        break;
@@ -161,42 +175,79 @@ char **sr_parse_triggerstring(struct sr_device *device, const char *triggerstrin
        return triggerlist;
 }
 
-uint64_t sr_parse_sizestring(const char *sizestring)
+/**
+ * Convert a "natural" string representation of a size value to uint64_t.
+ *
+ * E.g. a value of "3k" or "3 K" would be converted to 3000, a value
+ * of "15M" would be converted to 15000000.
+ *
+ * Value representations other than decimal (such as hex or octal) are not
+ * supported. Only 'k' (kilo), 'm' (mega), 'g' (giga) suffixes are supported.
+ * Spaces (but not other whitespace) between value and suffix are allowed.
+ *
+ * @param sizestring A string containing a (decimal) size value.
+ * @param size Pointer to uint64_t which will contain the string's size value.
+ * @return SR_OK or error code
+ *
+ */
+int sr_parse_sizestring(const char *sizestring, uint64_t *size)
 {
-       int multiplier;
-       uint64_t val;
+       int multiplier, done;
        char *s;
 
-       val = strtoull(sizestring, &s, 10);
+       *size = strtoull(sizestring, &s, 10);
        multiplier = 0;
-       while (s && *s && multiplier == 0) {
+       done = FALSE;
+       while (s && *s && multiplier == 0 && !done) {
                switch (*s) {
                case ' ':
                        break;
                case 'k':
                case 'K':
-                       multiplier = KHZ(1);
+                       multiplier = SR_KHZ(1);
                        break;
                case 'm':
                case 'M':
-                       multiplier = MHZ(1);
+                       multiplier = SR_MHZ(1);
                        break;
                case 'g':
                case 'G':
-                       multiplier = GHZ(1);
+                       multiplier = SR_GHZ(1);
                        break;
                default:
-                       val = 0;
-                       multiplier = -1;
+                       done = TRUE;
+                       s--;
                }
                s++;
        }
        if (multiplier > 0)
-               val *= multiplier;
+               *size *= multiplier;
 
-       return val;
+       if (*s && strcasecmp(s, "Hz"))
+               return SR_ERR;
+
+       return SR_OK;
 }
 
+/**
+ * Convert a "natural" string representation of a time value to an
+ * uint64_t value in milliseconds.
+ *
+ * E.g. a value of "3s" or "3 s" would be converted to 3000, a value
+ * of "15ms" would be converted to 15.
+ *
+ * Value representations other than decimal (such as hex or octal) are not
+ * supported. Only lower-case "s" and "ms" time suffixes are supported.
+ * Spaces (but not other whitespace) between value and suffix are allowed.
+ *
+ * @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.
+ */
 uint64_t sr_parse_timestring(const char *timestring)
 {
        uint64_t time_msec;
@@ -220,3 +271,17 @@ uint64_t sr_parse_timestring(const char *timestring)
        return time_msec;
 }
 
+gboolean sr_parse_boolstring(const char *boolstr)
+{
+       if (!boolstr)
+               return FALSE;
+
+       if (!g_strcasecmp(boolstr, "true") || 
+           !g_strcasecmp(boolstr, "yes") ||
+           !g_strcasecmp(boolstr, "on") ||
+           !g_strcasecmp(boolstr, "1")) 
+               return TRUE;
+
+       return FALSE;
+}
+