Add documentation for default UNIVERSAL methods
[p5sagit/p5-mst-13.2.git] / util.c
diff --git a/util.c b/util.c
index 3d36097..a11d98f 100644 (file)
--- a/util.c
+++ b/util.c
 #include <signal.h>
 #endif
 
+/* Omit this -- it causes too much grief on mixed systems.
 #ifdef I_UNISTD
 #  include <unistd.h>
 #endif
+*/
 
 #ifdef I_VFORK
 #  include <vfork.h>
 #endif
 
+#ifdef I_LIMITS  /* Needed for cast_xxx() functions below. */
+#  include <limits.h>
+#endif
+
+/* Put this after #includes because fork and vfork prototypes may
+   conflict.
+*/
+#ifndef HAS_VFORK
+#   define vfork fork
+#endif
+
 #ifdef I_FCNTL
 #  include <fcntl.h>
 #endif
@@ -97,9 +110,9 @@ unsigned long size;
 #endif /* MSDOS */
 {
     char *ptr;
-#ifndef STANDARD_C
+#if !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE)
     char *realloc();
-#endif /* ! STANDARD_C */
+#endif /* !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) */
 
 #ifdef MSDOS
        if (size > 0xffff) {
@@ -340,6 +353,48 @@ char *lend;
     return Nullch;
 }
 
+/* Initialize locale (and the fold[] array).*/
+int
+perl_init_i18nl14n(printwarn)  
+    int printwarn;
+{
+    int ok = 1;
+    /* returns
+     *    1 = set ok or not applicable,
+     *    0 = fallback to C locale,
+     *   -1 = fallback to C locale failed
+     */
+#if defined(HAS_SETLOCALE) && defined(LC_CTYPE)
+    char * lang     = getenv("LANG");
+    char * lc_all   = getenv("LC_ALL");
+    char * lc_ctype = getenv("LC_CTYPE");
+    int i;
+
+    if (setlocale(LC_CTYPE, "") == NULL && (lc_all || lc_ctype || lang)) {
+       if (printwarn) {
+           fprintf(stderr, "warning: setlocale(LC_CTYPE, \"\") failed.\n");
+           fprintf(stderr,
+             "warning: LC_ALL = \"%s\", LC_CTYPE = \"%s\", LANG = \"%s\",\n",
+             lc_all   ? lc_all   : "(null)",
+             lc_ctype ? lc_ctype : "(null)",
+             lang     ? lang     : "(null)"
+             );
+           fprintf(stderr, "warning: falling back to the \"C\" locale.\n");
+       }
+       ok = 0;
+       if (setlocale(LC_CTYPE, "C") == NULL)
+           ok = -1;
+    }
+
+    for (i = 0; i < 256; i++) {
+       if (isUPPER(i)) fold[i] = toLOWER(i);
+       else if (isLOWER(i)) fold[i] = toUPPER(i);
+       else fold[i] = i;
+    }
+#endif
+    return ok;
+}
+
 void
 fbm_compile(sv, iflag)
 SV *sv;
@@ -352,6 +407,8 @@ I32 iflag;
     I32 rarest = 0;
     U32 frequency = 256;
 
+    if (len > 255)
+       return;                 /* can't have offsets that big */
     Sv_Grow(sv,len+258);
     table = (unsigned char*)(SvPVX(sv) + len + 1);
     s = table - 2;
@@ -443,12 +500,12 @@ SV *littlestr;
        }
        else {
            s = bigend - littlelen;
-           if (*s == *little && bcmp(s,little,littlelen)==0)
+           if (*s == *little && bcmp((char*)s,(char*)little,littlelen)==0)
                return (char*)s;                /* how sweet it is */
            else if (bigend[-1] == '\n' && little[littlelen-1] != '\n'
              && s > big) {
                    s--;
-               if (*s == *little && bcmp(s,little,littlelen)==0)
+               if (*s == *little && bcmp((char*)s,(char*)little,littlelen)==0)
                    return (char*)s;
            }
            return Nullch;
@@ -688,10 +745,11 @@ char *pat;
 long a1, a2, a3, a4;
 {
     char *s;
+    char *s_start;
     I32 usermess = strEQ(pat,"%s");
     SV *tmpstr;
 
-    s = buf;
+    s = s_start = buf;
     if (usermess) {
        tmpstr = sv_newmortal();
        sv_setpv(tmpstr, (char*)a1);
@@ -720,10 +778,20 @@ long a1, a2, a3, a4;
                s += strlen(s);
            }
            (void)strcpy(s,".\n");
+           s += 2;
        }
        if (usermess)
            sv_catpv(tmpstr,buf+1);
     }
