contrib/perl5/handy.h

   1 /*    handy.h
   2  *
   3  *    Copyright (c) 1991-1999, Larry Wall
   4  *
   5  *    You may distribute under the terms of either the GNU General Public
   6  *    License or the Artistic License, as specified in the README file.
   7  *
   8  */
   9
  10 #if !defined(__STDC__)
  11 #ifdef NULL
  12 #undef NULL
  13 #endif
  14 #ifndef I286
  15 #  define NULL 0
  16 #else
  17 #  define NULL 0L
  18 #endif
  19 #endif
  20
  21 #define Null(type) ((type)NULL)
  22 #define Nullch Null(char*)
  23 #define Nullfp Null(PerlIO*)
  24 #define Nullsv Null(SV*)
  25
  26 #ifdef TRUE
  27 #undef TRUE
  28 #endif
  29 #ifdef FALSE
  30 #undef FALSE
  31 #endif
  32 #define TRUE (1)
  33 #define FALSE (0)
  34
  35
  36 /* XXX Configure ought to have a test for a boolean type, if I can
  37    just figure out all the headers such a test needs.
  38    Andy Dougherty       August 1996
  39 */
  40 /* bool is built-in for g++-2.6.3, which might be used for an extension.
  41    If the extension includes <_G_config.h> before this file then
  42    _G_HAVE_BOOL will be properly set.  If, however, the extension includes
  43    this file first, then you will have to manually set -DHAS_BOOL in
  44    your command line to avoid a conflict.
  45 */
  46 #ifdef _G_HAVE_BOOL
  47 # if _G_HAVE_BOOL
  48 #  ifndef HAS_BOOL
  49 #   define HAS_BOOL 1
  50 #  endif
  51 # endif
  52 #endif
  53
  54 /* The NeXT dynamic loader headers will not build with the bool macro
  55    So declare them now to clear confusion.
  56 */
  57 #ifdef NeXT
  58 # undef FALSE
  59 # undef TRUE
  60   typedef enum bool { FALSE = 0, TRUE = 1 } bool;
  61 # define ENUM_BOOL 1
  62 # ifndef HAS_BOOL
  63 #  define HAS_BOOL 1
  64 # endif /* !HAS_BOOL */
  65 #endif /* NeXT */
  66
  67 #ifndef HAS_BOOL
  68 # if defined(UTS) || defined(VMS)
  69 #  define bool int
  70 # else
  71 #  define bool char
  72 # endif
  73 #endif
  74
  75 /* XXX A note on the perl source internal type system.  The
  76    original intent was that I32 be *exactly* 32 bits.
  77
  78    Currently, we only guarantee that I32 is *at least* 32 bits.
  79    Specifically, if int is 64 bits, then so is I32.  (This is the case
  80    for the Cray.)  This has the advantage of meshing nicely with
  81    standard library calls (where we pass an I32 and the library is
  82    expecting an int), but the disadvantage that an I32 is not 32 bits.
  83    Andy Dougherty       August 1996
  84
  85    There is no guarantee that there is *any* integral type with
  86    exactly 32 bits.  It is perfectly legal for a system to have
  87    sizeof(short) == sizeof(int) == sizeof(long) == 8.
  88
  89    Similarly, there is no guarantee that I16 and U16 have exactly 16
  90    bits.
  91
  92    For dealing with issues that may arise from various 32/64-bit
  93    systems, we will ask Configure to check out
  94         SHORTSIZE == sizeof(short)
  95         INTSIZE == sizeof(int)
  96         LONGSIZE == sizeof(long)
  97         LONGLONGSIZE == sizeof(long long) (if HAS_LONG_LONG)
  98         PTRSIZE == sizeof(void *)
  99         DOUBLESIZE == sizeof(double)
 100         LONG_DOUBLESIZE == sizeof(long double) (if HAS_LONG_DOUBLE).
 101     Most of these are currently unused, but they are mentioned here so
 102     metaconfig will include the appropriate tests in Configure and
 103     we can then start to consider how best to deal with long long
 104     variables.
 105    Andy Dougherty       April 1998
 106 */
 107
 108 typedef char            I8;
 109 typedef unsigned char   U8;
 110 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
 111    Please search CHAR_MAX in perl.h for further details. */
 112 #define U8_MAX PERL_UCHAR_MAX
 113 #define U8_MIN PERL_UCHAR_MIN
 114
 115 typedef short           I16;
 116 typedef unsigned short  U16;
 117 #define I16_MAX PERL_SHORT_MAX
 118 #define I16_MIN PERL_SHORT_MIN
 119 #define U16_MAX PERL_USHORT_MAX
 120 #define U16_MIN PERL_USHORT_MIN
 121
 122 #if LONGSIZE > 4
 123   typedef int           I32;
 124   typedef unsigned int  U32;
 125 # define I32_MAX PERL_INT_MAX
 126 # define I32_MIN PERL_INT_MIN
 127 # define U32_MAX PERL_UINT_MAX
 128 # define U32_MIN PERL_UINT_MIN
 129 #else
 130   typedef long          I32;
 131   typedef unsigned long U32;
 132 # define I32_MAX PERL_LONG_MAX
 133 # define I32_MIN PERL_LONG_MIN
 134 # define U32_MAX PERL_ULONG_MAX
 135 # define U32_MIN PERL_ULONG_MIN
 136 #endif
 137
 138 #define BIT_DIGITS(N)   (((N)*146)/485 + 1)  /* log2(10) =~ 146/485 */
 139 #define TYPE_DIGITS(T)  BIT_DIGITS(sizeof(T) * 8)
 140 #define TYPE_CHARS(T)   (TYPE_DIGITS(T) + 2) /* sign, NUL */
 141
 142 #define Ctl(ch) ((ch) & 037)
 143
 144 #define strNE(s1,s2) (strcmp(s1,s2))
 145 #define strEQ(s1,s2) (!strcmp(s1,s2))
 146 #define strLT(s1,s2) (strcmp(s1,s2) < 0)
 147 #define strLE(s1,s2) (strcmp(s1,s2) <= 0)
 148 #define strGT(s1,s2) (strcmp(s1,s2) > 0)
 149 #define strGE(s1,s2) (strcmp(s1,s2) >= 0)
 150 #define strnNE(s1,s2,l) (strncmp(s1,s2,l))
 151 #define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
 152
 153 #ifdef HAS_MEMCMP
 154 #  define memNE(s1,s2,l) (memcmp(s1,s2,l))
 155 #  define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
 156 #else
 157 #  define memNE(s1,s2,l) (bcmp(s1,s2,l))
 158 #  define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
 159 #endif
 160
 161 /*
 162  * Character classes.
 163  *
 164  * Unfortunately, the introduction of locales means that we
 165  * can't trust isupper(), etc. to tell the truth.  And when
 166  * it comes to /\w+/ with tainting enabled, we *must* be able
 167  * to trust our character classes.
 168  *
 169  * Therefore, the default tests in the text of Perl will be
 170  * independent of locale.  Any code that wants to depend on
 171  * the current locale will use the tests that begin with "lc".
 172  */
 173
 174 #ifdef HAS_SETLOCALE  /* XXX Is there a better test for this? */
 175 #  ifndef CTYPE256
 176 #    define CTYPE256
 177 #  endif
 178 #endif
 179
 180 #define isALNUM(c)      (isALPHA(c) || isDIGIT(c) || (c) == '_')
 181 #define isIDFIRST(c)    (isALPHA(c) || (c) == '_')
 182 #define isALPHA(c)      (isUPPER(c) || isLOWER(c))
 183 #define isSPACE(c) \
 184         ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f')
 185 #define isDIGIT(c)      ((c) >= '0' && (c) <= '9')
 186 #ifdef EBCDIC
 187     /* In EBCDIC we do not do locales: therefore() isupper() is fine. */
 188 #   define isUPPER(c)   isupper(c)
 189 #   define isLOWER(c)   islower(c)
 190 #   define isPRINT(c)   isprint(c)
 191 #   define toUPPER(c)   toupper(c)
 192 #   define toLOWER(c)   tolower(c)
 193 #else
 194 #   define isUPPER(c)   ((c) >= 'A' && (c) <= 'Z')
 195 #   define isLOWER(c)   ((c) >= 'a' && (c) <= 'z')
 196 #   define isPRINT(c)   (((c) > 32 && (c) < 127) || isSPACE(c))
 197 #   define toUPPER(c)   (isLOWER(c) ? (c) - ('a' - 'A') : (c))
 198 #   define toLOWER(c)   (isUPPER(c) ? (c) + ('a' - 'A') : (c))
 199 #endif
 200
 201 #ifdef USE_NEXT_CTYPE
 202
 203 #  define isALNUM_LC(c) \
 204         (NXIsAlpha((unsigned int)(c)) || NXIsDigit((unsigned int)(c)) || \
 205          (char)(c) == '_')
 206 #  define isIDFIRST_LC(c) \
 207         (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
 208 #  define isALPHA_LC(c)         NXIsAlpha((unsigned int)(c))
 209 #  define isSPACE_LC(c)         NXIsSpace((unsigned int)(c))
 210 #  define isDIGIT_LC(c)         NXIsDigit((unsigned int)(c))
 211 #  define isUPPER_LC(c)         NXIsUpper((unsigned int)(c))
 212 #  define isLOWER_LC(c)         NXIsLower((unsigned int)(c))
 213 #  define isPRINT_LC(c)         NXIsPrint((unsigned int)(c))
 214 #  define toUPPER_LC(c)         NXToUpper((unsigned int)(c))
 215 #  define toLOWER_LC(c)         NXToLower((unsigned int)(c))
 216
 217 #else /* !USE_NEXT_CTYPE */
 218 #  if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
 219
 220 #    define isALNUM_LC(c) \
 221         (isalpha((unsigned char)(c)) || \
 222          isdigit((unsigned char)(c)) || (char)(c) == '_')
 223 #    define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_')
 224 #    define isALPHA_LC(c)       isalpha((unsigned char)(c))
 225 #    define isSPACE_LC(c)       isspace((unsigned char)(c))
 226 #    define isDIGIT_LC(c)       isdigit((unsigned char)(c))
 227 #    define isUPPER_LC(c)       isupper((unsigned char)(c))
 228 #    define isLOWER_LC(c)       islower((unsigned char)(c))
 229 #    define isPRINT_LC(c)       isprint((unsigned char)(c))
 230 #    define toUPPER_LC(c)       toupper((unsigned char)(c))
 231 #    define toLOWER_LC(c)       tolower((unsigned char)(c))
 232
 233 #  else
 234
 235 #    define isALNUM_LC(c) \
 236         (isascii(c) && (isalpha(c) || isdigit(c) || (c) == '_'))
 237 #    define isIDFIRST_LC(c)     (isascii(c) && (isalpha(c) || (c) == '_'))
 238 #    define isALPHA_LC(c)       (isascii(c) && isalpha(c))
 239 #    define isSPACE_LC(c)       (isascii(c) && isspace(c))
 240 #    define isDIGIT_LC(c)       (isascii(c) && isdigit(c))
 241 #    define isUPPER_LC(c)       (isascii(c) && isupper(c))
 242 #    define isLOWER_LC(c)       (isascii(c) && islower(c))
 243 #    define isPRINT_LC(c)       (isascii(c) && isprint(c))
 244 #    define toUPPER_LC(c)       toupper(c)
 245 #    define toLOWER_LC(c)       tolower(c)
 246
 247 #  endif
 248 #endif /* USE_NEXT_CTYPE */
 249
 250 #ifdef EBCDIC
 251 EXT int ebcdic_control _((int));
 252 #  define toCTRL(c)     ebcdic_control(c)
 253 #else
 254   /* This conversion works both ways, strangely enough. */
 255 #  define toCTRL(c)    (toUPPER(c) ^ 64)
 256 #endif
 257
 258 /* Line numbers are unsigned, 16 bits. */
 259 typedef U16 line_t;
 260 #ifdef lint
 261 #define NOLINE ((line_t)0)
 262 #else
 263 #define NOLINE ((line_t) 65535)
 264 #endif
 265
 266
 267 /* This looks obsolete (IZ):
 268
 269    XXX LEAKTEST doesn't really work in perl5.  There are direct calls to
 270    safemalloc() in the source, so LEAKTEST won't pick them up.
 271    Further, if you try LEAKTEST, you'll also end up calling
 272    Safefree, which might call safexfree() on some things that weren't
 273    malloced with safexmalloc.  The correct "fix" to this, if anyone
 274    is interested, is to ensure that all calls go through the New and
 275    Renew macros.
 276         --Andy Dougherty                August 1996
 277 */
 278
 279 #ifndef lint
 280
 281 #define NEWSV(x,len)    newSV(len)
 282
 283 #ifndef LEAKTEST
 284
 285 #define New(x,v,n,t)    (v = (t*)safemalloc((MEM_SIZE)((n)*sizeof(t))))
 286 #define Newc(x,v,n,t,c) (v = (c*)safemalloc((MEM_SIZE)((n)*sizeof(t))))
 287 #define Newz(x,v,n,t)   (v = (t*)safemalloc((MEM_SIZE)((n)*sizeof(t)))), \
 288                         memzero((char*)(v), (n)*sizeof(t))
 289 #define Renew(v,n,t) \
 290           (v = (t*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
 291 #define Renewc(v,n,t,c) \
 292           (v = (c*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
 293 #define Safefree(d)     safefree((Malloc_t)(d))
 294
 295 #else /* LEAKTEST */
 296
 297 #define New(x,v,n,t)    (v = (t*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t))))
 298 #define Newc(x,v,n,t,c) (v = (c*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t))))
 299 #define Newz(x,v,n,t)   (v = (t*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t)))), \
 300                          memzero((char*)(v), (n)*sizeof(t))
 301 #define Renew(v,n,t) \
 302           (v = (t*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
 303 #define Renewc(v,n,t,c) \
 304           (v = (c*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
 305 #define Safefree(d)     safexfree((Malloc_t)(d))
 306
 307 #define MAXXCOUNT 1400
 308 #define MAXY_SIZE 80
 309 #define MAXYCOUNT 16                    /* (MAXY_SIZE/4 + 1) */
 310 extern long xcount[MAXXCOUNT];
 311 extern long lastxcount[MAXXCOUNT];
 312 extern long xycount[MAXXCOUNT][MAXYCOUNT];
 313 extern long lastxycount[MAXXCOUNT][MAXYCOUNT];
 314
 315 #endif /* LEAKTEST */
 316
 317 #define Move(s,d,n,t)   (void)memmove((char*)(d),(char*)(s), (n) * sizeof(t))
 318 #define Copy(s,d,n,t)   (void)memcpy((char*)(d),(char*)(s), (n) * sizeof(t))
 319 #define Zero(d,n,t)     (void)memzero((char*)(d), (n) * sizeof(t))
 320
 321 #else /* lint */
 322
 323 #define New(x,v,n,s)    (v = Null(s *))
 324 #define Newc(x,v,n,s,c) (v = Null(s *))
 325 #define Newz(x,v,n,s)   (v = Null(s *))
 326 #define Renew(v,n,s)    (v = Null(s *))
 327 #define Move(s,d,n,t)
 328 #define Copy(s,d,n,t)
 329 #define Zero(d,n,t)
 330 #define Safefree(d)     (d) = (d)
 331
 332 #endif /* lint */
 333
 334 #ifdef USE_STRUCT_COPY
 335 #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
 336 #else
 337 #define StructCopy(s,d,t) Copy(s,d,1,t)
 338 #endif