This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update Changes.
[perl5.git] / av.c
diff --git a/av.c b/av.c
index 1253c12..d042892 100644 (file)
--- a/av.c
+++ b/av.c
@@ -1,6 +1,6 @@
 /*    av.c
  *
- *    Copyright (c) 1991-2000, Larry Wall
+ *    Copyright (c) 1991-2002, Larry Wall
  *
  *    You may distribute under the terms of either the GNU General Public
  *    License or the Artistic License, as specified in the README file.
  * meant that things should remain where they had set them)." --Treebeard
  */
 
+/*
+=head1 Array Manipulation Functions
+*/
+
 #include "EXTERN.h"
 #define PERL_IN_AV_C
 #include "perl.h"
@@ -25,7 +29,7 @@ Perl_av_reify(pTHX_ AV *av)
     if (AvREAL(av))
        return;
 #ifdef DEBUGGING
-    if (SvTIED_mg((SV*)av, 'P') && ckWARN_d(WARN_DEBUGGING))
+    if (SvTIED_mg((SV*)av, PERL_MAGIC_tied) && ckWARN_d(WARN_DEBUGGING))
        Perl_warner(aTHX_ WARN_DEBUGGING, "av_reify called on tied array");
 #endif
     key = AvMAX(av) + 1;
@@ -34,10 +38,8 @@ Perl_av_reify(pTHX_ AV *av)
     while (key) {
        sv = AvARRAY(av)[--key];
        assert(sv);
-       if (sv != &PL_sv_undef) {
-           dTHR;
+       if (sv != &PL_sv_undef)
            (void)SvREFCNT_inc(sv);
-       }
     }
     key = AvARRAY(av) - AvALLOC(av);
     while (key)