+
+    if (s - s_start >= sizeof(buf)) {  /* Ooops! */
+       if (usermess)
+           fputs(SvPVX(tmpstr), stderr);
+       else
+           fputs(buf, stderr);
+       fputs("panic: message overflow - memory corrupted!\n",stderr);
+       my_exit(1);
+    }
     if (usermess)
        return SvPVX(tmpstr);
     else
@@ -737,18 +805,41 @@ long a1, a2, a3, a4;
 {
     char *tmps;
     char *message;
+    HV *stash;
+    GV *gv;
+    CV *cv;
 
     message = mess(pat,a1,a2,a3,a4);
+    if (diehook && (cv = sv_2cv(diehook, &stash, &gv, 0)) && !CvDEPTH(cv)) {
+       dSP;
+
+       PUSHMARK(sp);
+       EXTEND(sp, 1);
+       PUSHs(sv_2mortal(newSVpv(message,0)));
+       PUTBACK;
+       perl_call_sv((SV*)cv, G_DISCARD);
+    }
     if (in_eval) {
        restartop = die_where(message);
-       longjmp(top_env, 3);
+       Siglongjmp(top_env, 3);
     }
     fputs(message,stderr);
-    (void)fflush(stderr);
-    if (e_fp)
+    (void)Fflush(stderr);
+    if (e_tmpname) {
+       if (e_fp) {
+           fclose(e_fp);
+           e_fp = Nullfp;
+       }
        (void)UNLINK(e_tmpname);
-    statusvalue >>= 8;
-    my_exit((I32)((errno&255)?errno:((statusvalue&255)?statusvalue:255)));
+       Safefree(e_tmpname);
+       e_tmpname = Nullch;
+    }
+    statusvalue = SHIFTSTATUS(statusvalue);
+#ifdef VMS
+    my_exit((U32)vaxc$errno?vaxc$errno:errno?errno:statusvalue?statusvalue:SS$_ABORT);
+#else
+    my_exit((U32)((errno&255)?errno:((statusvalue&255)?statusvalue:255)));
+#endif
 }
 
 /*VARARGS1*/
@@ -757,13 +848,28 @@ char *pat;
 long a1, a2, a3, a4;
 {
     char *message;
+    SV *sv;
+    HV *stash;
+    GV *gv;
+    CV *cv;
 
     message = mess(pat,a1,a2,a3,a4);
-    fputs(message,stderr);
+    if (warnhook && (cv = sv_2cv(warnhook, &stash, &gv, 0)) && !CvDEPTH(cv)) {
+       dSP;
+
+       PUSHMARK(sp);
+       EXTEND(sp, 1);
+       PUSHs(sv_2mortal(newSVpv(message,0)));
+       PUTBACK;
+       perl_call_sv((SV*)cv, G_DISCARD);
+    }
+    else {
+       fputs(message,stderr);
 #ifdef LEAKTEST
-    DEBUG_L(xstat());
+       DEBUG_L(xstat());
 #endif
-    (void)fflush(stderr);
+       (void)Fflush(stderr);
+    }
 }
 
 #else /* !defined(I_STDARG) && !defined(I_VARARGS) */
