src/strutil.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <stdint.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <strings.h>
  25 #include <errno.h>
  26 #include <libsigrok/libsigrok.h>
  27 #include "libsigrok-internal.h"
  28
  29 /** @cond PRIVATE */
  30 #define LOG_PREFIX "strutil"
  31 /** @endcond */
  32
  33 /**
  34  * @file
  35  *
  36  * Helper functions for handling or converting libsigrok-related strings.
  37  */
  38
  39 /**
  40  * @defgroup grp_strutil String utilities
  41  *
  42  * Helper functions for handling or converting libsigrok-related strings.
  43  *
  44  * @{
  45  */
  46
  47 /**
  48  * @private
  49  *
  50  * Convert a string representation of a numeric value (base 10) to a long integer. The
  51  * conversion is strict and will fail if the complete string does not represent
  52  * a valid long integer. The function sets errno according to the details of the
  53  * failure.
  54  *
  55  * @param str The string representation to convert.
  56  * @param ret Pointer to long where the result of the conversion will be stored.
  57  *
  58  * @retval SR_OK Conversion successful.
  59  * @retval SR_ERR Failure.
  60  *
  61  * @since 0.3.0
  62  */
  63 SR_PRIV int sr_atol(const char *str, long *ret)
  64 {
  65         long tmp;
  66         char *endptr = NULL;
  67
  68         errno = 0;
  69         tmp = strtol(str, &endptr, 10);
  70
  71         if (!endptr || *endptr || errno) {
  72                 if (!errno)
  73                         errno = EINVAL;
  74                 return SR_ERR;
  75         }
  76
  77         *ret = tmp;
  78         return SR_OK;
  79 }
  80
  81 /**
  82  * @private
  83  *
  84  * Convert a string representation of a numeric value (base 10) to an integer. The
  85  * conversion is strict and will fail if the complete string does not represent
  86  * a valid integer. The function sets errno according to the details of the
  87  * failure.
  88  *
  89  * @param str The string representation to convert.
  90  * @param ret Pointer to int where the result of the conversion will be stored.
  91  *
  92  * @retval SR_OK Conversion successful.
  93  * @retval SR_ERR Failure.
  94  *
  95  * @since 0.3.0
  96  */
  97 SR_PRIV int sr_atoi(const char *str, int *ret)
  98 {
  99         long tmp;
 100
 101         if (sr_atol(str, &tmp) != SR_OK)
 102                 return SR_ERR;
 103
 104         if ((int) tmp != tmp) {
 105                 errno = ERANGE;
 106                 return SR_ERR;
 107         }
 108
 109         *ret = (int) tmp;
 110         return SR_OK;
 111 }
 112
 113 /**
 114  * @private
 115  *
 116  * Convert a string representation of a numeric value to a double. The
 117  * conversion is strict and will fail if the complete string does not represent
 118  * a valid double. The function sets errno according to the details of the
 119  * failure.
 120  *
 121  * @param str The string representation to convert.
 122  * @param ret Pointer to double where the result of the conversion will be stored.
 123  *
 124  * @retval SR_OK Conversion successful.
 125  * @retval SR_ERR Failure.
 126  *
 127  * @since 0.3.0
 128  */
 129 SR_PRIV int sr_atod(const char *str, double *ret)
 130 {
 131         double tmp;
 132         char *endptr = NULL;
 133
 134         errno = 0;
 135         tmp = strtof(str, &endptr);
 136
 137         if (!endptr || *endptr || errno) {
 138                 if (!errno)
 139                         errno = EINVAL;
 140                 return SR_ERR;
 141         }
 142
 143         *ret = tmp;
 144         return SR_OK;
 145 }
 146
 147 /**
 148  * @private
 149  *
 150  * Convert a string representation of a numeric value to a float. The
 151  * conversion is strict and will fail if the complete string does not represent
 152  * a valid float. The function sets errno according to the details of the
 153  * failure.
 154  *
 155  * @param str The string representation to convert.
 156  * @param ret Pointer to float where the result of the conversion will be stored.
 157  *
 158  * @retval SR_OK Conversion successful.
 159  * @retval SR_ERR Failure.
 160  *
 161  * @since 0.3.0
 162  */
 163 SR_PRIV int sr_atof(const char *str, float *ret)
 164 {
 165         double tmp;
 166
 167         if (sr_atod(str, &tmp) != SR_OK)
 168                 return SR_ERR;
 169
 170         if ((float) tmp != tmp) {
 171                 errno = ERANGE;
 172                 return SR_ERR;
 173         }
 174
 175         *ret = (float) tmp;
 176         return SR_OK;
 177 }
 178
 179 /**
 180  * @private
 181  *
 182  * Convert a string representation of a numeric value to a float. The
 183  * conversion is strict and will fail if the complete string does not represent
 184  * a valid float. The function sets errno according to the details of the
 185  * failure. This version ignores the locale.
 186  *
 187  * @param str The string representation to convert.
 188  * @param ret Pointer to float where the result of the conversion will be stored.
 189  *
 190  * @retval SR_OK Conversion successful.
 191  * @retval SR_ERR Failure.
 192  *
 193  * @since 0.3.0
 194  */
 195 SR_PRIV int sr_atof_ascii(const char *str, float *ret)
 196 {
 197         double tmp;
 198         char *endptr = NULL;
 199
 200         errno = 0;
 201         tmp = g_ascii_strtod(str, &endptr);
 202
 203         if (!endptr || *endptr || errno) {
 204                 if (!errno)
 205                         errno = EINVAL;
 206                 return SR_ERR;
 207         }
 208
 209         /* FIXME This fails unexpectedly. Some other method to safel downcast
 210          * needs to be found. Checking against FLT_MAX doesn't work as well. */
 211         /*
 212         if ((float) tmp != tmp) {
 213                 errno = ERANGE;
 214                 sr_dbg("ERANGEEEE %e != %e", (float) tmp, tmp);
 215                 return SR_ERR;
 216         }
 217         */
 218
 219         *ret = (float) tmp;
 220         return SR_OK;
 221 }
 222
 223 /**
 224  * Convert a numeric value value to its "natural" string representation
 225  * in SI units.
 226  *
 227  * E.g. a value of 3000000, with units set to "W", would be converted
 228  * to "3 MW", 20000 to "20 kW", 31500 would become "31.5 kW".
 229  *
 230  * @param x The value to convert.
 231  * @param unit The unit to append to the string, or NULL if the string
 232  *             has no units.
 233  *
 234  * @return A newly allocated string representation of the samplerate value,
 235  *         or NULL upon errors. The caller is responsible to g_free() the
 236  *         memory.
 237  *
 238  * @since 0.2.0
 239  */
 240 SR_API char *sr_si_string_u64(uint64_t x, const char *unit)
 241 {
 242         uint8_t i;
 243         uint64_t quot, divisor[] = {
 244                 SR_HZ(1), SR_KHZ(1), SR_MHZ(1), SR_GHZ(1),
 245                 SR_GHZ(1000), SR_GHZ(1000 * 1000), SR_GHZ(1000 * 1000 * 1000),
 246         };
 247         const char *p, prefix[] = "\0kMGTPE";
 248         char fmt[16], fract[20] = "", *f;
 249
 250         if (!unit)
 251                 unit = "";
 252
 253         for (i = 0; (quot = x / divisor[i]) >= 1000; i++);
 254
 255         if (i) {
 256                 sprintf(fmt, ".%%0%d"PRIu64, i * 3);
 257                 f = fract + sprintf(fract, fmt, x % divisor[i]) - 1;
 258
 259                 while (f >= fract && strchr("0.", *f))
 260                         *f-- = 0;
 261         }
 262
 263         p = prefix + i;
 264
 265         return g_strdup_printf("%" PRIu64 "%s %.1s%s", quot, fract, p, unit);
 266 }
 267
 268 /**
 269  * Convert a numeric samplerate value to its "natural" string representation.
 270  *
 271  * E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz",
 272  * 31500 would become "31.5 kHz".
 273  *
 274  * @param samplerate The samplerate in Hz.
 275  *
 276  * @return A newly allocated string representation of the samplerate value,
 277  *         or NULL upon errors. The caller is responsible to g_free() the
 278  *         memory.
 279  *
 280  * @since 0.1.0
 281  */
 282 SR_API char *sr_samplerate_string(uint64_t samplerate)
 283 {
 284         return sr_si_string_u64(samplerate, "Hz");
 285 }
 286
 287 /**
 288  * Convert a numeric frequency value to the "natural" string representation
 289  * of its period.
 290  *
 291  * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms".
 292  *
 293  * @param frequency The frequency in Hz.
 294  *
 295  * @return A newly allocated string representation of the frequency value,
 296  *         or NULL upon errors. The caller is responsible to g_free() the
 297  *         memory.
 298  *
 299  * @since 0.1.0
 300  */
 301 SR_API char *sr_period_string(uint64_t frequency)
 302 {
 303         char *o;
 304         int r;
 305
 306         /* Allocate enough for a uint64_t as string + " ms". */
 307         o = g_malloc0(30 + 1);
 308
 309         if (frequency >= SR_GHZ(1))
 310                 r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000);
 311         else if (frequency >= SR_MHZ(1))
 312                 r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000);
 313         else if (frequency >= SR_KHZ(1))
 314                 r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000);
 315         else
 316                 r = snprintf(o, 30, "%" PRIu64 " s", frequency);
 317
 318         if (r < 0) {
 319                 /* Something went wrong... */
 320                 g_free(o);
 321                 return NULL;
 322         }
 323
 324         return o;
 325 }
 326
 327 /**
 328  * Convert a numeric voltage value to the "natural" string representation
 329  * of its voltage value. The voltage is specified as a rational number's
 330  * numerator and denominator.
 331  *
 332  * E.g. a value of 300000 would be converted to "300mV", 2 to "2V".
 333  *
 334  * @param v_p The voltage numerator.
 335  * @param v_q The voltage denominator.
 336  *
 337  * @return A newly allocated string representation of the voltage value,
 338  *         or NULL upon errors. The caller is responsible to g_free() the
 339  *         memory.
 340  *
 341  * @since 0.2.0
 342  */
 343 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q)
 344 {
 345         int r;
 346         char *o;
 347
 348         o = g_malloc0(30 + 1);
 349
 350         if (v_q == 1000)
 351                 r = snprintf(o, 30, "%" PRIu64 "mV", v_p);
 352         else if (v_q == 1)
 353                 r = snprintf(o, 30, "%" PRIu64 "V", v_p);
 354         else
 355                 r = snprintf(o, 30, "%gV", (float)v_p / (float)v_q);
 356
 357         if (r < 0) {
 358                 /* Something went wrong... */
 359                 g_free(o);
 360                 return NULL;
 361         }
 362
 363         return o;
 364 }
 365
 366 /**
 367  * Convert a "natural" string representation of a size value to uint64_t.
 368  *
 369  * E.g. a value of "3k" or "3 K" would be converted to 3000, a value
 370  * of "15M" would be converted to 15000000.
 371  *
 372  * Value representations other than decimal (such as hex or octal) are not
 373  * supported. Only 'k' (kilo), 'm' (mega), 'g' (giga) suffixes are supported.
 374  * Spaces (but not other whitespace) between value and suffix are allowed.
 375  *
 376  * @param sizestring A string containing a (decimal) size value.
 377  * @param size Pointer to uint64_t which will contain the string's size value.
 378  *
 379  * @return SR_OK upon success, SR_ERR upon errors.
 380  *
 381  * @since 0.1.0
 382  */
 383 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
 384 {
 385         int multiplier, done;
 386         double frac_part;
 387         char *s;
 388
 389         *size = strtoull(sizestring, &s, 10);
 390         multiplier = 0;
 391         frac_part = 0;
 392         done = FALSE;
 393         while (s && *s && multiplier == 0 && !done) {
 394                 switch (*s) {
 395                 case ' ':
 396                         break;
 397                 case '.':
 398                         frac_part = g_ascii_strtod(s, &s);
 399                         break;
 400                 case 'k':
 401                 case 'K':
 402                         multiplier = SR_KHZ(1);
 403                         break;
 404                 case 'm':
 405                 case 'M':
 406                         multiplier = SR_MHZ(1);
 407                         break;
 408                 case 'g':
 409                 case 'G':
 410                         multiplier = SR_GHZ(1);
 411                         break;
 412                 default:
 413                         done = TRUE;
 414                         s--;
 415                 }
 416                 s++;
 417         }
 418         if (multiplier > 0) {
 419                 *size *= multiplier;
 420                 *size += frac_part * multiplier;
 421         } else
 422                 *size += frac_part;
 423
 424         if (s && *s && strcasecmp(s, "Hz"))
 425                 return SR_ERR;
 426
 427         return SR_OK;
 428 }
 429
 430 /**
 431  * Convert a "natural" string representation of a time value to an
 432  * uint64_t value in milliseconds.
 433  *
 434  * E.g. a value of "3s" or "3 s" would be converted to 3000, a value
 435  * of "15ms" would be converted to 15.
 436  *
 437  * Value representations other than decimal (such as hex or octal) are not
 438  * supported. Only lower-case "s" and "ms" time suffixes are supported.
 439  * Spaces (but not other whitespace) between value and suffix are allowed.
 440  *
 441  * @param timestring A string containing a (decimal) time value.
 442  * @return The string's time value as uint64_t, in milliseconds.
 443  *
 444  * @todo Add support for "m" (minutes) and others.
 445  * @todo Add support for picoseconds?
 446  * @todo Allow both lower-case and upper-case? If no, document it.
 447  *
 448  * @since 0.1.0
 449  */
 450 SR_API uint64_t sr_parse_timestring(const char *timestring)
 451 {
 452         uint64_t time_msec;
 453         char *s;
 454
 455         /* TODO: Error handling, logging. */
 456
 457         time_msec = strtoull(timestring, &s, 10);
 458         if (time_msec == 0 && s == timestring)
 459                 return 0;
 460
 461         if (s && *s) {
 462                 while (*s == ' ')
 463                         s++;
 464                 if (!strcmp(s, "s"))
 465                         time_msec *= 1000;
 466                 else if (!strcmp(s, "ms"))
 467                         ; /* redundant */
 468                 else
 469                         return 0;
 470         }
 471
 472         return time_msec;
 473 }
 474
 475 /** @since 0.1.0 */
 476 SR_API gboolean sr_parse_boolstring(const char *boolstr)
 477 {
 478         if (!boolstr)
 479                 return FALSE;
 480
 481         if (!g_ascii_strncasecmp(boolstr, "true", 4) ||
 482             !g_ascii_strncasecmp(boolstr, "yes", 3) ||
 483             !g_ascii_strncasecmp(boolstr, "on", 2) ||
 484             !g_ascii_strncasecmp(boolstr, "1", 1))
 485                 return TRUE;
 486
 487         return FALSE;
 488 }
 489
 490 /** @since 0.2.0 */
 491 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
 492 {
 493         char *s;
 494
 495         *p = strtoull(periodstr, &s, 10);
 496         if (*p == 0 && s == periodstr)
 497                 /* No digits found. */
 498                 return SR_ERR_ARG;
 499
 500         if (s && *s) {
 501                 while (*s == ' ')
 502                         s++;
 503                 if (!strcmp(s, "fs"))
 504                         *q = 1000000000000000ULL;
 505                 else if (!strcmp(s, "ps"))
 506                         *q = 1000000000000ULL;
 507                 else if (!strcmp(s, "ns"))
 508                         *q = 1000000000ULL;
 509                 else if (!strcmp(s, "us"))
 510                         *q = 1000000;
 511                 else if (!strcmp(s, "ms"))
 512                         *q = 1000;
 513                 else if (!strcmp(s, "s"))
 514                         *q = 1;
 515                 else
 516                         /* Must have a time suffix. */
 517                         return SR_ERR_ARG;
 518         }
 519
 520         return SR_OK;
 521 }
 522
 523 /** @since 0.2.0 */
 524 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q)
 525 {
 526         char *s;
 527
 528         *p = strtoull(voltstr, &s, 10);
 529         if (*p == 0 && s == voltstr)
 530                 /* No digits found. */
 531                 return SR_ERR_ARG;
 532
 533         if (s && *s) {
 534                 while (*s == ' ')
 535                         s++;
 536                 if (!strcasecmp(s, "mv"))
 537                         *q = 1000L;
 538                 else if (!strcasecmp(s, "v"))
 539                         *q = 1;
 540                 else
 541                         /* Must have a base suffix. */
 542                         return SR_ERR_ARG;
 543         }
 544
 545         return SR_OK;
 546 }
 547
 548 /** @} */