xref: /freebsd/lib/libc/locale/isupper.3 (revision 315ee00fa9616b0a192b6834911f98bcf5316a6b)
1.\" Copyright (c) 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the American National Standards Committee X3, on Information
6.\" Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)isupper.3	8.1 (Berkeley) 6/4/93
33.\"
34.Dd December 19, 2022
35.Dt ISUPPER 3
36.Os
37.Sh NAME
38.Nm isupper ,
39.Nm isupper_l
40.Nd upper-case character test
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In ctype.h
45.Ft int
46.Fn isupper "int c"
47.Ft int
48.Fn isupper_l "int c" "locale_t loc"
49.Sh DESCRIPTION
50The
51.Fn isupper
52and
53.Fn isupper_l
54functions test for any upper-case letter.
55The value of the argument must be representable as an
56.Vt "unsigned char"
57or the value of
58.Dv EOF .
59.Pp
60In the ASCII character set, this includes the following characters
61(with their numeric values shown in octal):
62.Bl -column \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__
63.It "\&101\ ``A''" Ta "102\ ``B''" Ta "103\ ``C''" Ta "104\ ``D''" Ta "105\ ``E''"
64.It "\&106\ ``F''" Ta "107\ ``G''" Ta "110\ ``H''" Ta "111\ ``I''" Ta "112\ ``J''"
65.It "\&113\ ``K''" Ta "114\ ``L''" Ta "115\ ``M''" Ta "116\ ``N''" Ta "117\ ``O''"
66.It "\&120\ ``P''" Ta "121\ ``Q''" Ta "122\ ``R''" Ta "123\ ``S''" Ta "124\ ``T''"
67.It "\&125\ ``U''" Ta "126\ ``V''" Ta "127\ ``W''" Ta "130\ ``X''" Ta "131\ ``Y''"
68.It "\&132\ ``Z''" Ta \& Ta \& Ta \& Ta \&
69.El
70.Pp
71The
72.Fn isupper_l
73function takes an explicit locale argument, whereas the
74.Fn isupper
75function uses the current global or per-thread locale.
76.Sh RETURN VALUES
77The
78.Fn isupper
79and
80.Fn isupper_l
81functions return zero if the character tests false and
82return non-zero if the character tests true.
83.Sh COMPATIBILITY
84The
85.Bx 4.4
86extension of accepting arguments outside of the range of the
87.Vt "unsigned char"
88type in locales with large character sets is considered obsolete
89and may not be supported in future releases.
90The
91.Fn iswupper
92or
93.Fn iswupper_l
94function should be used instead.
95.Sh SEE ALSO
96.Xr ctype 3 ,
97.Xr ctype_l 3 ,
98.Xr iswupper 3 ,
99.Xr iswupper_l 3 ,
100.Xr toupper 3 ,
101.Xr toupper_l 3 ,
102.Xr xlocale 3 ,
103.Xr ascii 7
104.Sh STANDARDS
105The
106.Fn isupper
107function conforms to
108.St -isoC .
109.Sh HISTORY
110The
111.Fn isupper
112function first appeared in
113.At v7 .
114