This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document limitations in PUSHi et al macros and add new mPUSHi et al macros
[perl5.git] / universal.c
index 7999757..6b2214d 100644 (file)
@@ -1,6 +1,7 @@
 /*    universal.c
  *
- *    Copyright (c) 1997-2002, Larry Wall
+ *    Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
+ *    by Larry Wall and others
  *
  *    You may distribute under the terms of either the GNU General Public
  *    License or the Artistic License, as specified in the README file.
 #define PERL_IN_UNIVERSAL_C
 #include "perl.h"
 
+#ifdef USE_PERLIO
+#include "perliol.h" /* For the PERLIO_F_XXX */
+#endif
+
 /*
  * Contributed by Graham Barr  <Graham.Barr@tiuk.ti.com>
  * The main guts of traverse_isa was actually copied from gv_fetchmeth
@@ -40,6 +45,9 @@ S_isa_lookup(pTHX_ HV *stash, const char *name, HV* name_stash,
     if (strEQ(HvNAME(stash), name))
        return &PL_sv_yes;
 
+    if (strEQ(name, "UNIVERSAL"))
+       return &PL_sv_yes;
+
     if (level > 100)
        Perl_croak(aTHX_ "Recursive inheritance detected in package '%s'",
                   HvNAME(stash));
@@ -107,8 +115,7 @@ S_isa_lookup(pTHX_ HV *stash, const char *name, HV* name_stash,
            (void)hv_store(hv,name,len,&PL_sv_no,0);
        }
     }
-
-    return boolSV(strEQ(name, "UNIVERSAL"));
+    return &PL_sv_no;
 }
 
 /*
@@ -166,6 +173,9 @@ XS(XS_version_numify);
 XS(XS_version_vcmp);
 XS(XS_version_boolean);
 XS(XS_version_noop);
+XS(XS_version_is_alpha);
+XS(XS_version_qv);
+XS(XS_utf8_is_utf8);
 XS(XS_utf8_valid);
 XS(XS_utf8_encode);
 XS(XS_utf8_decode);
@@ -176,6 +186,11 @@ XS(XS_utf8_native_to_unicode);
 XS(XS_Internals_SvREADONLY);
 XS(XS_Internals_SvREFCNT);
 XS(XS_Internals_hv_clear_placehold);
+XS(XS_PerlIO_get_layers);
+XS(XS_Regexp_DESTROY);
+XS(XS_Internals_hash_seed);
+XS(XS_Internals_rehash_seed);
+XS(XS_Internals_HvREHASH);
 
 void
 Perl_boot_core_UNIVERSAL(pTHX)
@@ -202,7 +217,10 @@ Perl_boot_core_UNIVERSAL(pTHX)
        newXS("version::boolean", XS_version_boolean, file);
        newXS("version::(nomethod", XS_version_noop, file);
        newXS("version::noop", XS_version_noop, file);
+       newXS("version::is_alpha", XS_version_is_alpha, file);
+       newXS("version::qv", XS_version_qv, file);
     }
+    newXS("utf8::is_utf8", XS_utf8_is_utf8, file);
     newXS("utf8::valid", XS_utf8_valid, file);
     newXS("utf8::encode", XS_utf8_encode, file);
     newXS("utf8::decode", XS_utf8_decode, file);
@@ -214,6 +232,12 @@ Perl_boot_core_UNIVERSAL(pTHX)
     newXSproto("Internals::SvREFCNT",XS_Internals_SvREFCNT, file, "\\[$%@];$");
     newXSproto("Internals::hv_clear_placeholders",
                XS_Internals_hv_clear_placehold, file, "\\%");
+    newXSproto("PerlIO::get_layers",
+               XS_PerlIO_get_layers, file, "*;@");
+    newXS("Regexp::DESTROY", XS_Regexp_DESTROY, file);
+    newXSproto("Internals::hash_seed",XS_Internals_hash_seed, file, "");
+    newXSproto("Internals::rehash_seed",XS_Internals_rehash_seed, file, "");
+    newXSproto("Internals::HvREHASH", XS_Internals_HvREHASH, file, "\\%");
 }
 
 
@@ -232,7 +256,8 @@ XS(XS_UNIVERSAL_isa)
     if (SvGMAGICAL(sv))
        mg_get(sv);
 
-    if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))))
+    if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
+               || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
        XSRETURN_UNDEF;
 
     name = (char *)SvPV(ST(1),n_a);
@@ -258,7 +283,8 @@ XS(XS_UNIVERSAL_can)
     if (SvGMAGICAL(sv))
        mg_get(sv);
 
-    if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))))
+    if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
+               || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
        XSRETURN_UNDEF;
 
     name = (char *)SvPV(ST(1),n_a);
@@ -308,6 +334,8 @@ XS(XS_UNIVERSAL_VERSION)
         SV *nsv = sv_newmortal();
         sv_setsv(nsv, sv);
         sv = nsv;
+       if ( !sv_derived_from(sv, "version"))
+           upg_version(sv);
         undef = Nullch;
     }
     else {
@@ -331,18 +359,26 @@ XS(XS_UNIVERSAL_VERSION)
                             "%s defines neither package nor VERSION--version check failed", str);
             }
        }
-       if ( !sv_derived_from(sv, "version"))
-           sv = new_version(sv);
 
-       if ( !sv_derived_from(req, "version"))
-           req = new_version(req);
+       if ( !sv_derived_from(req, "version")) {
+           /* req may very well be R/O, so create a new object */
+           SV *nsv = sv_newmortal();
+           sv_setsv(nsv, req);
+           req = nsv;
+           upg_version(req);
+       }
 
