This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update release managers guide with notes from 5.13.3 release
[perl5.git] / doop.c
diff --git a/doop.c b/doop.c
index 5d1fc7a..c1a357c 100644 (file)
--- a/doop.c
+++ b/doop.c
@@ -1,7 +1,7 @@
 /*    doop.c
  *
- *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
- *    2000, 2001, 2002, 2004, 2005, 2006, by Larry Wall and others
+ *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
+ *    2001, 2002, 2004, 2005, 2006, 2007, 2008, 2009 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.
@@ -9,7 +9,9 @@
  */
 
 /*
- * "'So that was the job I felt I had to do when I started,' thought Sam."
+ *  'So that was the job I felt I had to do when I started,' thought Sam.
+ *
+ *     [p.934 of _The Lord of the Rings_, VI/iii: "Mount Doom"]
  */
 
 /* This file contains some common functions needed to carry out certain
@@ -33,8 +35,10 @@ S_do_trans_simple(pTHX_ SV * const sv)
     STRLEN len;
     U8 *s = (U8*)SvPV(sv,len);
     U8 * const send = s+len;
-
     const short * const tbl = (short*)cPVOP->op_pv;
+
+    PERL_ARGS_ASSERT_DO_TRANS_SIMPLE;
+
     if (!tbl)
        Perl_croak(aTHX_ "panic: do_trans_simple line %d",__LINE__);
 
@@ -100,8 +104,10 @@ S_do_trans_count(pTHX_ SV * const sv)
     const U8 *s = (const U8*)SvPV_const(sv, len);
     const U8 * const send = s + len;
     I32 matches = 0;
-
     const short * const tbl = (short*)cPVOP->op_pv;
+
+    PERL_ARGS_ASSERT_DO_TRANS_COUNT;
+
     if (!tbl)
        Perl_croak(aTHX_ "panic: do_trans_count line %d",__LINE__);
 
@@ -136,8 +142,10 @@ S_do_trans_complex(pTHX_ SV * const sv)
     U8 *s = (U8*)SvPV(sv, len);
     U8 * const send = s+len;
     I32 matches = 0;
-
     const short * const tbl = (short*)cPVOP->op_pv;
+
+    PERL_ARGS_ASSERT_DO_TRANS_COMPLEX;
+
     if (!tbl)
        Perl_croak(aTHX_ "panic: do_trans_complex line %d",__LINE__);
 
@@ -195,10 +203,6 @@ S_do_trans_complex(pTHX_ SV * const sv)
        if (complement && !del)
            rlen = tbl[0x100];
 
-#ifdef MACOS_TRADITIONAL
-#define comp CoMP   /* "comp" is a keyword in some compilers ... */
-#endif
-
        if (PL_op->op_private & OPpTRANS_SQUASH) {
            UV pch = 0xfeedface;
            while (s < send) {
@@ -306,15 +310,21 @@ S_do_trans_simple_utf8(pTHX_ SV * const sv)
     I32 matches = 0;
     const I32 grows = PL_op->op_private & OPpTRANS_GROWS;
     STRLEN len;
-
-    SV* const  rv = (SV*)cSVOP->op_sv;
-    HV* const  hv = (HV*)SvRV(rv);
+    SV* const  rv =
+#ifdef USE_ITHREADS
+                   PAD_SVl(cPADOP->op_padix);
+#else
+                   MUTABLE_SV(cSVOP->op_sv);
+#endif
+    HV* const  hv = MUTABLE_HV(SvRV(rv));
     SV* const * svp = hv_fetchs(hv, "NONE", FALSE);
     const UV none = svp ? SvUV(*svp) : 0x7fffffff;
     const UV extra = none + 1;
     UV final = 0;
     U8 hibit = 0;
 
+    PERL_ARGS_ASSERT_DO_TRANS_SIMPLE_UTF8;
+
     s = (U8*)SvPV(sv, len);
     if (!SvUTF8(sv)) {
        const U8 *t = s;
@@ -402,14 +412,20 @@ S_do_trans_count_utf8(pTHX_ SV * const sv)
     const U8 *send;
     I32 matches = 0;
     STRLEN len;
-
-    SV* const rv = (SV*)cSVOP->op_sv;
-    HV* const hv = (HV*)SvRV(rv);
+    SV* const  rv =
+#ifdef USE_ITHREADS
+                   PAD_SVl(cPADOP->op_padix);
+#else
+                   MUTABLE_SV(cSVOP->op_sv);
+#endif
+    HV* const hv = MUTABLE_HV(SvRV(rv));
     SV* const * const svp = hv_fetchs(hv, "NONE", FALSE);
     const UV none = svp ? SvUV(*svp) : 0x7fffffff;
     const UV extra = none + 1;
     U8 hibit = 0;
 
+    PERL_ARGS_ASSERT_DO_TRANS_COUNT_UTF8;
+
     s = (const U8*)SvPV_const(sv, len);
     if (!SvUTF8(sv)) {
        const U8 *t = s;
@@ -447,8 +463,13 @@ S_do_trans_complex_utf8(pTHX_ SV * const sv)
     const I32 squash   = PL_op->op_private & OPpTRANS_SQUASH;
     const I32 del      = PL_op->op_private & OPpTRANS_DELETE;
     const I32 grows    = PL_op->op_private & OPpTRANS_GROWS;
-    SV * const rv = (SV*)cSVOP->op_sv;
-    HV * const hv = (HV*)SvRV(rv);
+    SV* const  rv =
+#ifdef USE_ITHREADS
+                   PAD_SVl(cPADOP->op_padix);
+#else
+                   MUTABLE_SV(cSVOP->op_sv);
+#endif
+    HV * const hv = MUTABLE_HV(SvRV(rv));
     SV * const *svp = hv_fetchs(hv, "NONE", FALSE);
     const UV none = svp ? SvUV(*svp) : 0x7fffffff;
     const UV extra = none + 1;
@@ -457,8 +478,10 @@ S_do_trans_complex_utf8(pTHX_ SV * const sv)
     STRLEN len;
     U8 *dstart, *dend;
     U8 hibit = 0;
-
     U8 *s = (U8*)SvPV(sv, len);
+
+    PERL_ARGS_ASSERT_DO_TRANS_COMPLEX_UTF8;
+
     if (!SvUTF8(sv)) {
        const U8 *t = s;
        const U8 * const e = s + len;
@@ -606,11 +629,13 @@ Perl_do_trans(pTHX_ SV *sv)
     const I32 hasutf = (PL_op->op_private &
                     (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF));
 
-    if (SvREADONLY(sv)) {
+    PERL_ARGS_ASSERT_DO_TRANS;
+
+    if (SvREADONLY(sv) && !(PL_op->op_private & OPpTRANS_IDENTICAL)) {
         if (SvIsCOW(sv))
             sv_force_normal_flags(sv, 0);
-        if (SvREADONLY(sv) && !(PL_op->op_private & OPpTRANS_IDENTICAL))
-            Perl_croak(aTHX_ PL_no_modify);
+        if (SvREADONLY(sv))
+            Perl_croak_no_modify(aTHX);
     }
     (void)SvPV_const(sv, len);
     if (!len)
@@ -656,6 +681,8 @@ Perl_do_join(pTHX_ register SV *sv, SV *delim, register SV **mark, register SV *
     register STRLEN len;
     STRLEN delimlen;
 
+    PERL_ARGS_ASSERT_DO_JOIN;
+
     (void) SvPV_const(delim, delimlen); /* stringify and get the delimlen */
     /* SvCUR assumes it's SvPOK() and woe betide you if it's not. */
 
@@ -678,7 +705,7 @@ Perl_do_join(pTHX_ register SV *sv, SV *delim, register SV **mark, register SV *
        ++mark;
     }
 
-    sv_setpvn(sv, "", 0);
+    sv_setpvs(sv, "");
     /* sv_setpv retains old UTF8ness [perl #24846] */
     SvUTF8_off(sv);
 
@@ -712,6 +739,8 @@ Perl_do_sprintf(pTHX_ SV *sv, I32 len, SV **sarg)
     const char * const pat = SvPV_const(*sarg, patlen);
     bool do_taint = FALSE;
 
+    PERL_ARGS_ASSERT_DO_SPRINTF;
+
     SvUTF8_off(sv);
     if (DO_UTF8(*sarg))
         SvUTF8_on(sv);
@@ -726,25 +755,34 @@ UV
 Perl_do_vecget(pTHX_ SV *sv, I32 offset, I32 size)
 {
     dVAR;
-    STRLEN srclen, len, uoffset;
+    STRLEN srclen, len, uoffset, bitoffs = 0;
     const unsigned char *s = (const unsigned char *) SvPV_const(sv, srclen);
     UV retnum = 0;
 
+    PERL_ARGS_ASSERT_DO_VECGET;
+
     if (offset < 0)
-       return retnum;
+       return 0;
     if (size < 1 || (size & (size-1))) /* size < 1 or not a power of two */
        Perl_croak(aTHX_ "Illegal number of bits in vec");
 
     if (SvUTF8(sv))
        (void) Perl_sv_utf8_downgrade(aTHX_ sv, TRUE);
 
-    uoffset = offset*size;     /* turn into bit offset */
-    len = (uoffset + size + 7) / 8;    /* required number of bytes */
+    if (size < 8) {
+       bitoffs = ((offset%8)*size)%8;
+       uoffset = offset/(8/size);
+    }
+    else if (size > 8)
+       uoffset = offset*(size/8);
+    else
+       uoffset = offset;
+
+    len = uoffset + (bitoffs + size + 7)/8;    /* required number of bytes */
     if (len > srclen) {
        if (size <= 8)
            retnum = 0;
        else {
-           uoffset >>= 3;      /* turn into byte offset */
            if (size == 16) {
                if (uoffset >= srclen)
                    retnum = 0;
@@ -769,9 +807,8 @@ Perl_do_vecget(pTHX_ SV *sv, I32 offset, I32 size)
            }
 #ifdef UV_IS_QUAD
            else if (size == 64) {
-               if (ckWARN(WARN_PORTABLE))
-                   Perl_warner(aTHX_ packWARN(WARN_PORTABLE),
-                               "Bit vector size > 32 non-portable");
+               Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
+                              "Bit vector size > 32 non-portable");
                if (uoffset >= srclen)
                    retnum = 0;
                else if (uoffset + 1 >= srclen)
@@ -821,9 +858,8 @@ Perl_do_vecget(pTHX_ SV *sv, I32 offset, I32 size)
        }
     }
     else if (size < 8)
-       retnum = (s[uoffset >> 3] >> (uoffset & 7)) & ((1 << size) - 1);
+       retnum = (s[uoffset] >> bitoffs) & ((1 << size) - 1);
     else {
-       uoffset >>= 3;  /* turn into byte offset */
        if (size == 8)
            retnum = s[uoffset];
        else if (size == 16)
@@ -838,9 +874,8 @@ Perl_do_vecget(pTHX_ SV *sv, I32 offset, I32 size)
                      s[uoffset + 3];
 #ifdef UV_IS_QUAD
        else if (size == 64) {
-           if (ckWARN(WARN_PORTABLE))
-               Perl_warner(aTHX_ packWARN(WARN_PORTABLE),
-                           "Bit vector size > 32 non-portable");
+           Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
+                          "Bit vector size > 32 non-portable");
            retnum =
                ((UV) s[uoffset    ] << 56) +
                ((UV) s[uoffset + 1] << 48) +
@@ -865,7 +900,7 @@ void
 Perl_do_vecset(pTHX_ SV *sv)
 {
     dVAR;
-    register I32 offset;
+    register I32 offset, bitoffs = 0;
     register I32 size;
     register unsigned char *s;
     register UV lval;
@@ -874,6 +909,8 @@ Perl_do_vecset(pTHX_ SV *sv)
     STRLEN len;
     SV * const targ = LvTARG(sv);
 
+    PERL_ARGS_ASSERT_DO_VECSET;
+
     if (!targ)
        return;
     s = (unsigned char*)SvPV_force(targ, targlen);
@@ -894,8 +931,14 @@ Perl_do_vecset(pTHX_ SV *sv)
     if (size < 1 || (size & (size-1))) /* size < 1 or not a power of two */
        Perl_croak(aTHX_ "Illegal number of bits in vec");
 
-    offset *= size;                    /* turn into bit offset */
-    len = (offset + size + 7) / 8;     /* required number of bytes */
+    if (size < 8) {
+       bitoffs = ((offset%8)*size)%8;
+       offset /= 8/size;
+    }
+    else if (size > 8)
+       offset *= size/8;
+
+    len = offset + (bitoffs + size + 7)/8;     /* required number of bytes */
     if (len > targlen) {
        s = (unsigned char*)SvGROW(targ, len + 1);
        (void)memzero((char *)(s + targlen), len - targlen + 1);
@@ -904,14 +947,11 @@ Perl_do_vecset(pTHX_ SV *sv)
 
     if (size < 8) {
        mask = (1 << size) - 1;
-       size = offset & 7;
        lval &= mask;
-       offset >>= 3;                   /* turn into byte offset */
-       s[offset] &= ~(mask << size);
-       s[offset] |= lval << size;
+       s[offset] &= ~(mask << bitoffs);
+       s[offset] |= lval << bitoffs;
     }
     else {
-       offset >>= 3;                   /* turn into byte offset */
        if (size == 8)
            s[offset  ] = (U8)( lval        & 0xff);
        else if (size == 16) {
@@ -926,9 +966,8 @@ Perl_do_vecset(pTHX_ SV *sv)
        }
 #ifdef UV_IS_QUAD
        else if (size == 64) {
-           if (ckWARN(WARN_PORTABLE))
-               Perl_warner(aTHX_ packWARN(WARN_PORTABLE),
-                           "Bit vector size > 32 non-portable");
+           Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
+                          "Bit vector size > 32 non-portable");
            s[offset  ] = (U8)((lval >> 56) & 0xff);
            s[offset+1] = (U8)((lval >> 48) & 0xff);
            s[offset+2] = (U8)((lval >> 40) & 0xff);
@@ -950,20 +989,22 @@ Perl_do_chop(pTHX_ register SV *astr, register SV *sv)
     STRLEN len;
     char *s;
 
+    PERL_ARGS_ASSERT_DO_CHOP;
+
     if (SvTYPE(sv) == SVt_PVAV) {
        register I32 i;
-       AV* const av = (AV*)sv;
+       AV *const av = MUTABLE_AV(sv);
        const I32 max = AvFILL(av);
 
        for (i = 0; i <= max; i++) {
-           sv = (SV*)av_fetch(av, i, FALSE);
+           sv = MUTABLE_SV(av_fetch(av, i, FALSE));
            if (sv && ((sv = *(SV**)sv), sv != &PL_sv_undef))
                do_chop(astr, sv);
        }
         return;
     }
     else if (SvTYPE(sv) == SVt_PVHV) {
-       HV* const hv = (HV*)sv;
+       HV* const hv = MUTABLE_HV(sv);
        HE* entry;
         (void)hv_iterinit(hv);
         while ((entry = hv_iternext(hv)))
@@ -976,7 +1017,7 @@ Perl_do_chop(pTHX_ register SV *astr, register SV *sv)
            sv_force_normal_flags(sv, 0);
         }
         if (SvREADONLY(sv))
-            Perl_croak(aTHX_ PL_no_modify);
+            Perl_croak_no_modify(aTHX);
     }
 
     if (PL_encoding && !SvUTF8(sv)) {
@@ -987,7 +1028,7 @@ Perl_do_chop(pTHX_ register SV *astr, register SV *sv)
 
     s = SvPV(sv, len);
     if (len && !SvPOK(sv))
-       s = SvPV_force(sv, len);
+       s = SvPV_force_nomg(sv, len);
     if (DO_UTF8(sv)) {
        if (s && len) {
            char * const send = s + len;
@@ -1004,7 +1045,7 @@ Perl_do_chop(pTHX_ register SV *astr, register SV *sv)
            }
        }
        else
-           sv_setpvn(astr, "", 0);
+           sv_setpvs(astr, "");
     }
     else if (s && len) {
        s += --len;
@@ -1015,7 +1056,7 @@ Perl_do_chop(pTHX_ register SV *astr, register SV *sv)
        SvNIOK_off(sv);
     }
     else
-       sv_setpvn(astr, "", 0);
+       sv_setpvs(astr, "");
     SvSETMAGIC(sv);
 }
 
@@ -1029,6 +1070,8 @@ Perl_do_chomp(pTHX_ register SV *sv)
     char *temp_buffer = NULL;
     SV* svrecode = NULL;
 
+    PERL_ARGS_ASSERT_DO_CHOMP;
+
     if (RsSNARF(PL_rs))
        return 0;
     if (RsRECORD(PL_rs))
@@ -1036,18 +1079,18 @@ Perl_do_chomp(pTHX_ register SV *sv)
     count = 0;
     if (SvTYPE(sv) == SVt_PVAV) {
        register I32 i;
-       AV* const av = (AV*)sv;
+       AV *const av = MUTABLE_AV(sv);
        const I32 max = AvFILL(av);
 
        for (i = 0; i <= max; i++) {
-           sv = (SV*)av_fetch(av, i, FALSE);
+           sv = MUTABLE_SV(av_fetch(av, i, FALSE));
            if (sv && ((sv = *(SV**)sv), sv != &PL_sv_undef))
                count += do_chomp(sv);
        }
         return count;
     }
     else if (SvTYPE(sv) == SVt_PVHV) {
-       HV* const hv = (HV*)sv;
+       HV* const hv = MUTABLE_HV(sv);
        HE* entry;
         (void)hv_iterinit(hv);
         while ((entry = hv_iternext(hv)))
@@ -1060,7 +1103,7 @@ Perl_do_chomp(pTHX_ register SV *sv)
            sv_force_normal_flags(sv, 0);
         }
         if (SvREADONLY(sv))
-            Perl_croak(aTHX_ PL_no_modify);
+            Perl_croak_no_modify(aTHX);
     }
 
     if (PL_encoding) {
@@ -1148,8 +1191,7 @@ Perl_do_chomp(pTHX_ register SV *sv)
     }
   nope:
 
-    if (svrecode)
-        SvREFCNT_dec(svrecode);
+    SvREFCNT_dec(svrecode);
 
     Safefree(temp_buffer);
     return count;
@@ -1177,10 +1219,17 @@ Perl_do_vop(pTHX_ I32 optype, SV *sv, SV *left, SV *right)
     bool right_utf;
     STRLEN needlen = 0;
 
+    PERL_ARGS_ASSERT_DO_VOP;
 
     if (sv != left || (optype != OP_BIT_AND && !SvOK(sv) && !SvGMAGICAL(sv)))
-       sv_setpvn(sv, "", 0);   /* avoid undef warning on |= and ^= */
-    lsave = lc = SvPV_nomg_const(left, leftlen);
+       sv_setpvs(sv, "");      /* avoid undef warning on |= and ^= */
+    if (sv == left) {
+       lsave = lc = SvPV_force_nomg(left, leftlen);
+    }
+    else {
+       lsave = lc = SvPV_nomg_const(left, leftlen);
+       SvPV_force_nomg_nolen(sv);
+    }
     rsave = rc = SvPV_nomg_const(right, rightlen);
 
     /* This need to come after SvPV to ensure that string overloading has
@@ -1193,13 +1242,13 @@ Perl_do_vop(pTHX_ I32 optype, SV *sv, SV *left, SV *right)
        /* Avoid triggering overloading again by using temporaries.
           Maybe there should be a variant of sv_utf8_upgrade that takes pvn
        */
-       right = sv_2mortal(newSVpvn(rsave, rightlen));
+       right = newSVpvn_flags(rsave, rightlen, SVs_TEMP);
        sv_utf8_upgrade(right);
        rsave = rc = SvPV_nomg_const(right, rightlen);
        right_utf = TRUE;
     }
     else if (!left_utf && right_utf) {
-       left = sv_2mortal(newSVpvn(lsave, leftlen));
+       left = newSVpvn_flags(lsave, leftlen, SVs_TEMP);
        sv_utf8_upgrade(left);
        lsave = lc = SvPV_nomg_const(left, leftlen);
        left_utf = TRUE;
@@ -1382,7 +1431,7 @@ Perl_do_kv(pTHX)
 {
     dVAR;
     dSP;
-    HV * const hv = (HV*)POPs;
+    HV * const hv = MUTABLE_HV(POPs);
     HV *keys;
     register HE *entry;
     const I32 gimme = GIMME_V;
@@ -1416,17 +1465,18 @@ Perl_do_kv(pTHX)
                sv_magic(TARG, NULL, PERL_MAGIC_nkeys, NULL, 0);
            }
            LvTYPE(TARG) = 'k';
-           if (LvTARG(TARG) != (SV*)keys) {
-               if (LvTARG(TARG))
-                   SvREFCNT_dec(LvTARG(TARG));
+           if (LvTARG(TARG) != (const SV *)keys) {
+               SvREFCNT_dec(LvTARG(TARG));
                LvTARG(TARG) = SvREFCNT_inc_simple(keys);
            }
            PUSHs(TARG);
            RETURN;
        }
 
-       if (! SvTIED_mg((SV*)keys, PERL_MAGIC_tied))
+       if (! SvTIED_mg((const SV *)keys, PERL_MAGIC_tied) )
+       {
            i = HvKEYS(keys);
+       }
        else {
            i = 0;
            while (hv_iternext(keys)) i++;