README.devices: add JTAGulator section for Logic Analyzer mode

[libsigrok.git] / src / strutil.c

diff --git a/src/strutil.c b/src/strutil.c
index 56ccaa095bb62898fdc5ac56102ad9b1b7880388..0dff3c4b48c0bf8df4014f73bddde9dd279644c3 100644 (file)
--- a/src/strutil.c
+++ b/src/strutil.c
@@ -91,6 +91,60 @@ SR_PRIV int sr_atol(const char *str, long *ret)
        return SR_OK;
 }
 
+/**
+ * Convert a text to a number including support for non-decimal bases.
+ * Also optionally returns the position after the number, where callers
+ * can either error out, or support application specific suffixes.
+ *
+ * @param[in] str The input text to convert.
+ * @param[out] ret The conversion result.
+ * @param[out] end The position after the number.
+ * @param[in] base The number format's base, can be 0.
+ *
+ * @retval SR_OK Conversion successful.
+ * @retval SR_ERR Conversion failed.
+ *
+ * @private
+ *
+ * This routine is more general than @ref sr_atol(), which strictly
+ * expects the input text to contain just a decimal number, and nothing
+ * else in addition. The @ref sr_atol_base() routine accepts trailing
+ * text after the number, and supports non-decimal numbers (bin, hex),
+ * including automatic detection from prefix text.
+ */
+SR_PRIV int sr_atol_base(const char *str, long *ret, char **end, int base)
+{
+       long num;
+       char *endptr;
+
+       /* Add "0b" prefix support which strtol(3) may be missing. */
+       while (str && isspace(*str))
+               str++;
+       if (!base && strncmp(str, "0b", strlen("0b")) == 0) {
+               str += strlen("0b");
+               base = 2;
+       }
+
+       /* Run the number conversion. Quick bail out if that fails. */
+       errno = 0;
+       endptr = NULL;
+       num = strtol(str, &endptr, base);
+       if (!endptr || errno) {
+               if (!errno)
+                       errno = EINVAL;
+               return SR_ERR;
+       }
+       *ret = num;
+
+       /* Advance to optional non-space trailing suffix. */
+       while (endptr && isspace(*endptr))
+               endptr++;
+       if (end)
+               *end = endptr;
+
+       return SR_OK;
+}
+
 /**
  * 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
@@ -595,12 +649,12 @@ SR_API int sr_vsnprintf_ascii(char *buf, size_t buf_size,
 /**
  * Convert a sequence of bytes to its textual representation ("hex dump").
  *
- * Callers should free the allocated GString. See @ref sr_hexdump_free().
+ * Callers should free the allocated GString. See sr_hexdump_free().
  *
  * @param[in] data Pointer to the byte sequence to print.
  * @param[in] len Number of bytes to print.
  *
- * @return #NULL upon error, newly allocated GString pointer otherwise.
+ * @return NULL upon error, newly allocated GString pointer otherwise.
  *
  * @private
  */
@@ -620,7 +674,7 @@ SR_PRIV GString *sr_hexdump_new(const uint8_t *data, const size_t len)
 }
 
 /**
- * Free a hex dump text that was created by @ref sr_hexdump_new().
+ * Free a hex dump text that was created by sr_hexdump_new().
  *
  * @param[in] s Pointer to the GString to release.
  *