xref: /openbsd/gnu/lib/libiberty/src/safe-ctype.c (revision 20fce977)
12e0724c7Sespie /* <ctype.h> replacement macros.
22e0724c7Sespie 
3*20fce977Smiod    Copyright (C) 2000, 2001, 2002, 2003, 2004,
4*20fce977Smiod    2005 Free Software Foundation, Inc.
52e0724c7Sespie    Contributed by Zack Weinberg <zackw@stanford.edu>.
62e0724c7Sespie 
72e0724c7Sespie This file is part of the libiberty library.
82e0724c7Sespie Libiberty is free software; you can redistribute it and/or
92e0724c7Sespie modify it under the terms of the GNU Library General Public
102e0724c7Sespie License as published by the Free Software Foundation; either
112e0724c7Sespie version 2 of the License, or (at your option) any later version.
122e0724c7Sespie 
132e0724c7Sespie Libiberty is distributed in the hope that it will be useful,
142e0724c7Sespie but WITHOUT ANY WARRANTY; without even the implied warranty of
152e0724c7Sespie MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
162e0724c7Sespie Library General Public License for more details.
172e0724c7Sespie 
182e0724c7Sespie You should have received a copy of the GNU Library General Public
192e0724c7Sespie License along with libiberty; see the file COPYING.LIB.  If
20*20fce977Smiod not, write to the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
21*20fce977Smiod Boston, MA 02110-1301, USA.  */
222e0724c7Sespie 
23*20fce977Smiod /*
242e0724c7Sespie 
25*20fce977Smiod @defvr Extension HOST_CHARSET
26*20fce977Smiod This macro indicates the basic character set and encoding used by the
27*20fce977Smiod host: more precisely, the encoding used for character constants in
28*20fce977Smiod preprocessor @samp{#if} statements (the C "execution character set").
29*20fce977Smiod It is defined by @file{safe-ctype.h}, and will be an integer constant
30*20fce977Smiod with one of the following values:
31*20fce977Smiod 
32*20fce977Smiod @ftable @code
33*20fce977Smiod @item HOST_CHARSET_UNKNOWN
34*20fce977Smiod The host character set is unknown - that is, not one of the next two
35*20fce977Smiod possibilities.
36*20fce977Smiod 
37*20fce977Smiod @item HOST_CHARSET_ASCII
38*20fce977Smiod The host character set is ASCII.
39*20fce977Smiod 
40*20fce977Smiod @item HOST_CHARSET_EBCDIC
41*20fce977Smiod The host character set is some variant of EBCDIC.  (Only one of the
42*20fce977Smiod nineteen EBCDIC varying characters is tested; exercise caution.)
43*20fce977Smiod @end ftable
44*20fce977Smiod @end defvr
45*20fce977Smiod 
46*20fce977Smiod @deffn  Extension ISALPHA  (@var{c})
47*20fce977Smiod @deffnx Extension ISALNUM  (@var{c})
48*20fce977Smiod @deffnx Extension ISBLANK  (@var{c})
49*20fce977Smiod @deffnx Extension ISCNTRL  (@var{c})
50*20fce977Smiod @deffnx Extension ISDIGIT  (@var{c})
51*20fce977Smiod @deffnx Extension ISGRAPH  (@var{c})
52*20fce977Smiod @deffnx Extension ISLOWER  (@var{c})
53*20fce977Smiod @deffnx Extension ISPRINT  (@var{c})
54*20fce977Smiod @deffnx Extension ISPUNCT  (@var{c})
55*20fce977Smiod @deffnx Extension ISSPACE  (@var{c})
56*20fce977Smiod @deffnx Extension ISUPPER  (@var{c})
57*20fce977Smiod @deffnx Extension ISXDIGIT (@var{c})
58*20fce977Smiod 
59*20fce977Smiod These twelve macros are defined by @file{safe-ctype.h}.  Each has the
60*20fce977Smiod same meaning as the corresponding macro (with name in lowercase)
61*20fce977Smiod defined by the standard header @file{ctype.h}.  For example,
62*20fce977Smiod @code{ISALPHA} returns true for alphabetic characters and false for
63*20fce977Smiod others.  However, there are two differences between these macros and
64*20fce977Smiod those provided by @file{ctype.h}:
65*20fce977Smiod 
66*20fce977Smiod @itemize @bullet
67*20fce977Smiod @item These macros are guaranteed to have well-defined behavior for all
68*20fce977Smiod values representable by @code{signed char} and @code{unsigned char}, and
69*20fce977Smiod for @code{EOF}.
70*20fce977Smiod 
71*20fce977Smiod @item These macros ignore the current locale; they are true for these
72*20fce977Smiod fixed sets of characters:
73*20fce977Smiod @multitable {@code{XDIGIT}} {yada yada yada yada yada yada yada yada}
74*20fce977Smiod @item @code{ALPHA}  @tab @kbd{A-Za-z}
75*20fce977Smiod @item @code{ALNUM}  @tab @kbd{A-Za-z0-9}
76*20fce977Smiod @item @code{BLANK}  @tab @kbd{space tab}
77*20fce977Smiod @item @code{CNTRL}  @tab @code{!PRINT}
78*20fce977Smiod @item @code{DIGIT}  @tab @kbd{0-9}
79*20fce977Smiod @item @code{GRAPH}  @tab @code{ALNUM || PUNCT}
80*20fce977Smiod @item @code{LOWER}  @tab @kbd{a-z}
81*20fce977Smiod @item @code{PRINT}  @tab @code{GRAPH ||} @kbd{space}
82*20fce977Smiod @item @code{PUNCT}  @tab @kbd{`~!@@#$%^&*()_-=+[@{]@}\|;:'",<.>/?}
83*20fce977Smiod @item @code{SPACE}  @tab @kbd{space tab \n \r \f \v}
84*20fce977Smiod @item @code{UPPER}  @tab @kbd{A-Z}
85*20fce977Smiod @item @code{XDIGIT} @tab @kbd{0-9A-Fa-f}
86*20fce977Smiod @end multitable
87*20fce977Smiod 
88*20fce977Smiod Note that, if the host character set is ASCII or a superset thereof,
89*20fce977Smiod all these macros will return false for all values of @code{char} outside
90*20fce977Smiod the range of 7-bit ASCII.  In particular, both ISPRINT and ISCNTRL return
91*20fce977Smiod false for characters with numeric values from 128 to 255.
92*20fce977Smiod @end itemize
93*20fce977Smiod @end deffn
94*20fce977Smiod 
95*20fce977Smiod @deffn  Extension ISIDNUM         (@var{c})
96*20fce977Smiod @deffnx Extension ISIDST          (@var{c})
97*20fce977Smiod @deffnx Extension IS_VSPACE       (@var{c})
98*20fce977Smiod @deffnx Extension IS_NVSPACE      (@var{c})
99*20fce977Smiod @deffnx Extension IS_SPACE_OR_NUL (@var{c})
100*20fce977Smiod @deffnx Extension IS_ISOBASIC     (@var{c})
101*20fce977Smiod These six macros are defined by @file{safe-ctype.h} and provide
102*20fce977Smiod additional character classes which are useful when doing lexical
103*20fce977Smiod analysis of C or similar languages.  They are true for the following
104*20fce977Smiod sets of characters:
105*20fce977Smiod 
106*20fce977Smiod @multitable {@code{SPACE_OR_NUL}} {yada yada yada yada yada yada yada yada}
107*20fce977Smiod @item @code{IDNUM}        @tab @kbd{A-Za-z0-9_}
108*20fce977Smiod @item @code{IDST}         @tab @kbd{A-Za-z_}
109*20fce977Smiod @item @code{VSPACE}       @tab @kbd{\r \n}
110*20fce977Smiod @item @code{NVSPACE}      @tab @kbd{space tab \f \v \0}
111*20fce977Smiod @item @code{SPACE_OR_NUL} @tab @code{VSPACE || NVSPACE}
112*20fce977Smiod @item @code{ISOBASIC}     @tab @code{VSPACE || NVSPACE || PRINT}
113*20fce977Smiod @end multitable
114*20fce977Smiod @end deffn
115*20fce977Smiod 
116*20fce977Smiod */
1172e0724c7Sespie 
1182e0724c7Sespie #include "ansidecl.h"
1192e0724c7Sespie #include <safe-ctype.h>
1202e0724c7Sespie #include <stdio.h>  /* for EOF */
1212e0724c7Sespie 
122*20fce977Smiod #if EOF != -1
123*20fce977Smiod  #error "<safe-ctype.h> requires EOF == -1"
124*20fce977Smiod #endif
125*20fce977Smiod 
1262e0724c7Sespie /* Shorthand */
1272e0724c7Sespie #define bl _sch_isblank
1282e0724c7Sespie #define cn _sch_iscntrl
1292e0724c7Sespie #define di _sch_isdigit
1302e0724c7Sespie #define is _sch_isidst
1312e0724c7Sespie #define lo _sch_islower
1322e0724c7Sespie #define nv _sch_isnvsp
1332e0724c7Sespie #define pn _sch_ispunct
1342e0724c7Sespie #define pr _sch_isprint
1352e0724c7Sespie #define sp _sch_isspace
1362e0724c7Sespie #define up _sch_isupper
1372e0724c7Sespie #define vs _sch_isvsp
1382e0724c7Sespie #define xd _sch_isxdigit
1392e0724c7Sespie 
1402e0724c7Sespie /* Masks.  */
1419588ddcfSespie #define L  (const unsigned short) (lo|is   |pr)	/* lower case letter */
1429588ddcfSespie #define XL (const unsigned short) (lo|is|xd|pr)	/* lowercase hex digit */
1439588ddcfSespie #define U  (const unsigned short) (up|is   |pr)	/* upper case letter */
1449588ddcfSespie #define XU (const unsigned short) (up|is|xd|pr)	/* uppercase hex digit */
1459588ddcfSespie #define D  (const unsigned short) (di   |xd|pr)	/* decimal digit */
1469588ddcfSespie #define P  (const unsigned short) (pn      |pr)	/* punctuation */
1479588ddcfSespie #define _  (const unsigned short) (pn|is   |pr)	/* underscore */
1482e0724c7Sespie 
1499588ddcfSespie #define C  (const unsigned short) (         cn)	/* control character */
1509588ddcfSespie #define Z  (const unsigned short) (nv      |cn)	/* NUL */
1519588ddcfSespie #define M  (const unsigned short) (nv|sp   |cn)	/* cursor movement: \f \v */
1529588ddcfSespie #define V  (const unsigned short) (vs|sp   |cn)	/* vertical space: \r \n */
1539588ddcfSespie #define T  (const unsigned short) (nv|sp|bl|cn)	/* tab */
1549588ddcfSespie #define S  (const unsigned short) (nv|sp|bl|pr)	/* space */
1552e0724c7Sespie 
1562e0724c7Sespie /* Are we ASCII? */
157*20fce977Smiod #if HOST_CHARSET == HOST_CHARSET_ASCII
1582e0724c7Sespie 
1592e0724c7Sespie const unsigned short _sch_istable[256] =
1602e0724c7Sespie {
1612e0724c7Sespie   Z,  C,  C,  C,   C,  C,  C,  C,   /* NUL SOH STX ETX  EOT ENQ ACK BEL */
1622e0724c7Sespie   C,  T,  V,  M,   M,  V,  C,  C,   /* BS  HT  LF  VT   FF  CR  SO  SI  */
1632e0724c7Sespie   C,  C,  C,  C,   C,  C,  C,  C,   /* DLE DC1 DC2 DC3  DC4 NAK SYN ETB */
1642e0724c7Sespie   C,  C,  C,  C,   C,  C,  C,  C,   /* CAN EM  SUB ESC  FS  GS  RS  US  */
1652e0724c7Sespie   S,  P,  P,  P,   P,  P,  P,  P,   /* SP  !   "   #    $   %   &   '   */
1662e0724c7Sespie   P,  P,  P,  P,   P,  P,  P,  P,   /* (   )   *   +    ,   -   .   /   */
1672e0724c7Sespie   D,  D,  D,  D,   D,  D,  D,  D,   /* 0   1   2   3    4   5   6   7   */
1682e0724c7Sespie   D,  D,  P,  P,   P,  P,  P,  P,   /* 8   9   :   ;    <   =   >   ?   */
1692e0724c7Sespie   P, XU, XU, XU,  XU, XU, XU,  U,   /* @   A   B   C    D   E   F   G   */
1702e0724c7Sespie   U,  U,  U,  U,   U,  U,  U,  U,   /* H   I   J   K    L   M   N   O   */
1712e0724c7Sespie   U,  U,  U,  U,   U,  U,  U,  U,   /* P   Q   R   S    T   U   V   W   */
1722e0724c7Sespie   U,  U,  U,  P,   P,  P,  P,  _,   /* X   Y   Z   [    \   ]   ^   _   */
1732e0724c7Sespie   P, XL, XL, XL,  XL, XL, XL,  L,   /* `   a   b   c    d   e   f   g   */
1742e0724c7Sespie   L,  L,  L,  L,   L,  L,  L,  L,   /* h   i   j   k    l   m   n   o   */
1752e0724c7Sespie   L,  L,  L,  L,   L,  L,  L,  L,   /* p   q   r   s    t   u   v   w   */
1762e0724c7Sespie   L,  L,  L,  P,   P,  P,  P,  C,   /* x   y   z   {    |   }   ~   DEL */
1772e0724c7Sespie 
1782e0724c7Sespie   /* high half of unsigned char is locale-specific, so all tests are
1792e0724c7Sespie      false in "C" locale */
1802e0724c7Sespie   0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,
1812e0724c7Sespie   0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,
1822e0724c7Sespie   0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,
1832e0724c7Sespie   0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,
1842e0724c7Sespie 
1852e0724c7Sespie   0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,
1862e0724c7Sespie   0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,
1872e0724c7Sespie   0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,
1882e0724c7Sespie   0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,  0, 0, 0, 0,
1892e0724c7Sespie };
1902e0724c7Sespie 
1912e0724c7Sespie const unsigned char _sch_tolower[256] =
1922e0724c7Sespie {
1932e0724c7Sespie    0,  1,  2,  3,   4,  5,  6,  7,   8,  9, 10, 11,  12, 13, 14, 15,
1942e0724c7Sespie   16, 17, 18, 19,  20, 21, 22, 23,  24, 25, 26, 27,  28, 29, 30, 31,
1952e0724c7Sespie   32, 33, 34, 35,  36, 37, 38, 39,  40, 41, 42, 43,  44, 45, 46, 47,
1962e0724c7Sespie   48, 49, 50, 51,  52, 53, 54, 55,  56, 57, 58, 59,  60, 61, 62, 63,
1972e0724c7Sespie   64,
1982e0724c7Sespie 
1992e0724c7Sespie   'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
2002e0724c7Sespie   'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
2012e0724c7Sespie 
2022e0724c7Sespie   91, 92, 93, 94, 95, 96,
2032e0724c7Sespie 
2042e0724c7Sespie   'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
2052e0724c7Sespie   'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
2062e0724c7Sespie 
2072e0724c7Sespie  123,124,125,126,127,
2082e0724c7Sespie 
2092e0724c7Sespie  128,129,130,131, 132,133,134,135, 136,137,138,139, 140,141,142,143,
2102e0724c7Sespie  144,145,146,147, 148,149,150,151, 152,153,154,155, 156,157,158,159,
2112e0724c7Sespie  160,161,162,163, 164,165,166,167, 168,169,170,171, 172,173,174,175,
2122e0724c7Sespie  176,177,178,179, 180,181,182,183, 184,185,186,187, 188,189,190,191,
2132e0724c7Sespie 
2142e0724c7Sespie  192,193,194,195, 196,197,198,199, 200,201,202,203, 204,205,206,207,
2152e0724c7Sespie  208,209,210,211, 212,213,214,215, 216,217,218,219, 220,221,222,223,
2162e0724c7Sespie  224,225,226,227, 228,229,230,231, 232,233,234,235, 236,237,238,239,
2172e0724c7Sespie  240,241,242,243, 244,245,246,247, 248,249,250,251, 252,253,254,255,
2182e0724c7Sespie };
2192e0724c7Sespie 
2202e0724c7Sespie const unsigned char _sch_toupper[256] =
2212e0724c7Sespie {
2222e0724c7Sespie    0,  1,  2,  3,   4,  5,  6,  7,   8,  9, 10, 11,  12, 13, 14, 15,
2232e0724c7Sespie   16, 17, 18, 19,  20, 21, 22, 23,  24, 25, 26, 27,  28, 29, 30, 31,
2242e0724c7Sespie   32, 33, 34, 35,  36, 37, 38, 39,  40, 41, 42, 43,  44, 45, 46, 47,
2252e0724c7Sespie   48, 49, 50, 51,  52, 53, 54, 55,  56, 57, 58, 59,  60, 61, 62, 63,
2262e0724c7Sespie   64,
2272e0724c7Sespie 
2282e0724c7Sespie   'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
2292e0724c7Sespie   'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
2302e0724c7Sespie 
2312e0724c7Sespie   91, 92, 93, 94, 95, 96,
2322e0724c7Sespie 
2332e0724c7Sespie   'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
2342e0724c7Sespie   'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
2352e0724c7Sespie 
2362e0724c7Sespie  123,124,125,126,127,
2372e0724c7Sespie 
2382e0724c7Sespie  128,129,130,131, 132,133,134,135, 136,137,138,139, 140,141,142,143,
2392e0724c7Sespie  144,145,146,147, 148,149,150,151, 152,153,154,155, 156,157,158,159,
2402e0724c7Sespie  160,161,162,163, 164,165,166,167, 168,169,170,171, 172,173,174,175,
2412e0724c7Sespie  176,177,178,179, 180,181,182,183, 184,185,186,187, 188,189,190,191,
2422e0724c7Sespie 
2432e0724c7Sespie  192,193,194,195, 196,197,198,199, 200,201,202,203, 204,205,206,207,
2442e0724c7Sespie  208,209,210,211, 212,213,214,215, 216,217,218,219, 220,221,222,223,
2452e0724c7Sespie  224,225,226,227, 228,229,230,231, 232,233,234,235, 236,237,238,239,
2462e0724c7Sespie  240,241,242,243, 244,245,246,247, 248,249,250,251, 252,253,254,255,
2472e0724c7Sespie };
2482e0724c7Sespie 
2492e0724c7Sespie #else
250*20fce977Smiod # if HOST_CHARSET == HOST_CHARSET_EBCDIC
251*20fce977Smiod   #error "FIXME: write tables for EBCDIC"
252*20fce977Smiod # else
253*20fce977Smiod   #error "Unrecognized host character set"
254*20fce977Smiod # endif
255*20fce977Smiod #endif
256