xref: /freebsd/lib/libc/locale/isxdigit.3 (revision ec965063070e5753c166cf592c9336444b74720a)
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.\"     @(#)isxdigit.3	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD$
34.\"
35.Dd December 19, 2022
36.Dt ISXDIGIT 3
37.Os
38.Sh NAME
39.Nm isxdigit ,
40.Nm ishexnumber ,
41.Nm isxdigit_l ,
42.Nm ishexnumber_l
43.Nd hexadecimal-digit character test
44.Sh LIBRARY
45.Lb libc
46.Sh SYNOPSIS
47.In ctype.h
48.Ft int
49.Fn isxdigit "int c"
50.Ft int
51.Fn ishexnumber "int c"
52.Ft int
53.Fn isxdigit_l "int c" "locale_t loc"
54.Ft int
55.Fn ishexnumber_l "int c" "locale_t loc"
56.Sh DESCRIPTION
57The
58.Fn isxdigit
59and
60.Fn isxdigit_l
61functions test for any hexadecimal-digit character.
62Regardless of locale, this includes the following characters only:
63.Bl -column \&``0''______ \&``0''______ \&``0''______ \&``0''______ \&``0''______
64.It "\&``0''" Ta "``1''" Ta "``2''" Ta "``3''" Ta "``4''"
65.It "\&``5''" Ta "``6''" Ta "``7''" Ta "``8''" Ta "``9''"
66.It "\&``A''" Ta "``B''" Ta "``C''" Ta "``D''" Ta "``E''"
67.It "\&``F''" Ta "``a''" Ta "``b''" Ta "``c''" Ta "``d''"
68.It "\&``e''" Ta "``f''" Ta \& Ta \& Ta \&
69.El
70.Pp
71The
72.Fn ishexnumber
73and
74.Fn ishexnumber_l
75functions behave similarly to
76.Fn isxdigit
77and
78.Fn isxdigit_l ,
79but may recognize additional characters,
80depending on the current locale setting.
81.Pp
82The value of the argument must be representable as an
83.Vt "unsigned char"
84or the value of
85.Dv EOF .
86.Pp
87The _l-suffixed versions take an explicit locale argument, whereas the
88non-suffixed versions use the current global or per-thread locale.
89.Sh RETURN VALUES
90The
91.Fn isxdigit
92and
93.Fn isxdigit_l
94functions return zero if the character tests false and
95return non-zero if the character tests true.
96.Sh COMPATIBILITY
97The
98.Bx 4.4
99extension of accepting arguments outside of the range of the
100.Vt "unsigned char"
101type in locales with large character sets is considered obsolete
102and may not be supported in future releases.
103The
104.Fn iswxdigit
105or
106.Fn iswxdigit_l
107function should be used instead.
108.Sh SEE ALSO
109.Xr ctype 3 ,
110.Xr ctype_l 3 ,
111.Xr iswxdigit 3 ,
112.Xr iswxdigit_l 3 ,
113.Xr xlocale 3 ,
114.Xr ascii 7
115.Sh STANDARDS
116The
117.Fn isxdigit
118function conforms to
119.St -isoC .
120.Sh HISTORY
121The
122.Fn ishexnumber
123function appeared in
124.Bx 4.4 .
125