[apple/libc.git] / locale / isblank.3

.\" Copyright (c) 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" 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.
.\"
.\"     @(#)isblank.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD: src/lib/libc/locale/isblank.3,v 1.19 2004/08/21 07:37:08 tjr Exp $
.\"
.Dd August 21, 2004
.Dt ISBLANK 3
.Os
.Sh NAME
.Nm isblank
.Nd space or tab character test
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In ctype.h
.Ft int
.Fn isblank "int c"
.Sh DESCRIPTION
The
.Fn isblank
function tests for a space or tab character.
For any locale, this includes the following standard characters:
.Pp
.Bl -column \&`\et''___ \&``\et''___
.It "\&``\et''\t`` ''"
.El
.Pp
In the "C" locale,
.Fn isblank
successful test is limited to these characters only.
For single C
.Va char Ns s
locales (see
.Xr multibyte 3 ) ,
the value of the argument is
representable as an
.Li unsigned char
or the value of
.Dv EOF .
.Sh COMPATIBILITY
The
.Bx 4.4
extension of accepting arguments outside of the range of the
.Vt "unsigned char"
type in locales with large character sets is considered obsolete
and may not be supported in future releases.
The
.Fn iswblank
function should be used instead.
.Sh RETURN VALUES
The
.Fn isblank
function returns zero if the character tests false and
returns non-zero if the character tests true.
.Sh SEE ALSO
.Xr ctype 3 ,
.Xr isalnum_l 3 ,
.Xr iswblank 3 ,
.Xr multibyte 3 ,
.Xr ascii 7
.Sh STANDARDS
The
.Fn isblank
function
conforms to
.St -isoC-99 .
Commit	Line	Data
224c7076	1	.\" Copyright (c) 1991, 1993
e9ce8d39 A	2	.\" The Regents of the University of California. All rights reserved.
	3	.\"
	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
	12	.\" 3. All advertising materials mentioning features or use of this software
	13	.\" must display the following acknowledgement:
	14	.\" This product includes software developed by the University of
	15	.\" California, Berkeley and its contributors.
	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	.\"
224c7076 A	32	.\" @(#)isblank.3 8.1 (Berkeley) 6/4/93
224c7076 A	33	.\" $FreeBSD: src/lib/libc/locale/isblank.3,v 1.19 2004/08/21 07:37:08 tjr Exp $
e9ce8d39	34	.\"
224c7076 A	35	.Dd August 21, 2004
224c7076 A	36	.Dt ISBLANK 3
e9ce8d39 A	37	.Os
e9ce8d39 A	38	.Sh NAME
224c7076 A	39	.Nm isblank
224c7076 A	40	.Nd space or tab character test
e9ce8d39 A	41	.Sh LIBRARY
	42	.Lb libc
	43	.Sh SYNOPSIS
224c7076	44	.In ctype.h
e9ce8d39	45	.Ft int
224c7076	46	.Fn isblank "int c"
e9ce8d39 A	47	.Sh DESCRIPTION
e9ce8d39 A	48	The
224c7076 A	49	.Fn isblank
	50	function tests for a space or tab character.
	51	For any locale, this includes the following standard characters:
	52	.Pp
	53	.Bl -column \&`\et''___ \&``\et''___
	54	.It "\&``\et''\t`` ''"
	55	.El
	56	.Pp
	57	In the "C" locale,
	58	.Fn isblank
	59	successful test is limited to these characters only.
	60	For single C
	61	.Va char Ns s
	62	locales (see
	63	.Xr multibyte 3 ) ,
	64	the value of the argument is
	65	representable as an
	66	.Li unsigned char
	67	or the value of
	68	.Dv EOF .
	69	.Sh COMPATIBILITY
	70	The
	71	.Bx 4.4
	72	extension of accepting arguments outside of the range of the
	73	.Vt "unsigned char"
	74	type in locales with large character sets is considered obsolete
	75	and may not be supported in future releases.
e9ce8d39	76	The
224c7076 A	77	.Fn iswblank
224c7076 A	78	function should be used instead.
e9ce8d39	79	.Sh RETURN VALUES
5b2abdfb	80	The
224c7076 A	81	.Fn isblank
	82	function returns zero if the character tests false and
	83	returns non-zero if the character tests true.
e9ce8d39	84	.Sh SEE ALSO
224c7076 A	85	.Xr ctype 3 ,
	86	.Xr isalnum_l 3 ,
	87	.Xr iswblank 3 ,
	88	.Xr multibyte 3 ,
	89	.Xr ascii 7
	90	.Sh STANDARDS
e9ce8d39	91	The
224c7076 A	92	.Fn isblank
	93	function
	94	conforms to
	95	.St -isoC-99 .