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
27 #include <libsigrok/libsigrok.h>
28 #include "libsigrok-internal.h"
31 #define LOG_PREFIX "strutil"
37 * Helper functions for handling or converting libsigrok-related strings.
41 * @defgroup grp_strutil String utilities
43 * Helper functions for handling or converting libsigrok-related strings.
51 * Convert a string representation of a numeric value (base 10) to a long integer. The
52 * conversion is strict and will fail if the complete string does not represent
53 * a valid long integer. The function sets errno according to the details of the
56 * @param str The string representation to convert.
57 * @param ret Pointer to long where the result of the conversion will be stored.
59 * @retval SR_OK Conversion successful.
60 * @retval SR_ERR Failure.
62 SR_PRIV int sr_atol(const char *str, long *ret)
68 tmp = strtol(str, &endptr, 10);
70 if (!endptr || *endptr || errno) {
83 * Convert a string representation of a numeric value (base 10) to an integer. The
84 * conversion is strict and will fail if the complete string does not represent
85 * a valid integer. The function sets errno according to the details of the
88 * @param str The string representation to convert.
89 * @param ret Pointer to int where the result of the conversion will be stored.
91 * @retval SR_OK Conversion successful.
92 * @retval SR_ERR Failure.
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 * @retval SR_OK Conversion successful.
122 * @retval SR_ERR Failure.
124 SR_PRIV int sr_atod(const char *str, double *ret)
130 tmp = strtof(str, &endptr);
132 if (!endptr || *endptr || errno) {
145 * Convert a string representation of a numeric value to a float. The
146 * conversion is strict and will fail if the complete string does not represent
147 * a valid float. The function sets errno according to the details of the
150 * @param str The string representation to convert.
151 * @param ret Pointer to float where the result of the conversion will be stored.
153 * @retval SR_OK Conversion successful.
154 * @retval SR_ERR Failure.
156 SR_PRIV int sr_atof(const char *str, float *ret)
160 if (sr_atod(str, &tmp) != SR_OK)
163 if ((float) tmp != tmp) {
175 * Convert a string representation of a numeric value to a float. The
176 * conversion is strict and will fail if the complete string does not represent
177 * a valid float. The function sets errno according to the details of the
178 * failure. This version ignores the locale.
180 * @param str The string representation to convert.
181 * @param ret Pointer to float where the result of the conversion will be stored.
183 * @retval SR_OK Conversion successful.
184 * @retval SR_ERR Failure.
186 SR_PRIV int sr_atof_ascii(const char *str, float *ret)
192 tmp = g_ascii_strtod(str, &endptr);
194 if (!endptr || *endptr || errno) {
200 /* FIXME This fails unexpectedly. Some other method to safel downcast
201 * needs to be found. Checking against FLT_MAX doesn't work as well. */
203 if ((float) tmp != tmp) {
205 sr_dbg("ERANGEEEE %e != %e", (float) tmp, tmp);
215 * Convert a string representation of a numeric value to a sr_rational.
217 * The conversion is strict and will fail if the complete string does not
218 * represent a valid number. The function sets errno according to the details
219 * of the failure. This version ignores the locale.
221 * @param str The string representation to convert.
222 * @param ret Pointer to sr_rational where the result of the conversion will be stored.
224 * @retval SR_OK Conversion successful.
225 * @retval SR_ERR Failure.
229 SR_API int sr_parse_rational(const char *str, struct sr_rational *ret)
233 int64_t fractional = 0;
234 int64_t denominator = 1;
235 int32_t fractional_len = 0;
236 int32_t exponent = 0;
239 integral = g_ascii_strtoll(str, &endptr, 10);
244 if (*endptr == '.') {
245 const char* start = endptr + 1;
246 fractional = g_ascii_strtoll(start, &endptr, 10);
249 fractional_len = endptr - start;
252 if ((*endptr == 'E') || (*endptr == 'e')) {
253 exponent = g_ascii_strtoll(endptr + 1, &endptr, 10);
261 for (int i = 0; i < fractional_len; i++)
263 exponent -= fractional_len;
266 integral += fractional;
268 integral -= fractional;
270 while (exponent > 0) {
275 while (exponent < 0) {
281 ret->q = denominator;
287 * Convert a numeric value value to its "natural" string representation
290 * E.g. a value of 3000000, with units set to "W", would be converted
291 * to "3 MW", 20000 to "20 kW", 31500 would become "31.5 kW".
293 * @param x The value to convert.
294 * @param unit The unit to append to the string, or NULL if the string
297 * @return A newly allocated string representation of the samplerate value,
298 * or NULL upon errors. The caller is responsible to g_free() the
303 SR_API char *sr_si_string_u64(uint64_t x, const char *unit)
306 uint64_t quot, divisor[] = {
307 SR_HZ(1), SR_KHZ(1), SR_MHZ(1), SR_GHZ(1),
308 SR_GHZ(1000), SR_GHZ(1000 * 1000), SR_GHZ(1000 * 1000 * 1000),
310 const char *p, prefix[] = "\0kMGTPE";
311 char fmt[16], fract[20] = "", *f;
316 for (i = 0; (quot = x / divisor[i]) >= 1000; i++);
319 sprintf(fmt, ".%%0%d"PRIu64, i * 3);
320 f = fract + sprintf(fract, fmt, x % divisor[i]) - 1;
322 while (f >= fract && strchr("0.", *f))
328 return g_strdup_printf("%" PRIu64 "%s %.1s%s", quot, fract, p, unit);
332 * Convert a numeric samplerate value to its "natural" string representation.
334 * E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz",
335 * 31500 would become "31.5 kHz".
337 * @param samplerate The samplerate in Hz.
339 * @return A newly allocated string representation of the samplerate value,
340 * or NULL upon errors. The caller is responsible to g_free() the
345 SR_API char *sr_samplerate_string(uint64_t samplerate)
347 return sr_si_string_u64(samplerate, "Hz");
351 * Convert a numeric frequency value to the "natural" string representation
354 * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms".
356 * @param frequency The frequency in Hz.
358 * @return A newly allocated string representation of the frequency value,
359 * or NULL upon errors. The caller is responsible to g_free() the
364 SR_API char *sr_period_string(uint64_t frequency)
369 /* Allocate enough for a uint64_t as string + " ms". */
370 o = g_malloc0(30 + 1);
372 if (frequency >= SR_GHZ(1))
373 r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000);
374 else if (frequency >= SR_MHZ(1))
375 r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000);
376 else if (frequency >= SR_KHZ(1))
377 r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000);
379 r = snprintf(o, 30, "%" PRIu64 " s", frequency);
382 /* Something went wrong... */
391 * Convert a numeric voltage value to the "natural" string representation
392 * of its voltage value. The voltage is specified as a rational number's
393 * numerator and denominator.
395 * E.g. a value of 300000 would be converted to "300mV", 2 to "2V".
397 * @param v_p The voltage numerator.
398 * @param v_q The voltage denominator.
400 * @return A newly allocated string representation of the voltage value,
401 * or NULL upon errors. The caller is responsible to g_free() the
406 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q)
411 o = g_malloc0(30 + 1);
414 r = snprintf(o, 30, "%" PRIu64 "mV", v_p);
416 r = snprintf(o, 30, "%" PRIu64 "V", v_p);
418 r = snprintf(o, 30, "%gV", (float)v_p / (float)v_q);
421 /* Something went wrong... */
430 * Convert a "natural" string representation of a size value to uint64_t.
432 * E.g. a value of "3k" or "3 K" would be converted to 3000, a value
433 * of "15M" would be converted to 15000000.
435 * Value representations other than decimal (such as hex or octal) are not
436 * supported. Only 'k' (kilo), 'm' (mega), 'g' (giga) suffixes are supported.
437 * Spaces (but not other whitespace) between value and suffix are allowed.
439 * @param sizestring A string containing a (decimal) size value.
440 * @param size Pointer to uint64_t which will contain the string's size value.
442 * @return SR_OK upon success, SR_ERR upon errors.
446 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
448 int multiplier, done;
452 *size = strtoull(sizestring, &s, 10);
456 while (s && *s && multiplier == 0 && !done) {
461 frac_part = g_ascii_strtod(s, &s);
465 multiplier = SR_KHZ(1);
469 multiplier = SR_MHZ(1);
473 multiplier = SR_GHZ(1);
481 if (multiplier > 0) {
483 *size += frac_part * multiplier;
487 if (s && *s && g_ascii_strcasecmp(s, "Hz"))
494 * Convert a "natural" string representation of a time value to an
495 * uint64_t value in milliseconds.
497 * E.g. a value of "3s" or "3 s" would be converted to 3000, a value
498 * of "15ms" would be converted to 15.
500 * Value representations other than decimal (such as hex or octal) are not
501 * supported. Only lower-case "s" and "ms" time suffixes are supported.
502 * Spaces (but not other whitespace) between value and suffix are allowed.
504 * @param timestring A string containing a (decimal) time value.
505 * @return The string's time value as uint64_t, in milliseconds.
507 * @todo Add support for "m" (minutes) and others.
508 * @todo Add support for picoseconds?
509 * @todo Allow both lower-case and upper-case? If no, document it.
513 SR_API uint64_t sr_parse_timestring(const char *timestring)
518 /* TODO: Error handling, logging. */
520 time_msec = strtoull(timestring, &s, 10);
521 if (time_msec == 0 && s == timestring)
529 else if (!strcmp(s, "ms"))
539 SR_API gboolean sr_parse_boolstring(const char *boolstr)
544 if (!g_ascii_strncasecmp(boolstr, "true", 4) ||
545 !g_ascii_strncasecmp(boolstr, "yes", 3) ||
546 !g_ascii_strncasecmp(boolstr, "on", 2) ||
547 !g_ascii_strncasecmp(boolstr, "1", 1))
554 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
558 *p = strtoull(periodstr, &s, 10);
559 if (*p == 0 && s == periodstr)
560 /* No digits found. */
566 if (!strcmp(s, "fs"))
567 *q = 1000000000000000ULL;
568 else if (!strcmp(s, "ps"))
569 *q = 1000000000000ULL;
570 else if (!strcmp(s, "ns"))
572 else if (!strcmp(s, "us"))
574 else if (!strcmp(s, "ms"))
576 else if (!strcmp(s, "s"))
579 /* Must have a time suffix. */
587 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q)
591 *p = strtoull(voltstr, &s, 10);
592 if (*p == 0 && s == voltstr)
593 /* No digits found. */
599 if (!g_ascii_strcasecmp(s, "mv"))
601 else if (!g_ascii_strcasecmp(s, "v"))
604 /* Must have a base suffix. */