X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=strutil.c;h=1b65701eaf7abf0753f2143ed00b67d936b7302e;hb=82b904b173f1443c4d6bdebdf1a7f0dda01c4982;hp=0b0703e5e9655e3703ffb6bfa5ed09dd4db07ec6;hpb=7b870c38e3040fec1165a623ae3986e4fb342218;p=libsigrok.git diff --git a/strutil.c b/strutil.c index 0b0703e5..1b65701e 100644 --- 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; } @@ -137,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... */ @@ -178,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, @@ -200,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; @@ -210,15 +228,15 @@ 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) != 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 +252,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 +260,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 +271,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 +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; @@ -374,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; @@ -403,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; @@ -416,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;