#include "libsigrok.h"
#include "libsigrok-internal.h"
+/* Message logging helpers with driver-specific prefix string. */
+#define DRIVER_LOG_DOMAIN "strutil: "
+#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
+#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+
+/**
+ * @file
+ *
+ * Helper functions for handling or converting libsigrok-related strings.
+ */
+
+/**
+ * @defgroup grp_strutil String utilities
+ *
+ * Helper functions for handling or converting libsigrok-related strings.
+ *
+ * @{
+ */
+
+/**
+ * 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.
+ */
+SR_API char *sr_si_string_u64(uint64_t x, const char *unit)
+{
+ if (unit == NULL)
+ unit = "";
+
+ if ((x >= SR_GHZ(1)) && (x % SR_GHZ(1) == 0)) {
+ return g_strdup_printf("%" PRIu64 " G%s", x / SR_GHZ(1), unit);
+ } else if ((x >= SR_GHZ(1)) && (x % SR_GHZ(1) != 0)) {
+ return g_strdup_printf("%" PRIu64 ".%" PRIu64 " G%s",
+ x / SR_GHZ(1), x % SR_GHZ(1), unit);
+ } else if ((x >= SR_MHZ(1)) && (x % SR_MHZ(1) == 0)) {
+ return g_strdup_printf("%" PRIu64 " M%s",
+ x / SR_MHZ(1), unit);
+ } else if ((x >= SR_MHZ(1)) && (x % SR_MHZ(1) != 0)) {
+ return g_strdup_printf("%" PRIu64 ".%" PRIu64 " M%s",
+ x / SR_MHZ(1), x % SR_MHZ(1), unit);
+ } else if ((x >= SR_KHZ(1)) && (x % SR_KHZ(1) == 0)) {
+ return g_strdup_printf("%" PRIu64 " k%s",
+ x / SR_KHZ(1), unit);
+ } else if ((x >= SR_KHZ(1)) && (x % SR_KHZ(1) != 0)) {
+ return g_strdup_printf("%" PRIu64 ".%" PRIu64 " k%s",
+ x / SR_KHZ(1), x % SR_KHZ(1), unit);
+ } else {
+ return g_strdup_printf("%" PRIu64 " %s", x, unit);
+ }
+
+ sr_err("%s: Error creating SI units string.", __func__);
+ return NULL;
+}
+
/**
* Convert a numeric samplerate value to its "natural" string representation.
*
*/
SR_API char *sr_samplerate_string(uint64_t samplerate)
{
- char *o;
- uint64_t s = samplerate;
-
- if ((s >= SR_GHZ(1)) && (s % SR_GHZ(1) == 0)) {
- o = g_strdup_printf("%" PRIu64 " GHz", s / SR_GHZ(1));
- } else if ((s >= SR_GHZ(1)) && (s % SR_GHZ(1) != 0)) {
- o = g_strdup_printf("%" PRIu64 ".%" PRIu64 " GHz",
- s / SR_GHZ(1), s % SR_GHZ(1));
- } else if ((s >= SR_MHZ(1)) && (s % SR_MHZ(1) == 0)) {
- o = g_strdup_printf("%" PRIu64 " MHz", s / SR_MHZ(1));
- } else if ((s >= SR_MHZ(1)) && (s % SR_MHZ(1) != 0)) {
- o = g_strdup_printf("%" PRIu64 ".%" PRIu64 " MHz",
- s / SR_MHZ(1), s % SR_MHZ(1));
- } else if ((s >= SR_KHZ(1)) && (s % SR_KHZ(1) == 0)) {
- o = g_strdup_printf("%" PRIu64 " kHz", s / SR_KHZ(1));
- } else if ((s >= SR_KHZ(1)) && (s % SR_KHZ(1) != 0)) {
- o = g_strdup_printf("%" PRIu64 ".%" PRIu64 " kHz",
- s / SR_KHZ(1), s % SR_KHZ(1));
- } else {
- o = g_strdup_printf("%" PRIu64 " Hz", s);
- }
-
- if (!o) {
- sr_err("strutil: %s: Error creating samplerate string.",
- __func__);
- return NULL;
- }
-
- return o;
+ return sr_si_string_u64(samplerate, "Hz");
}
/**
/* Allocate enough for a uint64_t as string + " ms". */
if (!(o = g_try_malloc0(30 + 1))) {
- sr_err("strutil: %s: o malloc failed", __func__);
+ sr_err("%s: o malloc failed", __func__);
return NULL;
}
int r;
if (!(o = g_try_malloc0(30 + 1))) {
- sr_err("strutil: %s: o malloc failed", __func__);
+ sr_err("%s: o malloc failed", __func__);
return NULL;
}
/**
* Parse a trigger specification string.
*
- * @param dev The device for which the trigger specification is intended.
+ * @param sdi The device instance for which the trigger specification is
+ * intended. Must not be NULL. Also, sdi->driver and
+ * sdi->driver->info_get must not be NULL.
* @param triggerstring The string containing the trigger specification for
* one or more probes of this device. Entries for multiple probes are
* comma-separated. Triggers are specified in the form key=value,
* contain the respective trigger type which is requested for the
* respective probe (e.g. "r", "c", and so on).
*/
-SR_API char **sr_parse_triggerstring(struct sr_dev *dev,
+SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
const char *triggerstring)
{
GSList *l;
const char *trigger_types;
gboolean error;
- max_probes = g_slist_length(dev->probes);
+ max_probes = g_slist_length(sdi->probes);
error = FALSE;
if (!(triggerlist = g_try_malloc0(max_probes * sizeof(char *)))) {
- sr_err("strutil: %s: triggerlist malloc failed", __func__);
+ sr_err("%s: triggerlist malloc failed", __func__);
return NULL;
}
- tokens = g_strsplit(triggerstring, ",", max_probes);
-
- trigger_types = dev->driver->dev_info_get(0, SR_DI_TRIGGER_TYPES);
- if (!trigger_types) {
- sr_err("strutil: %s: Device doesn't support any triggers.",
- __func__);
+ if (sdi->driver->info_get(SR_DI_TRIGGER_TYPES,
+ (const void **)&trigger_types, sdi) != SR_OK) {
+ sr_err("%s: Device doesn't support any triggers.", __func__);
return NULL;
}
+ tokens = g_strsplit(triggerstring, ",", max_probes);
for (i = 0; tokens[i]; i++) {
- if (tokens[i][0] < '0' || tokens[i][0] > '9') {
- /* Named probe */
- probenum = 0;
- for (l = dev->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;
- }
+ probenum = -1;
+ for (l = sdi->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 (probenum < 1 || probenum > max_probes) {
- sr_err("strutil: Invalid probe (%d).", probenum);
+ if (probenum < 0 || probenum >= max_probes) {
+ sr_err("Invalid probe.");
error = TRUE;
break;
}
if ((trigger = strchr(tokens[i], '='))) {
for (tc = ++trigger; *tc; tc++) {
if (strchr(trigger_types, *tc) == NULL) {
- sr_err("strutil: Unsupported trigger "
+ sr_err("Unsupported trigger "
"type '%c'.", *tc);
error = TRUE;
break;
}
}
if (!error)
- triggerlist[probenum - 1] = g_strdup(trigger);
+ triggerlist[probenum] = g_strdup(trigger);
}
}
g_strfreev(tokens);
* @param timestring A string containing a (decimal) time value.
* @return The string's time value as uint64_t, in milliseconds.
*
- * TODO: Error handling.
- * TODO: Add support for "m" (minutes) and others.
- * TODO: picoseconds?
- * TODO: Allow both lower-case and upper-case.
+ * @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.
*/
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 SR_OK;
}
-
+/** @} */
projects / libsigrok.git / blobdiff