summaryrefslogtreecommitdiff
path: root/static/netbsd/man3/ctype.3
blob: 0286714df5e9ca783d70036689063421030079a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
.\"	$NetBSD: ctype.3,v 1.35 2025/10/05 00:35:47 riastradh Exp $
.\"
.\" Copyright (c) 1991 Regents of the University of California.
.\" All rights reserved.
.\"
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)ctype.3	6.5 (Berkeley) 4/19/91
.\"
.Dd September 14, 2025
.Dt CTYPE 3
.Os
.Sh NAME
.Nm ctype
.Nd character classification and mapping functions
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In ctype.h
.Fn isalpha "int c"
.Fn isupper "int c"
.Fn islower "int c"
.Fn isdigit "int c"
.Fn isxdigit "int c"
.Fn isalnum "int c"
.Fn isspace "int c"
.Fn ispunct "int c"
.Fn isprint "int c"
.Fn isgraph "int c"
.Fn iscntrl "int c"
.Fn isblank "int c"
.Fn toupper "int c"
.Fn tolower "int c"
.Sh DESCRIPTION
The above functions perform character tests and conversions on the integer
.Ar c .
.Pp
See the specific manual pages for information about the
test or conversion performed by each function.
.Sh ENVIRONMENT
In
.Nx 11 ,
the
.Nm
functions will always crash with a signal on certain invalid inputs as
a diagnostic aid for applications; see
.Sx CAVEATS .
Setting the environment variable
.Ev LIBC_ALLOWCTYPEABUSE
before starting a program will restore the old behavior of returning
nonsense answers for these inputs, or sometimes but not always
crashing, depending on factors such as address space layout
randomization.
.Sh EXAMPLES
To print an upper-case version of a string to stdout,
the following code can be used:
.Bd -literal -offset indent
const char *s = "xyz";

while (*s != '\e0') {
    putchar(toupper((unsigned char)*s));
    s++;
}
.Ed
.Sh SEE ALSO
.Xr isalnum 3 ,
.Xr isalpha 3 ,
.Xr isblank 3 ,
.Xr iscntrl 3 ,
.Xr isdigit 3 ,
.Xr isgraph 3 ,
.Xr islower 3 ,
.Xr isprint 3 ,
.Xr ispunct 3 ,
.Xr isspace 3 ,
.Xr isupper 3 ,
.Xr isxdigit 3 ,
.Xr tolower 3 ,
.Xr toupper 3 ,
.Xr ascii 7
.Sh STANDARDS
These functions, with the exception of
.Fn isblank ,
conform to
.St -ansiC .
All described functions, including
.Fn isblank ,
also conform to
.St -p1003.1-2001 .
.Sh CAVEATS
The argument of these functions is of type
.Vt int ,
but only a very restricted subset of values are actually valid.
The argument must either be the value of the macro
.Dv EOF
(which has a negative value),
or must be a non-negative value within the range representable as
.Vt unsigned char .
Passing invalid values leads to undefined behavior.
.Pp
Values of type
.Vt int
that were returned by
.Xr getc 3 ,
.Xr fgetc 3 ,
and similar functions or macros
are already in the correct range, and may be safely passed to these
.Nm ctype
functions without any casts.
.Pp
Values of type
.Vt char
or
.Vt signed char
must first be cast to
.Vt unsigned char ,
to ensure that the values are within the correct range.
Casting a negative-valued
.Vt char
or
.Vt signed char
directly to
.Vt int
will produce a negative-valued
.Vt int ,
which will be outside the range of allowed values
(unless it happens to be equal to
.Dv EOF ,
but even that would not give the desired result).
.Pp
Because the bugs may manifest as silent misbehavior or as crashes only
when fed input outside the US-ASCII range, the
.Nx
implementation of the
.Nm
functions is designed to elicit a compiler warning for code that passes
inputs of type
.Vt char
in order to flag code that may pass negative values at runtime that
would lead to undefined behavior:
.Bd -literal -offset indent
#include <ctype.h>
#include <locale.h>
#include <stdio.h>

int
main(int argc, char **argv)
{

	if (argc < 2)
		return 1;
	setlocale(LC_ALL, "");

	printf("  char=%-4d isprint? %d\en",
	    (int)*argv[1],
	    isprint(*argv[1]) ? 1 : 0);
	printf("u_char=%-4d isprint? %d\en",
	    (int)(unsigned char)*argv[1],
	    isprint((unsigned char)*argv[1]) ? 1 : 0);
	return 0;
}
.Ed
.Pp
When compiling this program, GCC reports a warning for the line that
passes
.Vt char .
At runtime, you may get nonsense answers for some inputs without the
cast \(em if you're lucky and it doesn't crash:
.Bd -literal
% gcc -Wall -o test test.c
In file included from /usr/include/ctype.h:100,
                 from test.c:1:
test.c: In function 'main':
test.c:15:21: warning: array subscript has type 'char' [-Wchar-subscripts]
   15 |             isprint(*argv[1]) ? 1 : 0);
      |                     ^
% LC_CTYPE=C ./test $(printf '\e270')
  char=-72  isprint? 1
u_char=184  isprint? 0
% LC_CTYPE=C ./test $(printf '\e377')
  char=-1   isprint? 0
u_char=255  isprint? 0
% LC_CTYPE=fr_FR.ISO8859-1 ./test $(printf '\e377')
  char=-1   isprint? 0
u_char=255  isprint? 1
.Ed
.Pp
Some implementations of libc, such as glibc as of 2018, hide the
undefined behavior by defining the functions to work for all integer
inputs representable by either
.Vt unsigned char
or
.Vt char ,
and suppress the warning.
However, this is not an excuse for avoiding conversion to
.Vt unsigned char :
if
.Dv EOF
coincides with any such value, as it does when it is \-1 on platforms
with signed
.Vt char ,
programs that pass
.Vt char
will still necessarily confuse the classification and mapping of
.Dv EOF
with the classification and mapping of some non-EOF inputs.