]> sigrok.org Git - libsigrok.git/blobdiff - src/strutil.c
drivers: Fix locale dependent string to float conversion
[libsigrok.git] / src / strutil.c
index d817e642d8f1cb9dfb44292c9ea0d8acf11f73af..30e992b815468e5a86c1210652b3a19aece2720b 100644 (file)
@@ -14,8 +14,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #include <config.h>
@@ -24,6 +23,7 @@
 #include <string.h>
 #include <strings.h>
 #include <errno.h>
+#include <stdbool.h>
 #include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
@@ -169,6 +169,38 @@ SR_PRIV int sr_atof(const char *str, float *ret)
        return SR_OK;
 }
 
+/**
+ * @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. This version ignores the locale.
+ *
+ * @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.
+ */
+SR_PRIV int sr_atod_ascii(const char *str, double *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;
+       }
+
+       *ret = tmp;
+       return SR_OK;
+}
+
 /**
  * @private
  *
@@ -211,6 +243,84 @@ SR_PRIV int sr_atof_ascii(const char *str, float *ret)
        return SR_OK;
 }
 
+/**
+ * Convert a string representation of a numeric value to a sr_rational.
+ *
+ * The conversion is strict and will fail if the complete string does not
+ * represent a valid number. 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 sr_rational where the result of the conversion will be stored.
+ *
+ * @retval SR_OK Conversion successful.
+ * @retval SR_ERR Failure.
+ *
+ * @since 0.5.0
+ */
+SR_API int sr_parse_rational(const char *str, struct sr_rational *ret)
+{
+       char *endptr = NULL;
+       int64_t integral;
+       int64_t fractional = 0;
+       int64_t denominator = 1;
+       int32_t fractional_len = 0;
+       int32_t exponent = 0;
+       bool is_negative = false;
+
+       errno = 0;
+       integral = g_ascii_strtoll(str, &endptr, 10);
+
+       if (str == endptr && (str[0] == '-' || str[0] == '+') && str[1] == '.')
+               endptr += 1;
+       else if (errno)
+               return SR_ERR;
+
+       if (integral < 0 || str[0] == '-')
+               is_negative = true;
+
+       if (*endptr == '.') {
+               const char* start = endptr + 1;
+               fractional = g_ascii_strtoll(start, &endptr, 10);
+               if (errno)
+                       return SR_ERR;
+               fractional_len = endptr - start;
+       }
+
+       if ((*endptr == 'E') || (*endptr == 'e')) {
+               exponent = g_ascii_strtoll(endptr + 1, &endptr, 10);
+               if (errno)
+                       return SR_ERR;
+       }
+
+       if (*endptr != '\0')
+               return SR_ERR;
+
+       for (int i = 0; i < fractional_len; i++)
+               integral *= 10;
+       exponent -= fractional_len;
+
+       if (!is_negative)
+               integral += fractional;
+       else
+               integral -= fractional;
+
+       while (exponent > 0) {
+               integral *= 10;
+               exponent--;
+       }
+
+       while (exponent < 0) {
+               denominator *= 10;
+               exponent++;
+       }
+
+       ret->p = integral;
+       ret->q = denominator;
+
+       return SR_OK;
+}
+
 /**
  * Convert a numeric value value to its "natural" string representation
  * in SI units.
@@ -276,43 +386,50 @@ SR_API char *sr_samplerate_string(uint64_t samplerate)
 }
 
 /**
- * Convert a numeric frequency value to the "natural" string representation
- * of its period.
+ * Convert a numeric period value to the "natural" string representation
+ * of its period value.
+ *
+ * The period is specified as a rational number's numerator and denominator.
  *
- * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms".
+ * E.g. a pair of (1, 5) would be converted to "200 ms", (10, 100) to "100 ms".
  *
- * @param frequency The frequency in Hz.
+ * @param v_p The period numerator.
+ * @param v_q The period denominator.
  *
- * @return A newly allocated string representation of the frequency value,
+ * @return A newly allocated string representation of the period value,
  *         or NULL upon errors. The caller is responsible to g_free() the
  *         memory.
  *
- * @since 0.1.0
+ * @since 0.5.0
  */
-SR_API char *sr_period_string(uint64_t frequency)
+SR_API char *sr_period_string(uint64_t v_p, uint64_t v_q)
 {
-       char *o;
-       int r;
-
-       /* Allocate enough for a uint64_t as string + " ms". */
-       o = g_malloc0(30 + 1);
-
-       if (frequency >= SR_GHZ(1))
-               r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000);
-       else if (frequency >= SR_MHZ(1))
-               r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000);
-       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... */
-               g_free(o);
-               return NULL;
+       double freq, v;
+       int prec;
+
+       freq = 1 / ((double)v_p / v_q);
+
+       if (freq > SR_GHZ(1)) {
+               v = (double)v_p / v_q * 1000000000000.0;
+               prec = ((v - (uint64_t)v) < FLT_MIN) ? 0 : 3;
+               return g_strdup_printf("%.*f ps", prec, v);
+       } else if (freq > SR_MHZ(1)) {
+               v = (double)v_p / v_q * 1000000000.0;
+               prec = ((v - (uint64_t)v) < FLT_MIN) ? 0 : 3;
+               return g_strdup_printf("%.*f ns", prec, v);
+       } else if (freq > SR_KHZ(1)) {
+               v = (double)v_p / v_q * 1000000.0;
+               prec = ((v - (uint64_t)v) < FLT_MIN) ? 0 : 3;
+               return g_strdup_printf("%.*f us", prec, v);
+       } else if (freq > 1) {
+               v = (double)v_p / v_q * 1000.0;
+               prec = ((v - (uint64_t)v) < FLT_MIN) ? 0 : 3;
+               return g_strdup_printf("%.*f ms", prec, v);
+       } else {
+               v = (double)v_p / v_q;
+               prec = ((v - (uint64_t)v) < FLT_MIN) ? 0 : 3;
+               return g_strdup_printf("%.*f s", prec, v);
        }
-
-       return o;
 }
 
 /**
@@ -333,25 +450,12 @@ SR_API char *sr_period_string(uint64_t frequency)
  */
 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q)
 {
-       int r;
-       char *o;
-
-       o = g_malloc0(30 + 1);
-
        if (v_q == 1000)
-               r = snprintf(o, 30, "%" PRIu64 "mV", v_p);
+               return g_strdup_printf("%" PRIu64 " mV", v_p);
        else if (v_q == 1)
-               r = snprintf(o, 30, "%" PRIu64 "V", v_p);
+               return g_strdup_printf("%" PRIu64 " V", v_p);
        else
-               r = snprintf(o, 30, "%gV", (float)v_p / (float)v_q);
-
-       if (r < 0) {
-               /* Something went wrong... */
-               g_free(o);
-               return NULL;
-       }
-
-       return o;
+               return g_strdup_printf("%g V", (float)v_p / (float)v_q);
 }
 
 /**
@@ -466,8 +570,13 @@ SR_API uint64_t sr_parse_timestring(const char *timestring)
 /** @since 0.1.0 */
 SR_API gboolean sr_parse_boolstring(const char *boolstr)
 {
-       if (!boolstr)
-               return FALSE;
+       /*
+        * Complete absence of an input spec is assumed to mean TRUE,
+        * as in command line option strings like this:
+        *   ...:samplerate=100k:header:numchannels=4:...
+        */
+       if (!boolstr || !*boolstr)
+               return TRUE;
 
        if (!g_ascii_strncasecmp(boolstr, "true", 4) ||
            !g_ascii_strncasecmp(boolstr, "yes", 3) ||