perl 5.003_04: utils/perldoc.PL
[p5sagit/p5-mst-13.2.git] / handy.h
diff --git a/handy.h b/handy.h
index 160d839..2d0e81f 100644 (file)
--- a/handy.h
+++ b/handy.h
 
 #define Null(type) ((type)NULL)
 #define Nullch Null(char*)
-#define Nullfp Null(FILE*)
+#define Nullfp Null(PerlIO*)
 #define Nullsv Null(SV*)
 
-#ifdef UTS
-#define bool int
-#else
-#define bool char
-#endif
-
 #ifdef TRUE
 #undef TRUE
 #endif
 #define TRUE (1)
 #define FALSE (0)
 
+
+/* XXX Configure ought to have a test for a boolean type, if I can
+   just figure out all the headers such a test needs.
+   Andy Dougherty      August 1996
+*/
+/* bool is built-in for g++-2.6.3, which might be used for an extension.
+   If the extension includes <_G_config.h> before this file then
+   _G_HAVE_BOOL will be properly set.  If, however, the extension includes
+   this file first, then you will have to manually set -DHAS_BOOL in 
+   your command line to avoid a conflict.
+*/
+#ifdef _G_HAVE_BOOL
+# if _G_HAVE_BOOL
+#  ifndef HAS_BOOL
+#   define HAS_BOOL 1
+#  endif
+# endif
+#endif
+
+/* The NeXT dynamic loader headers will not build with the bool macro
+   So declare them now to clear confusion.
+*/
+#ifdef NeXT
+# undef FALSE
+# undef TRUE
+  typedef enum bool { FALSE = 0, TRUE = 1 } bool;
+# define ENUM_BOOL 1
+# ifndef HAS_BOOL
+#  define HAS_BOOL 1
+# endif /* !HAS_BOOL */
+#endif /* NeXT */
+
+#ifndef HAS_BOOL
+# ifdef UTS
+#  define bool int
+# else
+#  define bool char
+# endif
+#endif
+
+/* XXX A note on the perl source internal type system.  The
+   original intent was that I32 be *exactly* 32 bits.
+
+   Currently, we only guarantee that I32 is *at least* 32 bits.
+   Specifically, if int is 64 bits, then so is I32.  (This is the case
+   for the Cray.)  This has the advantage of meshing nicely with
+   standard library calls (where we pass an I32 and the library is
+   expecting an int), but the disadvantage that an I32 is not 32 bits.
+   Andy Dougherty      August 1996
+*/
+
 typedef char           I8;
 typedef unsigned char  U8;
+#define I8_MAX PERL_CHAR_MAX
+#define I8_MIN PERL_CHAR_MIN
+#define U8_MAX PERL_UCHAR_MAX
+#define U8_MIN PERL_UCHAR_MIN
 
 typedef short          I16;
 typedef unsigned short U16;
+#define I16_MAX PERL_SHORT_MAX
+#define I16_MIN PERL_SHORT_MIN
+#define U16_MAX PERL_USHORT_MAX
+#define U16_MIN PERL_USHORT_MIN
 
 #if BYTEORDER > 0x4321
   typedef int          I32;
   typedef unsigned int U32;
+# define I32_MAX PERL_INT_MAX
+# define I32_MIN PERL_INT_MIN
+# define U32_MAX PERL_UINT_MAX
+# define U32_MIN PERL_UINT_MIN
 #else
   typedef long         I32;
   typedef unsigned long        U32;
+# define I32_MAX PERL_LONG_MAX
+# define I32_MIN PERL_LONG_MIN
+# define U32_MAX PERL_ULONG_MAX
+# define U32_MIN PERL_ULONG_MIN
 #endif
 
 #define Ctl(ch) (ch & 037)
@@ -111,41 +172,52 @@ typedef U16 line_t;
 #define NOLINE ((line_t) 65535)
 #endif
 
+/* XXX LEAKTEST doesn't really work in perl5.  There are direct calls to
+   safemalloc() in the source, so LEAKTEST won't pick them up.
+   Further, if you try LEAKTEST, you'll also end up calling
+   Safefree, which might call safexfree() on some things that weren't
+   malloced with safexmalloc.  The correct "fix" to this, if anyone
+   is interested, is to ensure that all calls go through the New and
+   Renew macros.
+       --Andy Dougherty                August 1996
+*/
 #ifndef lint
 #ifndef LEAKTEST
 #ifndef safemalloc
