This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Re: [PATCH] Add CPANPLUS 0.78 to the core
[perl5.git] / av.c
diff --git a/av.c b/av.c
index 2b28223..39b4b7d 100644 (file)
--- a/av.c
+++ b/av.c
@@ -1,7 +1,7 @@
 /*    av.c
  *
  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
- *    2000, 2001, 2002, 2003, 2004, 2005 by Larry Wall and others
+ *    2000, 2001, 2002, 2003, 2004, 2005, 2006, 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.
 void
 Perl_av_reify(pTHX_ AV *av)
 {
+    dVAR;
     I32 key;
 
+    assert(av);
+
     if (AvREAL(av))
        return;
 #ifdef DEBUGGING
@@ -39,7 +42,7 @@ Perl_av_reify(pTHX_ AV *av)
        SV * const sv = AvARRAY(av)[--key];
        assert(sv);
        if (sv != &PL_sv_undef)
-           (void)SvREFCNT_inc(sv);
+           SvREFCNT_inc_simple_void_NN(sv);
     }
     key = AvARRAY(av) - AvALLOC(av);
     while (key)
@@ -60,8 +63,13 @@ extended.
 void
 Perl_av_extend(pTHX_ AV *av, I32 key)
 {
+    dVAR;
     MAGIC *mg;
-    if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) {
+
+    assert(av);
+
+    mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied);
+    if (mg) {
        dSP;
        ENTER;
        SAVETMPS;
@@ -87,12 +95,11 @@ Perl_av_extend(pTHX_ AV *av, I32 key)
            tmp = AvARRAY(av) - AvALLOC(av);
            Move(AvARRAY(av), AvALLOC(av), AvFILLp(av)+1, SV*);
            AvMAX(av) += tmp;
-           SvPV_set(av, (char*)AvALLOC(av));
+           AvARRAY(av) = AvALLOC(av);
            if (AvREAL(av)) {
                while (tmp)
                    ary[--tmp] = &PL_sv_undef;
            }
-           
            if (key > AvMAX(av) - 10) {
                newmax = key + AvMAX(av);
                goto resize;
@@ -164,7 +171,7 @@ Perl_av_extend(pTHX_ AV *av, I32 key)
                    ary[--tmp] = &PL_sv_undef;
            }
            
-           SvPV_set(av, (char*)AvALLOC(av));
+           AvARRAY(av) = AvALLOC(av);
            AvMAX(av) = newmax;
        }
     }
@@ -186,33 +193,32 @@ more information on how to use this function on tied arrays.
 SV**
 Perl_av_fetch(pTHX_ register AV *av, I32 key, I32 lval)
 {
-    SV *sv;
+    dVAR;
 
-    if (!av)
-       return 0;
+    assert(av);
 
     if (SvRMAGICAL(av)) {
         const MAGIC * const tied_magic = mg_find((SV*)av, PERL_MAGIC_tied);
         if (tied_magic || mg_find((SV*)av, PERL_MAGIC_regdata)) {
-            U32 adjust_index = 1;
-
-            if (tied_magic && key < 0) {
-                /* Handle negative array indices 20020222 MJD */
-                SV **negative_indices_glob = 
-                    hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *)av, 
-                                                     tied_magic))), 
-                             NEGATIVE_INDICES_VAR, 16, 0);
-
-                if (negative_indices_glob
-                    && SvTRUE(GvSV(*negative_indices_glob)))
-                    adjust_index = 0;
-            }
+           SV *sv;
+           if (key < 0) {
+               I32 adjust_index = 1;
+               if (tied_magic) {
+                   /* Handle negative array indices 20020222 MJD */
+                   SV * const * const negative_indices_glob =
+                       hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *)av, tied_magic))),
+                               NEGATIVE_INDICES_VAR, 16, 0);
+
+                   if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
+                       adjust_index = 0;
+               }
 
-            if (key < 0 && adjust_index) {
-                key += AvFILL(av) + 1;
-                if (key < 0)
-                    return 0;
-            }
+               if (adjust_index) {
+                   key += AvFILL(av) + 1;
+                   if (key < 0)
+                       return NULL;
+               }
+           }
 
             sv = sv_newmortal();
            sv_upgrade(sv, SVt_PVLV);
