lib/libc/locale/isalnum.3

   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 .\"     @(#)isalnum.3   8.1 (Berkeley) 6/4/93
  33 .\"
  34 .Dd December 19, 2022
  35 .Dt ISALNUM 3
  36 .Os
  37 .Sh NAME
  38 .Nm isalnum ,
  39 .Nm isalnum_l
  40 .Nd alphanumeric character test
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In ctype.h
  45 .Ft int
  46 .Fn isalnum "int c"
  47 .Ft int
  48 .Fn isalnum_l "int c" "locale_t loc"
  49 .Sh DESCRIPTION
  50 The
  51 .Fn isalnum
  52 and
  53 .Fn isalnum_l
  54 functions test for any character for which
  55 .Xr isalpha 3 ,
  56 .Xr isalpha_l 3
  57 or
  58 .Xr isdigit 3 ,
  59 .Xr isdigit_l 3
  60 is true.
  61 The value of the argument must be representable as an
  62 .Vt "unsigned char"
  63 or the value of
  64 .Dv EOF .
  65 .Pp
  66 In the ASCII character set, this includes the following characters
  67 (with their numeric values shown in octal):
  68 .Bl -column \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__
  69 .It "\&060\ ``0''" Ta "061\ ``1''" Ta "062\ ``2''" Ta "063\ ``3''" Ta "064\ ``4''"
  70 .It "\&065\ ``5''" Ta "066\ ``6''" Ta "067\ ``7''" Ta "070\ ``8''" Ta "071\ ``9''"
  71 .It "\&101\ ``A''" Ta "102\ ``B''" Ta "103\ ``C''" Ta "104\ ``D''" Ta "105\ ``E''"
  72 .It "\&106\ ``F''" Ta "107\ ``G''" Ta "110\ ``H''" Ta "111\ ``I''" Ta "112\ ``J''"
  73 .It "\&113\ ``K''" Ta "114\ ``L''" Ta "115\ ``M''" Ta "116\ ``N''" Ta "117\ ``O''"
  74 .It "\&120\ ``P''" Ta "121\ ``Q''" Ta "122\ ``R''" Ta "123\ ``S''" Ta "124\ ``T''"
  75 .It "\&125\ ``U''" Ta "126\ ``V''" Ta "127\ ``W''" Ta "130\ ``X''" Ta "131\ ``Y''"
  76 .It "\&132\ ``Z''" Ta "141\ ``a''" Ta "142\ ``b''" Ta "143\ ``c''" Ta "144\ ``d''"
  77 .It "\&145\ ``e''" Ta "146\ ``f''" Ta "147\ ``g''" Ta "150\ ``h''" Ta "151\ ``i''"
  78 .It "\&152\ ``j''" Ta "153\ ``k''" Ta "154\ ``l''" Ta "155\ ``m''" Ta "156\ ``n''"
  79 .It "\&157\ ``o''" Ta "160\ ``p''" Ta "161\ ``q''" Ta "162\ ``r''" Ta "163\ ``s''"
  80 .It "\&164\ ``t''" Ta "165\ ``u''" Ta "166\ ``v''" Ta "167\ ``w''" Ta "170\ ``x''"
  81 .It "\&171\ ``y''" Ta "172\ ``z''" Ta \& Ta \& Ta \&
  82 .El
  83 .Pp
  84 The
  85 .Fn isalnum_l
  86 function takes an explicit locale argument, whereas the
  87 .Fn isalnum
  88 function uses the current global or per-thread locale.
  89 .Sh RETURN VALUES
  90 The
  91 .Fn isalnum
  92 and
  93 .Fn isalnum_l
  94 functions return zero if the character tests false and
  95 return non-zero if the character tests true.
  96 .Sh COMPATIBILITY
  97 The
  98 .Bx 4.4
  99 extension of accepting arguments outside of the range of the
 100 .Vt "unsigned char"
 101 type in locales with large character sets is considered obsolete
 102 and may not be supported in future releases.
 103 The
 104 .Fn iswalnum
 105 or
 106 .Fn iswalnum_l
 107 function should be used instead.
 108 .Sh SEE ALSO
 109 .Xr ctype 3 ,
 110 .Xr ctype_l 3 ,
 111 .Xr isalpha 3 ,
 112 .Xr isalpha_l 3 ,
 113 .Xr isdigit 3 ,
 114 .Xr isdigit_l 3 ,
 115 .Xr iswalnum 3 ,
 116 .Xr iswalnum_l 3 ,
 117 .Xr xlocale 3 ,
 118 .Xr ascii 7
 119 .Sh STANDARDS
 120 The
 121 .Fn isalnum
 122 function conforms to
 123 .St -isoC .
 124 The
 125 .Fn isalnum_l
 126 function conforms to
 127 .St -p1003.1-2008 .
 128 .Sh HISTORY
 129 The
 130 .Fn isalnum
 131 function first appeared in
 132 .At v7 .