xref: /freebsd/include/_ctype.h (revision 6780ab54325a71e7e70112b11657973edde8655e)
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. All advertising materials mentioning features or use of this software
22  *    must display the following acknowledgement:
23  *	This product includes software developed by the University of
24  *	California, Berkeley and its contributors.
25  * 4. Neither the name of the University nor the names of its contributors
26  *    may be used to endorse or promote products derived from this software
27  *    without specific prior written permission.
28  *
29  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39  * SUCH DAMAGE.
40  *
41  *	@(#)ctype.h	8.4 (Berkeley) 1/21/94
42  *      $FreeBSD$
43  */
44 
45 #ifndef _CTYPE_H_
46 #define	_CTYPE_H_
47 
48 #include <sys/cdefs.h>
49 #include <sys/_types.h>
50 
51 #define	_CTYPE_A	0x00000100L		/* Alpha */
52 #define	_CTYPE_C	0x00000200L		/* Control */
53 #define	_CTYPE_D	0x00000400L		/* Digit */
54 #define	_CTYPE_G	0x00000800L		/* Graph */
55 #define	_CTYPE_L	0x00001000L		/* Lower */
56 #define	_CTYPE_P	0x00002000L		/* Punct */
57 #define	_CTYPE_S	0x00004000L		/* Space */
58 #define	_CTYPE_U	0x00008000L		/* Upper */
59 #define	_CTYPE_X	0x00010000L		/* X digit */
60 #define	_CTYPE_B	0x00020000L		/* Blank */
61 #define	_CTYPE_R	0x00040000L		/* Print */
62 #define	_CTYPE_I	0x00080000L		/* Ideogram */
63 #define	_CTYPE_T	0x00100000L		/* Special */
64 #define	_CTYPE_Q	0x00200000L		/* Phonogram */
65 #define	_CTYPE_SW0	0x20000000L		/* 0 width character */
66 #define	_CTYPE_SW1	0x40000000L		/* 1 width character */
67 #define	_CTYPE_SW2	0x80000000L		/* 2 width character */
68 #define	_CTYPE_SW3	0xc0000000L		/* 3 width character */
69 
70 __BEGIN_DECLS
71 int	isalnum(int);
72 int	isalpha(int);
73 int	iscntrl(int);
74 int	isdigit(int);
75 int	isgraph(int);
76 int	islower(int);
77 int	isprint(int);
78 int	ispunct(int);
79 int	isspace(int);
80 int	isupper(int);
81 int	isxdigit(int);
82 int	tolower(int);
83 int	toupper(int);
84 
85 #if __XSI_VISIBLE
86 int	_tolower(int);
87 int	_toupper(int);
88 int	isascii(int);
89 int	toascii(int);
90 #endif
91 
92 #if __BSD_VISIBLE
93 int	digittoint(int);
94 int	isblank(int);
95 int	ishexnumber(int);
96 int	isideogram(int);
97 int	isnumber(int);
98 int	isphonogram(int);
99 int	isrune(int);
100 int	isspecial(int);
101 #endif
102 __END_DECLS
103 
104 #define	isalnum(c)	__istype((c), _CTYPE_A|_CTYPE_D)
105 #define	isalpha(c)	__istype((c), _CTYPE_A)
106 #define	iscntrl(c)	__istype((c), _CTYPE_C)
107 #define	isdigit(c)	__isctype((c), _CTYPE_D) /* ANSI -- locale independent */
108 #define	isgraph(c)	__istype((c), _CTYPE_G)
109 #define	islower(c)	__istype((c), _CTYPE_L)
110 #define	isprint(c)	__istype((c), _CTYPE_R)
111 #define	ispunct(c)	__istype((c), _CTYPE_P)
112 #define	isspace(c)	__istype((c), _CTYPE_S)
113 #define	isupper(c)	__istype((c), _CTYPE_U)
114 #define	isxdigit(c)	__isctype((c), _CTYPE_X) /* ANSI -- locale independent */
115 #define	tolower(c)	__tolower(c)
116 #define	toupper(c)	__toupper(c)
117 
118 #if __XSI_VISIBLE
119 /*
120  * POSIX.1-2001 specifies _tolower() and _toupper() to be macros equivalent to
121  * tolower() and toupper() respectively, minus extra checking to ensure that
122  * the argument is a lower or uppercase letter respectively.  We've chosen to
123  * implement these macros with the same error checking as tolower() and
124  * toupper() since this doesn't violate the specification itself, only its
125  * intent.  We purposely leave _tolower() and _toupper() undocumented to
126  * discourage their use.
127  *
128  * XXX isascii() and toascii() should similarly be undocumented.
129  */
130 #define	_tolower(c)	__tolower(c)
131 #define	_toupper(c)	__toupper(c)
132 #define	isascii(c)	(((c) & ~0x7F) == 0)
133 #define	toascii(c)	((c) & 0x7F)
134 #endif
135 
136 #if __BSD_VISIBLE
137 #define	digittoint(c)	__maskrune((c), 0xFF)
138 #define	isblank(c)	__istype((c), _CTYPE_B)
139 #define	ishexnumber(c)	__istype((c), _CTYPE_X)
140 #define	isideogram(c)	__istype((c), _CTYPE_I)
141 #define	isnumber(c)	__istype((c), _CTYPE_D)
142 #define	isphonogram(c)	__istype((c), _CTYPE_Q)
143 #define	isrune(c)	__istype((c), 0xFFFFFF00L)
144 #define	isspecial(c)	__istype((c), _CTYPE_T)
145 #endif
146 
147 /* See comments in <sys/_types.h> about __ct_rune_t. */
148 __BEGIN_DECLS
149 unsigned long	___runetype(__ct_rune_t);
150 __ct_rune_t	___tolower(__ct_rune_t);
151 __ct_rune_t	___toupper(__ct_rune_t);
152 __END_DECLS
153 
154 /*
155  * _EXTERNALIZE_CTYPE_INLINES_ is defined in locale/nomacros.c to tell us
156  * to generate code for extern versions of all our inline functions.
157  */
158 #ifdef _EXTERNALIZE_CTYPE_INLINES_
159 #define	_USE_CTYPE_INLINE_
160 #define	static
161 #define	__inline
162 #endif
163 
164 /*
165  * <runetype.h> brings namespace pollution (struct member names).  This prevents
166  * us from using the inline optimizations in the more strict __POSIX_VISIBLE and
167  * __XSI_VISIBLE namespaces.  To fix this properly would require that we rename
168  * member names of long-standing structs, or something equally evil.
169  */
170 #if !__BSD_VISIBLE && !defined(_USE_CTYPE_INLINE_) && \
171     !defined(_DONT_USE_CTYPE_INLINE_)
172 #define	_DONT_USE_CTYPE_INLINE_
173 #endif
174 
175 /*
176  * Use inline functions if we are allowed to and the compiler supports them.
177  */
178 #if !defined(_DONT_USE_CTYPE_INLINE_) && \
179     (defined(_USE_CTYPE_INLINE_) || defined(__GNUC__) || defined(__cplusplus))
180 
181 #include <runetype.h>
182 
183 static __inline int
184 __maskrune(__ct_rune_t _c, unsigned long _f)
185 {
186 	return ((_c < 0 || _c >= _CACHED_RUNES) ? ___runetype(_c) :
187 		_CurrentRuneLocale->runetype[_c]) & _f;
188 }
189 
190 static __inline int
191 __istype(__ct_rune_t _c, unsigned long _f)
192 {
193 	return (!!__maskrune(_c, _f));
194 }
195 
196 static __inline int
197 __isctype(__ct_rune_t _c, unsigned long _f)
198 {
199 	return (_c < 0 || _c >= _CACHED_RUNES) ? 0 :
200 	       !!(_DefaultRuneLocale.runetype[_c] & _f);
201 }
202 
203 static __inline __ct_rune_t
204 __toupper(__ct_rune_t _c)
205 {
206 	return (_c < 0 || _c >= _CACHED_RUNES) ? ___toupper(_c) :
207 	       _CurrentRuneLocale->mapupper[_c];
208 }
209 
210 static __inline __ct_rune_t
211 __tolower(__ct_rune_t _c)
212 {
213 	return (_c < 0 || _c >= _CACHED_RUNES) ? ___tolower(_c) :
214 	       _CurrentRuneLocale->maplower[_c];
215 }
216 
217 #else /* not using inlines */
218 
219 __BEGIN_DECLS
220 int		__maskrune(__ct_rune_t, unsigned long);
221 int		__istype(__ct_rune_t, unsigned long);
222 int		__isctype(__ct_rune_t, unsigned long);
223 __ct_rune_t	__toupper(__ct_rune_t);
224 __ct_rune_t	__tolower(__ct_rune_t);
225 __END_DECLS
226 #endif /* using inlines */
227 
228 #endif /* !_CTYPE_H_ */
229