@@ -226,26 +232,23 @@ Perl_av_fetch(pTHX_ register AV *av, I32 key, I32 lval)
     if (key < 0) {
        key += AvFILL(av) + 1;
        if (key < 0)
-           return 0;
+           return NULL;
     }
 
     if (key > AvFILLp(av)) {
        if (!lval)
-           return 0;
-       sv = NEWSV(5,0);
-       return av_store(av,key,sv);
+           return NULL;
+       return av_store(av,key,newSV(0));
     }
     if (AvARRAY(av)[key] == &PL_sv_undef) {
     emptyness:
-       if (lval) {
-           sv = NEWSV(6,0);
-           return av_store(av,key,sv);
-       }
-       return 0;
+       if (lval)
+           return av_store(av,key,newSV(0));
+       return NULL;
     }
     else if (AvREIFY(av)
             && (!AvARRAY(av)[key]      /* eg. @_ could have freed elts */
-                || SvTYPE(AvARRAY(av)[key]) == SVTYPEMASK)) {
+                || SvIS_FREED(AvARRAY(av)[key]))) {
        AvARRAY(av)[key] = &PL_sv_undef;        /* 1/2 reify */
        goto emptyness;
     }
@@ -272,10 +275,15 @@ more information on how to use this function on tied arrays.
 SV**
 Perl_av_store(pTHX_ register AV *av, I32 key, SV *val)
 {
+    dVAR;
     SV** ary;
 
-    if (!av)
-       return 0;
+    assert(av);
+
+    /* S_regclass relies on being able to pass in a NULL sv
+       (unicode_alternate may be NULL).
+    */
+
     if (!val)
        val = &PL_sv_undef;
 
@@ -284,8 +292,8 @@ Perl_av_store(pTHX_ register AV *av, I32 key, SV *val)
         if (tied_magic) {
             /* Handle negative array indices 20020222 MJD */
             if (key < 0) {
-                unsigned adjust_index = 1;
-                SV **negative_indices_glob = 
+               bool adjust_index = 1;
+               SV * const * const negative_indices_glob =
                     hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *)av, 
                                                      tied_magic))), 
                              NEGATIVE_INDICES_VAR, 16, 0);
@@ -301,7 +309,7 @@ Perl_av_store(pTHX_ register AV *av, I32 key, SV *val)
            if (val != &PL_sv_undef) {
                mg_copy((SV*)av, val, 0, key);
            }
-           return 0;
+           return NULL;
         }
     }
 
@@ -309,7 +317,7 @@ Perl_av_store(pTHX_ register AV *av, I32 key, SV *val)
     if (key < 0) {
        key += AvFILL(av) + 1;
        if (key < 0)
-           return 0;
+           return NULL;
     }
 
     if (SvREADONLY(av) && key >= AvFILL(av))
@@ -324,9 +332,9 @@ Perl_av_store(pTHX_ register AV *av, I32 key, SV *val)
        if (!AvREAL(av)) {
            if (av == PL_curstack && key > PL_stack_sp - PL_stack_base)
                PL_stack_sp = PL_stack_base + key;      /* XPUSH in disguise */
-           do
+           do {
                ary[++AvFILLp(av)] = &PL_sv_undef;
-           while (AvFILLp(av) < key);
+           while (AvFILLp(av) < key);
        }
        AvFILLp(av) = key;
     }
