[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.
.\" 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.26 2009/11/11 11:31:02 roam Exp $
.\"
.Dd July 17, 2005
.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, a successful
.Fn isblank
test is limited to these characters only.
The value of the argument must be representable as an
.Vt "unsigned char"
or the value of
.Dv EOF .
.Sh RETURN VALUES
The
.Fn isblank
function returns zero if the character tests false and
returns non-zero if the character tests true.
.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 SEE ALSO
.Xr ctype 3 ,
.Xr isalnum_l 3 ,
.Xr iswblank 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.
e9ce8d39 A	12	.\" 4. Neither the name of the University nor the names of its contributors
	13	.\" may be used to endorse or promote products derived from this software
	14	.\" without specific prior written permission.
	15	.\"
	16	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	17	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	18	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	19	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	20	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	21	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	22	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	23	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	24	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	25	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	26	.\" SUCH DAMAGE.
	27	.\"
224c7076	28	.\" @(#)isblank.3 8.1 (Berkeley) 6/4/93
1f2f436a	29	.\" $FreeBSD: src/lib/libc/locale/isblank.3,v 1.26 2009/11/11 11:31:02 roam Exp $
e9ce8d39	30	.\"
1f2f436a	31	.Dd July 17, 2005
224c7076	32	.Dt ISBLANK 3
e9ce8d39 A	33	.Os
e9ce8d39 A	34	.Sh NAME
224c7076 A	35	.Nm isblank
224c7076 A	36	.Nd space or tab character test
e9ce8d39 A	37	.Sh LIBRARY
	38	.Lb libc
	39	.Sh SYNOPSIS
224c7076	40	.In ctype.h
e9ce8d39	41	.Ft int
224c7076	42	.Fn isblank "int c"
e9ce8d39 A	43	.Sh DESCRIPTION
e9ce8d39 A	44	The
224c7076 A	45	.Fn isblank
	46	function tests for a space or tab character.
	47	For any locale, this includes the following standard characters:
	48	.Pp
	49	.Bl -column \&`\et''___ \&``\et''___
	50	.It "\&``\et''\t`` ''"
	51	.El
	52	.Pp
1f2f436a	53	In the "C" locale, a successful
224c7076	54	.Fn isblank
1f2f436a A	55	test is limited to these characters only.
	56	The value of the argument must be representable as an
	57	.Vt "unsigned char"
224c7076 A	58	or the value of
224c7076 A	59	.Dv EOF .
1f2f436a A	60	.Sh RETURN VALUES
	61	The
	62	.Fn isblank
	63	function returns zero if the character tests false and
	64	returns non-zero if the character tests true.
224c7076 A	65	.Sh COMPATIBILITY
	66	The
	67	.Bx 4.4
	68	extension of accepting arguments outside of the range of the
	69	.Vt "unsigned char"
	70	type in locales with large character sets is considered obsolete
	71	and may not be supported in future releases.
e9ce8d39	72	The
224c7076 A	73	.Fn iswblank
224c7076 A	74	function should be used instead.
e9ce8d39	75	.Sh SEE ALSO
224c7076 A	76	.Xr ctype 3 ,
	77	.Xr isalnum_l 3 ,
	78	.Xr iswblank 3 ,
224c7076 A	79	.Xr ascii 7
224c7076 A	80	.Sh STANDARDS
e9ce8d39	81	The
224c7076 A	82	.Fn isblank
	83	function
	84	conforms to
	85	.St -isoC-99 .