1 /* <ctype.h> replacement macros.
2
3 Copyright (C) 2000-2023 Free Software Foundation, Inc.
4 Contributed by Zack Weinberg <zackw@stanford.edu>.
5
6 This file is part of the libiberty library.
7 Libiberty is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Library General Public
9 License as published by the Free Software Foundation; either
10 version 2 of the License, or (at your option) any later version.
11
12 Libiberty is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Library General Public License for more details.
16
17 You should have received a copy of the GNU Library General Public
18 License along with libiberty; see the file COPYING.LIB. If
19 not, write to the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
20 Boston, MA 02110-1301, USA. */
21
22 /*
23
24 @defvr Extension HOST_CHARSET
25 This macro indicates the basic character set and encoding used by the
26 host: more precisely, the encoding used for character constants in
27 preprocessor @samp{#if} statements (the C "execution character set").
28 It is defined by @file{safe-ctype.h}, and will be an integer constant
29 with one of the following values:
30
31 @ftable @code
32 @item HOST_CHARSET_UNKNOWN
33 The host character set is unknown - that is, not one of the next two
34 possibilities.
35
36 @item HOST_CHARSET_ASCII
37 The host character set is ASCII.
38
39 @item HOST_CHARSET_EBCDIC
40 The host character set is some variant of EBCDIC. (Only one of the
41 nineteen EBCDIC varying characters is tested; exercise caution.)
42 @end ftable
43 @end defvr
44
45 @deffn Extension ISALPHA (@var{c})
46 @deffnx Extension ISALNUM (@var{c})
47 @deffnx Extension ISBLANK (@var{c})
48 @deffnx Extension ISCNTRL (@var{c})
49 @deffnx Extension ISDIGIT (@var{c})
50 @deffnx Extension ISGRAPH (@var{c})
51 @deffnx Extension ISLOWER (@var{c})
52 @deffnx Extension ISPRINT (@var{c})
53 @deffnx Extension ISPUNCT (@var{c})
54 @deffnx Extension ISSPACE (@var{c})
55 @deffnx Extension ISUPPER (@var{c})
56 @deffnx Extension ISXDIGIT (@var{c})
57
58 These twelve macros are defined by @file{safe-ctype.h}. Each has the
59 same meaning as the corresponding macro (with name in lowercase)
60 defined by the standard header @file{ctype.h}. For example,
61 @code{ISALPHA} returns true for alphabetic characters and false for
62 others. However, there are two differences between these macros and
63 those provided by @file{ctype.h}:
64
65 @itemize @bullet
66 @item These macros are guaranteed to have well-defined behavior for all
67 values representable by @code{signed char} and @code{unsigned char}, and
68 for @code{EOF}.
69
70 @item These macros ignore the current locale; they are true for these
71 fixed sets of characters:
72 @multitable {@code{XDIGIT}} {yada yada yada yada yada yada yada yada}
73 @item @code{ALPHA} @tab @kbd{A-Za-z}
74 @item @code{ALNUM} @tab @kbd{A-Za-z0-9}
75 @item @code{BLANK} @tab @kbd{space tab}
76 @item @code{CNTRL} @tab @code{!PRINT}
77 @item @code{DIGIT} @tab @kbd{0-9}
78 @item @code{GRAPH} @tab @code{ALNUM || PUNCT}
79 @item @code{LOWER} @tab @kbd{a-z}
80 @item @code{PRINT} @tab @code{GRAPH ||} @kbd{space}
81 @item @code{PUNCT} @tab @kbd{`~!@@#$%^&*()_-=+[@{]@}\|;:'",<.>/?}
82 @item @code{SPACE} @tab @kbd{space tab \n \r \f \v}
83 @item @code{UPPER} @tab @kbd{A-Z}
84 @item @code{XDIGIT} @tab @kbd{0-9A-Fa-f}
85 @end multitable
86
87 Note that, if the host character set is ASCII or a superset thereof,
88 all these macros will return false for all values of @code{char} outside
89 the range of 7-bit ASCII. In particular, both ISPRINT and ISCNTRL return
90 false for characters with numeric values from 128 to 255.
91 @end itemize
92 @end deffn
93
94 @deffn Extension ISIDNUM (@var{c})
95 @deffnx Extension ISIDST (@var{c})
96 @deffnx Extension IS_VSPACE (@var{c})
97 @deffnx Extension IS_NVSPACE (@var{c})
98 @deffnx Extension IS_SPACE_OR_NUL (@var{c})
99 @deffnx Extension IS_ISOBASIC (@var{c})
100 These six macros are defined by @file{safe-ctype.h} and provide
101 additional character classes which are useful when doing lexical
102 analysis of C or similar languages. They are true for the following
103 sets of characters:
104
105 @multitable {@code{SPACE_OR_NUL}} {yada yada yada yada yada yada yada yada}
106 @item @code{IDNUM} @tab @kbd{A-Za-z0-9_}
107 @item @code{IDST} @tab @kbd{A-Za-z_}
108 @item @code{VSPACE} @tab @kbd{\r \n}
109 @item @code{NVSPACE} @tab @kbd{space tab \f \v \0}
110 @item @code{SPACE_OR_NUL} @tab @code{VSPACE || NVSPACE}
111 @item @code{ISOBASIC} @tab @code{VSPACE || NVSPACE || PRINT}
112 @end multitable
113 @end deffn
114
115 */
116
117 #include "ansidecl.h"
118 #include <safe-ctype.h>
119 #include <stdio.h> /* for EOF */
120
121 #if EOF != -1
122 #error "<safe-ctype.h> requires EOF == -1"
123 #endif
124
125 /* Shorthand */
126 #define bl _sch_isblank
127 #define cn _sch_iscntrl
128 #define di _sch_isdigit
129 #define is _sch_isidst
130 #define lo _sch_islower
131 #define nv _sch_isnvsp
132 #define pn _sch_ispunct
133 #define pr _sch_isprint
134 #define sp _sch_isspace
135 #define up _sch_isupper
136 #define vs _sch_isvsp
137 #define xd _sch_isxdigit
138
139 /* Masks. */
140 #define L (const unsigned short) (lo|is |pr) /* lower case letter */
141 #define XL (const unsigned short) (lo|is|xd|pr) /* lowercase hex digit */
142 #define U (const unsigned short) (up|is |pr) /* upper case letter */
143 #define XU (const unsigned short) (up|is|xd|pr) /* uppercase hex digit */
144 #define D (const unsigned short) (di |xd|pr) /* decimal digit */
145 #define P (const unsigned short) (pn |pr) /* punctuation */
146 #define _ (const unsigned short) (pn|is |pr) /* underscore */
147
148 #define C (const unsigned short) ( cn) /* control character */
149 #define Z (const unsigned short) (nv |cn) /* NUL */
150 #define M (const unsigned short) (nv|sp |cn) /* cursor movement: \f \v */
151 #define V (const unsigned short) (vs|sp |cn) /* vertical space: \r \n */
152 #define T (const unsigned short) (nv|sp|bl|cn) /* tab */
153 #define S (const unsigned short) (nv|sp|bl|pr) /* space */
154
155 /* Are we ASCII? */
156 #if HOST_CHARSET == HOST_CHARSET_ASCII
157
158 const unsigned short _sch_istable[256] =
159 {
160 Z, C, C, C, C, C, C, C, /* NUL SOH STX ETX EOT ENQ ACK BEL */
161 C, T, V, M, M, V, C, C, /* BS HT LF VT FF CR SO SI */
162 C, C, C, C, C, C, C, C, /* DLE DC1 DC2 DC3 DC4 NAK SYN ETB */
163 C, C, C, C, C, C, C, C, /* CAN EM SUB ESC FS GS RS US */
164 S, P, P, P, P, P, P, P, /* SP ! " # $ % & ' */
165 P, P, P, P, P, P, P, P, /* ( ) * + , - . / */
166 D, D, D, D, D, D, D, D, /* 0 1 2 3 4 5 6 7 */
167 D, D, P, P, P, P, P, P, /* 8 9 : ; < = > ? */
168 P, XU, XU, XU, XU, XU, XU, U, /* @ A B C D E F G */
169 U, U, U, U, U, U, U, U, /* H I J K L M N O */
170 U, U, U, U, U, U, U, U, /* P Q R S T U V W */
171 U, U, U, P, P, P, P, _, /* X Y Z [ \ ] ^ _ */
172 P, XL, XL, XL, XL, XL, XL, L, /* ` a b c d e f g */
173 L, L, L, L, L, L, L, L, /* h i j k l m n o */
174 L, L, L, L, L, L, L, L, /* p q r s t u v w */
175 L, L, L, P, P, P, P, C, /* x y z { | } ~ DEL */
176
177 /* high half of unsigned char is locale-specific, so all tests are
178 false in "C" locale */
179 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
180 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
181 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
182 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
183
184 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
185 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
186 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
187 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
188 };
189
190 const unsigned char _sch_tolower[256] =
191 {
192 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15,
193 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31,
194 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47,
195 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63,
196 64,
197
198 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
199 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
200
201 91, 92, 93, 94, 95, 96,
202
203 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
204 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
205
206 123,124,125,126,127,
207
208 128,129,130,131, 132,133,134,135, 136,137,138,139, 140,141,142,143,
209 144,145,146,147, 148,149,150,151, 152,153,154,155, 156,157,158,159,
210 160,161,162,163, 164,165,166,167, 168,169,170,171, 172,173,174,175,
211 176,177,178,179, 180,181,182,183, 184,185,186,187, 188,189,190,191,
212
213 192,193,194,195, 196,197,198,199, 200,201,202,203, 204,205,206,207,
214 208,209,210,211, 212,213,214,215, 216,217,218,219, 220,221,222,223,
215 224,225,226,227, 228,229,230,231, 232,233,234,235, 236,237,238,239,
216 240,241,242,243, 244,245,246,247, 248,249,250,251, 252,253,254,255,
217 };
218
219 const unsigned char _sch_toupper[256] =
220 {
221 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15,
222 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31,
223 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47,
224 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63,
225 64,
226
227 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
228 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
229
230 91, 92, 93, 94, 95, 96,
231
232 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
233 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
234
235 123,124,125,126,127,
236
237 128,129,130,131, 132,133,134,135, 136,137,138,139, 140,141,142,143,
238 144,145,146,147, 148,149,150,151, 152,153,154,155, 156,157,158,159,
239 160,161,162,163, 164,165,166,167, 168,169,170,171, 172,173,174,175,
240 176,177,178,179, 180,181,182,183, 184,185,186,187, 188,189,190,191,
241
242 192,193,194,195, 196,197,198,199, 200,201,202,203, 204,205,206,207,
243 208,209,210,211, 212,213,214,215, 216,217,218,219, 220,221,222,223,
244 224,225,226,227, 228,229,230,231, 232,233,234,235, 236,237,238,239,
245 240,241,242,243, 244,245,246,247, 248,249,250,251, 252,253,254,255,
246 };
247
248 #else
249 # if HOST_CHARSET == HOST_CHARSET_EBCDIC
250 #error "FIXME: write tables for EBCDIC"
251 # else
252 #error "Unrecognized host character set"
253 # endif
254 #endif