@@ -780,6 +886,7 @@ mess(pat, args)
 #endif
 {
     char *s;
+    char *s_start;
     SV *tmpstr;
     I32 usermess;
 #ifndef HAS_VPRINTF
@@ -790,7 +897,7 @@ mess(pat, args)
 #endif
 #endif
 
-    s = buf;
+    s = s_start = buf;
     usermess = strEQ(pat, "%s");
     if (usermess) {
        tmpstr = sv_newmortal();
@@ -812,27 +919,37 @@ mess(pat, args)
                  SvPVX(GvSV(curcop->cop_filegv)), (long)curcop->cop_line);
                s += strlen(s);
            }
-           if (GvIO(last_in_gv) &&
-               IoLINES(GvIOp(last_in_gv)) ) {
+           if (GvIO(last_in_gv) && IoLINES(GvIOp(last_in_gv))) {
+               bool line_mode = (RsSIMPLE(rs) &&
+                                 SvLEN(rs) == 1 && *SvPVX(rs) == '\n');
                (void)sprintf(s,", <%s> %s %ld",
                  last_in_gv == argvgv ? "" : GvNAME(last_in_gv),
-                 strEQ(rs,"\n") ? "line" : "chunk", 
+                 line_mode ? "line" : "chunk", 
                  (long)IoLINES(GvIOp(last_in_gv)));
                s += strlen(s);
            }
            (void)strcpy(s,".\n");
+           s += 2;
        }
        if (usermess)
            sv_catpv(tmpstr,buf+1);
     }
 
+    if (s - s_start >= sizeof(buf)) {  /* Ooops! */
+       if (usermess)
+           fputs(SvPVX(tmpstr), stderr);
+       else
+           fputs(buf, stderr);
+       fputs("panic: message overflow - memory corrupted!\n",stderr);
+       my_exit(1);
+    }
     if (usermess)
        return SvPVX(tmpstr);
     else
        return buf;
 }
 
-#ifdef STANDARD_C
+#ifdef I_STDARG
 void
 croak(char* pat, ...)
 #else
@@ -845,6 +962,9 @@ croak(pat, va_alist)
 {
     va_list args;
     char *message;
+    HV *stash;
+    GV *gv;
+    CV *cv;
 
 #ifdef I_STDARG
     va_start(args, pat);
@@ -853,20 +973,40 @@ croak(pat, va_alist)
 #endif
     message = mess(pat, &args);
     va_end(args);
+    if (diehook && (cv = sv_2cv(diehook, &stash, &gv, 0)) && !CvDEPTH(cv)) {
+       dSP;
+
+       PUSHMARK(sp);
+       EXTEND(sp, 1);
+       PUSHs(sv_2mortal(newSVpv(message,0)));
+       PUTBACK;
+       perl_call_sv((SV*)cv, G_DISCARD);
+    }
     if (in_eval) {
        restartop = die_where(message);
-       longjmp(top_env, 3);
+       Siglongjmp(top_env, 3);
     }
     fputs(message,stderr);
-    (void)fflush(stderr);
-    if (e_fp)
+    (void)Fflush(stderr);
+    if (e_tmpname) {
+       if (e_fp) {
+           fclose(e_fp);
+           e_fp = Nullfp;
+       }
        (void)UNLINK(e_tmpname);
-    statusvalue >>= 8;
-    my_exit((I32)((errno&255)?errno:((statusvalue&255)?statusvalue:255)));
+       Safefree(e_tmpname);
+       e_tmpname = Nullch;
+    }
+    statusvalue = SHIFTSTATUS(statusvalue);
+#ifdef VMS
+    my_exit((U32)(vaxc$errno?vaxc$errno:(statusvalue?statusvalue:44)));
+#else
+    my_exit((U32)((errno&255)?errno:((statusvalue&255)?statusvalue:255)));
+#endif
 }
 
 void
