xref: /dragonfly/lib/libc/locale/isalnum.3 (revision 548a3528)
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.\" 4. 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: head/lib/libc/locale/isalnum.3 233992 2012-04-07 09:05:30Z joel $
34.\"
35.Dd December 25, 2013
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 locale"
50.Sh DESCRIPTION
51The
52.Fn isalnum
53and
54.Fn isalnum_l
55functions test for any character for which
56.Xr isalpha 3
57or
58.Xr isdigit 3
59is true.
60The value of the argument must be representable as an
61.Vt "unsigned char"
62or the value of
63.Dv EOF .
64.Pp
65In the ASCII character set, this includes the following characters
66(with their numeric values shown in octal):
67.Bl -column \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__
68.It "\&060\ ``0''" Ta "061\ ``1''" Ta "062\ ``2''" Ta "063\ ``3''" Ta "064\ ``4''"
69.It "\&065\ ``5''" Ta "066\ ``6''" Ta "067\ ``7''" Ta "070\ ``8''" Ta "071\ ``9''"
70.It "\&101\ ``A''" Ta "102\ ``B''" Ta "103\ ``C''" Ta "104\ ``D''" Ta "105\ ``E''"
71.It "\&106\ ``F''" Ta "107\ ``G''" Ta "110\ ``H''" Ta "111\ ``I''" Ta "112\ ``J''"
72.It "\&113\ ``K''" Ta "114\ ``L''" Ta "115\ ``M''" Ta "116\ ``N''" Ta "117\ ``O''"
73.It "\&120\ ``P''" Ta "121\ ``Q''" Ta "122\ ``R''" Ta "123\ ``S''" Ta "124\ ``T''"
74.It "\&125\ ``U''" Ta "126\ ``V''" Ta "127\ ``W''" Ta "130\ ``X''" Ta "131\ ``Y''"
75.It "\&132\ ``Z''" Ta "141\ ``a''" Ta "142\ ``b''" Ta "143\ ``c''" Ta "144\ ``d''"
76.It "\&145\ ``e''" Ta "146\ ``f''" Ta "147\ ``g''" Ta "150\ ``h''" Ta "151\ ``i''"
77.It "\&152\ ``j''" Ta "153\ ``k''" Ta "154\ ``l''" Ta "155\ ``m''" Ta "156\ ``n''"
78.It "\&157\ ``o''" Ta "160\ ``p''" Ta "161\ ``q''" Ta "162\ ``r''" Ta "163\ ``s''"
79.It "\&164\ ``t''" Ta "165\ ``u''" Ta "166\ ``v''" Ta "167\ ``w''" Ta "170\ ``x''"
80.It "\&171\ ``y''" Ta "172\ ``z''" Ta \& Ta \& Ta \&
81.El
82.Pp
83The
84.Fn isalnum_l
85function takes an explicit
86.Fa locale
87argument, 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
96returns 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
106and
107.Fn iswalnum_l
108functions should be used instead.
109.Sh SEE ALSO
110.Xr ctype 3 ,
111.Xr ctype_l 3 ,
112.Xr isalpha 3 ,
113.Xr isdigit 3 ,
114.Xr iswalnum 3 ,
115.Xr iswalnum_l 3 ,
116.Xr xlocale 3 ,
117.Xr ascii 7
118.Sh STANDARDS
119The
120.Fn isalnum
121function conforms to
122.St -isoC .
123The
124.Fn isalnum_l
125function conforms to
126.St -p1003.1-2008 .
127