X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=strutil.c;h=54dc1f39df50123ac985a158bc3d9ca425f9f5a6;hp=8abc556ec807875a0027c7e3a944d5d533436e8d;hb=43cd4637285833706f8a404ca027bcf0ee75b9ae;hpb=4cc9aea15b2d76930f565e810e0520918e2cc7bd diff --git a/strutil.c b/strutil.c index 8abc556e..54dc1f39 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 * @@ -21,12 +21,207 @@ #include #include #include +#include #include "libsigrok.h" #include "libsigrok-internal.h" +/** @cond PRIVATE */ +#define LOG_PREFIX "strutil" +/** @endcond */ + +/** + * @file + * + * Helper functions for handling or converting libsigrok-related strings. + */ + +/** + * @defgroup grp_strutil String utilities + * + * Helper functions for handling or converting libsigrok-related strings. + * + * @{ + */ + +/** + * @private + * + * Convert a string representation of a numeric value (base 10) to a long integer. The + * conversion is strict and will fail if the complete string does not represent + * a valid long integer. The function sets errno according to the details of the + * failure. + * + * @param str The string representation to convert. + * @param ret Pointer to long where the result of the conversion will be stored. + * + * @retval SR_OK Conversion successful. + * @retval SR_ERR Failure. + * + * @since 0.3.0 + */ +SR_PRIV int sr_atol(const char *str, long *ret) +{ + long tmp; + char *endptr = NULL; + + errno = 0; + tmp = strtol(str, &endptr, 10); + + if (!endptr || *endptr || errno) { + if (!errno) + errno = EINVAL; + return SR_ERR; + } + + *ret = tmp; + return SR_OK; +} + +/** + * @private + * + * Convert a string representation of a numeric value (base 10) to an integer. The + * conversion is strict and will fail if the complete string does not represent + * a valid integer. The function sets errno according to the details of the + * failure. + * + * @param str The string representation to convert. + * @param ret Pointer to int where the result of the conversion will be stored. + * + * @retval SR_OK Conversion successful. + * @retval SR_ERR Failure. + * + * @since 0.3.0 + */ +SR_PRIV int sr_atoi(const char *str, int *ret) +{ + long tmp; + + if (sr_atol(str, &tmp) != SR_OK) + return SR_ERR; + + if ((int) tmp != tmp) { + errno = ERANGE; + return SR_ERR; + } + + *ret = (int) tmp; + return SR_OK; +} + +/** + * @private + * + * Convert a string representation of a numeric value to a double. The + * conversion is strict and will fail if the complete string does not represent + * a valid double. The function sets errno according to the details of the + * failure. + * + * @param str The string representation to convert. + * @param ret Pointer to double where the result of the conversion will be stored. + * + * @retval SR_OK Conversion successful. + * @retval SR_ERR Failure. + * + * @since 0.3.0 + */ +SR_PRIV int sr_atod(const char *str, double *ret) +{ + double tmp; + char *endptr = NULL; + + errno = 0; + tmp = strtof(str, &endptr); + + if (!endptr || *endptr || errno) { + if (!errno) + errno = EINVAL; + return SR_ERR; + } + + *ret = tmp; + return SR_OK; +} + /** - * Convert a numeric value value to its "natural" string representation. - * in SI units + * @private + * + * Convert a string representation of a numeric value to a float. The + * conversion is strict and will fail if the complete string does not represent + * a valid float. The function sets errno according to the details of the + * failure. + * + * @param str The string representation to convert. + * @param ret Pointer to float where the result of the conversion will be stored. + * + * @retval SR_OK Conversion successful. + * @retval SR_ERR Failure. + * + * @since 0.3.0 + */ +SR_PRIV int sr_atof(const char *str, float *ret) +{ + double tmp; + + if (sr_atod(str, &tmp) != SR_OK) + return SR_ERR; + + if ((float) tmp != tmp) { + errno = ERANGE; + return SR_ERR; + } + + *ret = (float) tmp; + return SR_OK; +} + +/** + * @private + * + * Convert a string representation of a numeric value to a float. The + * conversion is strict and will fail if the complete string does not represent + * a valid float. The function sets errno according to the details of the + * failure. This version ignores the locale. + * + * @param str The string representation to convert. + * @param ret Pointer to float where the result of the conversion will be stored. + * + * @retval SR_OK Conversion successful. + * @retval SR_ERR Failure. + * + * @since 0.3.0 + */ +SR_PRIV int sr_atof_ascii(const char *str, float *ret) +{ + double tmp; + char *endptr = NULL; + + errno = 0; + tmp = g_ascii_strtod(str, &endptr); + + if (!endptr || *endptr || errno) { + if (!errno) + errno = EINVAL; + return SR_ERR; + } + + /* FIXME This fails unexpectedly. Some other method to safel downcast + * needs to be found. Checking against FLT_MAX doesn't work as well. */ + /* + if ((float) tmp != tmp) { + errno = ERANGE; + sr_dbg("ERANGEEEE %e != %e", (float) tmp, tmp); + return SR_ERR; + } + */ + + *ret = (float) tmp; + return SR_OK; +} + +/** + * 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". @@ -38,36 +233,35 @@ * @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. + * + * @since 0.2.0 */ 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[16], 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%d"PRIu64, 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); } /** @@ -81,6 +275,8 @@ SR_API char *sr_si_string_u64(uint64_t x, const char *unit) * @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. + * + * @since 0.1.0 */ SR_API char *sr_samplerate_string(uint64_t samplerate) { @@ -98,6 +294,8 @@ SR_API char *sr_samplerate_string(uint64_t samplerate) * @return A g_try_malloc()ed string representation of the frequency value, * or NULL upon errors. The caller is responsible to g_free() the * memory. + * + * @since 0.1.0 */ SR_API char *sr_period_string(uint64_t frequency) { @@ -106,7 +304,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; } @@ -129,34 +327,37 @@ 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. + * + * @since 0.2.0 */ -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... */ @@ -167,100 +368,6 @@ SR_API char *sr_voltage_string(struct sr_rational *voltage) return o; } -/** - * Parse a trigger specification string. - * - * @param dev The device for which the trigger specification is intended. - * @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, - * where the key is a probe number (or probe name) and the value is - * the requested trigger type. Valid trigger types currently - * include 'r' (rising edge), 'f' (falling edge), 'c' (any pin value - * change), '0' (low value), or '1' (high value). - * Example: "1=r,sck=f,miso=0,7=c" - * - * @return Pointer to a list of trigger types (strings), or NULL upon errors. - * The pointer list (if non-NULL) has as many entries as the - * respective device has probes (all physically available probes, - * not just enabled ones). Entries of the list which don't have - * a trigger value set in 'triggerstring' are NULL, the other entries - * contain the respective trigger type which is requested for the - * respective probe (e.g. "r", "c", and so on). - */ -SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi, - const char *triggerstring) -{ - GSList *l; - struct sr_probe *probe; - int max_probes, probenum, i; - char **tokens, **triggerlist, *trigger, *tc; - const char *trigger_types; - gboolean error; - - max_probes = g_slist_length(sdi->probes); - error = FALSE; - - if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) { - sr_err("strutil: %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__); - return 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; - } - } - } else { - probenum = strtol(tokens[i], NULL, 10); - } - - if (probenum < 0 || probenum >= max_probes) { - sr_err("strutil: Invalid probe (%d).", probenum); - error = TRUE; - break; - } - - if ((trigger = strchr(tokens[i], '='))) { - for (tc = ++trigger; *tc; tc++) { - if (strchr(trigger_types, *tc) == NULL) { - sr_err("strutil: Unsupported trigger " - "type '%c'.", *tc); - error = TRUE; - break; - } - } - if (!error) - triggerlist[probenum] = g_strdup(trigger); - } - } - g_strfreev(tokens); - - if (error) { - for (i = 0; i < max_probes; i++) - g_free(triggerlist[i]); - g_free(triggerlist); - triggerlist = NULL; - } - - return triggerlist; -} - /** * Convert a "natural" string representation of a size value to uint64_t. * @@ -275,19 +382,26 @@ SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi, * @param size Pointer to uint64_t which will contain the string's size value. * * @return SR_OK upon success, SR_ERR upon errors. + * + * @since 0.1.0 */ SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size) { int multiplier, done; + double frac_part; char *s; *size = strtoull(sizestring, &s, 10); multiplier = 0; + frac_part = 0; done = FALSE; while (s && *s && multiplier == 0 && !done) { switch (*s) { case ' ': break; + case '.': + frac_part = g_ascii_strtod(s, &s); + break; case 'k': case 'K': multiplier = SR_KHZ(1); @@ -306,8 +420,11 @@ SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size) } s++; } - if (multiplier > 0) + if (multiplier > 0) { *size *= multiplier; + *size += frac_part * multiplier; + } else + *size += frac_part; if (*s && strcasecmp(s, "Hz")) return SR_ERR; @@ -329,16 +446,19 @@ 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. + * + * @since 0.1.0 */ 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; @@ -357,6 +477,7 @@ SR_API uint64_t sr_parse_timestring(const char *timestring) return time_msec; } +/** @since 0.1.0 */ SR_API gboolean sr_parse_boolstring(const char *boolstr) { if (!boolstr) @@ -371,26 +492,31 @@ SR_API gboolean sr_parse_boolstring(const char *boolstr) return FALSE; } -SR_API int sr_parse_period(const char *periodstr, struct sr_rational *r) +/** @since 0.2.0 */ +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; @@ -399,13 +525,13 @@ SR_API int sr_parse_period(const char *periodstr, struct sr_rational *r) return SR_OK; } - -SR_API int sr_parse_voltage(const char *voltstr, struct sr_rational *r) +/** @since 0.2.0 */ +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; @@ -413,9 +539,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; @@ -424,4 +550,4 @@ SR_API int sr_parse_voltage(const char *voltstr, struct sr_rational *r) return SR_OK; } - +/** @} */