-#ifdef STANDARD_C
+#ifdef I_STDARG
 warn(char* pat,...)
 #else
 /*VARARGS0*/
@@ -877,6 +1017,9 @@ warn(pat,va_alist)
 {
     va_list args;
     char *message;
+    HV *stash;
+    GV *gv;
+    CV *cv;
 
 #ifdef I_STDARG
     va_start(args, pat);
@@ -886,11 +1029,22 @@ warn(pat,va_alist)
     message = mess(pat, &args);
     va_end(args);
 
-    fputs(message,stderr);
+    if (warnhook && (cv = sv_2cv(warnhook, &stash, &gv, 0)) && !CvDEPTH(cv)) {
+       dSP;
+
+       PUSHMARK(sp);
+       EXTEND(sp, 1);
+       PUSHs(sv_2mortal(newSVpv(message,0)));
+       PUTBACK;
+       perl_call_sv((SV*)cv, G_DISCARD);
+    }
+    else {
+       fputs(message,stderr);
 #ifdef LEAKTEST
-    DEBUG_L(xstat());
+       DEBUG_L(xstat());
 #endif
-    (void)fflush(stderr);
+       (void)Fflush(stderr);
+    }
 }
 #endif /* !defined(I_STDARG) && !defined(I_VARARGS) */
 
@@ -955,7 +1109,7 @@ char *nam;
 }
 #endif /* !VMS */
 
-#ifdef EUNICE
+#ifdef UNLINK_ALL_VERSIONS
 I32
 unlnk(f)       /* unlink all versions of a file */
 char *f;
@@ -1021,7 +1175,7 @@ register I32 len;
 }
 #endif /* HAS_MEMCMP */
 
-#ifdef I_VARARGS
+#if defined(I_STDARG) || defined(I_VARARGS)
 #ifndef HAS_VPRINTF
 
 #ifdef USE_CHAR_VSPRINTF
@@ -1058,21 +1212,17 @@ char *pat, *args;
     return 0;          /* wrong, but perl doesn't use the return value */
 }
 #endif /* HAS_VPRINTF */
-#endif /* I_VARARGS */
+#endif /* I_VARARGS || I_STDARGS */
 
-/*
- * I think my_swap(), htonl() and ntohl() have never been used.
- * perl.h contains last-chance references to my_swap(), my_htonl()
- * and my_ntohl().  I presume these are the intended functions;
- * but htonl() and ntohl() have the wrong names.  There are no
- * functions my_htonl() and my_ntohl() defined anywhere.
- * -DWS
- */
 #ifdef MYSWAP
 #if BYTEORDER != 0x4321
 short
+#ifndef CAN_PROTOTYPE
 my_swap(s)
 short s;
+#else
+my_swap(short s)
+#endif
 {
 #if (BYTEORDER & 1) == 0
     short result;
@@ -1085,8 +1235,12 @@ short s;
 }
 
 long
-htonl(l)
+#ifndef CAN_PROTOTYPE
+my_htonl(l)
 register long l;
