share/mk/: build-pdf-book: Fix chapter bookmarks
[man-pages.git] / man3 / iswpunct.3
blob4f5a220a1c1541ea272e13de8c325c75a7cafd1e
1 '\" t
2 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
3 .\"
4 .\" SPDX-License-Identifier: GPL-2.0-or-later
5 .\"
6 .\" References consulted:
7 .\"   GNU glibc-2 source code and manual
8 .\"   Dinkumware C library reference http://www.dinkumware.com/
9 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
10 .\"   ISO/IEC 9899:1999
11 .\"
12 .TH iswpunct 3 (date) "Linux man-pages (unreleased)"
13 .SH NAME
14 iswpunct \- test for punctuation or symbolic wide character
15 .SH LIBRARY
16 Standard C library
17 .RI ( libc ", " \-lc )
18 .SH SYNOPSIS
19 .nf
20 .B #include <wctype.h>
22 .BI "int iswpunct(wint_t " wc );
23 .fi
24 .SH DESCRIPTION
25 The
26 .BR iswpunct ()
27 function is the wide-character equivalent of the
28 .BR ispunct (3)
29 function.
30 It tests whether
31 .I wc
32 is a wide character
33 belonging to the wide-character class "punct".
35 The wide-character class "punct" is a subclass of the wide-character class
36 "graph", and therefore also a subclass of the wide-character class "print".
38 The wide-character class "punct" is disjoint from the wide-character class
39 "alnum" and therefore also disjoint from its subclasses "alpha", "upper",
40 "lower", "digit", "xdigit".
42 Being a subclass of the wide-character class "print",
43 the wide-character class
44 "punct" is disjoint from the wide-character class "cntrl".
46 Being a subclass of the wide-character class "graph",
47 the wide-character class
48 "punct" is disjoint from the wide-character class "space" and its subclass
49 "blank".
50 .SH RETURN VALUE
51 The
52 .BR iswpunct ()
53 function returns nonzero
55 .I wc
56 is a wide-character
57 belonging to the wide-character class "punct".
58 Otherwise, it returns zero.
59 .SH ATTRIBUTES
60 For an explanation of the terms used in this section, see
61 .BR attributes (7).
62 .TS
63 allbox;
64 lbx lb lb
65 l l l.
66 Interface       Attribute       Value
68 .na
69 .nh
70 .BR iswpunct ()
71 T}      Thread safety   MT-Safe locale
72 .TE
73 .SH STANDARDS
74 C11, POSIX.1-2008.
75 .SH HISTORY
76 POSIX.1-2001, C99.
77 .SH NOTES
78 The behavior of
79 .BR iswpunct ()
80 depends on the
81 .B LC_CTYPE
82 category of the
83 current locale.
85 This function's name is a misnomer when dealing with Unicode characters,
86 because the wide-character class "punct" contains both punctuation characters
87 and symbol (math, currency, etc.) characters.
88 .SH SEE ALSO
89 .BR ispunct (3),
90 .BR iswctype (3)