[apple/libc.git] / locale / FreeBSD / iswalnum.3

.\"	$NetBSD: iswalnum.3,v 1.5 2002/07/10 14:46:10 yamt Exp $
.\"
.\" Copyright (c) 1991 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the American National Standards Committee X3, on Information
.\" Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)isalnum.3	5.2 (Berkeley) 6/29/91
.\" $FreeBSD: src/lib/libc/locale/iswalnum.3,v 1.5 2002/11/29 17:35:09 ru Exp $
.\"
.Dd October 3, 2002
.Dt ISWALNUM 3
.Os
.Sh NAME
.Nm iswalnum ,
.Nm iswalpha ,
.Nm iswascii ,
.Nm iswblank ,
.Nm iswcntrl ,
.Nm iswdigit ,
.Nm iswgraph ,
.Nm iswhexnumber ,
.Nm iswideogram ,
.Nm iswlower ,
.Nm iswnumber ,
.Nm iswphonogram ,
.Nm iswprint ,
.Nm iswpunct ,
.Nm iswrune ,
.Nm iswspace ,
.Nm iswspecial ,
.Nm iswupper ,
.Nm iswxdigit
.Nd wide character classification utilities
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In wctype.h
.Ft int
.Fn iswalnum "wint_t wc"
.Ft int
.Fn iswalpha "wint_t wc"
.Ft int
.Fn iswascii "wint_t wc"
.Ft int
.Fn iswblank "wint_t wc"
.Ft int
.Fn iswcntrl "wint_t wc"
.Ft int
.Fn iswdigit "wint_t wc"
.Ft int
.Fn iswgraph "wint_t wc"
.Ft int
.Fn iswhexnumber "wint_t wc"
.Ft int
.Fn iswideogram "wint_t wc"
.Ft int
.Fn iswlower "wint_t wc"
.Ft int
.Fn iswnumber "wint_t wc"
.Ft int
.Fn iswphonogram "wint_t wc"
.Ft int
.Fn iswprint "wint_t wc"
.Ft int
.Fn iswpunct "wint_t wc"
.Ft int
.Fn iswrune "wint_t wc"
.Ft int
.Fn iswspace "wint_t wc"
.Ft int
.Fn iswspecial "wint_t wc"
.Ft int
.Fn iswupper "wint_t wc"
.Ft int
.Fn iswxdigit "wint_t wc"
.Sh DESCRIPTION
The above functions are character classification utility functions,
for use with wide characters
.Vt ( wchar_t
or
.Vt wint_t ) .
See the description for the similarly-named single byte classification
functions (like
.Xr isalnum 3 ) ,
for details.
.Sh RETURN VALUES
The functions return zero if the character tests false and
return non-zero if the character tests true.
.Sh SEE ALSO
.Xr isalnum 3 ,
.Xr isalpha 3 ,
.Xr isascii 3 ,
.Xr isblank 3 ,
.Xr iscntrl 3 ,
.Xr isdigit 3 ,
.Xr isgraph 3 ,
.Xr ishexnumber 3 ,
.Xr isideogram 3 ,
.Xr islower 3 ,
.Xr isnumber 3 ,
.Xr isphonogram 3 ,
.Xr isprint 3 ,
.Xr ispunct 3 ,
.Xr isrune 3 ,
.Xr isspace 3 ,
.Xr isspecial 3 ,
.Xr isupper 3 ,
.Xr isxdigit 3 ,
.Xr wctype 3
.Sh STANDARDS
These functions conform to
.St -p1003.1-2001 ,
except
.Fn iswascii ,
.Fn iswhexnumber ,
.Fn iswideogram ,
.Fn iswnumber ,
.Fn iswphonogram ,
.Fn iswrune
and
.Fn iswspecial ,
which are
.Fx
extensions.
.Sh CAVEATS
The result of these functions is undefined unless
the argument is
.Dv WEOF
or a valid
.Vt wchar_t
value for the current locale.
Commit	Line	Data
9385eb3d A	1	.\" $NetBSD: iswalnum.3,v 1.5 2002/07/10 14:46:10 yamt Exp $
	2	.\"
	3	.\" Copyright (c) 1991 The Regents of the University of California.
	4	.\" All rights reserved.
e9ce8d39	5	.\"
5b2abdfb A	6	.\" This code is derived from software contributed to Berkeley by
	7	.\" the American National Standards Committee X3, on Information
	8	.\" Processing Systems.
	9	.\"
e9ce8d39 A	10	.\" Redistribution and use in source and binary forms, with or without
	11	.\" modification, are permitted provided that the following conditions
	12	.\" are met:
	13	.\" 1. Redistributions of source code must retain the above copyright
	14	.\" notice, this list of conditions and the following disclaimer.
	15	.\" 2. Redistributions in binary form must reproduce the above copyright
	16	.\" notice, this list of conditions and the following disclaimer in the
	17	.\" documentation and/or other materials provided with the distribution.
	18	.\" 3. All advertising materials mentioning features or use of this software
	19	.\" must display the following acknowledgement:
	20	.\" This product includes software developed by the University of
	21	.\" California, Berkeley and its contributors.
	22	.\" 4. Neither the name of the University nor the names of its contributors
	23	.\" may be used to endorse or promote products derived from this software
	24	.\" without specific prior written permission.
	25	.\"
	26	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	27	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	28	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	29	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	30	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	31	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	32	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	33	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	34	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	35	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	36	.\" SUCH DAMAGE.
	37	.\"
