]> git.saurik.com Git - apple/libc.git/blame_incremental - locale/isspace.3
Libc-583.tar.gz
[apple/libc.git] / locale / isspace.3
... / ...
CommitLineData
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.\" 3. All advertising materials mentioning features or use of this software
17.\" must display the following acknowledgement:
18.\" This product includes software developed by the University of
19.\" California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\" may be used to endorse or promote products derived from this software
22.\" without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\" @(#)isspace.3 8.1 (Berkeley) 6/4/93
37.\" $FreeBSD: src/lib/libc/locale/isspace.3,v 1.17 2004/08/21 07:37:08 tjr Exp $
38.\"
39.Dd August 21, 2004
40.Dt ISSPACE 3
41.Os
42.Sh NAME
43.Nm isspace
44.Nd white-space character test
45.Sh LIBRARY
46.Lb libc
47.Sh SYNOPSIS
48.In ctype.h
49.Ft int
50.Fn isspace "int c"
51.Sh DESCRIPTION
52The
53.Fn isspace
54function tests for the white-space characters.
55For any locale, this includes the following standard characters:
56.Pp
57.Bl -column \&`\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___
58.It "\&``\et''\t``\en''\t``\ev''\t``\ef''\t``\er''\t`` ''"
59.El
60.Pp
61In the "C" locale,
62.Fn isspace
63successful test is limited to these characters only.
64For single C
65.Va char Ns s
66locales (see
67.Xr multibyte 3 ) ,
68the value of the argument is
69representable as an
70.Li unsigned char
71or the value of
72.Dv EOF .
73.Sh RETURN VALUES
74The
75.Fn isspace
76function returns zero if the character tests false and
77returns non-zero if the character tests true.
78.Sh COMPATIBILITY
79The
80.Bx 4.4
81extension of accepting arguments outside of the range of the
82.Vt "unsigned char"
83type in locales with large character sets is considered obsolete
84and may not be supported in future releases.
85The
86.Fn iswspace
87function should be used instead.
88.Sh SEE ALSO
89.Xr ctype 3 ,
90.Xr isalnum_l 3 ,
91.Xr iswspace 3 ,
92.Xr multibyte 3 ,
93.Xr ascii 7
94.Sh STANDARDS
95The
96.Fn isspace
97function conforms to
98.St -isoC .