Don't user __tolower directly for tolower implementation. Use inline
[kopensolaris-gnu/glibc.git] / ctype / ctype.h
1 /* Copyright (C) 1991,92,93,95,96,97,98,99 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 Library General Public License as
6    published by the Free Software Foundation; either version 2 of the
7    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    Library General Public License for more details.
13
14    You should have received a copy of the GNU Library General Public
15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17    Boston, MA 02111-1307, USA.  */
18
19 /*
20  *      ISO C Standard 4.3: 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 __tolower(c)    ((int) __ctype_tolower[(int) (c)])
86 #define __toupper(c)    ((int) __ctype_toupper[(int) (c)])
87
88 #define __exctype(name) extern int name __P ((int))
89
90 /* The following names are all functions:
91      int isCHARACTERISTIC(int c);
92    which return nonzero iff C has CHARACTERISTIC.
93    For the meaning of the characteristic names, see the `enum' above.  */
94 __exctype (isalnum);
95 __exctype (isalpha);
96 __exctype (iscntrl);
97 __exctype (isdigit);
98 __exctype (islower);
99 __exctype (isgraph);
100 __exctype (isprint);
101 __exctype (ispunct);
102 __exctype (isspace);
103 __exctype (isupper);
104 __exctype (isxdigit);
105
106 #ifdef  __USE_GNU
107 __exctype (isblank);
108 #endif
109
110
111 /* Return the lowercase version of C.  */
112 extern int tolower __P ((int __c));
113
114 /* Return the uppercase version of C.  */
115 extern int toupper __P ((int __c));
116
117
118 #if defined __USE_SVID || defined __USE_MISC || defined __USE_XOPEN
119
120 /* Return nonzero iff C is in the ASCII set
121    (i.e., is no more than 7 bits wide).  */
122 extern int isascii __P ((int __c));
123
124 /* Return the part of C that is in the ASCII set
125    (i.e., the low-order 7 bits of C).  */
126 extern int toascii __P ((int __c));
127
128 #endif /* Use SVID or use misc.  */
129
130 #if defined __USE_SVID || defined __USE_MISC || defined __USE_XOPEN
131 /* These are the same as `toupper' and `tolower'.  */
132 __exctype (_toupper);
133 __exctype (_tolower);
134 #endif
135
136 #ifndef __NO_CTYPE
137 # define isalnum(c)     __isctype((c), _ISalnum)
138 # define isalpha(c)     __isctype((c), _ISalpha)
139 # define iscntrl(c)     __isctype((c), _IScntrl)
140 # define isdigit(c)     __isctype((c), _ISdigit)
141 # define islower(c)     __isctype((c), _ISlower)
142 # define isgraph(c)     __isctype((c), _ISgraph)
143 # define isprint(c)     __isctype((c), _ISprint)
144 # define ispunct(c)     __isctype((c), _ISpunct)
145 # define isspace(c)     __isctype((c), _ISspace)
146 # define isupper(c)     __isctype((c), _ISupper)
147 # define isxdigit(c)    __isctype((c), _ISxdigit)
148
149 #ifdef  __USE_GNU
150 # define isblank(c)     __isctype((c), _ISblank)
151 #endif
152
153 #if __GNUC__ >= 2
154 extern inline int
155 tolower (int __c)
156 {
157   return __c >= -128 && __c < 256 ? __tolower (__c) : __c;
158 }
159
160 extern inline int
161 toupper (int __c)
162 {
163   return __c >= -128 && __c < 256 ? __toupper (__c) : __c;
164 }
165 #endif
166
167 #if defined __USE_SVID || defined __USE_MISC || defined __USE_XOPEN
168 # define isascii(c)     __isascii(c)
169 # define toascii(c)     __toascii(c)
170
171 # define _tolower(c)    __tolower(c)
172 # define _toupper(c)    __toupper(c)
173 #endif
174
175 #endif /* Not __NO_CTYPE.  */
176
177
178 #ifdef __USE_GNU
179 /* The concept of one static locale per category is not very well
180    thought out.  Many applications will need to process its data using
181    information from several different locales.  Another application is
182    the implementation of the internationalization handling in the
183    upcoming ISO C++ standard library.  To support this another set of
184    the functions using locale data exist which have an additional
185    argument.
186
187    Attention: all these functions are *not* standardized in any form.
188    This is a proof-of-concept implementation.  */
189
190 /* Structure for reentrant locale using functions.  This is an
191    (almost) opaque type for the user level programs.  */
192 # include <xlocale.h>
193
194 /* These definitions are similar to the ones above but all functions
195    take as an argument a handle for the locale which shall be used.  */
196 # define __isctype_l(c, type, locale) \
197   ((locale)->__ctype_b[(int) (c)] & (unsigned short int) type)
198
199 # define __tolower_l(c, locale) ((int) (locale)->__ctype_tolower[(int) (c)])
200 # define __toupper_l(c, locale) ((int) (locale)->__ctype_toupper[(int) (c)])
201
202 # define __exctype_l(name)      extern int name __P ((int, __locale_t))
203
204 /* The following names are all functions:
205      int isCHARACTERISTIC(int c, locale_t *locale);
206    which return nonzero iff C has CHARACTERISTIC.
207    For the meaning of the characteristic names, see the `enum' above.  */
208 __exctype_l (__isalnum_l);
209 __exctype_l (__isalpha_l);
210 __exctype_l (__iscntrl_l);
211 __exctype_l (__isdigit_l);
212 __exctype_l (__islower_l);
213 __exctype_l (__isgraph_l);
214 __exctype_l (__isprint_l);
215 __exctype_l (__ispunct_l);
216 __exctype_l (__isspace_l);
217 __exctype_l (__isupper_l);
218 __exctype_l (__isxdigit_l);
219
220 __exctype_l (__isblank_l);
221
222
223 /* Return the lowercase version of C in locale L.  */
224 extern int __tolower_l __P ((int __c, __locale_t __l));
225
226 /* Return the uppercase version of C.  */
227 extern int __toupper_l __P ((int __c, __locale_t __l));
228
229
230 # ifndef __NO_CTYPE
231 #  define __isalnum_l(c,l)      __isctype_l((c), _ISalnum, (l))
232 #  define __isalpha_l(c,l)      __isctype_l((c), _ISalpha, (l))
233 #  define __iscntrl_l(c,l)      __isctype_l((c), _IScntrl, (l))
234 #  define __isdigit_l(c,l)      __isctype_l((c), _ISdigit, (l))
235 #  define __islower_l(c,l)      __isctype_l((c), _ISlower, (l))
236 #  define __isgraph_l(c,l)      __isctype_l((c), _ISgraph, (l))
237 #  define __isprint_l(c,l)      __isctype_l((c), _ISprint, (l))
238 #  define __ispunct_l(c,l)      __isctype_l((c), _ISpunct, (l))
239 #  define __isspace_l(c,l)      __isctype_l((c), _ISspace, (l))
240 #  define __isupper_l(c,l)      __isctype_l((c), _ISupper, (l))
241 #  define __isxdigit_l(c,l)     __isctype_l((c), _ISxdigit, (l))
242
243 #  define __isblank_l(c,l)      __isctype_l((c), _ISblank, (l))
244
245 #  if defined __USE_SVID || defined __USE_MISC || defined __USE_XOPEN
246 #   define __isascii_l(c,l)     __isascii(c)
247 #   define __toascii_l(c,l)     __toascii(c)
248 #  endif
249
250 # endif /* Not __NO_CTYPE.  */
251
252 #endif /* Use GNU.  */
253
254 __END_DECLS
255
256 #endif /* ctype.h  */