9385eb3d A	38	.\" @(#)isalnum.3 5.2 (Berkeley) 6/29/91
9385eb3d A	39	.\" $FreeBSD: src/lib/libc/locale/iswalnum.3,v 1.5 2002/11/29 17:35:09 ru Exp $
e9ce8d39	40	.\"
9385eb3d A	41	.Dd October 3, 2002
9385eb3d A	42	.Dt ISWALNUM 3
e9ce8d39 A	43	.Os
e9ce8d39 A	44	.Sh NAME
9385eb3d A	45	.Nm iswalnum ,
	46	.Nm iswalpha ,
	47	.Nm iswascii ,
	48	.Nm iswblank ,
	49	.Nm iswcntrl ,
	50	.Nm iswdigit ,
	51	.Nm iswgraph ,
	52	.Nm iswhexnumber ,
	53	.Nm iswideogram ,
	54	.Nm iswlower ,
	55	.Nm iswnumber ,
	56	.Nm iswphonogram ,
	57	.Nm iswprint ,
	58	.Nm iswpunct ,
	59	.Nm iswrune ,
	60	.Nm iswspace ,
	61	.Nm iswspecial ,
	62	.Nm iswupper ,
	63	.Nm iswxdigit
	64	.Nd wide character classification utilities
e9ce8d39 A	65	.Sh LIBRARY
	66	.Lb libc
	67	.Sh SYNOPSIS
9385eb3d A	68	.In wctype.h
	69	.Ft int
	70	.Fn iswalnum "wint_t wc"
	71	.Ft int
	72	.Fn iswalpha "wint_t wc"
	73	.Ft int
	74	.Fn iswascii "wint_t wc"
	75	.Ft int
	76	.Fn iswblank "wint_t wc"
	77	.Ft int
	78	.Fn iswcntrl "wint_t wc"
	79	.Ft int
	80	.Fn iswdigit "wint_t wc"
	81	.Ft int
	82	.Fn iswgraph "wint_t wc"
	83	.Ft int
	84	.Fn iswhexnumber "wint_t wc"
	85	.Ft int
	86	.Fn iswideogram "wint_t wc"
	87	.Ft int
	88	.Fn iswlower "wint_t wc"
	89	.Ft int
	90	.Fn iswnumber "wint_t wc"
	91	.Ft int
	92	.Fn iswphonogram "wint_t wc"
	93	.Ft int
	94	.Fn iswprint "wint_t wc"
	95	.Ft int
	96	.Fn iswpunct "wint_t wc"
	97	.Ft int
	98	.Fn iswrune "wint_t wc"
	99	.Ft int
	100	.Fn iswspace "wint_t wc"
	101	.Ft int
	102	.Fn iswspecial "wint_t wc"
	103	.Ft int
	104	.Fn iswupper "wint_t wc"
e9ce8d39	105	.Ft int
9385eb3d	106	.Fn iswxdigit "wint_t wc"
e9ce8d39	107	.Sh DESCRIPTION
9385eb3d A	108	The above functions are character classification utility functions,
	109	for use with wide characters
	110	.Vt ( wchar_t
	111	or
	112	.Vt wint_t ) .
	113	See the description for the similarly-named single byte classification
	114	functions (like
	115	.Xr isalnum 3 ) ,
	116	for details.
e9ce8d39	117	.Sh RETURN VALUES
9385eb3d A	118	The functions return zero if the character tests false and
9385eb3d A	119	return non-zero if the character tests true.
e9ce8d39	120	.Sh SEE ALSO
5b2abdfb A	121	.Xr isalnum 3 ,
	122	.Xr isalpha 3 ,
	123	.Xr isascii 3 ,
9385eb3d	124	.Xr isblank 3 ,
5b2abdfb A	125	.Xr iscntrl 3 ,
	126	.Xr isdigit 3 ,
	127	.Xr isgraph 3 ,
9385eb3d A	128	.Xr ishexnumber 3 ,
9385eb3d A	129	.Xr isideogram 3 ,
5b2abdfb	130	.Xr islower 3 ,
9385eb3d A	131	.Xr isnumber 3 ,
9385eb3d A	132	.Xr isphonogram 3 ,
5b2abdfb A	133	.Xr isprint 3 ,
5b2abdfb A	134	.Xr ispunct 3 ,
9385eb3d	135	.Xr isrune 3 ,
5b2abdfb	136	.Xr isspace 3 ,
9385eb3d	137	.Xr isspecial 3 ,
5b2abdfb A	138	.Xr isupper 3 ,
5b2abdfb A	139	.Xr isxdigit 3 ,
9385eb3d	140	.Xr wctype 3
5b2abdfb	141	.Sh STANDARDS
9385eb3d A	142	These functions conform to
	143	.St -p1003.1-2001 ,
	144	except
	145	.Fn iswascii ,
	146	.Fn iswhexnumber ,
	147	.Fn iswideogram ,
	148	.Fn iswnumber ,
	149	.Fn iswphonogram ,
	150	.Fn iswrune
	151	and
	152	.Fn iswspecial ,
	153	which are
	154	.Fx
	155	extensions.
	156	.Sh CAVEATS
	157	The result of these functions is undefined unless
	158	the argument is
	159	.Dv WEOF
	160	or a valid
	161	.Vt wchar_t
	162	value for the current locale.