-char *safemalloc _((MEM_SIZE));
-char *saferealloc _((char *, MEM_SIZE));
-void safefree _((char *));
+Malloc_t safemalloc _((MEM_SIZE));
+Malloc_t saferealloc _((Malloc_t, MEM_SIZE));
+Free_t safefree _((Malloc_t));
+Malloc_t safecalloc _((MEM_SIZE, MEM_SIZE));
 #endif
 #ifndef MSDOS
 #define New(x,v,n,t)  (v = (t*)safemalloc((MEM_SIZE)((n) * sizeof(t))))
 #define Newc(x,v,n,t,c)  (v = (c*)safemalloc((MEM_SIZE)((n) * sizeof(t))))
 #define Newz(x,v,n,t) (v = (t*)safemalloc((MEM_SIZE)((n) * sizeof(t)))), \
     memzero((char*)(v), (n) * sizeof(t))
-#define Renew(v,n,t) (v = (t*)saferealloc((char*)(v),(MEM_SIZE)((n)*sizeof(t))))
-#define Renewc(v,n,t,c) (v = (c*)saferealloc((char*)(v),(MEM_SIZE)((n)*sizeof(t))))
+#define Renew(v,n,t) (v = (t*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
+#define Renewc(v,n,t,c) (v = (c*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
 #else
 #define New(x,v,n,t)  (v = (t*)safemalloc(((unsigned long)(n) * sizeof(t))))
 #define Newc(x,v,n,t,c)  (v = (c*)safemalloc(((unsigned long)(n) * sizeof(t))))
 #define Newz(x,v,n,t) (v = (t*)safemalloc(((unsigned long)(n) * sizeof(t)))), \
     memzero((char*)(v), (n) * sizeof(t))
-#define Renew(v,n,t) (v = (t*)saferealloc((char*)(v),((unsigned long)(n)*sizeof(t))))
-#define Renewc(v,n,t,c) (v = (c*)saferealloc((char*)(v),((unsigned long)(n)*sizeof(t))))
+#define Renew(v,n,t) (v = (t*)saferealloc((Malloc_t)(v),((unsigned long)(n)*sizeof(t))))
+#define Renewc(v,n,t,c) (v = (c*)saferealloc((Malloc_t)(v),((unsigned long)(n)*sizeof(t))))
 #endif /* MSDOS */
-#define Safefree(d) safefree((char*)d)
+#define Safefree(d) safefree((Malloc_t)(d))
 #define NEWSV(x,len) newSV(len)
 #else /* LEAKTEST */
-char *safexmalloc();
-char *safexrealloc();
-void safexfree();
+Malloc_t safexmalloc();
+Malloc_t safexrealloc();
+Free_t safexfree();
+Malloc_t safexcalloc();
 #define New(x,v,n,t)  (v = (t*)safexmalloc(x,(MEM_SIZE)((n) * sizeof(t))))
 #define Newc(x,v,n,t,c)  (v = (c*)safexmalloc(x,(MEM_SIZE)((n) * sizeof(t))))
 #define Newz(x,v,n,t) (v = (t*)safexmalloc(x,(MEM_SIZE)((n) * sizeof(t)))), \
     memzero((char*)(v), (n) * sizeof(t))
-#define Renew(v,n,t) (v = (t*)safexrealloc((char*)(v),(MEM_SIZE)((n)*sizeof(t))))
-#define Renewc(v,n,t,c) (v = (c*)safexrealloc((char*)(v),(MEM_SIZE)((n)*sizeof(t))))
-#define Safefree(d) safexfree((char*)d)
+#define Renew(v,n,t) (v = (t*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
+#define Renewc(v,n,t,c) (v = (c*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
+#define Safefree(d) safexfree((Malloc_t)d)
 #define NEWSV(x,len) newSV(x,len)
 #define MAXXCOUNT 1200
 long xcount[MAXXCOUNT];