maint: update copyright
[gnulib.git] / lib / xstrtol.c
index 42d3758..965cfcf 100644 (file)
-#ifdef HAVE_CONFIG_H
-#include <config.h>
-#endif
+/* A more useful interface to strtol.
 
-#ifdef STDC_HEADERS
-#include <stdlib.h>
-#endif
+   Copyright (C) 1995-1996, 1998-2001, 2003-2007, 2009-2014 Free Software
+   Foundation, Inc.
 
-#ifdef HAVE_STRING_H
-# include <string.h>
-#else
-# include <strings.h>
-# ifndef strchr
-#  define strchr index
-# endif
-#endif
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 3 of the License, or
+   (at your option) any later version.
 
-#define NDEBUG
-#include <assert.h>
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
-#include <errno.h>
-#ifndef errno
-extern int errno;
-#endif
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
-#if HAVE_LIMITS_H
-#include <limits.h>
-#endif
+/* Written by Jim Meyering. */
 
-#ifndef ULONG_MAX
-#define ULONG_MAX ((unsigned long) ~(unsigned long) 0)
+#ifndef __strtol
+# define __strtol strtol
+# define __strtol_t long int
+# define __xstrtol xstrtol
+# define STRTOL_T_MINIMUM LONG_MIN
+# define STRTOL_T_MAXIMUM LONG_MAX
 #endif
 
-#ifndef LONG_MAX
-#define LONG_MAX ((long int) (ULONG_MAX >> 1))
-#endif
+#include <config.h>
 
 #include "xstrtol.h"
 
-#define BKM_SCALE(x, scale_factor, error_return)                       \
-      do                                                               \
-       {                                                               \
-         if ((x) > (double) __ZLONG_MAX / (scale_factor))              \
-           return (error_return);                                      \
-         (x) *= (scale_factor);                                        \
-       }                                                               \
-      while (0)
+/* Some pre-ANSI implementations (e.g. SunOS 4)
+   need stderr defined if assertion checking is enabled.  */
+#include <stdio.h>
 
-__unsigned long int __strtol ();
+#include <assert.h>
+#include <ctype.h>
+#include <errno.h>
+#include <limits.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include "intprops.h"
+
+/* xstrtoll.c and xstrtoull.c, which include this file, require that
+   ULLONG_MAX, LLONG_MAX, LLONG_MIN are defined, but <limits.h> does not
+   define them on all platforms.  */
+#ifndef ULLONG_MAX
+# define ULLONG_MAX TYPE_MAXIMUM (unsigned long long)
+#endif
+#ifndef LLONG_MAX
+# define LLONG_MAX TYPE_MAXIMUM (long long int)
+#endif
+#ifndef LLONG_MIN
+# define LLONG_MIN TYPE_MINIMUM (long long int)
+#endif
+
+static strtol_error
+bkm_scale (__strtol_t *x, int scale_factor)
+{
+  if (TYPE_SIGNED (__strtol_t) && *x < STRTOL_T_MINIMUM / scale_factor)
+    {
+      *x = STRTOL_T_MINIMUM;
+      return LONGINT_OVERFLOW;
+    }
+  if (STRTOL_T_MAXIMUM / scale_factor < *x)
+    {
+      *x = STRTOL_T_MAXIMUM;
+      return LONGINT_OVERFLOW;
+    }
+  *x *= scale_factor;
+  return LONGINT_OK;
+}
+
+static strtol_error
+bkm_scale_by_power (__strtol_t *x, int base, int power)
+{
+  strtol_error err = LONGINT_OK;
+  while (power--)
+    err |= bkm_scale (x, base);
+  return err;
+}
 
 /* FIXME: comment.  */
 
 strtol_error
