[apple/libc.git] / locale / FreeBSD / isxdigit.3

.\" Copyright (c) 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the American National Standards Committee X3, on Information
.\" Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)isxdigit.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD: src/lib/libc/locale/isxdigit.3,v 1.25 2009/09/04 07:44:58 des Exp $
.\"
.Dd July 17, 2005
.Dt ISXDIGIT 3
.Os
.Sh NAME
.Nm isxdigit, ishexnumber
.Nd hexadecimal-digit character test
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In ctype.h
.Ft int
.Fn isxdigit "int c"
.Ft int
.Fn ishexnumber "int c"
.Sh DESCRIPTION
The
.Fn isxdigit
function tests for any hexadecimal-digit character.
Regardless of locale, this includes the following characters only:
.Pp
.Bl -column \&``0''______ \&``0''______ \&``0''______ \&``0''______ \&``0''______
.It "\&``0''\t``1''\t``2''\t``3''\t``4''"
.It "\&``5''\t``6''\t``7''\t``8''\t``9''"
.It "\&``A''\t``B''\t``C''\t``D''\t``E''"
.It "\&``F''\t``a''\t``b''\t``c''\t``d''"
.It "\&``e''\t``f''"
.El
.Pp
The
.Fn ishexnumber
function behaves similarly to
.Fn isxdigit ,
but may recognize additional characters,
depending on the current locale setting.
.Pp
The value of the argument must be representable as an
.Vt "unsigned char"
or the value of
.Dv EOF .
.Sh RETURN VALUES
The
.Fn isxdigit
function returns zero if the character tests false and
returns non-zero if the character tests true.
.Sh COMPATIBILITY
The
.Bx 4.4
extension of accepting arguments outside of the range of the
.Vt "unsigned char"
type in locales with large character sets is considered obsolete
and may not be supported in future releases.
The
.Fn iswxdigit
function should be used instead.
.Sh SEE ALSO
.Xr ctype 3 ,
.Xr isalnum_l 3 ,
.Xr iswxdigit 3 ,
.Xr ascii 7
.Sh STANDARDS
The
.Fn isxdigit
function conforms to
.St -isoC .
.Sh HISTORY
The
.Fn ishexnumber
function appeared in
.Bx 4.4 .
Commit	Line	Data
e9ce8d39 A	1	.\" Copyright (c) 1991, 1993
	2	.\" The Regents of the University of California. All rights reserved.
	3	.\"
5b2abdfb A	4	.\" This code is derived from software contributed to Berkeley by
	5	.\" the American National Standards Committee X3, on Information
	6	.\" Processing Systems.
	7	.\"
e9ce8d39 A	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.
e9ce8d39 A	16	.\" 4. 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	.\"
5b2abdfb	32	.\" @(#)isxdigit.3 8.1 (Berkeley) 6/4/93
1f2f436a	33	.\" $FreeBSD: src/lib/libc/locale/isxdigit.3,v 1.25 2009/09/04 07:44:58 des Exp $
e9ce8d39	34	.\"
1f2f436a	35	.Dd July 17, 2005
5b2abdfb	36	.Dt ISXDIGIT 3
e9ce8d39 A	37	.Os
e9ce8d39 A	38	.Sh NAME
9385eb3d	39	.Nm isxdigit, ishexnumber
5b2abdfb	40	.Nd hexadecimal-digit character test
e9ce8d39 A	41	.Sh LIBRARY
	42	.Lb libc
	43	.Sh SYNOPSIS
5b2abdfb	44	.In ctype.h
e9ce8d39	45	.Ft int
5b2abdfb	46	.Fn isxdigit "int c"
9385eb3d A	47	.Ft int
9385eb3d A	48	.Fn ishexnumber "int c"
e9ce8d39 A	49	.Sh DESCRIPTION
e9ce8d39 A	50	The
5b2abdfb A	51	.Fn isxdigit
5b2abdfb A	52	function tests for any hexadecimal-digit character.
3d9156a7	53	Regardless of locale, this includes the following characters only:
9385eb3d A	54	.Pp
	55	.Bl -column \&``0''______ \&``0''______ \&``0''______ \&``0''______ \&``0''______
	56	.It "\&``0''\t``1''\t``2''\t``3''\t``4''"
	57	.It "\&``5''\t``6''\t``7''\t``8''\t``9''"
	58	.It "\&``A''\t``B''\t``C''\t``D''\t``E''"
	59	.It "\&``F''\t``a''\t``b''\t``c''\t``d''"
	60	.It "\&``e''\t``f''"
	61	.El
	62	.Pp
3d9156a7 A	63	The
	64	.Fn ishexnumber
	65	function behaves similarly to
	66	.Fn isxdigit ,
	67	but may recognize additional characters,
	68	depending on the current locale setting.
	69	.Pp
1f2f436a A	70	The value of the argument must be representable as an
1f2f436a A	71	.Vt "unsigned char"
5b2abdfb A	72	or the value of
5b2abdfb A	73	.Dv EOF .
e9ce8d39	74	.Sh RETURN VALUES
5b2abdfb A	75	The
	76	.Fn isxdigit
	77	function returns zero if the character tests false and
	78	returns non-zero if the character tests true.
9385eb3d	79	.Sh COMPATIBILITY
3d9156a7	80	The
9385eb3d	81	.Bx 4.4
3d9156a7 A	82	extension of accepting arguments outside of the range of the
	83	.Vt "unsigned char"
	84	type in locales with large character sets is considered obsolete
	85	and may not be supported in future releases.
	86	The
	87	.Fn iswxdigit
	88	function should be used instead.
e9ce8d39	89	.Sh SEE ALSO
5b2abdfb	90	.Xr ctype 3 ,
ad3c9f2a	91	.Xr isalnum_l 3 ,
9385eb3d	92	.Xr iswxdigit 3 ,
5b2abdfb A	93	.Xr ascii 7
5b2abdfb A	94	.Sh STANDARDS
e9ce8d39	95	The
5b2abdfb A	96	.Fn isxdigit
	97	function conforms to
	98	.St -isoC .
3d9156a7 A	99	.Sh HISTORY
	100	The
	101	.Fn ishexnumber
	102	function appeared in
	103	.Bx 4.4 .