maint: update copyright
[gnulib.git] / lib / xstrtol.c
index 0dc871e..965cfcf 100644 (file)
@@ -1,10 +1,12 @@
 /* A more useful interface to strtol.
-   Copyright (C) 1995, 1996, 1998 Free Software Foundation, Inc.
 
-   This program is free software; you can redistribute it and/or modify
+   Copyright (C) 1995-1996, 1998-2001, 2003-2007, 2009-2014 Free Software
+   Foundation, Inc.
+
+   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 2, or (at your option)
-   any later version.
+   the Free Software Foundation; either version 3 of the License, or
+   (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 /* Written by Jim Meyering. */
 
-#if HAVE_CONFIG_H
-# include <config.h>
+#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
 
-#include <stdio.h>
+#include <config.h>
 
-#if STDC_HEADERS
-# include <stdlib.h>
-#endif
+#include "xstrtol.h"
 
-#if HAVE_STRING_H
-# include <string.h>
-#else
-# include <strings.h>
-# ifndef strchr
-#  define strchr index
-# endif
-#endif
+/* Some pre-ANSI implementations (e.g. SunOS 4)
+   need stderr defined if assertion checking is enabled.  */
+#include <stdio.h>
 
 #include <assert.h>
-
+#include <ctype.h>
 #include <errno.h>
-#ifndef errno
-extern int errno;
-#endif
+#include <limits.h>
+#include <stdlib.h>
+#include <string.h>
 
-#if HAVE_LIMITS_H
-# include <limits.h>
-#endif
+#include "intprops.h"
 
-#ifndef CHAR_BIT
-# define CHAR_BIT 8
+/* 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
-
-/* The extra casts work around common compiler bugs.  */
-#define TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
-/* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
-   It is necessary at least when t == time_t.  */
-#define TYPE_MINIMUM(t) ((t) (TYPE_SIGNED (t) \
-                             ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
-#define TYPE_MAXIMUM(t) (~ (t) 0 - TYPE_MINIMUM (t))
-
-#ifndef ULONG_MAX
-# define ULONG_MAX TYPE_MAXIMUM (unsigned long int)
+#ifndef LLONG_MAX
+# define LLONG_MAX TYPE_MAXIMUM (long long int)
 #endif
-
-#ifndef LONG_MAX
-# define LONG_MAX TYPE_MAXIMUM (long int)
+#ifndef LLONG_MIN
+# define LLONG_MIN TYPE_MINIMUM (long long int)
 #endif
 
-#include "xstrtol.h"
-
-__unsigned long int __strtol ();
-
-static int
-bkm_scale (__unsigned long int *x, int scale_factor)
+static strtol_error
+bkm_scale (__strtol_t *x, int scale_factor)
 {
-  __unsigned long int product = *x * scale_factor;
-  if (*x != product / scale_factor)
-    return 1;
-  *x = product;
-  return 0;
+  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 int
-bkm_scale_by_power (__unsigned long int *x, int base, int power)
+static strtol_error
+bkm_scale_by_power (__strtol_t *x, int base, int power)
 {
+  strtol_error err = LONGINT_OK;
   while (power--)
-    if (bkm_scale (x, base))
-      return 1;
-
-  return 0;
+    err |= bkm_scale (x, base);
+  return err;
 }
 
 /* FIXME: comment.  */
 
 strtol_error
 __xstrtol (const char *s, char **ptr, int strtol_base,
-          __unsigned long int *val, const char *valid_suffixes)
+           __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 <= 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, strtol_base);
-  if (errno != 0)
-    return LONGINT_OVERFLOW;
+
   if (*p == s)
-    return LONGINT_INVALID;
+    {
+      /* 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;
+    }
+  else if (errno != 0)
+    {
+      if (errno != ERANGE)
+        return LONGINT_INVALID;
+      err = LONGINT_OVERFLOW;
+    }
 
-  /* Let valid_suffixes == NULL mean `allow any suffix'.  */
-  /* FIXME: update all callers except the one in tail.c changing
-     last parameter NULL to `""'.  */
+  /* 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 LONGINT_OK;
+      return err;
     }
 
   if (**p != '\0')
     {
       int base = 1024;
       int suffixes = 1;
-      int overflow;
+      strtol_error overflow;
 
       if (!strchr (valid_suffixes, **p))
-       return LONGINT_INVALID_SUFFIX_CHAR;
+        {
+          *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, e.g. "100MD" for 100 megabytes decimal.  */
-
-         switch (p[0][1])
-           {
-           case 'B':
-             suffixes++;
-             break;
-
-           case 'D':
-             base = 1000;
-             suffixes++;
-             break;
-           }
-       }
+        {
+          /* 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 */
-         overflow = bkm_scale_by_power (&tmp, base, 6);
-         break;
-
-       case 'G': /* Giga */
-         overflow = bkm_scale_by_power (&tmp, base, 3);
-         break;
-
-       case 'k': /* kilo */
-         overflow = bkm_scale_by_power (&tmp, base, 1);
-         break;
-
-       case 'M': /* Mega */
-       case 'm': /* 'm' is undocumented; for backward compatibility only */
-         overflow = bkm_scale_by_power (&tmp, base, 2);
-         break;
-
-       case 'P': /* Peta */
-         overflow = bkm_scale_by_power (&tmp, base, 5);
-         break;
-
-       case 'T': /* Tera */
-         overflow = bkm_scale_by_power (&tmp, base, 4);
-         break;
-
-       case 'w':
-         overflow = bkm_scale (&tmp, 2);
-         break;
-
-       case 'Y': /* Yotta */
-         overflow = bkm_scale_by_power (&tmp, base, 8);
-         break;
-
-       case 'Z': /* Zetta */
-         overflow = bkm_scale_by_power (&tmp, base, 7);
-         break;
-
-       default:
-         return LONGINT_INVALID_SUFFIX_CHAR;
-         break;
-       }
-
-      if (overflow)
-       return LONGINT_OVERFLOW;
-
-      (*p) += suffixes;
+        {
+        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;
     }
 
   *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;
-
-  program_name = argv[0];
-  for (i=1; i<argc; i++)
-    {
-      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);
-       }
-    }
-  exit (0);
+  return err;
 }
-
-#endif /* TESTING_XSTRTO */