xref: /openbsd-src/lib/libc/locale/iswalnum.3 (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1.\"	$OpenBSD: iswalnum.3,v 1.5 2013/06/05 03:39:22 tedu Exp $
2.\"	$NetBSD: iswalnum.3,v 1.8 2003/09/08 17:54:31 wiz Exp $
3.\"
4.\" Copyright (c) 1991 The Regents of the University of California.
5.\" All rights reserved.
6.\"
7.\" This code is derived from software contributed to Berkeley by
8.\" the American National Standards Committee X3, on Information
9.\" Processing Systems.
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
14.\" 1. Redistributions of source code must retain the above copyright
15.\"    notice, this list of conditions and the following disclaimer.
16.\" 2. Redistributions in binary form must reproduce the above copyright
17.\"    notice, this list of conditions and the following disclaimer in the
18.\"    documentation and/or other materials provided with the distribution.
19.\" 3. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"     @(#)isalnum.3	5.2 (Berkeley) 6/29/91
36.\"
37.Dd $Mdocdate: June 5 2013 $
38.Dt ISWALNUM 3
39.Os
40.Sh NAME
41.Nm iswalnum ,
42.Nm iswalpha ,
43.Nm iswblank ,
44.Nm iswcntrl ,
45.Nm iswdigit ,
46.Nm iswgraph ,
47.Nm iswlower ,
48.Nm iswprint ,
49.Nm iswpunct ,
50.Nm iswspace ,
51.Nm iswupper ,
52.Nm iswxdigit
53.Nd wide-character classification utilities
54.Sh SYNOPSIS
55.In wctype.h
56.Ft int
57.Fn iswalnum "wint_t wc"
58.Ft int
59.Fn iswalpha "wint_t wc"
60.Ft int
61.Fn iswblank "wint_t wc"
62.Ft int
63.Fn iswcntrl "wint_t wc"
64.Ft int
65.Fn iswdigit "wint_t wc"
66.Ft int
67.Fn iswgraph "wint_t wc"
68.Ft int
69.Fn iswlower "wint_t wc"
70.Ft int
71.Fn iswprint "wint_t wc"
72.Ft int
73.Fn iswpunct "wint_t wc"
74.Ft int
75.Fn iswspace "wint_t wc"
76.Ft int
77.Fn iswupper "wint_t wc"
78.Ft int
79.Fn iswxdigit "wint_t wc"
80.Sh DESCRIPTION
81The functions are character classification utility functions,
82for use with wide characters
83.Po
84.Fa wchar_t
85or
86.Fa wint_t
87.Pc .
88See the description of singlebyte classification functions, like
89.Xr isalnum 3 ,
90for details.
91.Sh RETURN VALUES
92The functions return zero if the character tests false and
93return non-zero if the character tests true.
94.Sh SEE ALSO
95.Xr isalnum 3 ,
96.Xr isalpha 3 ,
97.Xr isblank 3 ,
98.Xr iscntrl 3 ,
99.Xr isdigit 3 ,
100.Xr isgraph 3 ,
101.Xr islower 3 ,
102.Xr isprint 3 ,
103.Xr ispunct 3 ,
104.Xr isspace 3 ,
105.Xr isupper 3 ,
106.Xr isxdigit 3
107.Sh STANDARDS
108The functions conform to
109.\" .St -isoC99 .
110ISO/IEC 9899:1999
111.Pq Dq ISO C99 .
112.Sh CAVEATS
113The argument to these functions must be
114.Dv WEOF
115or a valid
116.Fa wchar_t
117value with the current locale; otherwise, the result is undefined.
118.Sh BUGS
119In a UTF-8 locale these functions return wrong answers for some characters
120because they do not cover the entire Unicode character set.
121