xref: /freebsd/lib/libc/locale/isrune.3 (revision d9a42747950146bf03cda7f6e25d219253f8a57a)
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.\" $FreeBSD$
27.\"
28.Dd December 19, 2022
29.Dt ISRUNE 3
30.Os
31.Sh NAME
32.Nm isrune ,
33.Nm isrune_l
34.Nd valid character test
35.Sh LIBRARY
36.Lb libc
37.Sh SYNOPSIS
38.In ctype.h
39.Ft int
40.Fn isrune "int c"
41.Ft int
42.Fn isrune_l "int c" "locale_t loc"
43.Sh DESCRIPTION
44The
45.Fn isrune
46and
47.Fn isrune_l
48functions test for any character that is valid in the current
49character set.
50In the
51.Tn ASCII
52character set, this is equivalent to
53.Fn isascii .
54.Pp
55The
56.Fn isrune_l
57function takes an explicit locale argument, whereas the
58.Fn isrune
59function uses the current global or per-thread locale.
60.Sh RETURN VALUES
61The
62.Fn isrune
63and
64.Fn isrune_l
65functions return zero if the character tests false and
66return non-zero if the character tests true.
67.Sh COMPATIBILITY
68The
69.Bx 4.4
70extension of accepting arguments outside of the range of the
71.Vt "unsigned char"
72type in locales with large character sets is considered obsolete
73and may not be supported in future releases.
74The
75.Fn iswrune
76or
77.Fn iswrune_l
78function should be used instead.
79.Sh SEE ALSO
80.Xr ctype 3 ,
81.Xr ctype_l 3 ,
82.Xr isascii 3 ,
83.Xr iswrune 3 ,
84.Xr iswrune_l 3 ,
85.Xr xlocale 3 ,
86.Xr ascii 7
87.Sh HISTORY
88The
89.Fn isrune
90function appeared in
91.Bx 4.4 .
92