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, see <http://www.gnu.org/licenses/>.
20 /* Needed for POSIX.1-2008 locale functions */
21 #define _XOPEN_SOURCE 700
25 #if defined(__FreeBSD__) || defined(__APPLE__)
28 #if defined(__FreeBSD__)
29 #include <sys/param.h>
36 #include <libsigrok/libsigrok.h>
37 #include "libsigrok-internal.h"
40 #define LOG_PREFIX "strutil"
46 * Helper functions for handling or converting libsigrok-related strings.
50 * @defgroup grp_strutil String utilities
52 * Helper functions for handling or converting libsigrok-related strings.
60 * Convert a string representation of a numeric value (base 10) to a long integer. The
61 * conversion is strict and will fail if the complete string does not represent
62 * a valid long integer. The function sets errno according to the details of the
65 * @param str The string representation to convert.
66 * @param ret Pointer to long where the result of the conversion will be stored.
68 * @retval SR_OK Conversion successful.
69 * @retval SR_ERR Failure.
71 SR_PRIV int sr_atol(const char *str, long *ret)
77 tmp = strtol(str, &endptr, 10);
79 while (endptr && isspace(*endptr))
82 if (!endptr || *endptr || errno) {
95 * Convert a string representation of a numeric value (base 10) to an integer. The
96 * conversion is strict and will fail if the complete string does not represent
97 * a valid integer. The function sets errno according to the details of the
100 * @param str The string representation to convert.
101 * @param ret Pointer to int where the result of the conversion will be stored.
103 * @retval SR_OK Conversion successful.
104 * @retval SR_ERR Failure.
106 SR_PRIV int sr_atoi(const char *str, int *ret)
110 if (sr_atol(str, &tmp) != SR_OK)
113 if ((int) tmp != tmp) {
125 * Convert a string representation of a numeric value to a double. The
126 * conversion is strict and will fail if the complete string does not represent
127 * a valid double. The function sets errno according to the details of the
130 * @param str The string representation to convert.
131 * @param ret Pointer to double where the result of the conversion will be stored.
133 * @retval SR_OK Conversion successful.
134 * @retval SR_ERR Failure.
136 SR_PRIV int sr_atod(const char *str, double *ret)
142 tmp = strtof(str, &endptr);
144 while (endptr && isspace(*endptr))
147 if (!endptr || *endptr || errno) {
160 * Convert a string representation of a numeric value to a float. The
161 * conversion is strict and will fail if the complete string does not represent
162 * a valid float. The function sets errno according to the details of the
165 * @param str The string representation to convert.
166 * @param ret Pointer to float where the result of the conversion will be stored.
168 * @retval SR_OK Conversion successful.
169 * @retval SR_ERR Failure.
171 SR_PRIV int sr_atof(const char *str, float *ret)
175 if (sr_atod(str, &tmp) != SR_OK)
178 if ((float) tmp != tmp) {
190 * Convert a string representation of a numeric value to a double. The
191 * conversion is strict and will fail if the complete string does not represent
192 * a valid double. The function sets errno according to the details of the
193 * failure. This version ignores the locale.
195 * @param str The string representation to convert.
196 * @param ret Pointer to double where the result of the conversion will be stored.
198 * @retval SR_OK Conversion successful.
199 * @retval SR_ERR Failure.
201 SR_PRIV int sr_atod_ascii(const char *str, double *ret)
207 tmp = g_ascii_strtod(str, &endptr);
209 if (!endptr || *endptr || errno) {
222 * Convert a string representation of a numeric value to a float. The
223 * conversion is strict and will fail if the complete string does not represent
224 * a valid float. The function sets errno according to the details of the
225 * failure. This version ignores the locale.
227 * @param str The string representation to convert.
228 * @param ret Pointer to float where the result of the conversion will be stored.
230 * @retval SR_OK Conversion successful.
231 * @retval SR_ERR Failure.
233 SR_PRIV int sr_atof_ascii(const char *str, float *ret)
239 tmp = g_ascii_strtod(str, &endptr);
241 if (!endptr || *endptr || errno) {
247 /* FIXME This fails unexpectedly. Some other method to safel downcast
248 * needs to be found. Checking against FLT_MAX doesn't work as well. */
250 if ((float) tmp != tmp) {
252 sr_dbg("ERANGEEEE %e != %e", (float) tmp, tmp);
262 * Compose a string with a format string in the buffer pointed to by buf.
264 * It is up to the caller to ensure that the allocated buffer is large enough
265 * to hold the formatted result.
267 * A terminating NUL character is automatically appended after the content
270 * After the format parameter, the function expects at least as many additional
271 * arguments as needed for format.
273 * This version ignores the current locale and uses the locale "C" for Linux,
274 * FreeBSD, OSX and Android.
276 * @param buf Pointer to a buffer where the resulting C string is stored.
277 * @param format C string that contains a format string (see printf).
278 * @param ... A sequence of additional arguments, each containing a value to be
279 * used to replace a format specifier in the format string.
281 * @return On success, the number of characters that would have been written,
282 * not counting the terminating NUL character.
286 SR_API int sr_sprintf_ascii(char *buf, const char *format, ...)
291 va_start(args, format);
292 ret = sr_vsprintf_ascii(buf, format, args);
299 * Compose a string with a format string in the buffer pointed to by buf.
301 * It is up to the caller to ensure that the allocated buffer is large enough
302 * to hold the formatted result.
304 * Internally, the function retrieves arguments from the list identified by
305 * args as if va_arg was used on it, and thus the state of args is likely to
306 * be altered by the call.
308 * In any case, args should have been initialized by va_start at some point
309 * before the call, and it is expected to be released by va_end at some point
312 * This version ignores the current locale and uses the locale "C" for Linux,
313 * FreeBSD, OSX and Android.
315 * @param buf Pointer to a buffer where the resulting C string is stored.
316 * @param format C string that contains a format string (see printf).
317 * @param args A value identifying a variable arguments list initialized with
320 * @return On success, the number of characters that would have been written,
321 * not counting the terminating NUL character.
325 SR_API int sr_vsprintf_ascii(char *buf, const char *format, va_list args)
332 * TODO: This part compiles with mingw-w64 but doesn't run with Win7.
333 * Doesn't start because of "Procedure entry point _create_locale
334 * not found in msvcrt.dll".
335 * mingw-w64 should link to msvcr100.dll not msvcrt.dll!
336 * See: https://msdn.microsoft.com/en-us/en-en/library/1kt27hek.aspx
340 locale = _create_locale(LC_NUMERIC, "C");
341 ret = _vsprintf_l(buf, format, locale, args);
342 _free_locale(locale);
345 /* vsprintf() uses the current locale, may not work correctly for floats. */
346 ret = vsprintf(buf, format, args);
349 #elif defined(__APPLE__)
352 * https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man3/printf_l.3.html
353 * https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man3/xlocale.3.html
358 locale = newlocale(LC_NUMERIC_MASK, "C", NULL);
359 ret = vsprintf_l(buf, locale, format, args);
363 #elif defined(__FreeBSD__) && __FreeBSD_version >= 901000
366 * https://www.freebsd.org/cgi/man.cgi?query=printf_l&apropos=0&sektion=3&manpath=FreeBSD+9.1-RELEASE
367 * https://www.freebsd.org/cgi/man.cgi?query=xlocale&apropos=0&sektion=3&manpath=FreeBSD+9.1-RELEASE
372 locale = newlocale(LC_NUMERIC_MASK, "C", NULL);
373 ret = vsprintf_l(buf, locale, format, args);
377 #elif defined(__ANDROID__)
379 * The Bionic libc only has two locales ("C" aka "POSIX" and "C.UTF-8"
380 * aka "en_US.UTF-8"). The decimal point is hard coded as "."
381 * See: https://android.googlesource.com/platform/bionic/+/master/libc/bionic/locale.cpp
385 ret = vsprintf(buf, format, args);
388 #elif defined(__linux__)
390 locale_t old_locale, temp_locale;
392 /* Switch to C locale for proper float/double conversion. */
393 temp_locale = newlocale(LC_NUMERIC, "C", NULL);
394 old_locale = uselocale(temp_locale);
396 ret = vsprintf(buf, format, args);
398 /* Switch back to original locale. */
399 uselocale(old_locale);
400 freelocale(temp_locale);
403 #elif defined(__unix__) || defined(__unix)
405 * This is a fallback for all other BSDs, *nix and FreeBSD <= 9.0, by
406 * using the current locale for snprintf(). This may not work correctly
411 ret = vsprintf(buf, format, args);
415 /* No implementation for unknown systems! */
421 * Composes a string with a format string (like printf) in the buffer pointed
422 * by buf (taking buf_size as the maximum buffer capacity to fill).
423 * If the resulting string would be longer than n - 1 characters, the remaining
424 * characters are discarded and not stored, but counted for the value returned
426 * A terminating NUL character is automatically appended after the content
428 * After the format parameter, the function expects at least as many additional
429 * arguments as needed for format.
431 * This version ignores the current locale and uses the locale "C" for Linux,
432 * FreeBSD, OSX and Android.
434 * @param buf Pointer to a buffer where the resulting C string is stored.
435 * @param buf_size Maximum number of bytes to be used in the buffer. The
436 * generated string has a length of at most buf_size - 1, leaving space
437 * for the additional terminating NUL character.
438 * @param format C string that contains a format string (see printf).
439 * @param ... A sequence of additional arguments, each containing a value to be
440 * used to replace a format specifier in the format string.
442 * @return On success, the number of characters that would have been written if
443 * buf_size had been sufficiently large, not counting the terminating
444 * NUL character. On failure, a negative number is returned.
445 * Notice that only when this returned value is non-negative and less
446 * than buf_size, the string has been completely written.
450 SR_API int sr_snprintf_ascii(char *buf, size_t buf_size,
451 const char *format, ...)
456 va_start(args, format);
457 ret = sr_vsnprintf_ascii(buf, buf_size, format, args);
464 * Composes a string with a format string (like printf) in the buffer pointed
465 * by buf (taking buf_size as the maximum buffer capacity to fill).
466 * If the resulting string would be longer than n - 1 characters, the remaining
467 * characters are discarded and not stored, but counted for the value returned
469 * A terminating NUL character is automatically appended after the content
471 * Internally, the function retrieves arguments from the list identified by
472 * args as if va_arg was used on it, and thus the state of args is likely to
473 * be altered by the call.
474 * In any case, arg should have been initialized by va_start at some point
475 * before the call, and it is expected to be released by va_end at some point
478 * This version ignores the current locale and uses the locale "C" for Linux,
479 * FreeBSD, OSX and Android.
481 * @param buf Pointer to a buffer where the resulting C string is stored.
482 * @param buf_size Maximum number of bytes to be used in the buffer. The
483 * generated string has a length of at most buf_size - 1, leaving space
484 * for the additional terminating NUL character.
485 * @param format C string that contains a format string (see printf).
486 * @param args A value identifying a variable arguments list initialized with
489 * @return On success, the number of characters that would have been written if
490 * buf_size had been sufficiently large, not counting the terminating
491 * NUL character. On failure, a negative number is returned.
492 * Notice that only when this returned value is non-negative and less
493 * than buf_size, the string has been completely written.
497 SR_API int sr_vsnprintf_ascii(char *buf, size_t buf_size,
498 const char *format, va_list args)
505 * TODO: This part compiles with mingw-w64 but doesn't run with Win7.
506 * Doesn't start because of "Procedure entry point _create_locale
507 * not found in msvcrt.dll".
508 * mingw-w64 should link to msvcr100.dll not msvcrt.dll!.
509 * See: https://msdn.microsoft.com/en-us/en-en/library/1kt27hek.aspx
513 locale = _create_locale(LC_NUMERIC, "C");
514 ret = _vsnprintf_l(buf, buf_size, format, locale, args);
515 _free_locale(locale);
518 /* vsprintf uses the current locale, may cause issues for floats. */
519 ret = vsnprintf(buf, buf_size, format, args);
522 #elif defined(__APPLE__)
525 * https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man3/printf_l.3.html
526 * https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man3/xlocale.3.html
531 locale = newlocale(LC_NUMERIC_MASK, "C", NULL);
532 ret = vsnprintf_l(buf, buf_size, locale, format, args);
536 #elif defined(__FreeBSD__) && __FreeBSD_version >= 901000
539 * https://www.freebsd.org/cgi/man.cgi?query=printf_l&apropos=0&sektion=3&manpath=FreeBSD+9.1-RELEASE
540 * https://www.freebsd.org/cgi/man.cgi?query=xlocale&apropos=0&sektion=3&manpath=FreeBSD+9.1-RELEASE
545 locale = newlocale(LC_NUMERIC_MASK, "C", NULL);
546 ret = vsnprintf_l(buf, buf_size, locale, format, args);
550 #elif defined(__ANDROID__)
552 * The Bionic libc only has two locales ("C" aka "POSIX" and "C.UTF-8"
553 * aka "en_US.UTF-8"). The decimal point is hard coded as ".".
554 * See: https://android.googlesource.com/platform/bionic/+/master/libc/bionic/locale.cpp
558 ret = vsnprintf(buf, buf_size, format, args);
561 #elif defined(__linux__)
563 locale_t old_locale, temp_locale;
565 /* Switch to C locale for proper float/double conversion. */
566 temp_locale = newlocale(LC_NUMERIC, "C", NULL);
567 old_locale = uselocale(temp_locale);
569 ret = vsnprintf(buf, buf_size, format, args);
571 /* Switch back to original locale. */
572 uselocale(old_locale);
573 freelocale(temp_locale);
576 #elif defined(__unix__) || defined(__unix)
578 * This is a fallback for all other BSDs, *nix and FreeBSD <= 9.0, by
579 * using the current locale for snprintf(). This may not work correctly
584 ret = vsnprintf(buf, buf_size, format, args);
588 /* No implementation for unknown systems! */
594 * Convert a string representation of a numeric value to a sr_rational.
596 * The conversion is strict and will fail if the complete string does not
597 * represent a valid number. The function sets errno according to the details
598 * of the failure. This version ignores the locale.
600 * @param str The string representation to convert.
601 * @param ret Pointer to sr_rational where the result of the conversion will be stored.
603 * @retval SR_OK Conversion successful.
604 * @retval SR_ERR Failure.
608 SR_API int sr_parse_rational(const char *str, struct sr_rational *ret)
612 int64_t fractional = 0;
613 int64_t denominator = 1;
614 int32_t fractional_len = 0;
615 int32_t exponent = 0;
616 gboolean is_negative = FALSE;
617 gboolean no_integer, no_fractional;
619 while (isspace(*str))
623 integral = g_ascii_strtoll(str, &endptr, 10);
625 if (str == endptr && (str[0] == '-' || str[0] == '+') && str[1] == '.') {
628 } else if (str == endptr && str[0] == '.') {
636 if (integral < 0 || str[0] == '-')
640 if (*endptr == '.') {
641 gboolean is_exp, is_eos;
642 const char *start = endptr + 1;
643 fractional = g_ascii_strtoll(start, &endptr, 10);
644 is_exp = *endptr == 'E' || *endptr == 'e';
645 is_eos = *endptr == '\0';
646 if (endptr == start && (is_exp || is_eos)) {
652 no_fractional = endptr == start;
653 if (no_integer && no_fractional)
655 fractional_len = endptr - start;
659 if ((*endptr == 'E') || (*endptr == 'e')) {
660 exponent = g_ascii_strtoll(endptr + 1, &endptr, 10);
668 for (int i = 0; i < fractional_len; i++)
670 exponent -= fractional_len;
673 integral += fractional;
675 integral -= fractional;
677 while (exponent > 0) {
682 while (exponent < 0) {
688 ret->q = denominator;
694 * Convert a numeric value value to its "natural" string representation
697 * E.g. a value of 3000000, with units set to "W", would be converted
698 * to "3 MW", 20000 to "20 kW", 31500 would become "31.5 kW".
700 * @param x The value to convert.
701 * @param unit The unit to append to the string, or NULL if the string
704 * @return A newly allocated string representation of the samplerate value,
705 * or NULL upon errors. The caller is responsible to g_free() the
710 SR_API char *sr_si_string_u64(uint64_t x, const char *unit)
713 uint64_t quot, divisor[] = {
714 SR_HZ(1), SR_KHZ(1), SR_MHZ(1), SR_GHZ(1),
715 SR_GHZ(1000), SR_GHZ(1000 * 1000), SR_GHZ(1000 * 1000 * 1000),
717 const char *p, prefix[] = "\0kMGTPE";
718 char fmt[16], fract[20] = "", *f;
723 for (i = 0; (quot = x / divisor[i]) >= 1000; i++);
726 sprintf(fmt, ".%%0%d"PRIu64, i * 3);
727 f = fract + sprintf(fract, fmt, x % divisor[i]) - 1;
729 while (f >= fract && strchr("0.", *f))
735 return g_strdup_printf("%" PRIu64 "%s %.1s%s", quot, fract, p, unit);
739 * Convert a numeric samplerate value to its "natural" string representation.
741 * E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz",
742 * 31500 would become "31.5 kHz".
744 * @param samplerate The samplerate in Hz.
746 * @return A newly allocated string representation of the samplerate value,
747 * or NULL upon errors. The caller is responsible to g_free() the
752 SR_API char *sr_samplerate_string(uint64_t samplerate)
754 return sr_si_string_u64(samplerate, "Hz");
758 * Convert a numeric period value to the "natural" string representation
759 * of its period value.
761 * The period is specified as a rational number's numerator and denominator.
763 * E.g. a pair of (1, 5) would be converted to "200 ms", (10, 100) to "100 ms".
765 * @param v_p The period numerator.
766 * @param v_q The period denominator.
768 * @return A newly allocated string representation of the period value,
769 * or NULL upon errors. The caller is responsible to g_free() the
774 SR_API char *sr_period_string(uint64_t v_p, uint64_t v_q)
779 freq = 1 / ((double)v_p / v_q);
781 if (freq > SR_GHZ(1)) {
782 v = (double)v_p / v_q * 1000000000000.0;
783 prec = ((v - (uint64_t)v) < FLT_MIN) ? 0 : 3;
784 return g_strdup_printf("%.*f ps", prec, v);
785 } else if (freq > SR_MHZ(1)) {
786 v = (double)v_p / v_q * 1000000000.0;
787 prec = ((v - (uint64_t)v) < FLT_MIN) ? 0 : 3;
788 return g_strdup_printf("%.*f ns", prec, v);
789 } else if (freq > SR_KHZ(1)) {
790 v = (double)v_p / v_q * 1000000.0;
791 prec = ((v - (uint64_t)v) < FLT_MIN) ? 0 : 3;
792 return g_strdup_printf("%.*f us", prec, v);
793 } else if (freq > 1) {
794 v = (double)v_p / v_q * 1000.0;
795 prec = ((v - (uint64_t)v) < FLT_MIN) ? 0 : 3;
796 return g_strdup_printf("%.*f ms", prec, v);
798 v = (double)v_p / v_q;
799 prec = ((v - (uint64_t)v) < FLT_MIN) ? 0 : 3;
800 return g_strdup_printf("%.*f s", prec, v);
805 * Convert a numeric voltage value to the "natural" string representation
806 * of its voltage value. The voltage is specified as a rational number's
807 * numerator and denominator.
809 * E.g. a value of 300000 would be converted to "300mV", 2 to "2V".
811 * @param v_p The voltage numerator.
812 * @param v_q The voltage denominator.
814 * @return A newly allocated string representation of the voltage value,
815 * or NULL upon errors. The caller is responsible to g_free() the
820 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q)
823 return g_strdup_printf("%" PRIu64 " mV", v_p);
825 return g_strdup_printf("%" PRIu64 " V", v_p);
827 return g_strdup_printf("%g V", (float)v_p / (float)v_q);
831 * Convert a "natural" string representation of a size value to uint64_t.
833 * E.g. a value of "3k" or "3 K" would be converted to 3000, a value
834 * of "15M" would be converted to 15000000.
836 * Value representations other than decimal (such as hex or octal) are not
837 * supported. Only 'k' (kilo), 'm' (mega), 'g' (giga) suffixes are supported.
838 * Spaces (but not other whitespace) between value and suffix are allowed.
840 * @param sizestring A string containing a (decimal) size value.
841 * @param size Pointer to uint64_t which will contain the string's size value.
843 * @return SR_OK upon success, SR_ERR upon errors.
847 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
854 *size = strtoull(sizestring, &s, 10);
858 while (s && *s && multiplier == 0 && !done) {
863 frac_part = g_ascii_strtod(s, &s);
867 multiplier = SR_KHZ(1);
871 multiplier = SR_MHZ(1);
875 multiplier = SR_GHZ(1);
879 multiplier = SR_GHZ(1000);
883 multiplier = SR_GHZ(1000 * 1000);
887 multiplier = SR_GHZ(1000 * 1000 * 1000);
895 if (multiplier > 0) {
897 *size += frac_part * multiplier;
902 if (s && *s && g_ascii_strcasecmp(s, "Hz"))
909 * Convert a "natural" string representation of a time value to an
910 * uint64_t value in milliseconds.
912 * E.g. a value of "3s" or "3 s" would be converted to 3000, a value
913 * of "15ms" would be converted to 15.
915 * Value representations other than decimal (such as hex or octal) are not
916 * supported. Only lower-case "s" and "ms" time suffixes are supported.
917 * Spaces (but not other whitespace) between value and suffix are allowed.
919 * @param timestring A string containing a (decimal) time value.
920 * @return The string's time value as uint64_t, in milliseconds.
922 * @todo Add support for "m" (minutes) and others.
923 * @todo Add support for picoseconds?
924 * @todo Allow both lower-case and upper-case? If no, document it.
928 SR_API uint64_t sr_parse_timestring(const char *timestring)
933 /* TODO: Error handling, logging. */
935 time_msec = strtoull(timestring, &s, 10);
936 if (time_msec == 0 && s == timestring)
944 else if (!strcmp(s, "ms"))
954 SR_API gboolean sr_parse_boolstring(const char *boolstr)
957 * Complete absence of an input spec is assumed to mean TRUE,
958 * as in command line option strings like this:
959 * ...:samplerate=100k:header:numchannels=4:...
961 if (!boolstr || !*boolstr)
964 if (!g_ascii_strncasecmp(boolstr, "true", 4) ||
965 !g_ascii_strncasecmp(boolstr, "yes", 3) ||
966 !g_ascii_strncasecmp(boolstr, "on", 2) ||
967 !g_ascii_strncasecmp(boolstr, "1", 1))
974 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
978 *p = strtoull(periodstr, &s, 10);
979 if (*p == 0 && s == periodstr)
980 /* No digits found. */
986 if (!strcmp(s, "fs"))
987 *q = UINT64_C(1000000000000000);
988 else if (!strcmp(s, "ps"))
989 *q = UINT64_C(1000000000000);
990 else if (!strcmp(s, "ns"))
991 *q = UINT64_C(1000000000);
992 else if (!strcmp(s, "us"))
994 else if (!strcmp(s, "ms"))
996 else if (!strcmp(s, "s"))
999 /* Must have a time suffix. */
1007 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q)
1011 *p = strtoull(voltstr, &s, 10);
1012 if (*p == 0 && s == voltstr)
1013 /* No digits found. */
1019 if (!g_ascii_strcasecmp(s, "mv"))
1021 else if (!g_ascii_strcasecmp(s, "v"))
1024 /* Must have a base suffix. */