2 * This file is part of the libsigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "libsigrok.h"
26 #include "libsigrok-internal.h"
29 #define LOG_PREFIX "strutil"
35 * Helper functions for handling or converting libsigrok-related strings.
39 * @defgroup grp_strutil String utilities
41 * Helper functions for handling or converting libsigrok-related strings.
49 * Convert a string representation of a numeric value to a long integer. The
50 * conversion is strict and will fail if the complete string does not represent
51 * a valid long integer. The function sets errno according to the details of the
54 * @param str The string representation to convert.
55 * @param ret Pointer to long where the result of the conversion will be stored.
57 * @return SR_OK if conversion is successful, otherwise SR_ERR.
61 SR_PRIV int sr_atol(const char *str, long *ret)
67 tmp = strtol(str, &endptr, 0);
69 if (!endptr || *endptr || errno) {
82 * Convert a string representation of a numeric value to an integer. The
83 * conversion is strict and will fail if the complete string does not represent
84 * a valid integer. The function sets errno according to the details of the
87 * @param str The string representation to convert.
88 * @param ret Pointer to int where the result of the conversion will be stored.
90 * @return SR_OK if conversion is successful, otherwise SR_ERR.
94 SR_PRIV int sr_atoi(const char *str, int *ret)
98 if (sr_atol(str, &tmp) != SR_OK)
101 if ((int) tmp != tmp) {
113 * Convert a string representation of a numeric value to a double. The
114 * conversion is strict and will fail if the complete string does not represent
115 * a valid double. The function sets errno according to the details of the
118 * @param str The string representation to convert.
119 * @param ret Pointer to double where the result of the conversion will be stored.
121 * @return SR_OK if conversion is successful, otherwise SR_ERR.
125 SR_PRIV int sr_atod(const char *str, double *ret)
131 tmp = strtof(str, &endptr);
133 if (!endptr || *endptr || errno) {
146 * Convert a string representation of a numeric value to a float. The
147 * conversion is strict and will fail if the complete string does not represent
148 * a valid float. The function sets errno according to the details of the
151 * @param str The string representation to convert.
152 * @param ret Pointer to float where the result of the conversion will be stored.
154 * @return SR_OK if conversion is successful, otherwise SR_ERR.
158 SR_PRIV int sr_atof(const char *str, float *ret)
162 if (sr_atod(str, &tmp) != SR_OK)
165 if ((float) tmp != tmp) {
177 * Convert a string representation of a numeric value to a float. The
178 * conversion is strict and will fail if the complete string does not represent
179 * a valid float. The function sets errno according to the details of the
180 * failure. This version ignores the locale.
182 * @param str The string representation to convert.
183 * @param ret Pointer to float where the result of the conversion will be stored.
185 * @return SR_OK if conversion is successful, otherwise SR_ERR.
189 SR_PRIV int sr_atof_ascii(const char *str, float *ret)
195 tmp = g_ascii_strtod(str, &endptr);
197 if (!endptr || *endptr || errno) {
203 /* FIXME This fails unexpectedly. Some other method to safel downcast
204 * needs to be found. Checking against FLT_MAX doesn't work as well. */
206 if ((float) tmp != tmp) {
208 sr_dbg("ERANGEEEE %e != %e", (float) tmp, tmp);
218 * Convert a numeric value value to its "natural" string representation
221 * E.g. a value of 3000000, with units set to "W", would be converted
222 * to "3 MW", 20000 to "20 kW", 31500 would become "31.5 kW".
224 * @param x The value to convert.
225 * @param unit The unit to append to the string, or NULL if the string
228 * @return A g_try_malloc()ed string representation of the samplerate value,
229 * or NULL upon errors. The caller is responsible to g_free() the
234 SR_API char *sr_si_string_u64(uint64_t x, const char *unit)
237 uint64_t quot, divisor[] = {
238 SR_HZ(1), SR_KHZ(1), SR_MHZ(1), SR_GHZ(1),
239 SR_GHZ(1000), SR_GHZ(1000 * 1000), SR_GHZ(1000 * 1000 * 1000),
241 const char *p, prefix[] = "\0kMGTPE";
242 char fmt[16], fract[20] = "", *f;
247 for (i = 0; (quot = x / divisor[i]) >= 1000; i++);
250 sprintf(fmt, ".%%0%d"PRIu64, i * 3);
251 f = fract + sprintf(fract, fmt, x % divisor[i]) - 1;
253 while (f >= fract && strchr("0.", *f))
259 return g_strdup_printf("%" PRIu64 "%s %.1s%s", quot, fract, p, unit);
263 * Convert a numeric samplerate value to its "natural" string representation.
265 * E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz",
266 * 31500 would become "31.5 kHz".
268 * @param samplerate The samplerate in Hz.
270 * @return A g_try_malloc()ed string representation of the samplerate value,
271 * or NULL upon errors. The caller is responsible to g_free() the
276 SR_API char *sr_samplerate_string(uint64_t samplerate)
278 return sr_si_string_u64(samplerate, "Hz");
282 * Convert a numeric frequency value to the "natural" string representation
285 * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms".
287 * @param frequency The frequency in Hz.
289 * @return A g_try_malloc()ed string representation of the frequency value,
290 * or NULL upon errors. The caller is responsible to g_free() the
295 SR_API char *sr_period_string(uint64_t frequency)
300 /* Allocate enough for a uint64_t as string + " ms". */
301 if (!(o = g_try_malloc0(30 + 1))) {
302 sr_err("%s: o malloc failed", __func__);
306 if (frequency >= SR_GHZ(1))
307 r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000);
308 else if (frequency >= SR_MHZ(1))
309 r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000);
310 else if (frequency >= SR_KHZ(1))
311 r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000);
313 r = snprintf(o, 30, "%" PRIu64 " s", frequency);
316 /* Something went wrong... */
325 * Convert a numeric voltage value to the "natural" string representation
326 * of its voltage value. The voltage is specified as a rational number's
327 * numerator and denominator.
329 * E.g. a value of 300000 would be converted to "300mV", 2 to "2V".
331 * @param v_p The voltage numerator.
332 * @param v_q The voltage denominator.
334 * @return A g_try_malloc()ed string representation of the voltage value,
335 * or NULL upon errors. The caller is responsible to g_free() the
340 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q)
345 if (!(o = g_try_malloc0(30 + 1))) {
346 sr_err("%s: o malloc failed", __func__);
351 r = snprintf(o, 30, "%" PRIu64 "mV", v_p);
353 r = snprintf(o, 30, "%" PRIu64 "V", v_p);
355 r = snprintf(o, 30, "%gV", (float)v_p / (float)v_q);
358 /* Something went wrong... */
367 * Parse a trigger specification string.
369 * @param sdi The device instance for which the trigger specification is
370 * intended. Must not be NULL. Also, sdi->driver and
371 * sdi->driver->info_get must not be NULL.
372 * @param triggerstring The string containing the trigger specification for
373 * one or more channels of this device. Entries for multiple channels are
374 * comma-separated. Triggers are specified in the form key=value,
375 * where the key is a channel number (or channel name) and the value is
376 * the requested trigger type. Valid trigger types currently
377 * include 'r' (rising edge), 'f' (falling edge), 'c' (any pin value
378 * change), '0' (low value), or '1' (high value).
379 * Example: "1=r,sck=f,miso=0,7=c"
381 * @return Pointer to a list of trigger types (strings), or NULL upon errors.
382 * The pointer list (if non-NULL) has as many entries as the
383 * respective device has channels (all physically available channels,
384 * not just enabled ones). Entries of the list which don't have
385 * a trigger value set in 'triggerstring' are NULL, the other entries
386 * contain the respective trigger type which is requested for the
387 * respective channel (e.g. "r", "c", and so on).
391 SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
392 const char *triggerstring)
396 struct sr_channel *ch;
397 int max_channels, channelnum, i;
398 char **tokens, **triggerlist, *trigger, *tc;
399 const char *trigger_types;
402 max_channels = g_slist_length(sdi->channels);
405 if (!(triggerlist = g_try_malloc0(max_channels * sizeof(char *)))) {
406 sr_err("%s: triggerlist malloc failed", __func__);
410 if (sdi->driver->config_list(SR_CONF_TRIGGER_TYPE,
411 &gvar, sdi, NULL) != SR_OK) {
412 sr_err("%s: Device doesn't support any triggers.", __func__);
415 trigger_types = g_variant_get_string(gvar, NULL);
417 tokens = g_strsplit(triggerstring, ",", max_channels);
418 for (i = 0; tokens[i]; i++) {
420 for (l = sdi->channels; l; l = l->next) {
421 ch = (struct sr_channel *)l->data;
423 && !strncmp(ch->name, tokens[i],
425 channelnum = ch->index;
430 if (channelnum < 0 || channelnum >= max_channels) {
431 sr_err("Invalid channel.");
436 if ((trigger = strchr(tokens[i], '='))) {
437 for (tc = ++trigger; *tc; tc++) {
438 if (strchr(trigger_types, *tc) == NULL) {
439 sr_err("Unsupported trigger "
446 triggerlist[channelnum] = g_strdup(trigger);
450 g_variant_unref(gvar);
453 for (i = 0; i < max_channels; i++)
454 g_free(triggerlist[i]);
463 * Convert a "natural" string representation of a size value to uint64_t.
465 * E.g. a value of "3k" or "3 K" would be converted to 3000, a value
466 * of "15M" would be converted to 15000000.
468 * Value representations other than decimal (such as hex or octal) are not
469 * supported. Only 'k' (kilo), 'm' (mega), 'g' (giga) suffixes are supported.
470 * Spaces (but not other whitespace) between value and suffix are allowed.
472 * @param sizestring A string containing a (decimal) size value.
473 * @param size Pointer to uint64_t which will contain the string's size value.
475 * @return SR_OK upon success, SR_ERR upon errors.
479 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
481 int multiplier, done;
485 *size = strtoull(sizestring, &s, 10);
489 while (s && *s && multiplier == 0 && !done) {
494 frac_part = g_ascii_strtod(s, &s);
498 multiplier = SR_KHZ(1);
502 multiplier = SR_MHZ(1);
506 multiplier = SR_GHZ(1);
514 if (multiplier > 0) {
516 *size += frac_part * multiplier;
520 if (*s && strcasecmp(s, "Hz"))
527 * Convert a "natural" string representation of a time value to an
528 * uint64_t value in milliseconds.
530 * E.g. a value of "3s" or "3 s" would be converted to 3000, a value
531 * of "15ms" would be converted to 15.
533 * Value representations other than decimal (such as hex or octal) are not
534 * supported. Only lower-case "s" and "ms" time suffixes are supported.
535 * Spaces (but not other whitespace) between value and suffix are allowed.
537 * @param timestring A string containing a (decimal) time value.
538 * @return The string's time value as uint64_t, in milliseconds.
540 * @todo Add support for "m" (minutes) and others.
541 * @todo Add support for picoseconds?
542 * @todo Allow both lower-case and upper-case? If no, document it.
546 SR_API uint64_t sr_parse_timestring(const char *timestring)
551 /* TODO: Error handling, logging. */
553 time_msec = strtoull(timestring, &s, 10);
554 if (time_msec == 0 && s == timestring)
562 else if (!strcmp(s, "ms"))
572 SR_API gboolean sr_parse_boolstring(const char *boolstr)
577 if (!g_ascii_strncasecmp(boolstr, "true", 4) ||
578 !g_ascii_strncasecmp(boolstr, "yes", 3) ||
579 !g_ascii_strncasecmp(boolstr, "on", 2) ||
580 !g_ascii_strncasecmp(boolstr, "1", 1))
587 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
591 *p = strtoull(periodstr, &s, 10);
592 if (*p == 0 && s == periodstr)
593 /* No digits found. */
599 if (!strcmp(s, "fs"))
600 *q = 1000000000000000ULL;
601 else if (!strcmp(s, "ps"))
602 *q = 1000000000000ULL;
603 else if (!strcmp(s, "ns"))
605 else if (!strcmp(s, "us"))
607 else if (!strcmp(s, "ms"))
609 else if (!strcmp(s, "s"))
612 /* Must have a time suffix. */
620 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q)
624 *p = strtoull(voltstr, &s, 10);
625 if (*p == 0 && s == voltstr)
626 /* No digits found. */
632 if (!strcasecmp(s, "mv"))
634 else if (!strcasecmp(s, "v"))
637 /* Must have a base suffix. */