@@ -335,7 +343,7 @@ Perl_av_store(pTHX_ register AV *av, I32 key, SV *val)
     ary[key] = val;
     if (SvSMAGICAL(av)) {
        if (val != &PL_sv_undef) {
-           MAGIC* mg = SvMAGIC(av);
+           const MAGIC* const mg = SvMAGIC(av);
            sv_magic(val, (SV*)av, toLOWER(mg->mg_type), 0, key);
        }
        mg_set((SV*)av);
@@ -354,13 +362,10 @@ Creates a new AV.  The reference count is set to 1.
 AV *
 Perl_newAV(pTHX)
 {
-    register AV *av;
-
-    av = (AV*)NEWSV(3,0);
-    sv_upgrade((SV *)av, SVt_PVAV);
+    register AV * const av = (AV*)newSV_type(SVt_PVAV);
     /* sv_upgrade does AvREAL_only()  */
     AvALLOC(av) = 0;
-    SvPV_set(av, (char*)0);
+    AvARRAY(av) = NULL;
     AvMAX(av) = AvFILLp(av) = -1;
     return av;
 }
@@ -378,22 +383,18 @@ will have a reference count of 1.
 AV *
 Perl_av_make(pTHX_ register I32 size, register SV **strp)
 {
-    register AV *av;
-
-    av = (AV*)NEWSV(8,0);
-    sv_upgrade((SV *) av,SVt_PVAV);
+    register AV * const av = (AV*)newSV_type(SVt_PVAV);
     /* sv_upgrade does AvREAL_only()  */
     if (size) {                /* "defined" was returning undef for size==0 anyway. */
         register SV** ary;
         register I32 i;
        Newx(ary,size,SV*);
        AvALLOC(av) = ary;
-       SvPV_set(av, (char*)ary);
-       AvFILLp(av) = size - 1;
-       AvMAX(av) = size - 1;
+       AvARRAY(av) = ary;
+       AvFILLp(av) = AvMAX(av) = size - 1;
        for (i = 0; i < size; i++) {
            assert (*strp);
-           ary[i] = NEWSV(7,0);
+           ary[i] = newSV(0);
            sv_setsv(ary[i], *strp);
            strp++;
        }
@@ -401,29 +402,6 @@ Perl_av_make(pTHX_ register I32 size, register SV **strp)
     return av;
 }
 
-AV *
-Perl_av_fake(pTHX_ register I32 size, register SV **strp)
-{
-    register AV *av;
-    register SV** ary;
-
-    av = (AV*)NEWSV(9,0);
-    sv_upgrade((SV *)av, SVt_PVAV);
-    Newx(ary,size+1,SV*);
-    AvALLOC(av) = ary;
-    Copy(strp,ary,size,SV*);
-    AvREIFY_only(av);
-    SvPV_set(av, (char*)ary);
-    AvFILLp(av) = size - 1;
-    AvMAX(av) = size - 1;
-    while (size--) {
-       assert (*strp);
-       SvTEMP_off(*strp);
-       strp++;
-    }
-    return av;
-}
-
 /*
 =for apidoc av_clear
 
@@ -436,15 +414,15 @@ array itself.
 void
 Perl_av_clear(pTHX_ register AV *av)
 {
-    register I32 key;
+    dVAR;
+    I32 extra;
 
+    assert(av);
 #ifdef DEBUGGING
     if (SvREFCNT(av) == 0 && ckWARN_d(WARN_DEBUGGING)) {
        Perl_warner(aTHX_ packWARN(WARN_DEBUGGING), "Attempt to clear deleted array");
     }
 #endif
-    if (!av)
-       return;
 
     if (SvREADONLY(av))
        Perl_croak(aTHX_ PL_no_modify);
@@ -457,19 +435,20 @@ Perl_av_clear(pTHX_ register AV *av)
        return;
 
     if (AvREAL(av)) {
-        SV** ary = AvARRAY(av);
-       key = AvFILLp(av) + 1;
-       while (key) {
-           SV * sv = ary[--key];
+       SV** const ary = AvARRAY(av);
+       I32 index = AvFILLp(av) + 1;
+       while (index) {
+           SV * const sv = ary[--index];
            /* undef the slot before freeing the value, because a
-            * destructor might try to modify this arrray */
-           ary[key] = &PL_sv_undef;
+            * destructor might try to modify this array */
+           ary[index] = &PL_sv_undef;
            SvREFCNT_dec(sv);
        }
     }
