xref: /dragonfly/include/ctype.h (revision 9348a738)
1 /*
2  * Copyright (c) 1989, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * This code is derived from software contributed to Berkeley by
11  * Paul Borman at Krystal Technologies.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *	@(#)ctype.h	8.4 (Berkeley) 1/21/94
38  *      $FreeBSD: head/include/ctype.h 233600 2012-03-28 12:11:54Z theraven $
39  */
40 
41 #ifndef _CTYPE_H_
42 #define _CTYPE_H_
43 
44 #include <sys/cdefs.h>
45 #include <sys/types.h>
46 
47 #define	_CTYPE_A	0x00000100L		/* Alpha */
48 #define	_CTYPE_C	0x00000200L		/* Control */
49 #define	_CTYPE_D	0x00000400L		/* Digit */
50 #define	_CTYPE_G	0x00000800L		/* Graph */
51 #define	_CTYPE_L	0x00001000L		/* Lower */
52 #define	_CTYPE_P	0x00002000L		/* Punct */
53 #define	_CTYPE_S	0x00004000L		/* Space */
54 #define	_CTYPE_U	0x00008000L		/* Upper */
55 #define	_CTYPE_X	0x00010000L		/* X digit */
56 #define	_CTYPE_B	0x00020000L		/* Blank */
57 #define	_CTYPE_R	0x00040000L		/* Print */
58 #define	_CTYPE_I	0x00080000L		/* Ideogram */
59 #define	_CTYPE_T	0x00100000L		/* Special */
60 #define	_CTYPE_Q	0x00200000L		/* Phonogram */
61 #define	_CTYPE_N	0x00400000L		/* Number (superset of digit) */
62 #define	_CTYPE_SW0	0x20000000L		/* 0 width character */
63 #define	_CTYPE_SW1	0x40000000L		/* 1 width character */
64 #define	_CTYPE_SW2	0x80000000L		/* 2 width character */
65 #define	_CTYPE_SW3	0xc0000000L		/* 3 width character */
66 #define	_CTYPE_SWM	0xe0000000L		/* Mask for screen width data */
67 #define	_CTYPE_SWS	30			/* Bits to shift to get width */
68 
69 /* See comments in <sys/_types.h> about __ct_rune_t. */
70 __BEGIN_DECLS
71 unsigned long	___runetype(__ct_rune_t) __pure;
72 __ct_rune_t	___tolower(__ct_rune_t) __pure;
73 __ct_rune_t	___toupper(__ct_rune_t) __pure;
74 __END_DECLS
75 
76 /*
77  * _EXTERNALIZE_CTYPE_INLINES_ is defined in locale/nomacros.c to tell us
78  * to generate code for extern versions of all our inline functions.
79  */
80 #ifdef _EXTERNALIZE_CTYPE_INLINES_
81 #define	_USE_CTYPE_INLINE_
82 #define	static
83 #undef	__inline
84 #define	__inline
85 #undef	__always_inline
86 #define	__always_inline
87 #endif
88 
89 extern int __mb_sb_limit;
90 
91 /*
92  * Use inline functions if we are allowed to and the compiler supports them.
93  */
94 #if !defined(_DONT_USE_CTYPE_INLINE_) && \
95     (defined(_USE_CTYPE_INLINE_) || defined(__GNUC__) || defined(__cplusplus))
96 
97 #include <runetype.h>
98 
99 static __inline __always_inline int
100 __maskrune(__ct_rune_t _c, unsigned long _f)
101 {
102 	return ((_c < 0 || _c >= _CACHED_RUNES) ? ___runetype(_c) :
103 		_CurrentRuneLocale->__runetype[_c]) & _f;
104 }
105 
106 static __inline __always_inline int
107 __sbmaskrune(__ct_rune_t _c, unsigned long _f)
108 {
109 	return (_c < 0 || _c >= __mb_sb_limit) ? 0 :
110 	       _CurrentRuneLocale->__runetype[_c] & _f;
111 }
112 
113 static __inline __always_inline int
114 __istype(__ct_rune_t _c, unsigned long _f)
115 {
116 	return (!!__maskrune(_c, _f));
117 }
118 
119 static __inline __always_inline int
120 __sbistype(__ct_rune_t _c, unsigned long _f)
121 {
122 	return (!!__sbmaskrune(_c, _f));
123 }
124 
125 static __inline __always_inline int
126 __isctype(__ct_rune_t _c, unsigned long _f)
127 {
128 	return (_c < 0 || _c >= 128) ? 0 :
129 	       !!(_DefaultRuneLocale.__runetype[_c] & _f);
130 }
131 
132 static __inline __always_inline __ct_rune_t
133 __toupper(__ct_rune_t _c)
134 {
135 	return (_c < 0 || _c >= _CACHED_RUNES) ? ___toupper(_c) :
136 	       _CurrentRuneLocale->__mapupper[_c];
137 }
138 
139 static __inline __always_inline __ct_rune_t
140 __sbtoupper(__ct_rune_t _c)
141 {
142 	return (_c < 0 || _c >= __mb_sb_limit) ? _c :
143 	       _CurrentRuneLocale->__mapupper[_c];
144 }
145 
146 static __inline __always_inline __ct_rune_t
147 __tolower(__ct_rune_t _c)
148 {
149 	return (_c < 0 || _c >= _CACHED_RUNES) ? ___tolower(_c) :
150 	       _CurrentRuneLocale->__maplower[_c];
151 }
152 
153 static __inline __always_inline __ct_rune_t
154 __sbtolower(__ct_rune_t _c)
155 {
156 	return (_c < 0 || _c >= __mb_sb_limit) ? _c :
157 	       _CurrentRuneLocale->__maplower[_c];
158 }
159 
160 static __inline __always_inline int
161 __wcwidth(__ct_rune_t _c)
162 {
163 	unsigned int _x;
164 
165 	if (_c == 0)
166 		return (0);
167 	_x = (unsigned int)__maskrune(_c, _CTYPE_SWM|_CTYPE_R);
168 	if ((_x & _CTYPE_SWM) != 0)
169 		return ((_x & _CTYPE_SWM) >> _CTYPE_SWS);
170 	return ((_x & _CTYPE_R) != 0 ? 1 : -1);
171 }
172 
173 #else /* not using inlines */
174 
175 __BEGIN_DECLS
176 int		__maskrune(__ct_rune_t, unsigned long);
177 int		__sbmaskrune(__ct_rune_t, unsigned long);
178 int		__istype(__ct_rune_t, unsigned long);
179 int		__sbistype(__ct_rune_t, unsigned long);
180 int		__isctype(__ct_rune_t, unsigned long);
181 __ct_rune_t	__toupper(__ct_rune_t);
182 __ct_rune_t	__sbtoupper(__ct_rune_t);
183 __ct_rune_t	__tolower(__ct_rune_t);
184 __ct_rune_t	__sbtolower(__ct_rune_t);
185 int		__wcwidth(__ct_rune_t);
186 __END_DECLS
187 #endif /* using inlines */
188 
189 
190 __BEGIN_DECLS
191 int	isalnum(int);
192 int	isalpha(int);
193 int	iscntrl(int);
194 int	isdigit(int);
195 int	isgraph(int);
196 int	islower(int);
197 int	isprint(int);
198 int	ispunct(int);
199 int	isspace(int);
200 int	isupper(int);
201 int	isxdigit(int);
202 int	tolower(int);
203 int	toupper(int);
204 
205 #if __XSI_VISIBLE
206 int	isascii(int);
207 int	toascii(int);
208 #endif
209 
210 #if __ISO_C_VISIBLE >= 1999
211 int	isblank(int);
212 #endif
213 
214 #if __BSD_VISIBLE
215 int	digittoint(int);
216 int	ishexnumber(int);
217 int	isideogram(int);
218 int	isnumber(int);
219 int	isphonogram(int);
220 int	isrune(int);
221 int	isspecial(int);
222 #endif
223 
224 #if __POSIX_VISIBLE >= 200809 || defined(_XLOCALE_H_)
225 #include <xlocale/_ctype.h>
226 #endif
227 __END_DECLS
228 
229 #ifndef __cplusplus
230 #define	isalnum(c)	__sbistype((c), _CTYPE_A|_CTYPE_D|_CTYPE_N)
231 #define	isalpha(c)	__sbistype((c), _CTYPE_A)
232 #define	iscntrl(c)	__sbistype((c), _CTYPE_C)
233 #define	isdigit(c)	__sbistype((c), _CTYPE_D)
234 #define	isgraph(c)	__sbistype((c), _CTYPE_G)
235 #define	islower(c)	__sbistype((c), _CTYPE_L)
236 #define	isprint(c)	__sbistype((c), _CTYPE_R)
237 #define	ispunct(c)	__sbistype((c), _CTYPE_P)
238 #define	isspace(c)	__sbistype((c), _CTYPE_S)
239 #define	isupper(c)	__sbistype((c), _CTYPE_U)
240 #define	isxdigit(c)	__sbistype((c), _CTYPE_X)
241 #define	tolower(c)	__sbtolower(c)
242 #define	toupper(c)	__sbtoupper(c)
243 #endif /* !__cplusplus */
244 
245 #if __XSI_VISIBLE
246 /*
247  * POSIX.1-2001 specifies _tolower() and _toupper() to be macros equivalent to
248  * tolower() and toupper() respectively, minus extra checking to ensure that
249  * the argument is a lower or uppercase letter respectively.  We've chosen to
250  * implement these macros with the same error checking as tolower() and
251  * toupper() since this doesn't violate the specification itself, only its
252  * intent.  We purposely leave _tolower() and _toupper() undocumented to
253  * discourage their use.
254  *
255  * XXX isascii() and toascii() should similarly be undocumented.
256  */
257 #define	_tolower(c)	__sbtolower(c)
258 #define	_toupper(c)	__sbtoupper(c)
259 #define	isascii(c)	(((c) & ~0x7F) == 0)
260 #define	toascii(c)	((c) & 0x7F)
261 #endif
262 
263 #if __ISO_C_VISIBLE >= 1999 && !defined(__cplusplus)
264 #define	isblank(c)	__sbistype((c), _CTYPE_B)
265 #endif
266 
267 #if __BSD_VISIBLE
268 #define	digittoint(c)	__sbmaskrune((c), 0xFF)
269 #define	ishexnumber(c)	__sbistype((c), _CTYPE_X)
270 #define	isideogram(c)	__sbistype((c), _CTYPE_I)
271 #define	isnumber(c)	__sbistype((c), _CTYPE_D|_CTYPE_N)
272 #define	isphonogram(c)	__sbistype((c), _CTYPE_Q)
273 #define	isrune(c)	__sbistype((c), 0xFFFFFF00L)
274 #define	isspecial(c)	__sbistype((c), _CTYPE_T)
275 #endif
276 
277 #endif /* !_CTYPE_H_ */
278