-__xstrtol (s, ptr, base, val, valid_suffixes)
-     const char *s;
-     char **ptr;
-     int base;
-     __unsigned long int *val;
-     const char *valid_suffixes;
+__xstrtol (const char *s, char **ptr, int strtol_base,
+           __strtol_t *val, const char *valid_suffixes)
 {
   char *t_ptr;
   char **p;
-  __unsigned long int tmp;
+  __strtol_t tmp;
+  strtol_error err = LONGINT_OK;
 
-  assert (0 <= base && base <= 36);
+  assert (0 <= strtol_base && strtol_base <= 36);
 
   p = (ptr ? ptr : &t_ptr);
 
+  if (! TYPE_SIGNED (__strtol_t))
+    {
+      const char *q = s;
+      unsigned char ch = *q;
+      while (isspace (ch))
+        ch = *++q;
+      if (ch == '-')
+        return LONGINT_INVALID;
+    }
+
   errno = 0;
-  tmp = __strtol (s, p, base);
-  if (errno != 0)
-    return LONGINT_OVERFLOW;
+  tmp = __strtol (s, p, strtol_base);
+
   if (*p == s)
-    return LONGINT_INVALID;
-  if (!valid_suffixes)
     {
-      if (**p == '\0')
-       {
-         *val = tmp;
-         return LONGINT_OK;
-       }
+      /* If there is no number but there is a valid suffix, assume the
+         number is 1.  The string is invalid otherwise.  */
+      if (valid_suffixes && **p && strchr (valid_suffixes, **p))
+        tmp = 1;
       else
-       return LONGINT_INVALID_SUFFIX_CHAR;
+        return LONGINT_INVALID;
     }
-
-  if (**p != '\0' && strchr (valid_suffixes, **p))
+  else if (errno != 0)
     {
-      switch (**p)
-       {
-       case 'b':
-         BKM_SCALE (tmp, 512, LONGINT_OVERFLOW);
-         ++(*p);
-         break;
-
-       case 'c':
-         ++(*p);
-         break;
-
-       case 'B':
-       case 'k':
-         BKM_SCALE (tmp, 1024, LONGINT_OVERFLOW);
-         ++(*p);
-         break;
-
-       case 'm':
-         BKM_SCALE (tmp, 1024 * 1024, LONGINT_OVERFLOW);
-         ++(*p);
-         break;
-
-       case 'w':
-         BKM_SCALE (tmp, 2, LONGINT_OVERFLOW);
-         ++(*p);
-         break;
-
-       default:
-         return LONGINT_INVALID_SUFFIX_CHAR;
-         break;
-       }
+      if (errno != ERANGE)
+        return LONGINT_INVALID;
+      err = LONGINT_OVERFLOW;
     }
 
-  *val = tmp;
-  return LONGINT_OK;
-}
-
-#ifdef TESTING_XSTRTO
-
-#include <stdio.h>
-#include "error.h"
-
-char *program_name;
-
-int
-main (int argc, char** argv)
-{
-  strtol_error s_err;
-  int i;
+  /* Let valid_suffixes == NULL mean "allow any suffix".  */
+  /* FIXME: update all callers except the ones that allow suffixes
+     after the number, changing last parameter NULL to "".  */
+  if (!valid_suffixes)
+    {
+      *val = tmp;
+      return err;
+    }
 
-  program_name = argv[0];
-  for (i=1; i<argc; i++)
+  if (**p != '\0')
     {
-      char *p;
-      __unsigned long int val;
-
-      s_err = __xstrtol (argv[i], &p, 0, &val, "bckmw");
-      if (s_err == LONGINT_OK)
-       {
-         printf ("%s->%lu (%s)\n", argv[i], val, p);
-       }
-      else
-       {
-         STRTOL_FATAL_ERROR (argv[i], "arg", s_err);
-       }
+      int base = 1024;
+      int suffixes = 1;
+      strtol_error overflow;
+
+      if (!strchr (valid_suffixes, **p))
+        {
+          *val = tmp;
+          return err | LONGINT_INVALID_SUFFIX_CHAR;
+        }
+
+      if (strchr (valid_suffixes, '0'))
+        {
+          /* The "valid suffix" '0' is a special flag meaning that
+             an optional second suffix is allowed, which can change
+             the base.  A suffix "B" (e.g. "100MB") stands for a power
+             of 1000, whereas a suffix "iB" (e.g. "100MiB") stands for
+             a power of 1024.  If no suffix (e.g. "100M"), assume
+             power-of-1024.  */
+
+          switch (p[0][1])
+            {
+            case 'i':
+              if (p[0][2] == 'B')
+                suffixes += 2;
+              break;
+
+            case 'B':
+            case 'D': /* 'D' is obsolescent */
+              base = 1000;
+              suffixes++;
+              break;
+            }
+        }
+
+      switch (**p)
+        {
+        case 'b':
+          overflow = bkm_scale (&tmp, 512);
+          break;
+
+        case 'B':
+          overflow = bkm_scale (&tmp, 1024);
+          break;
+
+        case 'c':
+          overflow = 0;
+          break;
+
+        case 'E': /* exa or exbi */
+          overflow = bkm_scale_by_power (&tmp, base, 6);
+          break;
+
+        case 'G': /* giga or gibi */
+        case 'g': /* 'g' is undocumented; for compatibility only */
+          overflow = bkm_scale_by_power (&tmp, base, 3);
+          break;
+
+        case 'k': /* kilo */
+        case 'K': /* kibi */
+          overflow = bkm_scale_by_power (&tmp, base, 1);
+          break;
+
+        case 'M': /* mega or mebi */
+        case 'm': /* 'm' is undocumented; for compatibility only */
+          overflow = bkm_scale_by_power (&tmp, base, 2);
+          break;
+
+        case 'P': /* peta or pebi */
+          overflow = bkm_scale_by_power (&tmp, base, 5);
+          break;
+
+        case 'T': /* tera or tebi */
+        case 't': /* 't' is undocumented; for compatibility only */
+          overflow = bkm_scale_by_power (&tmp, base, 4);
+          break;
+
+        case 'w':
+          overflow = bkm_scale (&tmp, 2);
+          break;
+
+        case 'Y': /* yotta or 2**80 */
+          overflow = bkm_scale_by_power (&tmp, base, 8);
+          break;
+
+        case 'Z': /* zetta or 2**70 */
+          overflow = bkm_scale_by_power (&tmp, base, 7);
+          break;
+
+        default:
+          *val = tmp;
+          return err | LONGINT_INVALID_SUFFIX_CHAR;
+        }
+
+      err |= overflow;
+      *p += suffixes;
+      if (**p)
+        err |= LONGINT_INVALID_SUFFIX_CHAR;
     }
-  exit (0);
+
+  *val = tmp;
+  return err;
 }
-#endif /* TESTING_XSTRTO */