+#else
+my_htonl(long l)
+#endif
 {
     union {
        long result;
@@ -1115,8 +1269,12 @@ register long l;
 }
 
 long
-ntohl(l)
+#ifndef CAN_PROTOTYPE
+my_ntohl(l)
 register long l;
+#else
+my_ntohl(long l)
+#endif
 {
     union {
        long l;
@@ -1206,7 +1364,8 @@ VTOH(vtohs,short)
 VTOH(vtohl,long)
 #endif
 
-#if  !defined(DOSISH) && !defined(VMS)  /* VMS' my_popen() is in VMS.c */
+#if  !defined(DOSISH) && !defined(VMS)  /* VMS' my_popen() is in
+                                          VMS.c, same with OS/2. */
 FILE *
 my_popen(cmd,mode)
 char   *cmd;
@@ -1283,7 +1442,7 @@ char      *mode;
     return fdopen(p[this], mode);
 }
 #else
-#ifdef atarist
+#if defined(atarist)
 FILE *popen();
 FILE *
 my_popen(cmd,mode)
@@ -1296,7 +1455,7 @@ char      *mode;
 
 #endif /* !DOSISH */
 
-#ifdef NOTDEF
+#ifdef DUMP_FDS
 dump_fds(s)
 char *s;
 {
@@ -1313,46 +1472,45 @@ char *s;
 #endif
 
 #ifndef HAS_DUP2
+int
 dup2(oldfd,newfd)
 int oldfd;
 int newfd;
 {
 #if defined(HAS_FCNTL) && defined(F_DUPFD)
+    if (oldfd == newfd)
+       return oldfd;
     close(newfd);
-    fcntl(oldfd, F_DUPFD, newfd);
+    return fcntl(oldfd, F_DUPFD, newfd);
 #else
     int fdtmp[256];
     I32 fdx = 0;
     int fd;
 
     if (oldfd == newfd)
-       return 0;
+       return oldfd;
     close(newfd);
-    while ((fd = dup(oldfd)) != newfd) /* good enough for low fd's */
+    while ((fd = dup(oldfd)) != newfd && fd >= 0) /* good enough for low fd's */
        fdtmp[fdx++] = fd;
     while (fdx > 0)
        close(fdtmp[--fdx]);
+    return fd;
 #endif
 }
 #endif
 
-#ifndef DOSISH
-#ifndef VMS /* VMS' my_pclose() is in VMS.c */
+#if  !defined(DOSISH) && !defined(VMS)  /* VMS' my_popen() is in VMS.c */
 I32
 my_pclose(ptr)
 FILE *ptr;
 {
-#ifdef VOIDSIG
-    void (*hstat)(), (*istat)(), (*qstat)();
-#else
-    int (*hstat)(), (*istat)(), (*qstat)();
-#endif
+    Signal_t (*hstat)(), (*istat)(), (*qstat)();
     int status;
     SV **svp;
     int pid;
 
     svp = av_fetch(fdpid,fileno(ptr),TRUE);
-    pid = SvIVX(*svp);
+    pid = (int)SvIVX(*svp);
     SvREFCNT_dec(*svp);
     *svp = &sv_undef;
     fclose(ptr);
@@ -1362,13 +1520,17 @@ FILE *ptr;
     hstat = signal(SIGHUP, SIG_IGN);
     istat = signal(SIGINT, SIG_IGN);
     qstat = signal(SIGQUIT, SIG_IGN);
-    pid = wait4pid(pid, &status, 0);
+    do {
+       pid = wait4pid(pid, &status, 0);
+    } while (pid == -1 && errno == EINTR);
     signal(SIGHUP, hstat);
     signal(SIGINT, istat);
     signal(SIGQUIT, qstat);
     return(pid < 0 ? pid : status);
 }
-#endif /* !VMS */
+#endif /* !DOSISH */
+
+#if  !defined(DOSISH) || defined(OS2)
 I32
 wait4pid(pid,statusp,flags)
 int pid;
@@ -1386,7 +1548,7 @@ int flags;
        svp = hv_fetch(pidstatus,spid,strlen(spid),FALSE);
        if (svp && *svp != &sv_undef) {
            *statusp = SvIVX(*svp);
-           hv_delete(pidstatus,spid,strlen(spid));
+           (void)hv_delete(pidstatus,spid,strlen(spid),G_DISCARD);
            return pid;
        }
     }
@@ -1399,7 +1561,7 @@ int flags;
            sv = hv_iterval(pidstatus,entry);
            *statusp = SvIVX(sv);
            sprintf(spid, "%d", pid);
-           hv_delete(pidstatus,spid,strlen(spid));
+           (void)hv_delete(pidstatus,spid,strlen(spid),G_DISCARD);
            return pid;
        }
     }
@@ -1442,7 +1604,7 @@ int status;
     return;
 }
 