@@ -58,9 +60,8 @@ extended.
 void
 Perl_av_extend(pTHX_ AV *av, I32 key)
 {
-    dTHR;                      /* only necessary if we have to extend stack */
     MAGIC *mg;
-    if (mg = SvTIED_mg((SV*)av, 'P')) {
+    if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) {
        dSP;
        ENTER;
        SAVETMPS;
@@ -99,7 +100,7 @@ Perl_av_extend(pTHX_ AV *av, I32 key)
        }
        else {
            if (AvALLOC(av)) {
-#ifndef STRANGE_MALLOC
+#if !defined(STRANGE_MALLOC) && !defined(MYMALLOC)
                MEM_SIZE bytes;
                IV itmp;
 #endif
@@ -133,7 +134,9 @@ Perl_av_extend(pTHX_ AV *av, I32 key)
                    Safefree(AvALLOC(av));
                AvALLOC(av) = ary;
 #endif
+#if defined(MYMALLOC) && !defined(LEAKTEST)
              resized:
+#endif
                ary = AvALLOC(av) + AvMAX(av) + 1;
                tmp = newmax - AvMAX(av);
                if (av == PL_curstack) {        /* Oops, grew stack (via av_store()?) */
@@ -188,8 +191,9 @@ Perl_av_fetch(pTHX_ register AV *av, I32 key, I32 lval)
     }
 
     if (SvRMAGICAL(av)) {
-       if (mg_find((SV*)av,'P') || mg_find((SV*)av,'D')) {
-           dTHR;
+       if (mg_find((SV*)av, PERL_MAGIC_tied) ||
+               mg_find((SV*)av, PERL_MAGIC_regdata))
+       {
            sv = sv_newmortal();
            mg_copy((SV*)av, sv, 0, key);
            PL_av_fetch_sv = sv;
@@ -241,8 +245,6 @@ SV**
 Perl_av_store(pTHX_ register AV *av, I32 key, SV *val)
 {
     SV** ary;
-    U32  fill;
-
 
     if (!av)
        return 0;
@@ -259,7 +261,7 @@ Perl_av_store(pTHX_ register AV *av, I32 key, SV *val)
        Perl_croak(aTHX_ PL_no_modify);
 
     if (SvRMAGICAL(av)) {
-       if (mg_find((SV*)av,'P')) {
+       if (mg_find((SV*)av, PERL_MAGIC_tied)) {
            if (val != &PL_sv_undef) {
                mg_copy((SV*)av, val, 0, key);
            }
@@ -274,7 +276,6 @@ Perl_av_store(pTHX_ register AV *av, I32 key, SV *val)
     ary = AvARRAY(av);
     if (AvFILLp(av) < key) {
        if (!AvREAL(av)) {
-           dTHR;
            if (av == PL_curstack && key > PL_stack_sp - PL_stack_base)
                PL_stack_sp = PL_stack_base + key;      /* XPUSH in disguise */
            do
@@ -419,7 +420,7 @@ Perl_av_clear(pTHX_ register AV *av)
            ary[key] = &PL_sv_undef;
        }
     }
-    if (key = AvARRAY(av) - AvALLOC(av)) {
+    if ((key = AvARRAY(av) - AvALLOC(av))) {
        AvMAX(av) += key;
        SvPVX(av) = (char*)AvALLOC(av);
     }
@@ -445,7 +446,7 @@ Perl_av_undef(pTHX_ register AV *av)
     /*SUPPRESS 560*/
 
     /* Give any tie a chance to cleanup first */
-    if (SvTIED_mg((SV*)av, 'P')) 
+    if (SvTIED_mg((SV*)av, PERL_MAGIC_tied)) 
        av_fill(av, -1);   /* mg_clear() ? */
 
     if (AvREAL(av)) {
@@ -481,7 +482,7 @@ Perl_av_push(pTHX_ register AV *av, SV *val)
     if (SvREADONLY(av))
        Perl_croak(aTHX_ PL_no_modify);
 
-    if (mg = SvTIED_mg((SV*)av, 'P')) {
+    if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) {
        dSP;
        PUSHSTACKi(PERLSI_MAGIC);
        PUSHMARK(SP);
@@ -517,7 +518,7 @@ Perl_av_pop(pTHX_ register AV *av)
        return &PL_sv_undef;
     if (SvREADONLY(av))
        Perl_croak(aTHX_ PL_no_modify);
-    if (mg = SvTIED_mg((SV*)av, 'P')) {
+    if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) {
        dSP;    
        PUSHSTACKi(PERLSI_MAGIC);
        PUSHMARK(SP);
@@ -556,13 +557,14 @@ Perl_av_unshift(pTHX_ register AV *av, register I32 num)
     register I32 i;
     register SV **ary;
     MAGIC* mg;
+    I32 slide;
 
     if (!av || num <= 0)
        return;
     if (SvREADONLY(av))
        Perl_croak(aTHX_ PL_no_modify);
 
-    if (mg = SvTIED_mg((SV*)av, 'P')) {
+    if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) {
        dSP;
        PUSHSTACKi(PERLSI_MAGIC);
        PUSHMARK(SP);
@@ -593,6 +595,9 @@ Perl_av_unshift(pTHX_ register AV *av, register I32 num)
     }
     if (num) {
        i = AvFILLp(av);
+       /* Create extra elements */
+       slide = i > 0 ? i : 0;
+       num += slide;
        av_extend(av, i + num);
        AvFILLp(av) += num;
        ary = AvARRAY(av);
@@ -600,6 +605,10 @@ Perl_av_unshift(pTHX_ register AV *av, register I32 num)
        do {
            ary[--num] = &PL_sv_undef;
        } while (num);
+       /* Make extra elements into a buffer */
+       AvMAX(av) -= slide;
+       AvFILLp(av) -= slide;
+       SvPVX(av) = (char*)(AvARRAY(av) + slide);
     }
 }
 
@@ -621,7 +630,7 @@ Perl_av_shift(pTHX_ register AV *av)
        return &PL_sv_undef;
     if (SvREADONLY(av))
        Perl_croak(aTHX_ PL_no_modify);
-    if (mg = SvTIED_mg((SV*)av, 'P')) {
+    if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) {
        dSP;
        PUSHSTACKi(PERLSI_MAGIC);
        PUSHMARK(SP);
@@ -663,6 +672,14 @@ Perl_av_len(pTHX_ register AV *av)
     return AvFILL(av);
 }
 
+/*
+=for apidoc av_fill
+
+Ensure than an array has a given number of elements, equivalent to
+Perl's C<$#array = $fill;>.
+
+=cut
+*/
 void
 Perl_av_fill(pTHX_ register AV *av, I32 fill)
 {
@@ -671,7 +688,7 @@ Perl_av_fill(pTHX_ register AV *av, I32 fill)
        Perl_croak(aTHX_ "panic: null array");
     if (fill < 0)
        fill = -1;
-    if (mg = SvTIED_mg((SV*)av, 'P')) {
+    if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) {
        dSP;            
        ENTER;
        SAVETMPS;
@@ -710,6 +727,14 @@ Perl_av_fill(pTHX_ register AV *av, I32 fill)
        (void)av_store(av,fill,&PL_sv_undef);
 }
 
+/*
+=for apidoc av_delete
+
+Deletes the element indexed by C<key> from the array.  Returns the
+deleted element. C<flags> is currently ignored.
+
+=cut
+*/
 SV *
 Perl_av_delete(pTHX_ AV *av, I32 key, I32 flags)
 {
@@ -726,13 +751,14 @@ Perl_av_delete(pTHX_ AV *av, I32 key, I32 flags)
     }
     if (SvRMAGICAL(av)) {
        SV **svp;
-       if ((mg_find((SV*)av,'P') || mg_find((SV*)av,'D'))
+       if ((mg_find((SV*)av, PERL_MAGIC_tied) ||
+               mg_find((SV*)av, PERL_MAGIC_regdata))
            && (svp = av_fetch(av, key, TRUE)))
        {
            sv = *svp;
            mg_clear(sv);
-           if (mg_find(sv, 'p')) {
-               sv_unmagic(sv, 'p');            /* No longer an element */
+           if (mg_find(sv, PERL_MAGIC_tiedelem)) {
+               sv_unmagic(sv, PERL_MAGIC_tiedelem);    /* No longer an element */
                return sv;
            }
            return Nullsv;                      /* element cannot be deleted */
@@ -743,6 +769,7 @@ Perl_av_delete(pTHX_ AV *av, I32 key, I32 flags)
     else {
        sv = AvARRAY(av)[key];
        if (key == AvFILLp(av)) {
+           AvARRAY(av)[key] = &PL_sv_undef;
            do {
                AvFILLp(av)--;
            } while (--key >= 0 && AvARRAY(av)[key] == &PL_sv_undef);
@@ -760,10 +787,15 @@ Perl_av_delete(pTHX_ AV *av, I32 key, I32 flags)
 }
 
 /*
- * This relies on the fact that uninitialized array elements
- * are set to &PL_sv_undef.
- */
+=for apidoc av_exists
+
+Returns true if the element indexed by C<key> has been initialized.
 
+This relies on the fact that uninitialized array elements are set to
+C<&PL_sv_undef>.
+
+=cut
+*/
 bool
 Perl_av_exists(pTHX_ AV *av, I32 key)
 {
@@ -775,11 +807,18 @@ Perl_av_exists(pTHX_ AV *av, I32 key)
            return FALSE;
     }
     if (SvRMAGICAL(av)) {
-       if (mg_find((SV*)av,'P') || mg_find((SV*)av,'D')) {
+       if (mg_find((SV*)av, PERL_MAGIC_tied) ||
+               mg_find((SV*)av, PERL_MAGIC_regdata))
+       {
            SV *sv = sv_newmortal();
+           MAGIC *mg;
+
            mg_copy((SV*)av, sv, 0, key);
-           magic_existspack(sv, mg_find(sv, 'p'));
-           return SvTRUE(sv);
+           mg = mg_find(sv, PERL_MAGIC_tiedelem);
+           if (mg) {
+               magic_existspack(sv, mg);
+               return SvTRUE(sv);
+           }
        }
     }
     if (key <= AvFILLp(av) && AvARRAY(av)[key] != &PL_sv_undef