xref: /dragonfly/lib/libc/locale/isspace.3 (revision fa71f50a)
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.\" 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.\"
32.\"     @(#)isspace.3	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD: head/lib/libc/locale/isspace.3 238919 2012-07-30 20:56:19Z issyl0 $
34.\"
35.Dd July 30, 2012
36.Dt ISSPACE 3
37.Os
38.Sh NAME
39.Nm isspace ,
40.Nm isspace_l
41.Nd white-space character test
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.In ctype.h
46.Ft int
47.Fn isspace "int c"
48.In ctype.h
49.In xlocale.h
50.Ft int
51.Fn isspace_l "int c" "locale_t loc"
52.Sh DESCRIPTION
53The
54.Fn isspace
55function tests for white-space characters.
56For any locale, this includes the following standard characters:
57.Bl -column \&`\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___
58.It "\&``\et''" Ta "``\en''" Ta "``\ev''" Ta "``\ef''" Ta "``\er''" Ta "`` ''"
59.El
60.Pp
61In the "C" locale,
62.Fn isspace
63returns non-zero for these characters only.
64The value of the argument must be representable as an
65.Vt "unsigned char"
66or the value of
67.Dv EOF .
68.Pp
69The
70.Fn isspace_l
71function takes an explicit locale argument, whereas the
72.Fn isspace
73function uses the current global or per-thread locale.
74.Sh RETURN VALUES
75The
76.Fn isspace
77and
78.Fn isspace_l
79functions return zero if the character tests false and
80return non-zero if the character tests true.
81.Sh COMPATIBILITY
82The
83.Bx 4.4
84extension of accepting arguments outside of the range of the
85.Vt "unsigned char"
86type in locales with large character sets is considered obsolete
87and may not be supported in future releases.
88The
89.Fn iswspace
90function should be used instead.
91.Sh SEE ALSO
92.Xr ctype 3 ,
93.Xr ctype_l 3 ,
94.Xr iswspace 3 ,
95.Xr multibyte 3 ,
96.Xr xlocale 3 ,
97.Xr ascii 7
98.Sh STANDARDS
99The
100.Fn isspace
101function conforms to
102.St -isoC .
103The
104.Fn isspace_l
105function conforms to
106.St -p1003.1-2008 .
107