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"
28 /* Message logging helpers with subsystem-specific prefix string. */
29 #define LOG_PREFIX "strutil: "
30 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
31 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
32 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
33 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
34 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
35 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
40 * Helper functions for handling or converting libsigrok-related strings.
44 * @defgroup grp_strutil String utilities
46 * Helper functions for handling or converting libsigrok-related strings.
52 * Convert a string representation of a numeric value to a long integer. The
53 * conversion is strict and will fail if the complete string does not represent
54 * a valid long integer. The function sets errno according to the details of the
57 * @param str The string representation to convert.
58 * @param ret Pointer to long where the result of the conversion will be stored.
60 * @return SR_OK if conversion is successful, otherwise SR_ERR.
64 SR_PRIV int sr_atol(const char *str, long *ret)
70 tmp = strtol(str, &endptr, 0);
72 if (!endptr || *endptr || errno) {
83 * Convert a string representation of a numeric value 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 * @return SR_OK if conversion is successful, otherwise SR_ERR.
95 SR_PRIV int sr_atoi(const char *str, int *ret)
99 if (sr_atol(str, &tmp) != SR_OK)
102 if ((int) tmp != tmp) {
112 * Convert a string representation of a numeric value to a double. The
113 * conversion is strict and will fail if the complete string does not represent
114 * a valid double. The function sets errno according to the details of the
117 * @param str The string representation to convert.
118 * @param ret Pointer to double where the result of the conversion will be stored.
120 * @return SR_OK if conversion is successful, otherwise SR_ERR.
124 SR_PRIV int sr_atod(const char *str, double *ret)
130 tmp = strtof(str, &endptr);
132 if (!endptr || *endptr || errno) {
143 * Convert a string representation of a numeric value to a float. The
144 * conversion is strict and will fail if the complete string does not represent
145 * a valid float. The function sets errno according to the details of the
148 * @param str The string representation to convert.
149 * @param ret Pointer to float where the result of the conversion will be stored.
151 * @return SR_OK if conversion is successful, otherwise SR_ERR.
155 SR_PRIV int sr_atof(const char *str, float *ret)
159 if (sr_atod(str, &tmp) != SR_OK)
162 if ((float) tmp != tmp) {
172 * Convert a numeric value value to its "natural" string representation
175 * E.g. a value of 3000000, with units set to "W", would be converted
176 * to "3 MW", 20000 to "20 kW", 31500 would become "31.5 kW".
178 * @param x The value to convert.
179 * @param unit The unit to append to the string, or NULL if the string
182 * @return A g_try_malloc()ed string representation of the samplerate value,
183 * or NULL upon errors. The caller is responsible to g_free() the
186 SR_API char *sr_si_string_u64(uint64_t x, const char *unit)
189 uint64_t quot, divisor[] = {
190 SR_HZ(1), SR_KHZ(1), SR_MHZ(1), SR_GHZ(1),
191 SR_GHZ(1000), SR_GHZ(1000 * 1000), SR_GHZ(1000 * 1000 * 1000),
193 const char *p, prefix[] = "\0kMGTPE";
194 char fmt[8], fract[20] = "", *f;
199 for (i = 0; (quot = x / divisor[i]) >= 1000; i++);
202 sprintf(fmt, ".%%0%dlu", i * 3);
203 f = fract + sprintf(fract, fmt, x % divisor[i]) - 1;
205 while (f >= fract && strchr("0.", *f))
211 return g_strdup_printf("%" PRIu64 "%s %.1s%s", quot, fract, p, unit);
215 * Convert a numeric samplerate value to its "natural" string representation.
217 * E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz",
218 * 31500 would become "31.5 kHz".
220 * @param samplerate The samplerate in Hz.
222 * @return A g_try_malloc()ed string representation of the samplerate value,
223 * or NULL upon errors. The caller is responsible to g_free() the
226 SR_API char *sr_samplerate_string(uint64_t samplerate)
228 return sr_si_string_u64(samplerate, "Hz");
232 * Convert a numeric frequency value to the "natural" string representation
235 * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms".
237 * @param frequency The frequency in Hz.
239 * @return A g_try_malloc()ed string representation of the frequency value,
240 * or NULL upon errors. The caller is responsible to g_free() the
243 SR_API char *sr_period_string(uint64_t frequency)
248 /* Allocate enough for a uint64_t as string + " ms". */
249 if (!(o = g_try_malloc0(30 + 1))) {
250 sr_err("%s: o malloc failed", __func__);
254 if (frequency >= SR_GHZ(1))
255 r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000);
256 else if (frequency >= SR_MHZ(1))
257 r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000);
258 else if (frequency >= SR_KHZ(1))
259 r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000);
261 r = snprintf(o, 30, "%" PRIu64 " s", frequency);
264 /* Something went wrong... */
273 * Convert a numeric voltage value to the "natural" string representation
274 * of its voltage value. The voltage is specified as a rational number's
275 * numerator and denominator.
277 * E.g. a value of 300000 would be converted to "300mV", 2 to "2V".
279 * @param v_p The voltage numerator.
280 * @param v_q The voltage denominator.
282 * @return A g_try_malloc()ed string representation of the voltage value,
283 * or NULL upon errors. The caller is responsible to g_free() the
286 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q)
291 if (!(o = g_try_malloc0(30 + 1))) {
292 sr_err("%s: o malloc failed", __func__);
297 r = snprintf(o, 30, "%" PRIu64 "mV", v_p);
299 r = snprintf(o, 30, "%" PRIu64 "V", v_p);
301 r = snprintf(o, 30, "%gV", (float)v_p / (float)v_q);
304 /* Something went wrong... */
313 * Parse a trigger specification string.
315 * @param sdi The device instance for which the trigger specification is
316 * intended. Must not be NULL. Also, sdi->driver and
317 * sdi->driver->info_get must not be NULL.
318 * @param triggerstring The string containing the trigger specification for
319 * one or more probes of this device. Entries for multiple probes are
320 * comma-separated. Triggers are specified in the form key=value,
321 * where the key is a probe number (or probe name) and the value is
322 * the requested trigger type. Valid trigger types currently
323 * include 'r' (rising edge), 'f' (falling edge), 'c' (any pin value
324 * change), '0' (low value), or '1' (high value).
325 * Example: "1=r,sck=f,miso=0,7=c"
327 * @return Pointer to a list of trigger types (strings), or NULL upon errors.
328 * The pointer list (if non-NULL) has as many entries as the
329 * respective device has probes (all physically available probes,
330 * not just enabled ones). Entries of the list which don't have
331 * a trigger value set in 'triggerstring' are NULL, the other entries
332 * contain the respective trigger type which is requested for the
333 * respective probe (e.g. "r", "c", and so on).
335 SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
336 const char *triggerstring)
340 struct sr_probe *probe;
341 int max_probes, probenum, i;
342 char **tokens, **triggerlist, *trigger, *tc;
343 const char *trigger_types;
346 max_probes = g_slist_length(sdi->probes);
349 if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) {
350 sr_err("%s: triggerlist malloc failed", __func__);
354 if (sdi->driver->config_list(SR_CONF_TRIGGER_TYPE,
355 &gvar, sdi, NULL) != SR_OK) {
356 sr_err("%s: Device doesn't support any triggers.", __func__);
359 trigger_types = g_variant_get_string(gvar, NULL);
361 tokens = g_strsplit(triggerstring, ",", max_probes);
362 for (i = 0; tokens[i]; i++) {
364 for (l = sdi->probes; l; l = l->next) {
365 probe = (struct sr_probe *)l->data;
367 && !strncmp(probe->name, tokens[i],
368 strlen(probe->name))) {
369 probenum = probe->index;
374 if (probenum < 0 || probenum >= max_probes) {
375 sr_err("Invalid probe.");
380 if ((trigger = strchr(tokens[i], '='))) {
381 for (tc = ++trigger; *tc; tc++) {
382 if (strchr(trigger_types, *tc) == NULL) {
383 sr_err("Unsupported trigger "
390 triggerlist[probenum] = g_strdup(trigger);
394 g_variant_unref(gvar);
397 for (i = 0; i < max_probes; i++)
398 g_free(triggerlist[i]);
407 * Convert a "natural" string representation of a size value to uint64_t.
409 * E.g. a value of "3k" or "3 K" would be converted to 3000, a value
410 * of "15M" would be converted to 15000000.
412 * Value representations other than decimal (such as hex or octal) are not
413 * supported. Only 'k' (kilo), 'm' (mega), 'g' (giga) suffixes are supported.
414 * Spaces (but not other whitespace) between value and suffix are allowed.
416 * @param sizestring A string containing a (decimal) size value.
417 * @param size Pointer to uint64_t which will contain the string's size value.
419 * @return SR_OK upon success, SR_ERR upon errors.
421 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
423 int multiplier, done;
426 *size = strtoull(sizestring, &s, 10);
429 while (s && *s && multiplier == 0 && !done) {
435 multiplier = SR_KHZ(1);
439 multiplier = SR_MHZ(1);
443 multiplier = SR_GHZ(1);
454 if (*s && strcasecmp(s, "Hz"))
461 * Convert a "natural" string representation of a time value to an
462 * uint64_t value in milliseconds.
464 * E.g. a value of "3s" or "3 s" would be converted to 3000, a value
465 * of "15ms" would be converted to 15.
467 * Value representations other than decimal (such as hex or octal) are not
468 * supported. Only lower-case "s" and "ms" time suffixes are supported.
469 * Spaces (but not other whitespace) between value and suffix are allowed.
471 * @param timestring A string containing a (decimal) time value.
472 * @return The string's time value as uint64_t, in milliseconds.
474 * @todo Add support for "m" (minutes) and others.
475 * @todo Add support for picoseconds?
476 * @todo Allow both lower-case and upper-case? If no, document it.
478 SR_API uint64_t sr_parse_timestring(const char *timestring)
483 /* TODO: Error handling, logging. */
485 time_msec = strtoull(timestring, &s, 10);
486 if (time_msec == 0 && s == timestring)
494 else if (!strcmp(s, "ms"))
503 SR_API gboolean sr_parse_boolstring(const char *boolstr)
508 if (!g_ascii_strncasecmp(boolstr, "true", 4) ||
509 !g_ascii_strncasecmp(boolstr, "yes", 3) ||
510 !g_ascii_strncasecmp(boolstr, "on", 2) ||
511 !g_ascii_strncasecmp(boolstr, "1", 1))
517 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
521 *p = strtoull(periodstr, &s, 10);
522 if (*p == 0 && s == periodstr)
523 /* No digits found. */
529 if (!strcmp(s, "fs"))
530 *q = 1000000000000000ULL;
531 else if (!strcmp(s, "ps"))
532 *q = 1000000000000ULL;
533 else if (!strcmp(s, "ns"))
535 else if (!strcmp(s, "us"))
537 else if (!strcmp(s, "ms"))
539 else if (!strcmp(s, "s"))
542 /* Must have a time suffix. */
550 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q)
554 *p = strtoull(voltstr, &s, 10);
555 if (*p == 0 && s == voltstr)
556 /* No digits found. */
562 if (!strcasecmp(s, "mv"))
564 else if (!strcasecmp(s, "v"))
567 /* Must have a base suffix. */