lib/xstrtol.c

   1 /* A more useful interface to strtol.
   2    Copyright (C) 1995, 1996, 1998 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software Foundation,
  16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  17
  18 /* Written by Jim Meyering. */
  19
  20 #if HAVE_CONFIG_H
  21 # include <config.h>
  22 #endif
  23
  24 #include <stdio.h>
  25
  26 #if STDC_HEADERS
  27 # include <stdlib.h>
  28 #endif
  29
  30 #if HAVE_STRING_H
  31 # include <string.h>
  32 #else
  33 # include <strings.h>
  34 # ifndef strchr
  35 #  define strchr index
  36 # endif
  37 #endif
  38
  39 /* Some pre-ANSI implementations (e.g. SunOS 4)
  40    need stderr defined if assertion checking is enabled.  */
  41 #ifndef NDEBUG
  42 # include <stdio.h>
  43 #endif
  44
  45 #include <assert.h>
  46
  47 #include <errno.h>
  48 #ifndef errno
  49 extern int errno;
  50 #endif
  51
  52 #if HAVE_LIMITS_H
  53 # include <limits.h>
  54 #endif
  55
  56 #ifndef CHAR_BIT
  57 # define CHAR_BIT 8
  58 #endif
  59
  60 /* The extra casts work around common compiler bugs.  */
  61 #define TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
  62 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
  63    It is necessary at least when t == time_t.  */
  64 #define TYPE_MINIMUM(t) ((t) (TYPE_SIGNED (t) \
  65                               ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
  66 #define TYPE_MAXIMUM(t) (~ (t) 0 - TYPE_MINIMUM (t))
  67
  68 #ifndef ULONG_MAX
  69 # define ULONG_MAX TYPE_MAXIMUM (unsigned long int)
  70 #endif
  71
  72 #ifndef LONG_MAX
  73 # define LONG_MAX TYPE_MAXIMUM (long int)
  74 #endif
  75
  76 #include "xstrtol.h"
  77
  78 __unsigned long int __strtol ();
  79
  80 static int
  81 bkm_scale (__unsigned long int *x, int scale_factor)
  82 {
  83   __unsigned long int product = *x * scale_factor;
  84   if (*x != product / scale_factor)
  85     return 1;
  86   *x = product;
  87   return 0;
  88 }
  89
  90 static int
  91 bkm_scale_by_power (__unsigned long int *x, int base, int power)
  92 {
  93   while (power--)
  94     if (bkm_scale (x, base))
  95       return 1;
  96
  97   return 0;
  98 }
  99
 100 /* FIXME: comment.  */
 101
 102 strtol_error
 103 __xstrtol (const char *s, char **ptr, int strtol_base,
 104            __unsigned long int *val, const char *valid_suffixes)
 105 {
 106   char *t_ptr;
 107   char **p;
 108   __unsigned long int tmp;
 109
 110   assert (0 <= strtol_base && strtol_base <= 36);
 111
 112   p = (ptr ? ptr : &t_ptr);
 113
 114   errno = 0;
 115   tmp = __strtol (s, p, strtol_base);
 116   if (errno != 0)
 117     return LONGINT_OVERFLOW;
 118   if (*p == s)
 119     return LONGINT_INVALID;
 120
 121   /* Let valid_suffixes == NULL mean `allow any suffix'.  */
 122   /* FIXME: update all callers except the one in tail.c changing
 123      last parameter NULL to `""'.  */
 124   if (!valid_suffixes)
 125     {
 126       *val = tmp;
 127       return LONGINT_OK;
 128     }
 129
 130   if (**p != '\0')
 131     {
 132       int base = 1024;
 133       int suffixes = 1;
 134       int overflow;
 135
 136       if (!strchr (valid_suffixes, **p))
 137         return LONGINT_INVALID_SUFFIX_CHAR;
 138
 139       if (strchr (valid_suffixes, '0'))
 140         {
 141           /* The ``valid suffix'' '0' is a special flag meaning that
 142              an optional second suffix is allowed, which can change
 143              the base, e.g. "100MD" for 100 megabytes decimal.  */
 144
 145           switch (p[0][1])
 146             {
 147             case 'B':
 148               suffixes++;
 149               break;
 150
 151             case 'D':
 152               base = 1000;
 153               suffixes++;
 154               break;
 155             }
 156         }
 157
 158       switch (**p)
 159         {
 160         case 'b':
 161           overflow = bkm_scale (&tmp, 512);
 162           break;
 163
 164         case 'B':
 165           overflow = bkm_scale (&tmp, 1024);
 166           break;
 167
 168         case 'c':
 169           overflow = 0;
 170           break;
 171
 172         case 'E': /* Exa */
 173           overflow = bkm_scale_by_power (&tmp, base, 6);
 174           break;
 175
 176         case 'G': /* Giga */
 177           overflow = bkm_scale_by_power (&tmp, base, 3);
 178           break;
 179
 180         case 'k': /* kilo */
 181           overflow = bkm_scale_by_power (&tmp, base, 1);
 182           break;
 183
 184         case 'M': /* Mega */
 185         case 'm': /* 'm' is undocumented; for backward compatibility only */
 186           overflow = bkm_scale_by_power (&tmp, base, 2);
 187           break;
 188
 189         case 'P': /* Peta */
 190           overflow = bkm_scale_by_power (&tmp, base, 5);
 191           break;
 192
 193         case 'T': /* Tera */
 194           overflow = bkm_scale_by_power (&tmp, base, 4);
 195           break;
 196
 197         case 'w':
 198           overflow = bkm_scale (&tmp, 2);
 199           break;
 200
 201         case 'Y': /* Yotta */
 202           overflow = bkm_scale_by_power (&tmp, base, 8);
 203           break;
 204
 205         case 'Z': /* Zetta */
 206           overflow = bkm_scale_by_power (&tmp, base, 7);
 207           break;
 208
 209         default:
 210           return LONGINT_INVALID_SUFFIX_CHAR;
 211           break;
 212         }
 213
 214       if (overflow)
 215         return LONGINT_OVERFLOW;
 216
 217       (*p) += suffixes;
 218     }
 219
 220   *val = tmp;
 221   return LONGINT_OK;
 222 }
 223
 224 #ifdef TESTING_XSTRTO
 225
 226 # include <stdio.h>
 227 # include "error.h"
 228
 229 char *program_name;
 230
 231 int
 232 main (int argc, char** argv)
 233 {
 234   strtol_error s_err;
 235   int i;
 236
 237   program_name = argv[0];
 238   for (i=1; i<argc; i++)
 239     {
 240       char *p;
 241       __unsigned long int val;
 242
 243       s_err = __xstrtol (argv[i], &p, 0, &val, "bckmw");
 244       if (s_err == LONGINT_OK)
 245         {
 246           printf ("%s->%lu (%s)\n", argv[i], val, p);
 247         }
 248       else
 249         {
 250           STRTOL_FATAL_ERROR (argv[i], "arg", s_err);
 251         }
 252     }
 253   exit (0);
 254 }
 255
 256 #endif /* TESTING_XSTRTO */