12a6b7db3Sskrll /* Hex character manipulation support.
2*f22f0ef4Schristos    Copyright (C) 1995-2022 Free Software Foundation, Inc.
32a6b7db3Sskrll 
42a6b7db3Sskrll This file is part of the libiberty library.
52a6b7db3Sskrll Libiberty is free software; you can redistribute it and/or
62a6b7db3Sskrll modify it under the terms of the GNU Library General Public
72a6b7db3Sskrll License as published by the Free Software Foundation; either
82a6b7db3Sskrll version 2 of the License, or (at your option) any later version.
92a6b7db3Sskrll 
102a6b7db3Sskrll Libiberty is distributed in the hope that it will be useful,
112a6b7db3Sskrll but WITHOUT ANY WARRANTY; without even the implied warranty of
122a6b7db3Sskrll MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
132a6b7db3Sskrll Library General Public License for more details.
142a6b7db3Sskrll 
152a6b7db3Sskrll You should have received a copy of the GNU Library General Public
162a6b7db3Sskrll License along with libiberty; see the file COPYING.LIB.  If
172a6b7db3Sskrll not, write to the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
182a6b7db3Sskrll Boston, MA 02110-1301, USA.  */
192a6b7db3Sskrll 
202a6b7db3Sskrll #include <stdio.h>  /* for EOF */
212a6b7db3Sskrll #ifdef HAVE_CONFIG_H
222a6b7db3Sskrll #include "config.h"
232a6b7db3Sskrll #endif
242a6b7db3Sskrll #include "libiberty.h"
252a6b7db3Sskrll #include "safe-ctype.h" /* for HOST_CHARSET_ASCII */
262a6b7db3Sskrll 
272a6b7db3Sskrll #if EOF != -1
282a6b7db3Sskrll  #error "hex.c requires EOF == -1"
292a6b7db3Sskrll #endif
302a6b7db3Sskrll 
312a6b7db3Sskrll /*
322a6b7db3Sskrll 
332a6b7db3Sskrll @deftypefn Extension void hex_init (void)
342a6b7db3Sskrll 
352a6b7db3Sskrll Initializes the array mapping the current character set to
362a6b7db3Sskrll corresponding hex values.  This function must be called before any
372a6b7db3Sskrll call to @code{hex_p} or @code{hex_value}.  If you fail to call it, a
382a6b7db3Sskrll default ASCII-based table will normally be used on ASCII systems.
392a6b7db3Sskrll 
402a6b7db3Sskrll @end deftypefn
412a6b7db3Sskrll 
422a6b7db3Sskrll @deftypefn Extension int hex_p (int @var{c})
432a6b7db3Sskrll 
442a6b7db3Sskrll Evaluates to non-zero if the given character is a valid hex character,
452a6b7db3Sskrll or zero if it is not.  Note that the value you pass will be cast to
462a6b7db3Sskrll @code{unsigned char} within the macro.
472a6b7db3Sskrll 
482a6b7db3Sskrll @end deftypefn
492a6b7db3Sskrll 
502a6b7db3Sskrll @deftypefn Extension {unsigned int} hex_value (int @var{c})
512a6b7db3Sskrll 
522a6b7db3Sskrll Returns the numeric equivalent of the given character when interpreted
532a6b7db3Sskrll as a hexadecimal digit.  The result is undefined if you pass an
542a6b7db3Sskrll invalid hex digit.  Note that the value you pass will be cast to
552a6b7db3Sskrll @code{unsigned char} within the macro.
562a6b7db3Sskrll 
572a6b7db3Sskrll The @code{hex_value} macro returns @code{unsigned int}, rather than
582a6b7db3Sskrll signed @code{int}, to make it easier to use in parsing addresses from
592a6b7db3Sskrll hex dump files: a signed @code{int} would be sign-extended when
602a6b7db3Sskrll converted to a wider unsigned type --- like @code{bfd_vma}, on some
612a6b7db3Sskrll systems.
622a6b7db3Sskrll 
632a6b7db3Sskrll @end deftypefn
642a6b7db3Sskrll 
652a6b7db3Sskrll @undocumented _hex_array_size
662a6b7db3Sskrll @undocumented _hex_bad
672a6b7db3Sskrll @undocumented _hex_value
682a6b7db3Sskrll 
692a6b7db3Sskrll */
702a6b7db3Sskrll 
712a6b7db3Sskrll 
722a6b7db3Sskrll /* Are we ASCII? */
732a6b7db3Sskrll #if HOST_CHARSET == HOST_CHARSET_ASCII
742a6b7db3Sskrll 
752a6b7db3Sskrll const unsigned char _hex_value[_hex_array_size] =
762a6b7db3Sskrll {
772a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* NUL SOH STX ETX */
782a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* EOT ENQ ACK BEL */
792a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* BS  HT  LF  VT  */
802a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* FF  CR  SO  SI  */
812a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* DLE DC1 DC2 DC3 */
822a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* DC4 NAK SYN ETB */
832a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* CAN EM  SUB ESC */
842a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* FS  GS  RS  US  */
852a6b7db3Sskrll 
862a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* SP  !   "   #   */
872a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* $   %   &   '   */
882a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* (   )   *   +   */
892a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* ,   -   .   /   */
902a6b7db3Sskrll   0,        1,        2,        3,          /* 0   1   2   3   */
912a6b7db3Sskrll   4,        5,        6,        7,          /* 4   5   6   7   */
922a6b7db3Sskrll   8,        9,        _hex_bad, _hex_bad,   /* 8   9   :   ;   */
932a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* <   =   >   ?   */
942a6b7db3Sskrll 
952a6b7db3Sskrll   _hex_bad, 10,       11,       12,         /* @   A   B   C   */
962a6b7db3Sskrll   13,       14,       15,       _hex_bad,   /* D   E   F   G   */
972a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* H   I   J   K   */
982a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* L   M   N   O   */
992a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* P   Q   R   S   */
1002a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* T   U   V   W   */
1012a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* X   Y   Z   [   */
1022a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* \   ]   ^   _   */
1032a6b7db3Sskrll 
1042a6b7db3Sskrll   _hex_bad, 10,       11,       12,         /* `   a   b   c   */
1052a6b7db3Sskrll   13,       14,       15,       _hex_bad,   /* d   e   f   g   */
1062a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* h   i   j   k   */
1072a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* l   m   n   o   */
1082a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* p   q   r   s   */
1092a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* t   u   v   w   */
1102a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* x   y   z   {   */
1112a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,   /* |   }   ~   DEL */
1122a6b7db3Sskrll 
1132a6b7db3Sskrll   /* The high half of unsigned char, all values are _hex_bad.  */
1142a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1152a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1162a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1172a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1182a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1192a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1202a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1212a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1222a6b7db3Sskrll 
1232a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1242a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1252a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1262a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1272a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1282a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1292a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1302a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1312a6b7db3Sskrll 
1322a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1332a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1342a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1352a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1362a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1372a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1382a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1392a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1402a6b7db3Sskrll 
1412a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1422a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1432a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1442a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1452a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1462a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1472a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1482a6b7db3Sskrll   _hex_bad, _hex_bad, _hex_bad, _hex_bad,
1492a6b7db3Sskrll };
1502a6b7db3Sskrll #define HEX_TABLE_INITIALIZED
1512a6b7db3Sskrll 
1522a6b7db3Sskrll #else
1532a6b7db3Sskrll 
1542a6b7db3Sskrll unsigned char _hex_value[_hex_array_size];
1552a6b7db3Sskrll 
1562a6b7db3Sskrll #endif /* not ASCII */
1572a6b7db3Sskrll 
1582a6b7db3Sskrll void
hex_init(void)1592a6b7db3Sskrll hex_init (void)
1602a6b7db3Sskrll {
1612a6b7db3Sskrll #ifndef HEX_TABLE_INITIALIZED
1622a6b7db3Sskrll   int i;
1632a6b7db3Sskrll 
1642a6b7db3Sskrll   for (i=0; i<_hex_array_size; i++)
1652a6b7db3Sskrll     {
1662a6b7db3Sskrll       switch (i)
1672a6b7db3Sskrll 	{
1682a6b7db3Sskrll 	case '0': _hex_value[i] = 0; break;
1692a6b7db3Sskrll 	case '1': _hex_value[i] = 1; break;
1702a6b7db3Sskrll 	case '2': _hex_value[i] = 2; break;
1712a6b7db3Sskrll 	case '3': _hex_value[i] = 3; break;
1722a6b7db3Sskrll 	case '4': _hex_value[i] = 4; break;
1732a6b7db3Sskrll 	case '5': _hex_value[i] = 5; break;
1742a6b7db3Sskrll 	case '6': _hex_value[i] = 6; break;
1752a6b7db3Sskrll 	case '7': _hex_value[i] = 7; break;
1762a6b7db3Sskrll 	case '8': _hex_value[i] = 8; break;
1772a6b7db3Sskrll 	case '9': _hex_value[i] = 9; break;
1782a6b7db3Sskrll 
1792a6b7db3Sskrll 	case 'a': case 'A': _hex_value[i] = 10; break;
1802a6b7db3Sskrll 	case 'b': case 'B': _hex_value[i] = 11; break;
1812a6b7db3Sskrll 	case 'c': case 'C': _hex_value[i] = 12; break;
1822a6b7db3Sskrll 	case 'd': case 'D': _hex_value[i] = 13; break;
1832a6b7db3Sskrll 	case 'e': case 'E': _hex_value[i] = 14; break;
1842a6b7db3Sskrll 	case 'f': case 'F': _hex_value[i] = 15; break;
1852a6b7db3Sskrll 
1862a6b7db3Sskrll 	default:
1872a6b7db3Sskrll 	  _hex_value[i] = _hex_bad;
1882a6b7db3Sskrll 	  break;
1892a6b7db3Sskrll 	}
1902a6b7db3Sskrll     }
1912a6b7db3Sskrll #endif
1922a6b7db3Sskrll }
193