-       if ( vcmp( SvRV(req), SvRV(sv) ) > 0 )
-           Perl_croak(aTHX_ "%s version %_ required--this is only version %_",
-               HvNAME(pkg), req, sv);
+       if ( vcmp( req, sv ) > 0 )
+           Perl_croak(aTHX_ "%s version %"SVf" (%"SVf") required--"
+                   "this is only version %"SVf" (%"SVf")", HvNAME(pkg),
+                   vnumify(req),vnormal(req),vnumify(sv),vnormal(sv));
     }
 
-    ST(0) = sv;
+    if ( sv_derived_from(sv, "version") ) {
+       ST(0) = vnumify(sv);
+    } else {
+       ST(0) = sv;
+    }
 
     XSRETURN(1);
 }
@@ -350,17 +386,24 @@ XS(XS_UNIVERSAL_VERSION)
 XS(XS_version_new)
 {
     dXSARGS;
-    if (items != 2)
+    if (items > 3)
        Perl_croak(aTHX_ "Usage: version::new(class, version)");
     SP -= items;
     {
-/*     char *  class = (char *)SvPV_nolen(ST(0)); */
-       SV *    version = ST(1);
+       char *  class = (char *)SvPV_nolen(ST(0));
+        SV *vs = ST(1);
+       SV *rv;
+       if (items == 3 )
+       {
+           vs = sv_newmortal(); 
+           Perl_sv_setpvf(aTHX_ vs,"v%s",SvPV_nolen(ST(2)));
+       }
 
-{
-    PUSHs(new_version(version));
-}
+       rv = new_version(vs);
+       if ( strcmp(class,"version") != 0 ) /* inherited new() */
+           sv_bless(rv, gv_stashpv(class,TRUE));
 
+       PUSHs(sv_2mortal(rv));
        PUTBACK;
        return;
     }
@@ -368,62 +411,153 @@ XS(XS_version_new)
 
 XS(XS_version_stringify)
 {
-    dXSARGS;
-    if (items < 1)
-       Perl_croak(aTHX_ "Usage: version::stringify(lobj, ...)");
-    SP -= items;
-    {
-       SV *    lobj;
-
-        if (sv_derived_from(ST(0), "version")) {
-                SV *tmp = SvRV(ST(0));
-               lobj = tmp;
-        }
-        else
-                Perl_croak(aTHX_ "lobj is not of type version");
-
-{
-    PUSHs(vstringify(lobj));
-}
-
-       PUTBACK;
-       return;
-    }
+     dXSARGS;
+     if (items < 1)
+         Perl_croak(aTHX_ "Usage: version::stringify(lobj, ...)");
+     SP -= items;
+     {
+         SV *  lobj;
+
+         if (sv_derived_from(ST(0), "version")) {
+              SV *tmp = SvRV(ST(0));
+              lobj = tmp;
+         }
+         else
+              Perl_croak(aTHX_ "lobj is not of type version");
+
+         PUSHs(sv_2mortal(vstringify(lobj)));
+
+         PUTBACK;
+         return;
+     }
 }
 
 XS(XS_version_numify)
 {
-    dXSARGS;
-    if (items < 1)
-       Perl_croak(aTHX_ "Usage: version::numify(lobj, ...)");
-    SP -= items;
-    {
-       SV *    lobj;
+     dXSARGS;
+     if (items < 1)
+         Perl_croak(aTHX_ "Usage: version::numify(lobj, ...)");
+     SP -= items;
+     {
+         SV *  lobj;
+
+         if (sv_derived_from(ST(0), "version")) {
+              SV *tmp = SvRV(ST(0));
+              lobj = tmp;
+         }
+         else
+              Perl_croak(aTHX_ "lobj is not of type version");
+
+         PUSHs(sv_2mortal(vnumify(lobj)));
+
+         PUTBACK;
+         return;
+     }
+}
 
-        if (sv_derived_from(ST(0), "version")) {
-                SV *tmp = SvRV(ST(0));
-               lobj = tmp;
-        }
-        else
-                Perl_croak(aTHX_ "lobj is not of type version");
+XS(XS_version_vcmp)
+{
+     dXSARGS;
+     if (items < 1)
+         Perl_croak(aTHX_ "Usage: version::vcmp(lobj, ...)");
+     SP -= items;
+     {
+         SV *  lobj;
+
+         if (sv_derived_from(ST(0), "version")) {
+              SV *tmp = SvRV(ST(0));
+              lobj = tmp;
+         }
+         else
+              Perl_croak(aTHX_ "lobj is not of type version");
+
+         {
+              SV       *rs;
+              SV       *rvs;
+              SV * robj = ST(1);
+              IV        swap = (IV)SvIV(ST(2));
+
+              if ( ! sv_derived_from(robj, "version") )
+              {
+                   robj = new_version(robj);
+              }
+              rvs = SvRV(robj);
+
+              if ( swap )
+              {
+                   rs = newSViv(vcmp(rvs,lobj));
+              }
+              else
+              {
+                   rs = newSViv(vcmp(lobj,rvs));
+              }
+
+              PUSHs(sv_2mortal(rs));
+         }
+
+         PUTBACK;
+         return;
+     }
+}
 
+XS(XS_version_boolean)
 {
-    PUSHs(vnumify(lobj));
+     dXSARGS;
+     if (items < 1)
+         Perl_croak(aTHX_ "Usage: version::boolean(lobj, ...)");
+     SP -= items;
+     {
+         SV *  lobj;
+
+         if (sv_derived_from(ST(0), "version")) {
+              SV *tmp = SvRV(ST(0));
+              lobj = tmp;
+         }
+         else
+              Perl_croak(aTHX_ "lobj is not of type version");
+
+         {
+              SV       *rs;
+              rs = newSViv( vcmp(lobj,new_version(newSVpvn("0",1))) );
+              PUSHs(sv_2mortal(rs));
+         }
+
+         PUTBACK;
+         return;
+     }
 }
 
-       PUTBACK;
-       return;
-    }
+XS(XS_version_noop)
+{
+     dXSARGS;
+     if (items < 1)
+         Perl_croak(aTHX_ "Usage: version::noop(lobj, ...)");
+     {
+         SV *  lobj;
+
+         if (sv_derived_from(ST(0), "version")) {
+              SV *tmp = SvRV(ST(0));
+              lobj = tmp;
+         }
+         else
+              Perl_croak(aTHX_ "lobj is not of type version");
+
+         {
+              Perl_croak(aTHX_ "operation not supported with version object");
+         }
+
+     }
+     XSRETURN_EMPTY;
 }
 
-XS(XS_version_vcmp)
+XS(XS_version_is_alpha)
 {
     dXSARGS;
-    if (items < 1)
-       Perl_croak(aTHX_ "Usage: version::vcmp(lobj, ...)");
+    if (items != 1)
+       Perl_croak(aTHX_ "Usage: version::is_alpha(lobj)");
     SP -= items;
     {
-       SV *    lobj;
+       SV *lobj;
 
         if (sv_derived_from(ST(0), "version")) {
                 SV *tmp = SvRV(ST(0));
@@ -431,103 +565,90 @@ XS(XS_version_vcmp)
         }
         else
                 Perl_croak(aTHX_ "lobj is not of type version");
-
 {
-    SV *rs;
-    SV *rvs;
-    SV * robj = ST(1);
-    IV  swap = (IV)SvIV(ST(2));
-
-    if ( ! sv_derived_from(robj, "version") )
-    {
-       robj = new_version(robj);
-    }
-    rvs = SvRV(robj);
-
-    if ( swap )
-    {
-        rs = newSViv(vcmp(rvs,lobj));
-    }
+    I32 len = av_len((AV *)lobj);
+    I32 digit = SvIVX(*av_fetch((AV *)lobj, len, 0));
+    if ( digit < 0 )
+       XSRETURN_YES;
     else
-    {
-        rs = newSViv(vcmp(lobj,rvs));
-    }
-
-    PUSHs(rs);
+       XSRETURN_NO;
 }
-
        PUTBACK;
        return;
     }
 }
 
-XS(XS_version_boolean)
+XS(XS_version_qv)
 {
     dXSARGS;
-    if (items < 1)
-       Perl_croak(aTHX_ "Usage: version::boolean(lobj, ...)");
+    if (items != 1)
+       Perl_croak(aTHX_ "Usage: version::qv(ver)");
     SP -= items;
     {
-       SV *    lobj;
-
-        if (sv_derived_from(ST(0), "version")) {
-                SV *tmp = SvRV(ST(0));
-               lobj = tmp;
-        }
-        else
-                Perl_croak(aTHX_ "lobj is not of type version");
+       SV *    ver = ST(0);
+       if ( !SvVOK(ver) ) /* only need to do with if not already v-string */
+       {
+           SV *vs = sv_newmortal();
+           char *version;
+           if ( SvNOK(ver) ) /* may get too much accuracy */
+           {
+               char tbuf[64];
+               sprintf(tbuf,"%.9"NVgf, SvNVX(ver));
+               version = savepv(tbuf);
+           }
+           else
+           {
+               version = savepv(SvPV_nolen(ver));
+           }
+           (void)scan_version(version,vs,TRUE);
+           Safefree(version);
 
-{
-    SV *rs;
-    rs = newSViv( vcmp(lobj,new_version(newSVpvn("0",1))) );
-    PUSHs(rs);
-}
+           PUSHs(vs);
+       }
+       else
+       {
+           PUSHs(sv_2mortal(new_version(ver)));
+       }
 
        PUTBACK;
        return;
     }
 }
 
-XS(XS_version_noop)
+XS(XS_utf8_is_utf8)
 {
-    dXSARGS;
-    if (items < 1)
-       Perl_croak(aTHX_ "Usage: version::noop(lobj, ...)");
-    {
-       SV *    lobj;
-
-        if (sv_derived_from(ST(0), "version")) {
-                SV *tmp = SvRV(ST(0));
-               lobj = tmp;
-        }
-        else
-                Perl_croak(aTHX_ "lobj is not of type version");
-
-{
-    Perl_croak(aTHX_ "operation not supported with version object");
-}
-
-    }
-    XSRETURN_EMPTY;
+     dXSARGS;
+     if (items != 1)
+         Perl_croak(aTHX_ "Usage: utf8::is_utf8(sv)");
+     {
+         SV *  sv = ST(0);
+         {
+              if (SvUTF8(sv))
+                   XSRETURN_YES;
+              else
+                   XSRETURN_NO;
+         }
+     }
+     XSRETURN_EMPTY;
 }
 
 XS(XS_utf8_valid)
 {
-    dXSARGS;
-    if (items != 1)
-       Perl_croak(aTHX_ "Usage: utf8::valid(sv)");
-    {
-       SV *    sv = ST(0);
- {
-  STRLEN len;
-  char *s = SvPV(sv,len);
-  if (!SvUTF8(sv) || is_utf8_string((U8*)s,len))
-   XSRETURN_YES;
-  else
-   XSRETURN_NO;
- }
-    }
-    XSRETURN_EMPTY;
+     dXSARGS;
+     if (items != 1)
+         Perl_croak(aTHX_ "Usage: utf8::valid(sv)");
+     {
+         SV *  sv = ST(0);
        {
+              STRLEN len;
+              char *s = SvPV(sv,len);
+              if (!SvUTF8(sv) || is_utf8_string((U8*)s,len))
+                   XSRETURN_YES;
+              else
+                   XSRETURN_NO;
        }
+     }
+     XSRETURN_EMPTY;
 }
 
 XS(XS_utf8_encode)
@@ -660,52 +781,173 @@ XS(XS_Internals_SvREFCNT)        /* This is dangerous stuff. */
     XSRETURN_UNDEF; /* Can't happen. */
 }
 
