]> git.ipfire.org Git - thirdparty/man-pages.git/blob - man3/iswpunct.3
All pages: Remove the 5th argument to .TH
[thirdparty/man-pages.git] / man3 / iswpunct.3
1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
2 .\"
3 .\" SPDX-License-Identifier: GPL-2.0-or-later
4 .\"
5 .\" References consulted:
6 .\" GNU glibc-2 source code and manual
7 .\" Dinkumware C library reference http://www.dinkumware.com/
8 .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
9 .\" ISO/IEC 9899:1999
10 .\"
11 .TH ISWPUNCT 3 2021-03-22 "Linux man-pages (unreleased)"
12 .SH NAME
13 iswpunct \- test for punctuation or symbolic wide character
14 .SH LIBRARY
15 Standard C library
16 .RI ( libc ", " \-lc )
17 .SH SYNOPSIS
18 .nf
19 .B #include <wctype.h>
20 .PP
21 .BI "int iswpunct(wint_t " wc );
22 .fi
23 .SH DESCRIPTION
24 The
25 .BR iswpunct ()
26 function is the wide-character equivalent of the
27 .BR ispunct (3)
28 function.
29 It tests whether
30 .I wc
31 is a wide character
32 belonging to the wide-character class "punct".
33 .PP
34 The wide-character class "punct" is a subclass of the wide-character class
35 "graph", and therefore also a subclass of the wide-character class "print".
36 .PP
37 The wide-character class "punct" is disjoint from the wide-character class
38 "alnum" and therefore also disjoint from its subclasses "alpha", "upper",
39 "lower", "digit", "xdigit".
40 .PP
41 Being a subclass of the wide-character class "print",
42 the wide-character class
43 "punct" is disjoint from the wide-character class "cntrl".
44 .PP
45 Being a subclass of the wide-character class "graph",
46 the wide-character class
47 "punct" is disjoint from the wide-character class "space" and its subclass
48 "blank".
49 .SH RETURN VALUE
50 The
51 .BR iswpunct ()
52 function returns nonzero
53 if
54 .I wc
55 is a wide-character
56 belonging to the wide-character class "punct".
57 Otherwise, it returns zero.
58 .SH ATTRIBUTES
59 For an explanation of the terms used in this section, see
60 .BR attributes (7).
61 .ad l
62 .nh
63 .TS
64 allbox;
65 lbx lb lb
66 l l l.
67 Interface Attribute Value
68 T{
69 .BR iswpunct ()
70 T} Thread safety MT-Safe locale
71 .TE
72 .hy
73 .ad
74 .sp 1
75 .SH STANDARDS
76 POSIX.1-2001, POSIX.1-2008, 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.
84 .PP
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)