freebsd-dev/lib/libc/locale/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$
.\"
.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:
.Bl -column \&``0''______ \&``0''______ \&``0''______ \&``0''______ \&``0''______
.It "\&``0''" Ta "``1''" Ta "``2''" Ta "``3''" Ta "``4''"
.It "\&``5''" Ta "``6''" Ta "``7''" Ta "``8''" Ta "``9''"
.It "\&``A''" Ta "``B''" Ta "``C''" Ta "``D''" Ta "``E''"
.It "\&``F''" Ta "``a''" Ta "``b''" Ta "``c''" Ta "``d''"
.It "\&``e''" Ta "``f''" Ta \& Ta \& Ta \&
.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 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 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" 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`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
Let the armchair generals handle this one. 2009-09-04 07:44:58 +00:00			`.Dd July 17, 2005`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Dt ISXDIGIT 3`
			`.Os`
			`.Sh NAME`
From the PR: 1. ctype.h defines digittoint(), isnumber() and ishexnmber(), yet they are not documented in any of the manpages. 2. The ctype manpage references a non-existent manpage for digittoint(). 3. The isascii() manpage claims it is standards compliant, when it isn't. 4. isblank() claims it is _not_ standards compliant, when it is. Fix by including the appropriate .Nm entries, and with a new digittoint.3 page. PR: docs/26451 Submitted by: Adrian Filipi-Martin <adrian@ubergeeks.com> 2002-01-09 13:43:31 +00:00			`.Nm isxdigit, ishexnumber`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Nd hexadecimal-digit character test`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In ctype.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft int`
Don't use literal semicolons in .Fn macro invocations. 1997-04-13 12:55:36 +00:00			`.Fn isxdigit "int c"`
From the PR: 1. ctype.h defines digittoint(), isnumber() and ishexnmber(), yet they are not documented in any of the manpages. 2. The ctype manpage references a non-existent manpage for digittoint(). 3. The isascii() manpage claims it is standards compliant, when it isn't. 4. isblank() claims it is _not_ standards compliant, when it is. Fix by including the appropriate .Nm entries, and with a new digittoint.3 page. PR: docs/26451 Submitted by: Adrian Filipi-Martin <adrian@ubergeeks.com> 2002-01-09 13:43:31 +00:00			`.Ft int`
			`.Fn ishexnumber "int c"`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Fn isxdigit`
			`function tests for any hexadecimal-digit character.`
Document the isnumber() and ishexnumber() functions, and explain how they differ (at least in theory) from isdigit() and isxdigit(). 2004-03-30 07:02:04 +00:00			`Regardless of locale, this includes the following characters only:`
Clarify that is[x]digit() class is the same in any locale 2001-11-29 15:23:46 +00:00			.Bl -column \&``0''______ \&``0''______ \&``0''______ \&``0''______ \&``0''______
mdoc: fix column names, indentation, column separation within each row, and quotation. Also make sure we have the same amount of columns in each row as the number of columns we specify in the head arguments. Reviewed by: brueffer 2012-04-07 09:05:30 +00:00			.It "\&``0''" Ta "``1''" Ta "``2''" Ta "``3''" Ta "``4''"
			.It "\&``5''" Ta "``6''" Ta "``7''" Ta "``8''" Ta "``9''"
			.It "\&``A''" Ta "``B''" Ta "``C''" Ta "``D''" Ta "``E''"
			.It "\&``F''" Ta "``a''" Ta "``b''" Ta "``c''" Ta "``d''"
			.It "\&``e''" Ta "``f''" Ta \& Ta \& Ta \&
Clarify that is[x]digit() class is the same in any locale 2001-11-29 15:23:46 +00:00			`.El`
			`.Pp`
Document the isnumber() and ishexnumber() functions, and explain how they differ (at least in theory) from isdigit() and isxdigit(). 2004-03-30 07:02:04 +00:00			`The`
			`.Fn ishexnumber`
			`function behaves similarly to`
			`.Fn isxdigit ,`
			`but may recognize additional characters,`
Spelling fixes. 2004-06-21 19:54:56 +00:00			`depending on the current locale setting.`
Document the isnumber() and ishexnumber() functions, and explain how they differ (at least in theory) from isdigit() and isxdigit(). 2004-03-30 07:02:04 +00:00			`.Pp`
Remove confusing "single C char locales" phrase; arguments to these functions and must now be either an unsigned char or EOF, regardless of locale. 2005-07-17 04:11:06 +00:00			`The value of the argument must be representable as an`
-mdoc sweep. 2005-11-17 13:00:00 +00:00			`.Vt "unsigned char"`
Better wording according to multibyte(3) Better man formatting Add reference to multibyte(3) 2000-04-11 14:41:37 +00:00			`or the value of`
			`.Dv EOF .`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh RETURN VALUES`
			`The`
			`.Fn isxdigit`
			`function returns zero if the character tests false and`
			`returns non-zero if the character tests true.`
Add a note to the Compatiblity section suggesting that these functions only be used for byte values. Add cross-references to the wide-char counterparts. 2002-10-06 10:15:38 +00:00			`.Sh COMPATIBILITY`
Re-word the COMPATIBILITY section, taking care to use the word "deprecated" to describe the 4.4BSD extension of accepting arguments outside the range of unsigned char. This gives us freedom to remove this extension when we remove the <rune.h> interface in FreeBSD 6. 2004-07-29 23:32:41 +00:00			`The`
Add a note to the Compatiblity section suggesting that these functions only be used for byte values. Add cross-references to the wide-char counterparts. 2002-10-06 10:15:38 +00:00			`.Bx 4.4`
Re-word the COMPATIBILITY section, taking care to use the word "deprecated" to describe the 4.4BSD extension of accepting arguments outside the range of unsigned char. This gives us freedom to remove this extension when we remove the <rune.h> interface in FreeBSD 6. 2004-07-29 23:32:41 +00:00			`extension of accepting arguments outside of the range of the`
			`.Vt "unsigned char"`
Re-word compatibility section, taking care to use the word "obsolete" to describe the 4.4BSD extension of accepting characters (runes) outside of the range of unsigned char. 2004-08-21 07:37:08 +00:00			`type in locales with large character sets is considered obsolete`
			`and may not be supported in future releases.`
Re-word the COMPATIBILITY section, taking care to use the word "deprecated" to describe the 4.4BSD extension of accepting arguments outside the range of unsigned char. This gives us freedom to remove this extension when we remove the <rune.h> interface in FreeBSD 6. 2004-07-29 23:32:41 +00:00			`The`
			`.Fn iswxdigit`
Re-word compatibility section, taking care to use the word "obsolete" to describe the 4.4BSD extension of accepting characters (runes) outside of the range of unsigned char. 2004-08-21 07:37:08 +00:00			`function should be used instead.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SEE ALSO`
			`.Xr ctype 3 ,`
Add a note to the Compatiblity section suggesting that these functions only be used for byte values. Add cross-references to the wide-char counterparts. 2002-10-06 10:15:38 +00:00			`.Xr iswxdigit 3 ,`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Xr ascii 7`
			`.Sh STANDARDS`
			`The`
			`.Fn isxdigit`
			`function conforms to`
.St -ansiC -> .St -isoC 2001-02-26 13:23:47 +00:00			`.St -isoC .`
Document the isnumber() and ishexnumber() functions, and explain how they differ (at least in theory) from isdigit() and isxdigit(). 2004-03-30 07:02:04 +00:00			`.Sh HISTORY`
			`The`
			`.Fn ishexnumber`
			`function appeared in`
			`.Bx 4.4 .`