Changes: Ready for 5.13
[man-pages.git] / man3 / iswspace.3
blob5c3089b7547a1a244216bd5a57ed6924e0d788ea
1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
2 .\"
3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
4 .\" This is free documentation; you can redistribute it and/or
5 .\" modify it under the terms of the GNU General Public License as
6 .\" published by the Free Software Foundation; either version 2 of
7 .\" the License, or (at your option) any later version.
8 .\" %%%LICENSE_END
9 .\"
10 .\" References consulted:
11 .\"   GNU glibc-2 source code and manual
12 .\"   Dinkumware C library reference http://www.dinkumware.com/
13 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
14 .\"   ISO/IEC 9899:1999
15 .\"
16 .TH ISWSPACE 3  2021-03-22 "GNU" "Linux Programmer's Manual"
17 .SH NAME
18 iswspace \- test for whitespace wide character
19 .SH SYNOPSIS
20 .nf
21 .B #include <wctype.h>
22 .PP
23 .BI "int iswspace(wint_t " wc );
24 .fi
25 .SH DESCRIPTION
26 The
27 .BR iswspace ()
28 function is the wide-character equivalent of the
29 .BR isspace (3)
30 function.
31 It tests whether
32 .I wc
33 is a wide character
34 belonging to the wide-character class "space".
35 .PP
36 The wide-character class "space" is disjoint from the wide-character class
37 "graph" and therefore also disjoint from its subclasses "alnum", "alpha",
38 "upper", "lower", "digit", "xdigit", "punct".
39 .\" Note: UNIX98 (susv2/xbd/locale.html) says that "space" and "graph" may
40 .\" have characters in common, except U+0020. But C99 (ISO/IEC 9899:1999
41 .\" section 7.25.2.1.10) says that "space" and "graph" are disjoint.
42 .PP
43 The wide-character class "space" contains the wide-character class "blank".
44 .PP
45 The wide-character class "space" always contains at least the space character
46 and the control
47 characters \(aq\ef\(aq, \(aq\en\(aq, \(aq\er\(aq, \(aq\et\(aq, \(aq\ev\(aq.
48 .SH RETURN VALUE
49 The
50 .BR iswspace ()
51 function returns nonzero if
52 .I wc
53 is a wide character
54 belonging to the wide-character class "space".
55 Otherwise, it returns zero.
56 .SH ATTRIBUTES
57 For an explanation of the terms used in this section, see
58 .BR attributes (7).
59 .ad l
60 .nh
61 .TS
62 allbox;
63 lbx lb lb
64 l l l.
65 Interface       Attribute       Value
67 .BR iswspace ()
68 T}      Thread safety   MT-Safe locale
69 .TE
70 .hy
71 .ad
72 .sp 1
73 .SH CONFORMING TO
74 POSIX.1-2001, POSIX.1-2008, C99.
75 .SH NOTES
76 The behavior of
77 .BR iswspace ()
78 depends on the
79 .B LC_CTYPE
80 category of the
81 current locale.
82 .SH SEE ALSO
83 .BR isspace (3),
84 .BR iswctype (3)