X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=strutil.c;h=b7b0af16d72bc9df0af4f78c658690150229a36d;hb=e52e712d05419e4387704262a07e00904b2acbed;hp=0a03ca7545719f6db0e5a83c6fd521a045ccc119;hpb=92ae7984834778dc7da128159d8e90024318909d;p=libsigrok.git diff --git a/strutil.c b/strutil.c index 0a03ca75..b7b0af16 100644 --- 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 * @@ -24,6 +24,74 @@ #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 + * + * Helper functions for handling or converting libsigrok-related strings. + * + * @{ + */ + +/** + * 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". + * + * @param x The value to convert. + * @param unit The unit to append to the string, or NULL if the string + * has no units. + * + * @return A g_try_malloc()ed string representation of the samplerate value, + * or NULL upon errors. The caller is responsible to g_free() the + * memory. + */ +SR_API char *sr_si_string_u64(uint64_t x, const char *unit) +{ + 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); + } + + sr_err("%s: Error creating SI units string.", __func__); + return NULL; +} + /** * Convert a numeric samplerate value to its "natural" string representation. * @@ -38,35 +106,7 @@ */ SR_API char *sr_samplerate_string(uint64_t samplerate) { - char *o; - uint64_t s = samplerate; - - if ((s >= SR_GHZ(1)) && (s % SR_GHZ(1) == 0)) { - o = g_strdup_printf("%" PRIu64 " GHz", s / SR_GHZ(1)); - } else if ((s >= SR_GHZ(1)) && (s % SR_GHZ(1) != 0)) { - o = g_strdup_printf("%" PRIu64 ".%" PRIu64 " GHz", - s / SR_GHZ(1), s % SR_GHZ(1)); - } else if ((s >= SR_MHZ(1)) && (s % SR_MHZ(1) == 0)) { - o = g_strdup_printf("%" PRIu64 " MHz", s / SR_MHZ(1)); - } else if ((s >= SR_MHZ(1)) && (s % SR_MHZ(1) != 0)) { - o = g_strdup_printf("%" PRIu64 ".%" PRIu64 " MHz", - s / SR_MHZ(1), s % SR_MHZ(1)); - } else if ((s >= SR_KHZ(1)) && (s % SR_KHZ(1) == 0)) { - o = g_strdup_printf("%" PRIu64 " kHz", s / SR_KHZ(1)); - } else if ((s >= SR_KHZ(1)) && (s % SR_KHZ(1) != 0)) { - o = g_strdup_printf("%" PRIu64 ".%" PRIu64 " kHz", - s / SR_KHZ(1), s % SR_KHZ(1)); - } else { - o = g_strdup_printf("%" PRIu64 " Hz", s); - } - - if (!o) { - sr_err("strutil: %s: Error creating samplerate string.", - __func__); - return NULL; - } - - return o; + return sr_si_string_u64(samplerate, "Hz"); } /** @@ -88,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; } @@ -111,34 +151,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... */ @@ -152,7 +193,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, @@ -174,6 +217,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; @@ -184,37 +228,31 @@ 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; } - tokens = g_strsplit(triggerstring, ",", max_probes); - - 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) != 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++) { - if (tokens[i][0] < '0' || tokens[i][0] > '9') { - /* Named probe */ - probenum = 0; - for (l = sdi->probes; l; l = l->next) { - probe = (struct sr_probe *)l->data; - if (probe->enabled - && !strncmp(probe->name, tokens[i], - strlen(probe->name))) { - probenum = probe->index; - break; - } + probenum = -1; + for (l = sdi->probes; l; l = l->next) { + probe = (struct sr_probe *)l->data; + if (probe->enabled + && !strncmp(probe->name, tokens[i], + strlen(probe->name))) { + probenum = probe->index; + break; } - } else { - probenum = strtol(tokens[i], NULL, 10); } - if (probenum < 1 || probenum > max_probes) { - sr_err("strutil: Invalid probe (%d).", probenum); + if (probenum < 0 || probenum >= max_probes) { + sr_err("Invalid probe."); error = TRUE; break; } @@ -222,17 +260,18 @@ 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; } } if (!error) - triggerlist[probenum - 1] = g_strdup(trigger); + triggerlist[probenum] = g_strdup(trigger); } } g_strfreev(tokens); + g_variant_unref(gvar); if (error) { for (i = 0; i < max_probes; i++) @@ -312,16 +351,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; @@ -354,26 +394,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; @@ -383,12 +427,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; @@ -396,9 +440,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; @@ -407,4 +451,4 @@ SR_API int sr_parse_voltage(const char *voltstr, struct sr_rational *r) return SR_OK; } - +/** @} */