]> sigrok.org Git - libsigrok.git/blobdiff - strutil.c
strutil: Add helper functions: string to number.
[libsigrok.git] / strutil.c
index 5c547aa9ecf408f25787b3b7c2a339152fabee79..6c6538446eb84e4090beb05dcf2402c77908ac42 100644 (file)
--- a/strutil.c
+++ b/strutil.c
 #include <stdint.h>
 #include <stdlib.h>
 #include <string.h>
+#include <errno.h>
 #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)
+/* Message logging helpers with subsystem-specific prefix string. */
+#define LOG_PREFIX "strutil: "
+#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
+#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
+#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
+#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
+#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
+#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
 
 /**
  * @file
  */
 
 /**
- * Convert a numeric value value to its "natural" string representation.
- * in SI units
+ * Convert a string representation of a numeric value 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.
+ *
+ * @return SR_OK if conversion is successful, otherwise SR_ERR.
+ *
+ * @since 0.3.0
+ */
+SR_API int sr_atol(const char *str, long *ret)
+{
+       long tmp;
+       char *endptr = NULL;
+
+       errno = 0;
+       tmp = strtol(str, &endptr, 0);
+
+       if (!endptr || *endptr || errno) {
+               if (!errno)
+                       errno = EINVAL;
+               return SR_ERR;
+       }
+
+       *ret = tmp;
+       return SR_OK;
+}
+
+/**
+ * Convert a string representation of a numeric value 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.
+ *
+ * @return SR_OK if conversion is successful, otherwise SR_ERR.
+ *
+ * @since 0.3.0
+ */
+SR_API 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;
+       }
+
+       *ret = (int) tmp;
+       return SR_OK;
+}
+
+/**
+ * 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.
+ *
+ * @return SR_OK if conversion is successful, otherwise SR_ERR.
+ *
+ * @since 0.3.0
+ */
+SR_API 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;
+}
+
+/**
+ * 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.
+ *
+ * @return SR_OK if conversion is successful, otherwise SR_ERR.
+ *
+ * @since 0.3.0
+ */
+SR_API 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;
+}
+
+/**
+ * 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".
  */
 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[8], fract[20] = "", *f;
+
        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);
+       for (i = 0; (quot = x / divisor[i]) >= 1000; i++);
+
+       if (i) {
+               sprintf(fmt, ".%%0%dlu", i * 3);
+               f = fract + sprintf(fract, fmt, x % divisor[i]) - 1;
+
+               while (f >= fract && strchr("0.", *f))
+                       *f-- = 0;
        }
 
-       sr_err("%s: Error creating SI units string.", __func__);
-       return NULL;
+       p = prefix + i;
+
+       return g_strdup_printf("%" PRIu64 "%s %.1s%s", quot, fract, p, unit);
 }
 
 /**
@@ -232,7 +351,8 @@ SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
                return NULL;
        }
 
-       if (sdi->driver->config_list(SR_CONF_TRIGGER_TYPE, &gvar, sdi) != SR_OK) {
+       if (sdi->driver->config_list(SR_CONF_TRIGGER_TYPE,
+                               &gvar, sdi, NULL) != SR_OK) {
                sr_err("%s: Device doesn't support any triggers.", __func__);
                return NULL;
        }