xref: /freebsd/lib/libc/locale/isalnum.3 (revision b3e7694832e81d7a904a10f525f8797b753bf0d3)
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.\"     @(#)isalnum.3	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD$
34.\"
35.Dd December 19, 2022
36.Dt ISALNUM 3
37.Os
38.Sh NAME
39.Nm isalnum ,
40.Nm isalnum_l
41.Nd alphanumeric character test
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.In ctype.h
46.Ft int
47.Fn isalnum "int c"
48.Ft int
49.Fn isalnum_l "int c" "locale_t loc"
50.Sh DESCRIPTION
51The
52.Fn isalnum
53and
54.Fn isalnum_l
55functions test for any character for which
56.Xr isalpha 3 ,
57.Xr isalpha_l 3
58or
59.Xr isdigit 3 ,
60.Xr isdigit_l 3
61is true.
62The value of the argument must be representable as an
63.Vt "unsigned char"
64or the value of
65.Dv EOF .
66.Pp
67In the ASCII character set, this includes the following characters
68(with their numeric values shown in octal):
69.Bl -column \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__
70.It "\&060\ ``0''" Ta "061\ ``1''" Ta "062\ ``2''" Ta "063\ ``3''" Ta "064\ ``4''"
71.It "\&065\ ``5''" Ta "066\ ``6''" Ta "067\ ``7''" Ta "070\ ``8''" Ta "071\ ``9''"
72.It "\&101\ ``A''" Ta "102\ ``B''" Ta "103\ ``C''" Ta "104\ ``D''" Ta "105\ ``E''"
73.It "\&106\ ``F''" Ta "107\ ``G''" Ta "110\ ``H''" Ta "111\ ``I''" Ta "112\ ``J''"
74.It "\&113\ ``K''" Ta "114\ ``L''" Ta "115\ ``M''" Ta "116\ ``N''" Ta "117\ ``O''"
75.It "\&120\ ``P''" Ta "121\ ``Q''" Ta "122\ ``R''" Ta "123\ ``S''" Ta "124\ ``T''"
76.It "\&125\ ``U''" Ta "126\ ``V''" Ta "127\ ``W''" Ta "130\ ``X''" Ta "131\ ``Y''"
77.It "\&132\ ``Z''" Ta "141\ ``a''" Ta "142\ ``b''" Ta "143\ ``c''" Ta "144\ ``d''"
78.It "\&145\ ``e''" Ta "146\ ``f''" Ta "147\ ``g''" Ta "150\ ``h''" Ta "151\ ``i''"
79.It "\&152\ ``j''" Ta "153\ ``k''" Ta "154\ ``l''" Ta "155\ ``m''" Ta "156\ ``n''"
80.It "\&157\ ``o''" Ta "160\ ``p''" Ta "161\ ``q''" Ta "162\ ``r''" Ta "163\ ``s''"
81.It "\&164\ ``t''" Ta "165\ ``u''" Ta "166\ ``v''" Ta "167\ ``w''" Ta "170\ ``x''"
82.It "\&171\ ``y''" Ta "172\ ``z''" Ta \& Ta \& Ta \&
83.El
84.Pp
85The
86.Fn isalnum_l
87function takes an explicit locale argument, whereas the
88.Fn isalnum
89function uses the current global or per-thread locale.
90.Sh RETURN VALUES
91The
92.Fn isalnum
93and
94.Fn isalnum_l
95functions return zero if the character tests false and
96return non-zero if the character tests true.
97.Sh COMPATIBILITY
98The
99.Bx 4.4
100extension of accepting arguments outside of the range of the
101.Vt "unsigned char"
102type in locales with large character sets is considered obsolete
103and may not be supported in future releases.
104The
105.Fn iswalnum
106or
107.Fn iswalnum_l
108function should be used instead.
109.Sh SEE ALSO
110.Xr ctype 3 ,
111.Xr ctype_l 3 ,
112.Xr isalpha 3 ,
113.Xr isalpha_l 3 ,
114.Xr isdigit 3 ,
115.Xr isdigit_l 3 ,
116.Xr iswalnum 3 ,
117.Xr iswalnum_l 3 ,
118.Xr xlocale 3 ,
119.Xr ascii 7
120.Sh STANDARDS
121The
122.Fn isalnum
123function conforms to
124.St -isoC .
125The
126.Fn isalnum_l
127function conforms to
128.St -p1003.1-2008 .
129.Sh HISTORY
130The
131.Fn isalnum
132function first appeared in
133.At v7 .
134