-#ifdef atarist
+#if defined(atarist) || defined(OS2)
 int pclose();
 I32
 my_pclose(ptr)
@@ -1497,36 +1659,75 @@ double f;
 #endif
 
 #ifndef CASTI32
+
+/* Look for MAX and MIN integral values.  If we can't find them,
+   we'll use 32-bit two's complement defaults.
+*/
+#ifndef LONG_MAX
+#  ifdef MAXLONG    /* Often used in <values.h> */
+#    define LONG_MAX MAXLONG
+#  else
+#    define LONG_MAX        2147483647L
+#  endif
+#endif
+
+#ifndef LONG_MIN
+#    define LONG_MIN        (-LONG_MAX - 1)
+#endif
+
+#ifndef ULONG_MAX
+#  ifdef MAXULONG 
+#    define LONG_MAX MAXULONG
+#  else
+#    define ULONG_MAX       4294967295L
+#  endif
+#endif
+
+/* Unfortunately, on some systems the cast_uv() function doesn't
+   work with the system-supplied definition of ULONG_MAX.  The
+   comparison  (f >= ULONG_MAX) always comes out true.  It must be a
+   problem with the compiler constant folding.
+
+   In any case, this workaround should be fine on any two's complement
+   system.  If it's not, supply a '-DMY_ULONG_MAX=whatever' in your
+   ccflags.
+              --Andy Dougherty      <doughera@lafcol.lafayette.edu>
+*/
+#ifndef MY_ULONG_MAX
+#  define MY_ULONG_MAX ((UV)LONG_MAX * (UV)2 + (UV)1)
+#endif
+
 I32
 cast_i32(f)
 double f;
 {
-#   define BIGDOUBLE 2147483648.0        /* Assume 32 bit int's ! */
-#   define BIGNEGDOUBLE (-2147483648.0)
-    if (f >= BIGDOUBLE)
-       return (I32)fmod(f, BIGDOUBLE);
-    if (f <= BIGNEGDOUBLE)
-       return (I32)fmod(f, BIGNEGDOUBLE);
+    if (f >= LONG_MAX)
+       return (I32) LONG_MAX;
+    if (f <= LONG_MIN)
+       return (I32) LONG_MIN;
     return (I32) f;
 }
-# undef BIGDOUBLE
-# undef BIGNEGDOUBLE
 
 IV
 cast_iv(f)
 double f;
 {
-    /* XXX  This should be fixed.  It assumes 32 bit IV's. */
-#   define BIGDOUBLE 2147483648.0        /* Assume 32 bit IV's ! */
-#   define BIGNEGDOUBLE (-2147483648.0)
-    if (f >= BIGDOUBLE)
-       return (IV)fmod(f, BIGDOUBLE);
-    if (f <= BIGNEGDOUBLE)
-       return (IV)fmod(f, BIGNEGDOUBLE);
+    if (f >= LONG_MAX)
+       return (IV) LONG_MAX;
+    if (f <= LONG_MIN)
+       return (IV) LONG_MIN;
     return (IV) f;
 }
-# undef BIGDOUBLE
-# undef BIGNEGDOUBLE
+
+UV
+cast_uv(f)
+double f;
+{
+    if (f >= MY_ULONG_MAX)
+       return (UV) MY_ULONG_MAX;
+    return (UV) f;
+}
+
 #endif
 
 #ifndef HAS_RENAME
@@ -1580,10 +1781,13 @@ I32 *retlen;
     register char *s = start;
     register unsigned long retval = 0;
 
-    while (len-- && *s >= '0' && *s <= '7') {
+    while (len && *s >= '0' && *s <= '7') {
        retval <<= 3;
        retval |= *s++ - '0';
+       len--;
     }
+    if (dowarn && len && (*s == '8' || *s == '9'))
+       warn("Illegal octal digit ignored");
     *retlen = s - start;
     return retval;
 }