ctype/ctype.h

   1 /* Copyright (C) 1991,92,93,95,96,97,98,99,2001 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3
   4    The GNU C Library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Lesser General Public
   6    License as published by the Free Software Foundation; either
   7    version 2.1 of the License, or (at your option) any later version.
   8
   9    The GNU C Library 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 GNU
  12    Lesser General Public License for more details.
  13
  14    You should have received a copy of the GNU Lesser General Public
  15    License along with the GNU C Library; if not, write to the Free
  16    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  17    02111-1307 USA.  */
  18
  19 /*
  20  *      ISO C99 Standard 7.4: Character handling        <ctype.h>
  21  */
  22
  23 #ifndef _CTYPE_H
  24 #define _CTYPE_H        1
  25
  26 #include <features.h>
  27 #include <bits/types.h>
  28
  29 __BEGIN_DECLS
  30
  31 #ifndef _ISbit
  32 /* These are all the characteristics of characters.
  33    If there get to be more than 16 distinct characteristics,
  34    many things must be changed that use `unsigned short int's.
  35
  36    The characteristics are stored always in network byte order (big
  37    endian).  We define the bit value interpretations here dependent on the
  38    machine's byte order.  */
  39
  40 # include <endian.h>
  41 # if __BYTE_ORDER == __BIG_ENDIAN
  42 #  define _ISbit(bit)   (1 << (bit))
  43 # else /* __BYTE_ORDER == __LITTLE_ENDIAN */
  44 #  define _ISbit(bit)   ((bit) < 8 ? ((1 << (bit)) << 8) : ((1 << (bit)) >> 8))
  45 # endif
  46
  47 enum
  48 {
  49   _ISupper = _ISbit (0),        /* UPPERCASE.  */
  50   _ISlower = _ISbit (1),        /* lowercase.  */
  51   _ISalpha = _ISbit (2),        /* Alphabetic.  */
  52   _ISdigit = _ISbit (3),        /* Numeric.  */
  53   _ISxdigit = _ISbit (4),       /* Hexadecimal numeric.  */
  54   _ISspace = _ISbit (5),        /* Whitespace.  */
  55   _ISprint = _ISbit (6),        /* Printing.  */
  56   _ISgraph = _ISbit (7),        /* Graphical.  */
  57   _ISblank = _ISbit (8),        /* Blank (usually SPC and TAB).  */
  58   _IScntrl = _ISbit (9),        /* Control character.  */
  59   _ISpunct = _ISbit (10),       /* Punctuation.  */
  60   _ISalnum = _ISbit (11)        /* Alphanumeric.  */
  61 };
  62 #endif /* ! _ISbit  */
  63
  64 /* These are defined in ctype-info.c.
  65    The declarations here must match those in localeinfo.h.
  66
  67    These point into arrays of 384, so they can be indexed by any `unsigned
  68    char' value [0,255]; by EOF (-1); or by any `signed char' value
  69    [-128,-1).  ISO C requires that the ctype functions work for `unsigned
  70    char' values and for EOF; we also support negative `signed char' values
  71    for broken old programs.  The case conversion arrays are of `int's
  72    rather than `unsigned char's because tolower (EOF) must be EOF, which
  73    doesn't fit into an `unsigned char'.  But today more important is that
  74    the arrays are also used for multi-byte character sets.  */
  75 extern __const unsigned short int *__ctype_b;   /* Characteristics.  */
  76 extern __const __int32_t *__ctype_tolower; /* Case conversions.  */
  77 extern __const __int32_t *__ctype_toupper; /* Case conversions.  */
  78
  79 #define __isctype(c, type) \
  80   (__ctype_b[(int) (c)] & (unsigned short int) type)
  81
  82 #define __isascii(c)    (((c) & ~0x7f) == 0)    /* If C is a 7 bit value.  */
  83 #define __toascii(c)    ((c) & 0x7f)            /* Mask off high bits.  */
  84
  85 #define __exctype(name) extern int name (int) __THROW
  86
  87 /* The following names are all functions:
  88      int isCHARACTERISTIC(int c);
  89    which return nonzero iff C has CHARACTERISTIC.
  90    For the meaning of the characteristic names, see the `enum' above.  */
  91 __exctype (isalnum);
  92 __exctype (isalpha);
  93 __exctype (iscntrl);
  94 __exctype (isdigit);
  95 __exctype (islower);
  96 __exctype (isgraph);
  97 __exctype (isprint);
  98 __exctype (ispunct);
  99 __exctype (isspace);
 100 __exctype (isupper);
 101 __exctype (isxdigit);
 102
 103 #ifdef  __USE_ISOC99
 104 __exctype (isblank);
 105 #endif
 106
 107
 108 /* Return the lowercase version of C.  */
 109 extern int tolower (int __c) __THROW;
 110
 111 /* Return the uppercase version of C.  */
 112 extern int toupper (int __c) __THROW;
 113
 114
 115 #if defined __USE_SVID || defined __USE_MISC || defined __USE_XOPEN
 116
 117 /* Return nonzero iff C is in the ASCII set
 118    (i.e., is no more than 7 bits wide).  */
 119 extern int isascii (int __c) __THROW;
 120
 121 /* Return the part of C that is in the ASCII set
 122    (i.e., the low-order 7 bits of C).  */
 123 extern int toascii (int __c) __THROW;
 124
 125 /* These are the same as `toupper' and `tolower' except that they do not
 126    check the argument for being in the range of a `char'.  */
 127 __exctype (_toupper);
 128 __exctype (_tolower);
 129 #endif /* Use SVID or use misc.  */
 130
 131 /* This code is needed for the optimized mapping functions.  */
 132 #define __tobody(c, f, a, args) \
 133   (__extension__                                                              \
 134    ({ int __res;                                                              \
 135       if (sizeof (c) > 1)                                                     \
 136         {                                                                     \
 137           if (__builtin_constant_p (c))                                       \
 138             {                                                                 \
 139               int __c = (c);                                                  \
 140               __res = __c < -128 || __c > 255 ? __c : a[__c];                 \
 141             }                                                                 \
 142           else                                                                \
 143             __res = f args;                                                   \
 144         }                                                                     \
 145       else                                                                    \
 146         __res = a[(int) (c)];                                                 \
 147       __res; }))
 148
 149 #ifndef __NO_CTYPE
 150 # define isalnum(c)     __isctype((c), _ISalnum)
 151 # define isalpha(c)     __isctype((c), _ISalpha)
 152 # define iscntrl(c)     __isctype((c), _IScntrl)
 153 # define isdigit(c)     __isctype((c), _ISdigit)
 154 # define islower(c)     __isctype((c), _ISlower)
 155 # define isgraph(c)     __isctype((c), _ISgraph)
 156 # define isprint(c)     __isctype((c), _ISprint)
 157 # define ispunct(c)     __isctype((c), _ISpunct)
 158 # define isspace(c)     __isctype((c), _ISspace)
 159 # define isupper(c)     __isctype((c), _ISupper)
 160 # define isxdigit(c)    __isctype((c), _ISxdigit)
 161
 162 # ifdef __USE_ISOC99
 163 #  define isblank(c)    __isctype((c), _ISblank)
 164 # endif
 165
 166 # ifdef __USE_EXTERN_INLINES
 167 extern __inline int
 168 tolower (int __c) __THROW
 169 {
 170   return __c >= -128 && __c < 256 ? __ctype_tolower[__c] : __c;
 171 }
 172
 173 extern __inline int
 174 toupper (int __c) __THROW
 175 {
 176   return __c >= -128 && __c < 256 ? __ctype_toupper[__c] : __c;
 177 }
 178 # endif
 179
 180 # if __GNUC__ >= 2 && defined __OPTIMIZE__ && !defined __cplusplus
 181 #  define tolower(c) __tobody (c, tolower, __ctype_tolower, (c))
 182 #  define toupper(c) __tobody (c, toupper, __ctype_toupper, (c))
 183 # endif /* Optimizing gcc */
 184
 185 # if defined __USE_SVID || defined __USE_MISC || defined __USE_XOPEN
 186 #  define isascii(c)    __isascii (c)
 187 #  define toascii(c)    __toascii (c)
 188
 189 #  define _tolower(c)   ((int) __ctype_tolower[(int) (c)])
 190 #  define _toupper(c)   ((int) __ctype_toupper[(int) (c)])
 191 # endif
 192
 193 #endif /* Not __NO_CTYPE.  */
 194
 195
 196 #ifdef __USE_GNU
 197 /* The concept of one static locale per category is not very well
 198    thought out.  Many applications will need to process its data using
 199    information from several different locales.  Another application is
 200    the implementation of the internationalization handling in the
 201    upcoming ISO C++ standard library.  To support this another set of
 202    the functions using locale data exist which have an additional
 203    argument.
 204
 205    Attention: all these functions are *not* standardized in any form.
 206    This is a proof-of-concept implementation.  */
 207
 208 /* Structure for reentrant locale using functions.  This is an
 209    (almost) opaque type for the user level programs.  */
 210 # include <xlocale.h>
 211
 212 /* These definitions are similar to the ones above but all functions
 213    take as an argument a handle for the locale which shall be used.  */
 214 #  define __isctype_l(c, type, locale) \
 215   ((locale)->__ctype_b[(int) (c)] & (unsigned short int) type)
 216
 217 # define __exctype_l(name)      extern int name (int, __locale_t) __THROW
 218
 219 /* The following names are all functions:
 220      int isCHARACTERISTIC(int c, locale_t *locale);
 221    which return nonzero iff C has CHARACTERISTIC.
 222    For the meaning of the characteristic names, see the `enum' above.  */
 223 __exctype_l (__isalnum_l);
 224 __exctype_l (__isalpha_l);
 225 __exctype_l (__iscntrl_l);
 226 __exctype_l (__isdigit_l);
 227 __exctype_l (__islower_l);
 228 __exctype_l (__isgraph_l);
 229 __exctype_l (__isprint_l);
 230 __exctype_l (__ispunct_l);
 231 __exctype_l (__isspace_l);
 232 __exctype_l (__isupper_l);
 233 __exctype_l (__isxdigit_l);
 234
 235 __exctype_l (__isblank_l);
 236
 237
 238 /* Return the lowercase version of C in locale L.  */
 239 extern int __tolower_l (int __c, __locale_t __l) __THROW;
 240
 241 /* Return the uppercase version of C.  */
 242 extern int __toupper_l (int __c, __locale_t __l) __THROW;
 243
 244 # if __GNUC__ >= 2 && defined __OPTIMIZE__ && !defined __cplusplus
 245 #  define __tolower_l(c, locale) \
 246   __tobody (c, __tolower_l, (locale)->__ctype_tolower, (c, locale))
 247 #  define __toupper_l(c, locale) \
 248   __tobody (c, __toupper_l, (locale)->__ctype_toupper, (c, locale))
 249 # endif /* Optimizing gcc */
 250
 251
 252 # ifndef __NO_CTYPE
 253 #  define __isalnum_l(c,l)      __isctype_l((c), _ISalnum, (l))
 254 #  define __isalpha_l(c,l)      __isctype_l((c), _ISalpha, (l))
 255 #  define __iscntrl_l(c,l)      __isctype_l((c), _IScntrl, (l))
 256 #  define __isdigit_l(c,l)      __isctype_l((c), _ISdigit, (l))
 257 #  define __islower_l(c,l)      __isctype_l((c), _ISlower, (l))
 258 #  define __isgraph_l(c,l)      __isctype_l((c), _ISgraph, (l))
 259 #  define __isprint_l(c,l)      __isctype_l((c), _ISprint, (l))
 260 #  define __ispunct_l(c,l)      __isctype_l((c), _ISpunct, (l))
 261 #  define __isspace_l(c,l)      __isctype_l((c), _ISspace, (l))
 262 #  define __isupper_l(c,l)      __isctype_l((c), _ISupper, (l))
 263 #  define __isxdigit_l(c,l)     __isctype_l((c), _ISxdigit, (l))
 264
 265 #  define __isblank_l(c,l)      __isctype_l((c), _ISblank, (l))
 266
 267 #  if defined __USE_SVID || defined __USE_MISC || defined __USE_XOPEN
 268 #   define __isascii_l(c,l)     __isascii(c)
 269 #   define __toascii_l(c,l)     __toascii(c)
 270 #  endif
 271
 272 # endif /* Not __NO_CTYPE.  */
 273
 274 #endif /* Use GNU.  */
 275
 276 __END_DECLS
 277
 278 #endif /* ctype.h  */