mbrtowc.3: SYNOPSIS: Use 'restrict' in prototypes
[man-pages.git] / man3 / iswpunct.3
blob6db0f75f2d08fc4ad4cec10d04a5c65a74bc504c
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 ISWPUNCT 3  2015-08-08 "GNU" "Linux Programmer's Manual"
17 .SH NAME
18 iswpunct \- test for punctuation or symbolic wide character
19 .SH SYNOPSIS
20 .nf
21 .B #include <wctype.h>
22 .PP
23 .BI "int iswpunct(wint_t " wc );
24 .fi
25 .SH DESCRIPTION
26 The
27 .BR iswpunct ()
28 function is the wide-character equivalent of the
29 .BR ispunct (3)
30 function.
31 It tests whether
32 .I wc
33 is a wide character
34 belonging to the wide-character class "punct".
35 .PP
36 The wide-character class "punct" is a subclass of the wide-character class
37 "graph", and therefore also a subclass of the wide-character class "print".
38 .PP
39 The wide-character class "punct" is disjoint from the wide-character class
40 "alnum" and therefore also disjoint from its subclasses "alpha", "upper",
41 "lower", "digit", "xdigit".
42 .PP
43 Being a subclass of the wide-character class "print",
44 the wide-character class
45 "punct" is disjoint from the wide-character class "cntrl".
46 .PP
47 Being a subclass of the wide-character class "graph",
48 the wide-character class
49 "punct" is disjoint from the wide-character class "space" and its subclass
50 "blank".
51 .SH RETURN VALUE
52 The
53 .BR iswpunct ()
54 function returns nonzero
56 .I wc
57 is a wide-character
58 belonging to the wide-character class "punct".
59 Otherwise, it returns zero.
60 .SH ATTRIBUTES
61 For an explanation of the terms used in this section, see
62 .BR attributes (7).
63 .ad l
64 .nh
65 .TS
66 allbox;
67 lbx lb lb
68 l l l.
69 Interface       Attribute       Value
71 .BR iswpunct ()
72 T}      Thread safety   MT-Safe locale
73 .TE
74 .hy
75 .ad
76 .sp 1
77 .SH CONFORMING TO
78 POSIX.1-2001, POSIX.1-2008, C99.
79 .SH NOTES
80 The behavior of
81 .BR iswpunct ()
82 depends on the
83 .B LC_CTYPE
84 category of the
85 current locale.
86 .PP
87 This function's name is a misnomer when dealing with Unicode characters,
88 because the wide-character class "punct" contains both punctuation characters
89 and symbol (math, currency, etc.) characters.
90 .SH SEE ALSO
91 .BR ispunct (3),
92 .BR iswctype (3)