-    if ((key = AvARRAY(av) - AvALLOC(av))) {
-       AvMAX(av) += key;
-       SvPV_set(av, (char*)AvALLOC(av));
+    extra = AvARRAY(av) - AvALLOC(av);
+    if (extra) {
+       AvMAX(av) += extra;
+       AvARRAY(av) = AvALLOC(av);
     }
     AvFILLp(av) = -1;
 
@@ -486,8 +465,7 @@ Undefines the array.  Frees the memory used by the array itself.
 void
 Perl_av_undef(pTHX_ register AV *av)
 {
-    if (!av)
-       return;
+    assert(av);
 
     /* Give any tie a chance to cleanup first */
     if (SvTIED_mg((SV*)av, PERL_MAGIC_tied)) 
@@ -499,11 +477,27 @@ Perl_av_undef(pTHX_ register AV *av)
            SvREFCNT_dec(AvARRAY(av)[--key]);
     }
     Safefree(AvALLOC(av));
-    AvALLOC(av) = 0;
-    SvPV_set(av, (char*)0);
+    AvALLOC(av) = NULL;
+    AvARRAY(av) = NULL;
     AvMAX(av) = AvFILLp(av) = -1;
-    /* It's in magic - it must already be gone.  */
-    assert (!AvARYLEN(av));
+}
+
+/*
+
+=for apidoc av_create_and_push
+
+Push an SV onto the end of the array, creating the array if necessary.
+A small internal helper function to remove a commonly duplicated idiom.
+
+=cut
+*/
+
+void
+Perl_av_create_and_push(pTHX_ AV **const avp, SV *const val)
+{
+    if (!*avp)
+       *avp = newAV();
+    av_push(*avp, val);
 }
 
 /*
@@ -520,8 +514,8 @@ Perl_av_push(pTHX_ register AV *av, SV *val)
 {             
     dVAR;
     MAGIC *mg;
-    if (!av)
-       return;
+    assert(av);
+
     if (SvREADONLY(av))
        Perl_croak(aTHX_ PL_no_modify);
 
@@ -558,8 +552,8 @@ Perl_av_pop(pTHX_ register AV *av)
     SV *retval;
     MAGIC* mg;
 
-    if (!av)
-      return &PL_sv_undef;
+    assert(av);
+
     if (SvREADONLY(av))
        Perl_croak(aTHX_ PL_no_modify);
     if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) {
@@ -588,6 +582,26 @@ Perl_av_pop(pTHX_ register AV *av)
 }
 
 /*
+
+=for apidoc av_create_and_unshift_one
+
+Unshifts an SV onto the beginning of the array, creating the array if
+necessary.
+A small internal helper function to remove a commonly duplicated idiom.
+
+=cut
+*/
+
+SV **
+Perl_av_create_and_unshift_one(pTHX_ AV **const avp, SV *const val)
+{
+    if (!*avp)
+       *avp = newAV();
+    av_unshift(*avp, 1);
+    return av_store(*avp, 0, val);
+}
+
+/*
 =for apidoc av_unshift
 
 Unshift the given number of C<undef> values onto the beginning of the
@@ -604,8 +618,8 @@ Perl_av_unshift(pTHX_ register AV *av, register I32 num)
     register I32 i;
     MAGIC* mg;
 
-    if (!av)
-       return;
+    assert(av);
+
     if (SvREADONLY(av))
        Perl_croak(aTHX_ PL_no_modify);
 
@@ -638,7 +652,7 @@ Perl_av_unshift(pTHX_ register AV *av, register I32 num)
     
        AvMAX(av) += i;
        AvFILLp(av) += i;
-       SvPV_set(av, (char*)(AvARRAY(av) - i));
+       AvARRAY(av) = AvARRAY(av) - i;
     }
     if (num) {
        register SV **ary;
@@ -657,7 +671,7 @@ Perl_av_unshift(pTHX_ register AV *av, register I32 num)
        /* Make extra elements into a buffer */
        AvMAX(av) -= slide;
        AvFILLp(av) -= slide;
-       SvPV_set(av, (char*)(AvARRAY(av) + slide));
+       AvARRAY(av) = AvARRAY(av) + slide;
     }
 }
 
@@ -676,8 +690,8 @@ Perl_av_shift(pTHX_ register AV *av)
     SV *retval;
     MAGIC* mg;
 
-    if (!av)
-       return &PL_sv_undef;
+    assert(av);
+
     if (SvREADONLY(av))
        Perl_croak(aTHX_ PL_no_modify);
     if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) {
@@ -701,7 +715,7 @@ Perl_av_shift(pTHX_ register AV *av)
     retval = *AvARRAY(av);
     if (AvREAL(av))
        *AvARRAY(av) = &PL_sv_undef;
-    SvPV_set(av, (char*)(AvARRAY(av) + 1));
+    AvARRAY(av) = AvARRAY(av) + 1;
     AvMAX(av)--;
     AvFILLp(av)--;
     if (SvSMAGICAL(av))
@@ -712,8 +726,8 @@ Perl_av_shift(pTHX_ register AV *av)
 /*
 =for apidoc av_len
 
-Returns the highest index in the array.  Returns -1 if the array is
-empty.
+Returns the highest index in the array.  The number of elements in the
+array is C<av_len(av) + 1>.  Returns -1 if the array is empty.
 
 =cut
 */
@@ -721,15 +735,22 @@ empty.
 I32
 Perl_av_len(pTHX_ register const AV *av)
 {
+    assert(av);
     return AvFILL(av);
 }
 
 /*
 =for apidoc av_fill
 
-Ensure than an array has a given number of elements, equivalent to
+Set the highest index in the array to the given number, equivalent to
 Perl's C<$#array = $fill;>.
 
+The number of elements in the an array will be C<fill + 1> after
+av_fill() returns.  If the array was previously shorter then the
+additional elements appended are set to C<PL_sv_undef>.  If the array
+was longer, then the excess elements are freed.  C<av_fill(av, -1)> is
+the same as C<av_clear(av)>.
+
 =cut
 */
 void
@@ -737,8 +758,9 @@ Perl_av_fill(pTHX_ register AV *av, I32 fill)
 {
     dVAR;
     MAGIC *mg;
-    if (!av)
-       Perl_croak(aTHX_ "panic: null array");
+
+    assert(av);
+
     if (fill < 0)
        fill = -1;
     if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) {
@@ -759,7 +781,7 @@ Perl_av_fill(pTHX_ register AV *av, I32 fill)
     }
     if (fill <= AvMAX(av)) {
        I32 key = AvFILLp(av);
-       SV** ary = AvARRAY(av);
+       SV** const ary = AvARRAY(av);
 
        if (AvREAL(av)) {
            while (key > fill) {
@@ -792,10 +814,11 @@ and null is returned.
 SV *
 Perl_av_delete(pTHX_ AV *av, I32 key, I32 flags)
 {
+    dVAR;
     SV *sv;
 
-    if (!av)
-       return Nullsv;
+    assert(av);
+
     if (SvREADONLY(av))
        Perl_croak(aTHX_ PL_no_modify);
 
@@ -807,7 +830,7 @@ Perl_av_delete(pTHX_ AV *av, I32 key, I32 flags)
             if (key < 0) {
                 unsigned adjust_index = 1;
                 if (tied_magic) {
-                    SV **negative_indices_glob = 
+                   SV * const * const negative_indices_glob =
                         hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *)av, 
                                                          tied_magic))), 
                                  NEGATIVE_INDICES_VAR, 16, 0);
@@ -818,7 +841,7 @@ Perl_av_delete(pTHX_ AV *av, I32 key, I32 flags)
                 if (adjust_index) {
                     key += AvFILL(av) + 1;
                     if (key < 0)
-                        return Nullsv;
+                       return NULL;
                 }
             }
             svp = av_fetch(av, key, TRUE);
@@ -829,7 +852,7 @@ Perl_av_delete(pTHX_ AV *av, I32 key, I32 flags)
                     sv_unmagic(sv, PERL_MAGIC_tiedelem); /* No longer an element */
                     return sv;
                 }
