]> sigrok.org Git - libsigrok.git/blob - strutil.c
README: Document new libserialport requirement.
[libsigrok.git] / strutil.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5  *
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.
10  *
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.
15  *
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
19  */
20
21 #include <stdint.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include "libsigrok.h"
25 #include "libsigrok-internal.h"
26
27 /* Message logging helpers with subsystem-specific prefix string. */
28 #define LOG_PREFIX "strutil: "
29 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
30 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
31 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
32 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
33 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
34 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
35
36 /**
37  * @file
38  *
39  * Helper functions for handling or converting libsigrok-related strings.
40  */
41
42 /**
43  * @defgroup grp_strutil String utilities
44  *
45  * Helper functions for handling or converting libsigrok-related strings.
46  *
47  * @{
48  */
49
50 /**
51  * Convert a numeric value value to its "natural" string representation
52  * in SI units.
53  *
54  * E.g. a value of 3000000, with units set to "W", would be converted
55  * to "3 MW", 20000 to "20 kW", 31500 would become "31.5 kW".
56  *
57  * @param x The value to convert.
58  * @param unit The unit to append to the string, or NULL if the string
59  *             has no units.
60  *
61  * @return A g_try_malloc()ed string representation of the samplerate value,
62  *         or NULL upon errors. The caller is responsible to g_free() the
63  *         memory.
64  */
65 SR_API char *sr_si_string_u64(uint64_t x, const char *unit)
66 {
67         uint8_t i;
68         uint64_t quot, divisor[] = {
69                 SR_HZ(1), SR_KHZ(1), SR_MHZ(1), SR_GHZ(1),
70                 SR_GHZ(1000), SR_GHZ(1000 * 1000), SR_GHZ(1000 * 1000 * 1000),
71         };
72         const char *p, prefix[] = "\0kMGTPE";
73         char fmt[8], fract[20] = "", *f;
74
75         if (unit == NULL)
76                 unit = "";
77
78         for (i = 0; (quot = x / divisor[i]) >= 1000; i++);
79
80         if (i) {
81                 sprintf(fmt, ".%%0%dlu", i * 3);
82                 f = fract + sprintf(fract, fmt, x % divisor[i]) - 1;
83
84                 while (f >= fract && strchr("0.", *f))
85                         *f-- = 0;
86         }
87
88         p = prefix + i;
89
90         return g_strdup_printf("%" PRIu64 "%s %.1s%s", quot, fract, p, unit);
91 }
92
93 /**
94  * Convert a numeric samplerate value to its "natural" string representation.
95  *
96  * E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz",
97  * 31500 would become "31.5 kHz".
98  *
99  * @param samplerate The samplerate in Hz.
100  *
101  * @return A g_try_malloc()ed string representation of the samplerate value,
102  *         or NULL upon errors. The caller is responsible to g_free() the
103  *         memory.
104  */
105 SR_API char *sr_samplerate_string(uint64_t samplerate)
106 {
107         return sr_si_string_u64(samplerate, "Hz");
108 }
109
110 /**
111  * Convert a numeric frequency value to the "natural" string representation
112  * of its period.
113  *
114  * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms".
115  *
116  * @param frequency The frequency in Hz.
117  *
118  * @return A g_try_malloc()ed string representation of the frequency value,
119  *         or NULL upon errors. The caller is responsible to g_free() the
120  *         memory.
121  */
122 SR_API char *sr_period_string(uint64_t frequency)
123 {
124         char *o;
125         int r;
126
127         /* Allocate enough for a uint64_t as string + " ms". */
128         if (!(o = g_try_malloc0(30 + 1))) {
129                 sr_err("%s: o malloc failed", __func__);
130                 return NULL;
131         }
132
133         if (frequency >= SR_GHZ(1))
134                 r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000);
135         else if (frequency >= SR_MHZ(1))
136                 r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000);
137         else if (frequency >= SR_KHZ(1))
138                 r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000);
139         else
140                 r = snprintf(o, 30, "%" PRIu64 " s", frequency);
141
142         if (r < 0) {
143                 /* Something went wrong... */
144                 g_free(o);
145                 return NULL;
146         }
147
148         return o;
149 }
150
151 /**
152  * Convert a numeric voltage value to the "natural" string representation
153  * of its voltage value. The voltage is specified as a rational number's
154  * numerator and denominator.
155  *
156  * E.g. a value of 300000 would be converted to "300mV", 2 to "2V".
157  *
158  * @param v_p The voltage numerator.
159  * @param v_q The voltage denominator.
160  *
161  * @return A g_try_malloc()ed string representation of the voltage value,
162  *         or NULL upon errors. The caller is responsible to g_free() the
163  *         memory.
164  */
165 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q)
166 {
167         int r;
168         char *o;
169
170         if (!(o = g_try_malloc0(30 + 1))) {
171                 sr_err("%s: o malloc failed", __func__);
172                 return NULL;
173         }
174
175         if (v_q == 1000)
176                 r = snprintf(o, 30, "%" PRIu64 "mV", v_p);
177         else if (v_q == 1)
178                 r = snprintf(o, 30, "%" PRIu64 "V", v_p);
179         else
180                 r = snprintf(o, 30, "%gV", (float)v_p / (float)v_q);
181
182         if (r < 0) {
183                 /* Something went wrong... */
184                 g_free(o);
185                 return NULL;
186         }
187
188         return o;
189 }
190
191 /**
192  * Parse a trigger specification string.
193  *
194  * @param sdi The device instance for which the trigger specification is
195  *            intended. Must not be NULL. Also, sdi->driver and
196  *            sdi->driver->info_get must not be NULL.
197  * @param triggerstring The string containing the trigger specification for
198  *        one or more probes of this device. Entries for multiple probes are
199  *        comma-separated. Triggers are specified in the form key=value,
200  *        where the key is a probe number (or probe name) and the value is
201  *        the requested trigger type. Valid trigger types currently
202  *        include 'r' (rising edge), 'f' (falling edge), 'c' (any pin value
203  *        change), '0' (low value), or '1' (high value).
204  *        Example: "1=r,sck=f,miso=0,7=c"
205  *
206  * @return Pointer to a list of trigger types (strings), or NULL upon errors.
207  *         The pointer list (if non-NULL) has as many entries as the
208  *         respective device has probes (all physically available probes,
209  *         not just enabled ones). Entries of the list which don't have
210  *         a trigger value set in 'triggerstring' are NULL, the other entries
211  *         contain the respective trigger type which is requested for the
212  *         respective probe (e.g. "r", "c", and so on).
213  */
214 SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
215                                      const char *triggerstring)
216 {
217         GSList *l;
218         GVariant *gvar;
219         struct sr_probe *probe;
220         int max_probes, probenum, i;
221         char **tokens, **triggerlist, *trigger, *tc;
222         const char *trigger_types;
223         gboolean error;
224
225         max_probes = g_slist_length(sdi->probes);
226         error = FALSE;
227
228         if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) {
229                 sr_err("%s: triggerlist malloc failed", __func__);
230                 return NULL;
231         }
232
233         if (sdi->driver->config_list(SR_CONF_TRIGGER_TYPE,
234                                 &gvar, sdi, NULL) != SR_OK) {
235                 sr_err("%s: Device doesn't support any triggers.", __func__);
236                 return NULL;
237         }
238         trigger_types = g_variant_get_string(gvar, NULL);
239
240         tokens = g_strsplit(triggerstring, ",", max_probes);
241         for (i = 0; tokens[i]; i++) {
242                 probenum = -1;
243                 for (l = sdi->probes; l; l = l->next) {
244                         probe = (struct sr_probe *)l->data;
245                         if (probe->enabled
246                                 && !strncmp(probe->name, tokens[i],
247                                         strlen(probe->name))) {
248                                 probenum = probe->index;
249                                 break;
250                         }
251                 }
252
253                 if (probenum < 0 || probenum >= max_probes) {
254                         sr_err("Invalid probe.");
255                         error = TRUE;
256                         break;
257                 }
258
259                 if ((trigger = strchr(tokens[i], '='))) {
260                         for (tc = ++trigger; *tc; tc++) {
261                                 if (strchr(trigger_types, *tc) == NULL) {
262                                         sr_err("Unsupported trigger "
263                                                "type '%c'.", *tc);
264                                         error = TRUE;
265                                         break;
266                                 }
267                         }
268                         if (!error)
269                                 triggerlist[probenum] = g_strdup(trigger);
270                 }
271         }
272         g_strfreev(tokens);
273         g_variant_unref(gvar);
274
275         if (error) {
276                 for (i = 0; i < max_probes; i++)
277                         g_free(triggerlist[i]);
278                 g_free(triggerlist);
279                 triggerlist = NULL;
280         }
281
282         return triggerlist;
283 }
284
285 /**
286  * Convert a "natural" string representation of a size value to uint64_t.
287  *
288  * E.g. a value of "3k" or "3 K" would be converted to 3000, a value
289  * of "15M" would be converted to 15000000.
290  *
291  * Value representations other than decimal (such as hex or octal) are not
292  * supported. Only 'k' (kilo), 'm' (mega), 'g' (giga) suffixes are supported.
293  * Spaces (but not other whitespace) between value and suffix are allowed.
294  *
295  * @param sizestring A string containing a (decimal) size value.
296  * @param size Pointer to uint64_t which will contain the string's size value.
297  *
298  * @return SR_OK upon success, SR_ERR upon errors.
299  */
300 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
301 {
302         int multiplier, done;
303         char *s;
304
305         *size = strtoull(sizestring, &s, 10);
306         multiplier = 0;
307         done = FALSE;
308         while (s && *s && multiplier == 0 && !done) {
309                 switch (*s) {
310                 case ' ':
311                         break;
312                 case 'k':
313                 case 'K':
314                         multiplier = SR_KHZ(1);
315                         break;
316                 case 'm':
317                 case 'M':
318                         multiplier = SR_MHZ(1);
319                         break;
320                 case 'g':
321                 case 'G':
322                         multiplier = SR_GHZ(1);
323                         break;
324                 default:
325                         done = TRUE;
326                         s--;
327                 }
328                 s++;
329         }
330         if (multiplier > 0)
331                 *size *= multiplier;
332
333         if (*s && strcasecmp(s, "Hz"))
334                 return SR_ERR;
335
336         return SR_OK;
337 }
338
339 /**
340  * Convert a "natural" string representation of a time value to an
341  * uint64_t value in milliseconds.
342  *
343  * E.g. a value of "3s" or "3 s" would be converted to 3000, a value
344  * of "15ms" would be converted to 15.
345  *
346  * Value representations other than decimal (such as hex or octal) are not
347  * supported. Only lower-case "s" and "ms" time suffixes are supported.
348  * Spaces (but not other whitespace) between value and suffix are allowed.
349  *
350  * @param timestring A string containing a (decimal) time value.
351  * @return The string's time value as uint64_t, in milliseconds.
352  *
353  * @todo Add support for "m" (minutes) and others.
354  * @todo Add support for picoseconds?
355  * @todo Allow both lower-case and upper-case? If no, document it.
356  */
357 SR_API uint64_t sr_parse_timestring(const char *timestring)
358 {
359         uint64_t time_msec;
360         char *s;
361
362         /* TODO: Error handling, logging. */
363
364         time_msec = strtoull(timestring, &s, 10);
365         if (time_msec == 0 && s == timestring)
366                 return 0;
367
368         if (s && *s) {
369                 while (*s == ' ')
370                         s++;
371                 if (!strcmp(s, "s"))
372                         time_msec *= 1000;
373                 else if (!strcmp(s, "ms"))
374                         ; /* redundant */
375                 else
376                         return 0;
377         }
378
379         return time_msec;
380 }
381
382 SR_API gboolean sr_parse_boolstring(const char *boolstr)
383 {
384         if (!boolstr)
385                 return FALSE;
386
387         if (!g_ascii_strncasecmp(boolstr, "true", 4) ||
388             !g_ascii_strncasecmp(boolstr, "yes", 3) ||
389             !g_ascii_strncasecmp(boolstr, "on", 2) ||
390             !g_ascii_strncasecmp(boolstr, "1", 1))
391                 return TRUE;
392
393         return FALSE;
394 }
395
396 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
397 {
398         char *s;
399
400         *p = strtoull(periodstr, &s, 10);
401         if (*p == 0 && s == periodstr)
402                 /* No digits found. */
403                 return SR_ERR_ARG;
404
405         if (s && *s) {
406                 while (*s == ' ')
407                         s++;
408                 if (!strcmp(s, "fs"))
409                         *q = 1000000000000000ULL;
410                 else if (!strcmp(s, "ps"))
411                         *q = 1000000000000ULL;
412                 else if (!strcmp(s, "ns"))
413                         *q = 1000000000ULL;
414                 else if (!strcmp(s, "us"))
415                         *q = 1000000;
416                 else if (!strcmp(s, "ms"))
417                         *q = 1000;
418                 else if (!strcmp(s, "s"))
419                         *q = 1;
420                 else
421                         /* Must have a time suffix. */
422                         return SR_ERR_ARG;
423         }
424
425         return SR_OK;
426 }
427
428
429 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q)
430 {
431         char *s;
432
433         *p = strtoull(voltstr, &s, 10);
434         if (*p == 0 && s == voltstr)
435                 /* No digits found. */
436                 return SR_ERR_ARG;
437
438         if (s && *s) {
439                 while (*s == ' ')
440                         s++;
441                 if (!strcasecmp(s, "mv"))
442                         *q = 1000L;
443                 else if (!strcasecmp(s, "v"))
444                         *q = 1;
445                 else
446                         /* Must have a base suffix. */
447                         return SR_ERR_ARG;
448         }
449
450         return SR_OK;
451 }
452
453 /** @} */