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