-                return Nullsv;     
+               return NULL;
             }
         }
     }
@@ -837,11 +860,11 @@ Perl_av_delete(pTHX_ AV *av, I32 key, I32 flags)
     if (key < 0) {
        key += AvFILL(av) + 1;
        if (key < 0)
-           return Nullsv;
+           return NULL;
     }
 
     if (key > AvFILLp(av))
-       return Nullsv;
+       return NULL;
     else {
        if (!AvREAL(av) && AvREIFY(av))
            av_reify(av);
@@ -859,7 +882,7 @@ Perl_av_delete(pTHX_ AV *av, I32 key, I32 flags)
     }
     if (flags & G_DISCARD) {
        SvREFCNT_dec(sv);
-       sv = Nullsv;
+       sv = NULL;
     }
     else if (AvREAL(av))
        sv = sv_2mortal(sv);
@@ -879,20 +902,19 @@ C<&PL_sv_undef>.
 bool
 Perl_av_exists(pTHX_ AV *av, I32 key)
 {
-    if (!av)
-       return FALSE;
-
+    dVAR;
+    assert(av);
 
     if (SvRMAGICAL(av)) {
         const MAGIC * const tied_magic = mg_find((SV*)av, PERL_MAGIC_tied);
         if (tied_magic || mg_find((SV*)av, PERL_MAGIC_regdata)) {
-            SV *sv = sv_newmortal();
+           SV * const sv = sv_newmortal();
             MAGIC *mg;
             /* Handle negative array indices 20020222 MJD */
             if (key < 0) {
                 unsigned adjust_index = 1;
                 if (tied_magic) {
-                    SV **negative_indices_glob = 
+                   SV * const * const negative_indices_glob =
                         hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *)av, 
                                                          tied_magic))), 
                                  NEGATIVE_INDICES_VAR, 16, 0);
@@ -935,15 +957,16 @@ Perl_av_exists(pTHX_ AV *av, I32 key)
 SV **
 Perl_av_arylen_p(pTHX_ AV *av) {
     dVAR;
-    MAGIC *mg = mg_find((SV*)av, PERL_MAGIC_arylen_p);
+    MAGIC *mg;
+
+    assert(av);
+
+    mg = mg_find((SV*)av, PERL_MAGIC_arylen_p);
 
     if (!mg) {
        mg = sv_magicext((SV*)av, 0, PERL_MAGIC_arylen_p, &PL_vtbl_arylen_p,
                         0, 0);
-
-       if (!mg) {
-           Perl_die(aTHX_ "panic: av_arylen_p");
-       }
+       assert(mg);
        /* sv_magicext won't set this for us because we pass in a NULL obj  */
        mg->mg_flags |= MGf_REFCOUNTED;
     }