xref: /freebsd/lib/libc/locale/isupper.3 (revision 4b9d6057)
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.Dd December 19, 2022
33.Dt ISUPPER 3
34.Os
35.Sh NAME
36.Nm isupper ,
37.Nm isupper_l
38.Nd upper-case character test
39.Sh LIBRARY
40.Lb libc
41.Sh SYNOPSIS
42.In ctype.h
43.Ft int
44.Fn isupper "int c"
45.Ft int
46.Fn isupper_l "int c" "locale_t loc"
47.Sh DESCRIPTION
48The
49.Fn isupper
50and
51.Fn isupper_l
52functions test for any upper-case letter.
53The value of the argument must be representable as an
54.Vt "unsigned char"
55or the value of
56.Dv EOF .
57.Pp
58In the ASCII character set, this includes the following characters
59(with their numeric values shown in octal):
60.Bl -column \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__
61.It "\&101\ ``A''" Ta "102\ ``B''" Ta "103\ ``C''" Ta "104\ ``D''" Ta "105\ ``E''"
62.It "\&106\ ``F''" Ta "107\ ``G''" Ta "110\ ``H''" Ta "111\ ``I''" Ta "112\ ``J''"
63.It "\&113\ ``K''" Ta "114\ ``L''" Ta "115\ ``M''" Ta "116\ ``N''" Ta "117\ ``O''"
64.It "\&120\ ``P''" Ta "121\ ``Q''" Ta "122\ ``R''" Ta "123\ ``S''" Ta "124\ ``T''"
65.It "\&125\ ``U''" Ta "126\ ``V''" Ta "127\ ``W''" Ta "130\ ``X''" Ta "131\ ``Y''"
66.It "\&132\ ``Z''" Ta \& Ta \& Ta \& Ta \&
67.El
68.Pp
69The
70.Fn isupper_l
71function takes an explicit locale argument, whereas the
72.Fn isupper
73function uses the current global or per-thread locale.
74.Sh RETURN VALUES
75The
76.Fn isupper
77and
78.Fn isupper_l
79functions return zero if the character tests false and
80return non-zero if the character tests true.
81.Sh COMPATIBILITY
82The
83.Bx 4.4
84extension of accepting arguments outside of the range of the
85.Vt "unsigned char"
86type in locales with large character sets is considered obsolete
87and may not be supported in future releases.
88The
89.Fn iswupper
90or
91.Fn iswupper_l
92function should be used instead.
93.Sh SEE ALSO
94.Xr ctype 3 ,
95.Xr ctype_l 3 ,
96.Xr iswupper 3 ,
97.Xr iswupper_l 3 ,
98.Xr toupper 3 ,
99.Xr toupper_l 3 ,
100.Xr xlocale 3 ,
101.Xr ascii 7
102.Sh STANDARDS
103The
104.Fn isupper
105function conforms to
106.St -isoC .
107.Sh HISTORY
108The
109.Fn isupper
110function first appeared in
111.At v7 .
112