xref: /freebsd/lib/libc/locale/ispunct.3 (revision 315ee00f)
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.\"	@(#)ispunct.3	8.1 (Berkeley) 6/4/93
33.\"
34.Dd December 19, 2022
35.Dt ISPUNCT 3
36.Os
37.Sh NAME
38.Nm ispunct ,
39.Nm ispunct_l
40.Nd punctuation character test
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In ctype.h
45.Ft int
46.Fn ispunct "int c"
47.Ft int
48.Fn ispunct_l "int c" "locale_t loc"
49.Sh DESCRIPTION
50The
51.Fn ispunct
52and
53.Fn ispunct_l
54functions test for any printing character except for space
55.Pq Ql "\ "
56or a
57character for which
58.Xr isalnum 3
59or
60.Xr isalnum_l 3
61is true.
62The value of the argument must be representable as an
63.Vt "unsigned char"
64or the value of
65.Dv EOF .
66.Pp
67In the ASCII character set, this includes the following characters
68(with their numeric values shown in octal):
69.Bl -column \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__
70.It "\&041\ ``!''" Ta "042\ ``""''" Ta "043\ ``#''" Ta "044\ ``$''" Ta "045\ ``%''"
71.It "\&046\ ``&''" Ta "047\ ``'''" Ta "050\ ``(''" Ta "051\ ``)''" Ta "052\ ``*''"
72.It "\&053\ ``+''" Ta "054\ ``,''" Ta "055\ ``-''" Ta "056\ ``.''" Ta "057\ ``/''"
73.It "\&072\ ``:''" Ta "073\ ``;''" Ta "074\ ``<''" Ta "075\ ``=''" Ta "076\ ``>''"
74.It "\&077\ ``?''" Ta "100\ ``@''" Ta "133\ ``[''" Ta "134\ ``\e\|''" Ta "135\ ``]''"
75.It "\&136\ ``^''" Ta "137\ ``_''" Ta "140\ ```''" Ta "173\ ``{''" Ta "174\ ``|''"
76.It "\&175\ ``}''" Ta "176\ ``~''" Ta \& Ta \& Ta \&
77.El
78.Pp
79The
80.Fn ispunct_l
81function takes an explicit locale argument, whereas the
82.Fn ispunct
83function uses the current global or per-thread locale.
84.Sh RETURN VALUES
85The
86.Fn ispunct
87and
88.Fn ispunct_l
89functions return zero if the character tests false and
90return non-zero if the character tests true.
91.Sh COMPATIBILITY
92The
93.Bx 4.4
94extension of accepting arguments outside of the range of the
95.Vt "unsigned char"
96type in locales with large character sets is considered obsolete
97and may not be supported in future releases.
98The
99.Fn iswpunct
100or
101.Fn iswpunct_l
102function should be used instead.
103.Sh SEE ALSO
104.Xr ctype 3 ,
105.Xr ctype_l 3 ,
106.Xr iswpunct 3 ,
107.Xr iswpunct_l 3 ,
108.Xr xlocale 3 ,
109.Xr ascii 7
110.Sh STANDARDS
111The
112.Fn ispunct
113function conforms to
114.St -isoC .
115The
116.Fn ispunct_l
117function conforms to
118.St -p1003.1-2008 .
119.Sh HISTORY
120The
121.Fn ispunct
122function first appeared in
123.At v7 .
124