xref: /freebsd/lib/libc/locale/isrune.3 (revision 2008043f386721d58158e37e0d7e50df8095942d)
1.\"
2.\" Copyright (c) 2004 Tim J. Robbins
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd December 19, 2022
27.Dt ISRUNE 3
28.Os
29.Sh NAME
30.Nm isrune ,
31.Nm isrune_l
32.Nd valid character test
33.Sh LIBRARY
34.Lb libc
35.Sh SYNOPSIS
36.In ctype.h
37.Ft int
38.Fn isrune "int c"
39.Ft int
40.Fn isrune_l "int c" "locale_t loc"
41.Sh DESCRIPTION
42The
43.Fn isrune
44and
45.Fn isrune_l
46functions test for any character that is valid in the current
47character set.
48In the
49.Tn ASCII
50character set, this is equivalent to
51.Fn isascii .
52.Pp
53The
54.Fn isrune_l
55function takes an explicit locale argument, whereas the
56.Fn isrune
57function uses the current global or per-thread locale.
58.Sh RETURN VALUES
59The
60.Fn isrune
61and
62.Fn isrune_l
63functions return zero if the character tests false and
64return non-zero if the character tests true.
65.Sh COMPATIBILITY
66The
67.Bx 4.4
68extension of accepting arguments outside of the range of the
69.Vt "unsigned char"
70type in locales with large character sets is considered obsolete
71and may not be supported in future releases.
72The
73.Fn iswrune
74or
75.Fn iswrune_l
76function should be used instead.
77.Sh SEE ALSO
78.Xr ctype 3 ,
79.Xr ctype_l 3 ,
80.Xr isascii 3 ,
81.Xr iswrune 3 ,
82.Xr iswrune_l 3 ,
83.Xr xlocale 3 ,
84.Xr ascii 7
85.Sh HISTORY
86The
87.Fn isrune
88function appeared in
89.Bx 4.4 .
90