/*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
*
* Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
*
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
-#include <sigrok.h>
+#include <errno.h>
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
+
+/** @cond PRIVATE */
+#define LOG_PREFIX "strutil"
+/** @endcond */
/**
- * Convert a numeric samplerate value to its "natural" string representation.
+ * @file
*
- * E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz".
+ * Helper functions for handling or converting libsigrok-related strings.
+ */
+
+/**
+ * @defgroup grp_strutil String utilities
*
- * @param samplerate The samplerate in Hz.
- * @return A malloc()ed string representation of the samplerate value,
- * or NULL upon errors. The caller is responsible to free() the memory.
+ * Helper functions for handling or converting libsigrok-related strings.
+ *
+ * @{
+ */
+
+/**
+ * @private
+ *
+ * Convert a string representation of a numeric value (base 10) to a long integer. The
+ * conversion is strict and will fail if the complete string does not represent
+ * a valid long integer. The function sets errno according to the details of the
+ * failure.
+ *
+ * @param str The string representation to convert.
+ * @param ret Pointer to long where the result of the conversion will be stored.
+ *
+ * @retval SR_OK Conversion successful.
+ * @retval SR_ERR Failure.
+ *
+ * @since 0.3.0
*/
-char *sr_samplerate_string(uint64_t samplerate)
+SR_PRIV int sr_atol(const char *str, long *ret)
{
- char *o;
- int r;
+ long tmp;
+ char *endptr = NULL;
- o = malloc(30 + 1); /* Enough for a uint64_t as string + " GHz". */
- if (!o)
- return NULL;
+ errno = 0;
+ tmp = strtol(str, &endptr, 10);
- if (samplerate >= GHZ(1))
- r = snprintf(o, 30, "%" PRIu64 " GHz", samplerate / 1000000000);
- else if (samplerate >= MHZ(1))
- r = snprintf(o, 30, "%" PRIu64 " MHz", samplerate / 1000000);
- else if (samplerate >= KHZ(1))
- r = snprintf(o, 30, "%" PRIu64 " kHz", samplerate / 1000);
- else
- r = snprintf(o, 30, "%" PRIu64 " Hz", samplerate);
+ if (!endptr || *endptr || errno) {
+ if (!errno)
+ errno = EINVAL;
+ return SR_ERR;
+ }
- if (r < 0) {
- /* Something went wrong... */
- free(o);
- return NULL;
+ *ret = tmp;
+ return SR_OK;
+}
+
+/**
+ * @private
+ *
+ * Convert a string representation of a numeric value (base 10) to an integer. The
+ * conversion is strict and will fail if the complete string does not represent
+ * a valid integer. The function sets errno according to the details of the
+ * failure.
+ *
+ * @param str The string representation to convert.
+ * @param ret Pointer to int where the result of the conversion will be stored.
+ *
+ * @retval SR_OK Conversion successful.
+ * @retval SR_ERR Failure.
+ *
+ * @since 0.3.0
+ */
+SR_PRIV int sr_atoi(const char *str, int *ret)
+{
+ long tmp;
+
+ if (sr_atol(str, &tmp) != SR_OK)
+ return SR_ERR;
+
+ if ((int) tmp != tmp) {
+ errno = ERANGE;
+ return SR_ERR;
}
- return o;
+ *ret = (int) tmp;
+ return SR_OK;
}
/**
- * Convert a numeric samplerate value to the "natural" string representation
+ * @private
+ *
+ * Convert a string representation of a numeric value to a double. The
+ * conversion is strict and will fail if the complete string does not represent
+ * a valid double. The function sets errno according to the details of the
+ * failure.
+ *
+ * @param str The string representation to convert.
+ * @param ret Pointer to double where the result of the conversion will be stored.
+ *
+ * @retval SR_OK Conversion successful.
+ * @retval SR_ERR Failure.
+ *
+ * @since 0.3.0
+ */
+SR_PRIV int sr_atod(const char *str, double *ret)
+{
+ double tmp;
+ char *endptr = NULL;
+
+ errno = 0;
+ tmp = strtof(str, &endptr);
+
+ if (!endptr || *endptr || errno) {
+ if (!errno)
+ errno = EINVAL;
+ return SR_ERR;
+ }
+
+ *ret = tmp;
+ return SR_OK;
+}
+
+/**
+ * @private
+ *
+ * Convert a string representation of a numeric value to a float. The
+ * conversion is strict and will fail if the complete string does not represent
+ * a valid float. The function sets errno according to the details of the
+ * failure.
+ *
+ * @param str The string representation to convert.
+ * @param ret Pointer to float where the result of the conversion will be stored.
+ *
+ * @retval SR_OK Conversion successful.
+ * @retval SR_ERR Failure.
+ *
+ * @since 0.3.0
+ */
+SR_PRIV int sr_atof(const char *str, float *ret)
+{
+ double tmp;
+
+ if (sr_atod(str, &tmp) != SR_OK)
+ return SR_ERR;
+
+ if ((float) tmp != tmp) {
+ errno = ERANGE;
+ return SR_ERR;
+ }
+
+ *ret = (float) tmp;
+ return SR_OK;
+}
+
+/**
+ * @private
+ *
+ * Convert a string representation of a numeric value to a float. The
+ * conversion is strict and will fail if the complete string does not represent
+ * a valid float. The function sets errno according to the details of the
+ * failure. This version ignores the locale.
+ *
+ * @param str The string representation to convert.
+ * @param ret Pointer to float where the result of the conversion will be stored.
+ *
+ * @retval SR_OK Conversion successful.
+ * @retval SR_ERR Failure.
+ *
+ * @since 0.3.0
+ */
+SR_PRIV int sr_atof_ascii(const char *str, float *ret)
+{
+ double tmp;
+ char *endptr = NULL;
+
+ errno = 0;
+ tmp = g_ascii_strtod(str, &endptr);
+
+ if (!endptr || *endptr || errno) {
+ if (!errno)
+ errno = EINVAL;
+ return SR_ERR;
+ }
+
+ /* FIXME This fails unexpectedly. Some other method to safel downcast
+ * needs to be found. Checking against FLT_MAX doesn't work as well. */
+ /*
+ if ((float) tmp != tmp) {
+ errno = ERANGE;
+ sr_dbg("ERANGEEEE %e != %e", (float) tmp, tmp);
+ return SR_ERR;
+ }
+ */
+
+ *ret = (float) tmp;
+ return SR_OK;
+}
+
+/**
+ * Convert a numeric value value to its "natural" string representation
+ * in SI units.
+ *
+ * E.g. a value of 3000000, with units set to "W", would be converted
+ * to "3 MW", 20000 to "20 kW", 31500 would become "31.5 kW".
+ *
+ * @param x The value to convert.
+ * @param unit The unit to append to the string, or NULL if the string
+ * has no units.
+ *
+ * @return A g_try_malloc()ed string representation of the samplerate value,
+ * or NULL upon errors. The caller is responsible to g_free() the
+ * memory.
+ *
+ * @since 0.2.0
+ */
+SR_API char *sr_si_string_u64(uint64_t x, const char *unit)
+{
+ uint8_t i;
+ uint64_t quot, divisor[] = {
+ SR_HZ(1), SR_KHZ(1), SR_MHZ(1), SR_GHZ(1),
+ SR_GHZ(1000), SR_GHZ(1000 * 1000), SR_GHZ(1000 * 1000 * 1000),
+ };
+ const char *p, prefix[] = "\0kMGTPE";
+ char fmt[16], fract[20] = "", *f;
+
+ if (unit == NULL)
+ unit = "";
+
+ for (i = 0; (quot = x / divisor[i]) >= 1000; i++);
+
+ if (i) {
+ sprintf(fmt, ".%%0%d"PRIu64, i * 3);
+ f = fract + sprintf(fract, fmt, x % divisor[i]) - 1;
+
+ while (f >= fract && strchr("0.", *f))
+ *f-- = 0;
+ }
+
+ p = prefix + i;
+
+ return g_strdup_printf("%" PRIu64 "%s %.1s%s", quot, fract, p, unit);
+}
+
+/**
+ * Convert a numeric samplerate value to its "natural" string representation.
+ *
+ * E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz",
+ * 31500 would become "31.5 kHz".
+ *
+ * @param samplerate The samplerate in Hz.
+ *
+ * @return A g_try_malloc()ed string representation of the samplerate value,
+ * or NULL upon errors. The caller is responsible to g_free() the
+ * memory.
+ *
+ * @since 0.1.0
+ */
+SR_API char *sr_samplerate_string(uint64_t samplerate)
+{
+ return sr_si_string_u64(samplerate, "Hz");
+}
+
+/**
+ * Convert a numeric frequency value to the "natural" string representation
* of its period.
*
* E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms".
*
* @param frequency The frequency in Hz.
- * @return A malloc()ed string representation of the frequency value,
- * or NULL upon errors. The caller is responsible to free() the memory.
+ *
+ * @return A g_try_malloc()ed string representation of the frequency value,
+ * or NULL upon errors. The caller is responsible to g_free() the
+ * memory.
+ *
+ * @since 0.1.0
*/
-char *sr_period_string(uint64_t frequency)
+SR_API char *sr_period_string(uint64_t frequency)
{
char *o;
int r;
- o = malloc(30 + 1); /* Enough for a uint64_t as string + " ms". */
- if (!o)
+ /* Allocate enough for a uint64_t as string + " ms". */
+ if (!(o = g_try_malloc0(30 + 1))) {
+ sr_err("%s: o malloc failed", __func__);
return NULL;
+ }
- if (frequency >= GHZ(1))
+ if (frequency >= SR_GHZ(1))
r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000);
- else if (frequency >= MHZ(1))
+ else if (frequency >= SR_MHZ(1))
r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000);
- else if (frequency >= KHZ(1))
+ else if (frequency >= SR_KHZ(1))
r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000);
else
r = snprintf(o, 30, "%" PRIu64 " s", frequency);
if (r < 0) {
/* Something went wrong... */
- free(o);
+ g_free(o);
return NULL;
}
return o;
}
-char **sr_parse_triggerstring(struct sr_device *device, const char *triggerstring)
+/**
+ * Convert a numeric voltage value to the "natural" string representation
+ * of its voltage value. The voltage is specified as a rational number's
+ * numerator and denominator.
+ *
+ * E.g. a value of 300000 would be converted to "300mV", 2 to "2V".
+ *
+ * @param v_p The voltage numerator.
+ * @param v_q The voltage denominator.
+ *
+ * @return A g_try_malloc()ed string representation of the voltage value,
+ * or NULL upon errors. The caller is responsible to g_free() the
+ * memory.
+ *
+ * @since 0.2.0
+ */
+SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q)
{
- GSList *l;
- struct sr_probe *probe;
- int max_probes, probenum, i;
- char **tokens, **triggerlist, *trigger, *tc, *trigger_types;
- gboolean error;
-
- max_probes = g_slist_length(device->probes);
- error = FALSE;
- triggerlist = g_malloc0(max_probes * sizeof(char *));
- tokens = g_strsplit(triggerstring, ",", max_probes);
- trigger_types = device->plugin->get_device_info(0, SR_DI_TRIGGER_TYPES);
- if (trigger_types == NULL)
- return NULL;
+ int r;
+ char *o;
- for (i = 0; tokens[i]; i++) {
- if (tokens[i][0] < '0' || tokens[i][0] > '9') {
- /* Named probe */
- probenum = 0;
- for (l = device->probes; l; l = l->next) {
- probe = (struct sr_probe *)l->data;
- if (probe->enabled
- && !strncmp(probe->name, tokens[i],
- strlen(probe->name))) {
- probenum = probe->index;
- break;
- }
- }
- } else {
- probenum = strtol(tokens[i], NULL, 10);
- }
+ if (!(o = g_try_malloc0(30 + 1))) {
+ sr_err("%s: o malloc failed", __func__);
+ return NULL;
+ }
- if (probenum < 1 || probenum > max_probes) {
- printf("Invalid probe.\n");
- error = TRUE;
- break;
- }
+ if (v_q == 1000)
+ r = snprintf(o, 30, "%" PRIu64 "mV", v_p);
+ else if (v_q == 1)
+ r = snprintf(o, 30, "%" PRIu64 "V", v_p);
+ else
+ r = snprintf(o, 30, "%gV", (float)v_p / (float)v_q);
- if ((trigger = strchr(tokens[i], '='))) {
- for (tc = ++trigger; *tc; tc++) {
- if (strchr(trigger_types, *tc) == NULL) {
- printf("Unsupported trigger type "
- "'%c'\n", *tc);
- error = TRUE;
- break;
- }
- }
- if (!error)
- triggerlist[probenum - 1] = g_strdup(trigger);
- }
- }
- g_strfreev(tokens);
-
- if (error) {
- for (i = 0; i < max_probes; i++)
- if (triggerlist[i])
- g_free(triggerlist[i]);
- g_free(triggerlist);
- triggerlist = NULL;
+ if (r < 0) {
+ /* Something went wrong... */
+ g_free(o);
+ return NULL;
}
- return triggerlist;
+ return o;
}
-uint64_t sr_parse_sizestring(const char *sizestring)
+/**
+ * Convert a "natural" string representation of a size value to uint64_t.
+ *
+ * E.g. a value of "3k" or "3 K" would be converted to 3000, a value
+ * of "15M" would be converted to 15000000.
+ *
+ * Value representations other than decimal (such as hex or octal) are not
+ * supported. Only 'k' (kilo), 'm' (mega), 'g' (giga) suffixes are supported.
+ * Spaces (but not other whitespace) between value and suffix are allowed.
+ *
+ * @param sizestring A string containing a (decimal) size value.
+ * @param size Pointer to uint64_t which will contain the string's size value.
+ *
+ * @return SR_OK upon success, SR_ERR upon errors.
+ *
+ * @since 0.1.0
+ */
+SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
{
- int multiplier;
- uint64_t val;
+ int multiplier, done;
+ double frac_part;
char *s;
- val = strtoull(sizestring, &s, 10);
+ *size = strtoull(sizestring, &s, 10);
multiplier = 0;
- while (s && *s && multiplier == 0) {
+ frac_part = 0;
+ done = FALSE;
+ while (s && *s && multiplier == 0 && !done) {
switch (*s) {
case ' ':
break;
+ case '.':
+ frac_part = g_ascii_strtod(s, &s);
+ break;
case 'k':
case 'K':
- multiplier = KHZ(1);
+ multiplier = SR_KHZ(1);
break;
case 'm':
case 'M':
- multiplier = MHZ(1);
+ multiplier = SR_MHZ(1);
break;
case 'g':
case 'G':
- multiplier = GHZ(1);
+ multiplier = SR_GHZ(1);
break;
default:
- val = 0;
- multiplier = -1;
+ done = TRUE;
+ s--;
}
s++;
}
- if (multiplier > 0)
- val *= multiplier;
+ if (multiplier > 0) {
+ *size *= multiplier;
+ *size += frac_part * multiplier;
+ } else
+ *size += frac_part;
+
+ if (*s && strcasecmp(s, "Hz"))
+ return SR_ERR;
- return val;
+ return SR_OK;
}
-uint64_t sr_parse_timestring(const char *timestring)
+/**
+ * Convert a "natural" string representation of a time value to an
+ * uint64_t value in milliseconds.
+ *
+ * E.g. a value of "3s" or "3 s" would be converted to 3000, a value
+ * of "15ms" would be converted to 15.
+ *
+ * Value representations other than decimal (such as hex or octal) are not
+ * supported. Only lower-case "s" and "ms" time suffixes are supported.
+ * Spaces (but not other whitespace) between value and suffix are allowed.
+ *
+ * @param timestring A string containing a (decimal) time value.
+ * @return The string's time value as uint64_t, in milliseconds.
+ *
+ * @todo Add support for "m" (minutes) and others.
+ * @todo Add support for picoseconds?
+ * @todo Allow both lower-case and upper-case? If no, document it.
+ *
+ * @since 0.1.0
+ */
+SR_API uint64_t sr_parse_timestring(const char *timestring)
{
uint64_t time_msec;
char *s;
+ /* TODO: Error handling, logging. */
+
time_msec = strtoull(timestring, &s, 10);
if (time_msec == 0 && s == timestring)
return 0;
return time_msec;
}
+/** @since 0.1.0 */
+SR_API gboolean sr_parse_boolstring(const char *boolstr)
+{
+ if (!boolstr)
+ return FALSE;
+
+ if (!g_ascii_strncasecmp(boolstr, "true", 4) ||
+ !g_ascii_strncasecmp(boolstr, "yes", 3) ||
+ !g_ascii_strncasecmp(boolstr, "on", 2) ||
+ !g_ascii_strncasecmp(boolstr, "1", 1))
+ return TRUE;
+
+ return FALSE;
+}
+
+/** @since 0.2.0 */
+SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
+{
+ char *s;
+
+ *p = strtoull(periodstr, &s, 10);
+ if (*p == 0 && s == periodstr)
+ /* No digits found. */
+ return SR_ERR_ARG;
+
+ if (s && *s) {
+ while (*s == ' ')
+ s++;
+ if (!strcmp(s, "fs"))
+ *q = 1000000000000000ULL;
+ else if (!strcmp(s, "ps"))
+ *q = 1000000000000ULL;
+ else if (!strcmp(s, "ns"))
+ *q = 1000000000ULL;
+ else if (!strcmp(s, "us"))
+ *q = 1000000;
+ else if (!strcmp(s, "ms"))
+ *q = 1000;
+ else if (!strcmp(s, "s"))
+ *q = 1;
+ else
+ /* Must have a time suffix. */
+ return SR_ERR_ARG;
+ }
+
+ return SR_OK;
+}
+
+/** @since 0.2.0 */
+SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q)
+{
+ char *s;
+
+ *p = strtoull(voltstr, &s, 10);
+ if (*p == 0 && s == voltstr)
+ /* No digits found. */
+ return SR_ERR_ARG;
+
+ if (s && *s) {
+ while (*s == ' ')
+ s++;
+ if (!strcasecmp(s, "mv"))
+ *q = 1000L;
+ else if (!strcasecmp(s, "v"))
+ *q = 1;
+ else
+ /* Must have a base suffix. */
+ return SR_ERR_ARG;
+ }
+
+ return SR_OK;
+}
+
+/** @} */
projects / libsigrok.git / blobdiff