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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <config.h>
  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 SR_PRIV int sr_atol(const char *str, long *ret)
  62 {
  63         long tmp;
  64         char *endptr = NULL;
  65
  66         errno = 0;
  67         tmp = strtol(str, &endptr, 10);
  68
  69         if (!endptr || *endptr || errno) {
  70                 if (!errno)
  71                         errno = EINVAL;
  72                 return SR_ERR;
  73         }
  74
  75         *ret = tmp;
  76         return SR_OK;
  77 }
  78
  79 /**
  80  * @private
  81  *
  82  * Convert a string representation of a numeric value (base 10) to an integer. The
  83  * conversion is strict and will fail if the complete string does not represent
  84  * a valid integer. The function sets errno according to the details of the
  85  * failure.
  86  *
  87  * @param str The string representation to convert.
  88  * @param ret Pointer to int where the result of the conversion will be stored.
  89  *
  90  * @retval SR_OK Conversion successful.
  91  * @retval SR_ERR Failure.
  92  */
  93 SR_PRIV int sr_atoi(const char *str, int *ret)
  94 {
  95         long tmp;
  96
  97         if (sr_atol(str, &tmp) != SR_OK)
  98                 return SR_ERR;
  99
 100         if ((int) tmp != tmp) {
 101                 errno = ERANGE;
 102                 return SR_ERR;
 103         }
 104
 105         *ret = (int) tmp;
 106         return SR_OK;
 107 }
 108
 109 /**
 110  * @private
 111  *
 112  * Convert a string representation of a numeric value to a double. The
 113  * conversion is strict and will fail if the complete string does not represent
 114  * a valid double. The function sets errno according to the details of the
 115  * failure.
 116  *
 117  * @param str The string representation to convert.
 118  * @param ret Pointer to double where the result of the conversion will be stored.
 119  *
 120  * @retval SR_OK Conversion successful.
 121  * @retval SR_ERR Failure.
 122  */
 123 SR_PRIV int sr_atod(const char *str, double *ret)
 124 {
 125         double tmp;
 126         char *endptr = NULL;
 127
 128         errno = 0;
 129         tmp = strtof(str, &endptr);
 130
 131         if (!endptr || *endptr || errno) {
 132                 if (!errno)
 133                         errno = EINVAL;
 134                 return SR_ERR;
 135         }
 136
 137         *ret = tmp;
 138         return SR_OK;
 139 }
 140
 141 /**
 142  * @private
 143  *
 144  * Convert a string representation of a numeric value to a float. The
 145  * conversion is strict and will fail if the complete string does not represent
 146  * a valid float. The function sets errno according to the details of the
 147  * failure.
 148  *
 149  * @param str The string representation to convert.
 150  * @param ret Pointer to float where the result of the conversion will be stored.
 151  *
 152  * @retval SR_OK Conversion successful.
 153  * @retval SR_ERR Failure.
 154  */
 155 SR_PRIV int sr_atof(const char *str, float *ret)
 156 {
 157         double tmp;
 158
 159         if (sr_atod(str, &tmp) != SR_OK)
 160                 return SR_ERR;
 161
 162         if ((float) tmp != tmp) {
 163                 errno = ERANGE;
 164                 return SR_ERR;
 165         }
 166
 167         *ret = (float) tmp;
 168         return SR_OK;
 169 }
 170
 171 /**
 172  * @private
 173  *
 174  * Convert a string representation of a numeric value to a float. The
 175  * conversion is strict and will fail if the complete string does not represent
 176  * a valid float. The function sets errno according to the details of the
 177  * failure. This version ignores the locale.
 178  *
 179  * @param str The string representation to convert.
 180  * @param ret Pointer to float where the result of the conversion will be stored.
 181  *
 182  * @retval SR_OK Conversion successful.
 183  * @retval SR_ERR Failure.
 184  */
 185 SR_PRIV int sr_atof_ascii(const char *str, float *ret)
 186 {
 187         double tmp;
 188         char *endptr = NULL;
 189
 190         errno = 0;
 191         tmp = g_ascii_strtod(str, &endptr);
 192
 193         if (!endptr || *endptr || errno) {
 194                 if (!errno)
 195                         errno = EINVAL;
 196                 return SR_ERR;
 197         }
 198
 199         /* FIXME This fails unexpectedly. Some other method to safel downcast
 200          * needs to be found. Checking against FLT_MAX doesn't work as well. */
 201         /*
 202         if ((float) tmp != tmp) {
 203                 errno = ERANGE;
 204                 sr_dbg("ERANGEEEE %e != %e", (float) tmp, tmp);
 205                 return SR_ERR;
 206         }
 207         */
 208
 209         *ret = (float) tmp;
 210         return SR_OK;
 211 }
 212
 213 /**
 214  * Convert a string representation of a numeric value to a sr_rational.
 215  *
 216  * The conversion is strict and will fail if the complete string does not
 217  * represent a valid number. The function sets errno according to the details
 218  * of the failure. This version ignores the locale.
 219  *
 220  * @param str The string representation to convert.
 221  * @param ret Pointer to sr_rational where the result of the conversion will be stored.
 222  *
 223  * @retval SR_OK Conversion successful.
 224  * @retval SR_ERR Failure.
 225  *
 226  * @since 0.5.0
 227  */
 228 SR_API int sr_parse_rational(const char *str, struct sr_rational *ret)
 229 {
 230         char *endptr = NULL;
 231         int64_t integral;
 232         int64_t fractional = 0;
 233         int64_t denominator = 1;
 234         int32_t fractional_len = 0;
 235         int32_t exponent = 0;
 236
 237         errno = 0;
 238         integral = g_ascii_strtoll(str, &endptr, 10);
 239
 240         if (errno)
 241                 return SR_ERR;
 242
 243         if (*endptr == '.') {
 244                 const char* start = endptr + 1;
 245                 fractional = g_ascii_strtoll(start, &endptr, 10);
 246                 if (errno)
 247                         return SR_ERR;
 248                 fractional_len = endptr - start;
 249         }
 250
 251         if ((*endptr == 'E') || (*endptr == 'e')) {
 252                 exponent = g_ascii_strtoll(endptr + 1, &endptr, 10);
 253                 if (errno)
 254                         return SR_ERR;
 255         }
 256
 257         if (*endptr != '\0')
 258                 return SR_ERR;
 259
 260         for (int i = 0; i < fractional_len; i++)
 261                 integral *= 10;
 262         exponent -= fractional_len;
 263
 264         if (integral >= 0)
 265                 integral += fractional;
 266         else
 267                 integral -= fractional;
 268
 269         while (exponent > 0) {
 270                 integral *= 10;
 271                 exponent--;
 272         }
 273
 274         while (exponent < 0) {
 275                 denominator *= 10;
 276                 exponent++;
 277         }
 278
 279         ret->p = integral;
 280         ret->q = denominator;
 281
 282         return SR_OK;
 283 }
 284
 285 /**
 286  * Convert a numeric value value to its "natural" string representation
 287  * in SI units.
 288  *
 289  * E.g. a value of 3000000, with units set to "W", would be converted
 290  * to "3 MW", 20000 to "20 kW", 31500 would become "31.5 kW".
 291  *
 292  * @param x The value to convert.
 293  * @param unit The unit to append to the string, or NULL if the string
 294  *             has no units.
 295  *
 296  * @return A newly allocated string representation of the samplerate value,
 297  *         or NULL upon errors. The caller is responsible to g_free() the
 298  *         memory.
 299  *
 300  * @since 0.2.0
 301  */
 302 SR_API char *sr_si_string_u64(uint64_t x, const char *unit)
 303 {
 304         uint8_t i;
 305         uint64_t quot, divisor[] = {
 306                 SR_HZ(1), SR_KHZ(1), SR_MHZ(1), SR_GHZ(1),
 307                 SR_GHZ(1000), SR_GHZ(1000 * 1000), SR_GHZ(1000 * 1000 * 1000),
 308         };
 309         const char *p, prefix[] = "\0kMGTPE";
 310         char fmt[16], fract[20] = "", *f;
 311
 312         if (!unit)
 313                 unit = "";
 314
 315         for (i = 0; (quot = x / divisor[i]) >= 1000; i++);
 316
 317         if (i) {
 318                 sprintf(fmt, ".%%0%d"PRIu64, i * 3);
 319                 f = fract + sprintf(fract, fmt, x % divisor[i]) - 1;
 320
 321                 while (f >= fract && strchr("0.", *f))
 322                         *f-- = 0;
 323         }
 324
 325         p = prefix + i;
 326
 327         return g_strdup_printf("%" PRIu64 "%s %.1s%s", quot, fract, p, unit);
 328 }
 329
 330 /**
 331  * Convert a numeric samplerate value to its "natural" string representation.
 332  *
 333  * E.g. a value of 3000000 would be converted to "3 MHz", 20000 to "20 kHz",
 334  * 31500 would become "31.5 kHz".
 335  *
 336  * @param samplerate The samplerate in Hz.
 337  *
 338  * @return A newly allocated string representation of the samplerate value,
 339  *         or NULL upon errors. The caller is responsible to g_free() the
 340  *         memory.
 341  *
 342  * @since 0.1.0
 343  */
 344 SR_API char *sr_samplerate_string(uint64_t samplerate)
 345 {
 346         return sr_si_string_u64(samplerate, "Hz");
 347 }
 348
 349 /**
 350  * Convert a numeric period value to the "natural" string representation
 351  * of its period value.
 352  *
 353  * The period is specified as a rational number's numerator and denominator.
 354  *
 355  * E.g. a pair of (1, 5) would be converted to "200 ms", (10, 100) to "100 ms".
 356  *
 357  * @param v_p The period numerator.
 358  * @param v_q The period denominator.
 359  *
 360  * @return A newly allocated string representation of the period value,
 361  *         or NULL upon errors. The caller is responsible to g_free() the
 362  *         memory.
 363  *
 364  * @since 0.5.0
 365  */
 366 SR_API char *sr_period_string(uint64_t v_p, uint64_t v_q)
 367 {
 368         double freq, v;
 369         int prec;
 370
 371         freq = 1 / ((double)v_p / v_q);
 372
 373         if (freq > SR_GHZ(1)) {
 374                 v = (double)v_p / v_q * 1000000000000.0;
 375                 prec = ((v - (uint64_t)v) < FLT_MIN) ? 0 : 3;
 376                 return g_strdup_printf("%.*f ps", prec, v);
 377         } else if (freq > SR_MHZ(1)) {
 378                 v = (double)v_p / v_q * 1000000000.0;
 379                 prec = ((v - (uint64_t)v) < FLT_MIN) ? 0 : 3;
 380                 return g_strdup_printf("%.*f ns", prec, v);
 381         } else if (freq > SR_KHZ(1)) {
 382                 v = (double)v_p / v_q * 1000000.0;
 383                 prec = ((v - (uint64_t)v) < FLT_MIN) ? 0 : 3;
 384                 return g_strdup_printf("%.*f us", prec, v);
 385         } else if (freq > 1) {
 386                 v = (double)v_p / v_q * 1000.0;
 387                 prec = ((v - (uint64_t)v) < FLT_MIN) ? 0 : 3;
 388                 return g_strdup_printf("%.*f ms", prec, v);
 389         } else {
 390                 v = (double)v_p / v_q;
 391                 prec = ((v - (uint64_t)v) < FLT_MIN) ? 0 : 3;
 392                 return g_strdup_printf("%.*f s", prec, v);
 393         }
 394 }
 395
 396 /**
 397  * Convert a numeric voltage value to the "natural" string representation
 398  * of its voltage value. The voltage is specified as a rational number's
 399  * numerator and denominator.
 400  *
 401  * E.g. a value of 300000 would be converted to "300mV", 2 to "2V".
 402  *
 403  * @param v_p The voltage numerator.
 404  * @param v_q The voltage denominator.
 405  *
 406  * @return A newly allocated string representation of the voltage value,
 407  *         or NULL upon errors. The caller is responsible to g_free() the
 408  *         memory.
 409  *
 410  * @since 0.2.0
 411  */
 412 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q)
 413 {
 414         if (v_q == 1000)
 415                 return g_strdup_printf("%" PRIu64 " mV", v_p);
 416         else if (v_q == 1)
 417                 return g_strdup_printf("%" PRIu64 " V", v_p);
 418         else
 419                 return g_strdup_printf("%g V", (float)v_p / (float)v_q);
 420 }
 421
 422 /**
 423  * Convert a "natural" string representation of a size value to uint64_t.
 424  *
 425  * E.g. a value of "3k" or "3 K" would be converted to 3000, a value
 426  * of "15M" would be converted to 15000000.
 427  *
 428  * Value representations other than decimal (such as hex or octal) are not
 429  * supported. Only 'k' (kilo), 'm' (mega), 'g' (giga) suffixes are supported.
 430  * Spaces (but not other whitespace) between value and suffix are allowed.
 431  *
 432  * @param sizestring A string containing a (decimal) size value.
 433  * @param size Pointer to uint64_t which will contain the string's size value.
 434  *
 435  * @return SR_OK upon success, SR_ERR upon errors.
 436  *
 437  * @since 0.1.0
 438  */
 439 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
 440 {
 441         int multiplier, done;
 442         double frac_part;
 443         char *s;
 444
 445         *size = strtoull(sizestring, &s, 10);
 446         multiplier = 0;
 447         frac_part = 0;
 448         done = FALSE;
 449         while (s && *s && multiplier == 0 && !done) {
 450                 switch (*s) {
 451                 case ' ':
 452                         break;
 453                 case '.':
 454                         frac_part = g_ascii_strtod(s, &s);
 455                         break;
 456                 case 'k':
 457                 case 'K':
 458                         multiplier = SR_KHZ(1);
 459                         break;
 460                 case 'm':
 461                 case 'M':
 462                         multiplier = SR_MHZ(1);
 463                         break;
 464                 case 'g':
 465                 case 'G':
 466                         multiplier = SR_GHZ(1);
 467                         break;
 468                 default:
 469                         done = TRUE;
 470                         s--;
 471                 }
 472                 s++;
 473         }
 474         if (multiplier > 0) {
 475                 *size *= multiplier;
 476                 *size += frac_part * multiplier;
 477         } else
 478                 *size += frac_part;
 479
 480         if (s && *s && g_ascii_strcasecmp(s, "Hz"))
 481                 return SR_ERR;
 482
 483         return SR_OK;
 484 }
 485
 486 /**
 487  * Convert a "natural" string representation of a time value to an
 488  * uint64_t value in milliseconds.
 489  *
 490  * E.g. a value of "3s" or "3 s" would be converted to 3000, a value
 491  * of "15ms" would be converted to 15.
 492  *
 493  * Value representations other than decimal (such as hex or octal) are not
 494  * supported. Only lower-case "s" and "ms" time suffixes are supported.
 495  * Spaces (but not other whitespace) between value and suffix are allowed.
 496  *
 497  * @param timestring A string containing a (decimal) time value.
 498  * @return The string's time value as uint64_t, in milliseconds.
 499  *
 500  * @todo Add support for "m" (minutes) and others.
 501  * @todo Add support for picoseconds?
 502  * @todo Allow both lower-case and upper-case? If no, document it.
 503  *
 504  * @since 0.1.0
 505  */
 506 SR_API uint64_t sr_parse_timestring(const char *timestring)
 507 {
 508         uint64_t time_msec;
 509         char *s;
 510
 511         /* TODO: Error handling, logging. */
 512
 513         time_msec = strtoull(timestring, &s, 10);
 514         if (time_msec == 0 && s == timestring)
 515                 return 0;
 516
 517         if (s && *s) {
 518                 while (*s == ' ')
 519                         s++;
 520                 if (!strcmp(s, "s"))
 521                         time_msec *= 1000;
 522                 else if (!strcmp(s, "ms"))
 523                         ; /* redundant */
 524                 else
 525                         return 0;
 526         }
 527
 528         return time_msec;
 529 }
 530
 531 /** @since 0.1.0 */
 532 SR_API gboolean sr_parse_boolstring(const char *boolstr)
 533 {
 534         /*
 535          * Complete absence of an input spec is assumed to mean TRUE,
 536          * as in command line option strings like this:
 537          *   ...:samplerate=100k:header:numchannels=4:...
 538          */
 539         if (!boolstr || !*boolstr)
 540                 return TRUE;
 541
 542         if (!g_ascii_strncasecmp(boolstr, "true", 4) ||
 543             !g_ascii_strncasecmp(boolstr, "yes", 3) ||
 544             !g_ascii_strncasecmp(boolstr, "on", 2) ||
 545             !g_ascii_strncasecmp(boolstr, "1", 1))
 546                 return TRUE;
 547
 548         return FALSE;
 549 }
 550
 551 /** @since 0.2.0 */
 552 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
 553 {
 554         char *s;
 555
 556         *p = strtoull(periodstr, &s, 10);
 557         if (*p == 0 && s == periodstr)
 558                 /* No digits found. */
 559                 return SR_ERR_ARG;
 560
 561         if (s && *s) {
 562                 while (*s == ' ')
 563                         s++;
 564                 if (!strcmp(s, "fs"))
 565                         *q = 1000000000000000ULL;
 566                 else if (!strcmp(s, "ps"))
 567                         *q = 1000000000000ULL;
 568                 else if (!strcmp(s, "ns"))
 569                         *q = 1000000000ULL;
 570                 else if (!strcmp(s, "us"))
 571                         *q = 1000000;
 572                 else if (!strcmp(s, "ms"))
 573                         *q = 1000;
 574                 else if (!strcmp(s, "s"))
 575                         *q = 1;
 576                 else
 577                         /* Must have a time suffix. */
 578                         return SR_ERR_ARG;
 579         }
 580
 581         return SR_OK;
 582 }
 583
 584 /** @since 0.2.0 */
 585 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q)
 586 {
 587         char *s;
 588
 589         *p = strtoull(voltstr, &s, 10);
 590         if (*p == 0 && s == voltstr)
 591                 /* No digits found. */
 592                 return SR_ERR_ARG;
 593
 594         if (s && *s) {
 595                 while (*s == ' ')
 596                         s++;
 597                 if (!g_ascii_strcasecmp(s, "mv"))
 598                         *q = 1000L;
 599                 else if (!g_ascii_strcasecmp(s, "v"))
 600                         *q = 1;
 601                 else
 602                         /* Must have a base suffix. */
 603                         return SR_ERR_ARG;
 604         }
 605
 606         return SR_OK;
 607 }
 608
 609 /** @} */