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