xref: /freebsd/lib/libc/locale/isspace.3 (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
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.\" $FreeBSD$
34.\"
35.Dd December 19, 2022
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.Ft int
49.Fn isspace_l "int c" "locale_t loc"
50.Sh DESCRIPTION
51The
52.Fn isspace
53and
54.Fn isspace_l
55functions test 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
63and
64.Fn isspace_l
65return non-zero for these characters only.
66The value of the argument must be representable as an
67.Vt "unsigned char"
68or the value of
69.Dv EOF .
70.Pp
71The
72.Fn isspace_l
73function takes an explicit locale argument, whereas the
74.Fn isspace
75function uses the current global or per-thread locale.
76.Sh RETURN VALUES
77The
78.Fn isspace
79and
80.Fn isspace_l
81functions return zero if the character tests false and
82return non-zero if the character tests true.
83.Sh COMPATIBILITY
84The
85.Bx 4.4
86extension of accepting arguments outside of the range of the
87.Vt "unsigned char"
88type in locales with large character sets is considered obsolete
89and may not be supported in future releases.
90The
91.Fn iswspace
92or
93.Fn iswspace_l
94function should be used instead.
95.Sh SEE ALSO
96.Xr ctype 3 ,
97.Xr ctype_l 3 ,
98.Xr iswspace 3 ,
99.Xr iswspace_l 3 ,
100.Xr multibyte 3 ,
101.Xr xlocale 3 ,
102.Xr ascii 7
103.Sh STANDARDS
104The
105.Fn isspace
106function conforms to
107.St -isoC .
108The
109.Fn isspace_l
110function conforms to
111.St -p1003.1-2008 .
112.Sh HISTORY
113The
114.Fn isspace
115function first appeared in
116.At v7 .
117