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