-/* Maybe this should return the number of placeholders found in scalar context,
-   and a list of them in list context.  */
 XS(XS_Internals_hv_clear_placehold)
 {
     dXSARGS;
     HV *hv = (HV *) SvRV(ST(0));
+    if (items != 1)
+       Perl_croak(aTHX_ "Usage: UNIVERSAL::hv_clear_placeholders(hv)");
+    hv_clear_placeholders(hv);
+    XSRETURN(0);
+}
 
-    /* I don't care how many parameters were passed in, but I want to avoid
-       the unused variable warning. */
-
-    items = (I32)HvPLACEHOLDERS(hv);
-
-    if (items) {
-        HE *entry;
-        I32 riter = HvRITER(hv);
-        HE *eiter = HvEITER(hv);
-        hv_iterinit(hv);
-        /* This may look suboptimal with the items *after* the iternext, but
-           it's quite deliberate. We only get here with items==0 if we've
-           just deleted the last placeholder in the hash. If we've just done
-           that then it means that the hash is in lazy delete mode, and the
-           HE is now only referenced in our iterator. If we just quit the loop
-           and discarded our iterator then the HE leaks. So we do the && the
-           other way to ensure iternext is called just one more time, which
-           has the side effect of triggering the lazy delete.  */
-        while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))
-            && items) {
-            SV *val = hv_iterval(hv, entry);
-
-            if (val == &PL_sv_undef) {
-
-                /* It seems that I have to go back in the front of the hash
-                   API to delete a hash, even though I have a HE structure
-                   pointing to the very entry I want to delete, and could hold
-                   onto the previous HE that points to it. And it's easier to
-                   go in with SVs as I can then specify the precomputed hash,
-                   and don't have fun and games with utf8 keys.  */
-                SV *key = hv_iterkeysv(entry);
-
-                hv_delete_ent (hv, key, G_DISCARD, HeHASH(entry));
-                items--;
-            }
-        }
-        HvRITER(hv) = riter;
-        HvEITER(hv) = eiter;
+XS(XS_Regexp_DESTROY)
+{
+
+}
+
+XS(XS_PerlIO_get_layers)
+{
+    dXSARGS;
+    if (items < 1 || items % 2 == 0)
+       Perl_croak(aTHX_ "Usage: PerlIO_get_layers(filehandle[,args])");
+#ifdef USE_PERLIO
+    {
+       SV *    sv;
+       GV *    gv;
+       IO *    io;
+       bool    input = TRUE;
+       bool    details = FALSE;
+
+       if (items > 1) {
+            SV **svp;
+            
+            for (svp = MARK + 2; svp <= SP; svp += 2) {
+                 SV **varp = svp;
+                 SV **valp = svp + 1;
+                 STRLEN klen;
+                 char *key = SvPV(*varp, klen);
+
+                 switch (*key) {
+                 case 'i':
+                      if (klen == 5 && memEQ(key, "input", 5)) {
+                           input = SvTRUE(*valp);
+                           break;
+                      }
+                      goto fail;
+                 case 'o': 
+                      if (klen == 6 && memEQ(key, "output", 6)) {
+                           input = !SvTRUE(*valp);
+                           break;
+                      }
+                      goto fail;
+                 case 'd':
+                      if (klen == 7 && memEQ(key, "details", 7)) {
+                           details = SvTRUE(*valp);
+                           break;
+                      }
+                      goto fail;
+                 default:
+                 fail:
+                      Perl_croak(aTHX_
+                                 "get_layers: unknown argument '%s'",
+                                 key);
+                 }
+            }
+
+            SP -= (items - 1);
+       }
+
+       sv = POPs;
+       gv = (GV*)sv;
+
+       if (!isGV(sv)) {
+            if (SvROK(sv) && isGV(SvRV(sv)))
+                 gv = (GV*)SvRV(sv);
+            else
+                 gv = gv_fetchpv(SvPVX(sv), FALSE, SVt_PVIO);
+       }
+
+       if (gv && (io = GvIO(gv))) {
+            dTARGET;
+            AV* av = PerlIO_get_layers(aTHX_ input ?
+                                       IoIFP(io) : IoOFP(io));
+            I32 i;
+            I32 last = av_len(av);
+            I32 nitem = 0;
+            
+            for (i = last; i >= 0; i -= 3) {
+                 SV **namsvp;
+                 SV **argsvp;
+                 SV **flgsvp;
+                 bool namok, argok, flgok;
+
+                 namsvp = av_fetch(av, i - 2, FALSE);
+                 argsvp = av_fetch(av, i - 1, FALSE);
+                 flgsvp = av_fetch(av, i,     FALSE);
+
+                 namok = namsvp && *namsvp && SvPOK(*namsvp);
+                 argok = argsvp && *argsvp && SvPOK(*argsvp);
+                 flgok = flgsvp && *flgsvp && SvIOK(*flgsvp);
+
+                 if (details) {
+                      XPUSHs(namok ?
+                            newSVpv(SvPVX(*namsvp), 0) : &PL_sv_undef);
+                      XPUSHs(argok ?
+                            newSVpv(SvPVX(*argsvp), 0) : &PL_sv_undef);
+                      if (flgok)
+                           XPUSHi(SvIVX(*flgsvp));
+                      else
+                           XPUSHs(&PL_sv_undef);
+                      nitem += 3;
+                 }
+                 else {
+                      if (namok && argok)
+                           XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf"(%"SVf")",
+                                              *namsvp, *argsvp));
+                      else if (namok)
+                           XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf, *namsvp));
+                      else
+                           XPUSHs(&PL_sv_undef);
+                      nitem++;
+                      if (flgok) {
+                           IV flags = SvIVX(*flgsvp);
+
+                           if (flags & PERLIO_F_UTF8) {
+                                XPUSHs(newSVpvn("utf8", 4));
+                                nitem++;
+                           }
+                      }
+                 }
+            }
+
+            SvREFCNT_dec(av);
+
+            XSRETURN(nitem);
+       }
     }
+#endif
 
     XSRETURN(0);
 }
+
+XS(XS_Internals_hash_seed)
+{
+    /* Using dXSARGS would also have dITEM and dSP,
+     * which define 2 unused local variables.  */
+    dMARK; dAX;
+    XSRETURN_UV(PERL_HASH_SEED);
+}
+
+XS(XS_Internals_rehash_seed)
+{
+    /* Using dXSARGS would also have dITEM and dSP,
+     * which define 2 unused local variables.  */
+    dMARK; dAX;
+    XSRETURN_UV(PL_rehash_seed);
+}
+
+XS(XS_Internals_HvREHASH)      /* Subject to change  */
+{
+    dXSARGS;
+    if (SvROK(ST(0))) {
+       HV *hv = (HV *) SvRV(ST(0));
+       if (items == 1 && SvTYPE(hv) == SVt_PVHV) {
+           if (HvREHASH(hv))
+               XSRETURN_YES;
+           else
+               XSRETURN_NO;
+       }
+    }
+    Perl_croak(aTHX_ "Internals::HvREHASH $hashref");
+}