X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/6f12eb6d2a1dfaf441504d869b27d2e40ef4966a..81a5ff157a0f5e961a89ba2b873dd463cf2df856:/av.c diff --git a/av.c b/av.c index a1d62fb..776dafd 100644 --- a/av.c +++ b/av.c @@ -1,6 +1,7 @@ /* av.c * - * Copyright (c) 1991-2002, Larry Wall + * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, + * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 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. @@ -8,8 +9,10 @@ */ /* - * "...for the Entwives desired order, and plenty, and peace (by which they - * meant that things should remain where they had set them)." --Treebeard + * '...for the Entwives desired order, and plenty, and peace (by which they + * meant that things should remain where they had set them).' --Treebeard + * + * [p.476 of _The Lord of the Rings_, III/iv: "Treebeard"] */ /* @@ -23,23 +26,26 @@ void Perl_av_reify(pTHX_ AV *av) { + dVAR; I32 key; - SV* sv; + + PERL_ARGS_ASSERT_AV_REIFY; + assert(SvTYPE(av) == SVt_PVAV); if (AvREAL(av)) return; #ifdef DEBUGGING - if (SvTIED_mg((SV*)av, PERL_MAGIC_tied) && ckWARN_d(WARN_DEBUGGING)) - Perl_warner(aTHX_ packWARN(WARN_DEBUGGING), "av_reify called on tied array"); + if (SvTIED_mg((const SV *)av, PERL_MAGIC_tied)) + Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING), "av_reify called on tied array"); #endif key = AvMAX(av) + 1; while (key > AvFILLp(av) + 1) AvARRAY(av)[--key] = &PL_sv_undef; while (key) { - sv = AvARRAY(av)[--key]; + 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,21 +66,18 @@ extended. void Perl_av_extend(pTHX_ AV *av, I32 key) { + dVAR; MAGIC *mg; - if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) { - dSP; - ENTER; - SAVETMPS; - PUSHSTACKi(PERLSI_MAGIC); - PUSHMARK(SP); - EXTEND(SP,2); - PUSHs(SvTIED_obj((SV*)av, mg)); - PUSHs(sv_2mortal(newSViv(key+1))); - PUTBACK; - call_method("EXTEND", G_SCALAR|G_DISCARD); - POPSTACK; - FREETMPS; - LEAVE; + + PERL_ARGS_ASSERT_AV_EXTEND; + assert(SvTYPE(av) == SVt_PVAV); + + mg = SvTIED_mg((const SV *)av, PERL_MAGIC_tied); + if (mg) { + SV *arg1 = sv_newmortal(); + sv_setiv(arg1, (IV)(key + 1)); + Perl_magic_methcall(aTHX_ MUTABLE_SV(av), mg, "EXTEND", G_DISCARD, 1, + arg1); return; } if (key > AvMAX(av)) { @@ -87,54 +90,70 @@ 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; - SvPVX(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; } } else { +#ifdef PERL_MALLOC_WRAP + static const char oom_array_extend[] = + "Out of memory during array extend"; /* Duplicated in pp_hot.c */ +#endif + if (AvALLOC(av)) { #if !defined(STRANGE_MALLOC) && !defined(MYMALLOC) MEM_SIZE bytes; IV itmp; #endif -#if defined(MYMALLOC) && !defined(LEAKTEST) - newmax = malloced_size((void*)AvALLOC(av))/sizeof(SV*) - 1; +#ifdef Perl_safesysmalloc_size + /* Whilst it would be quite possible to move this logic around + (as I did in the SV code), so as to set AvMAX(av) early, + based on calling Perl_safesysmalloc_size() immediately after + allocation, I'm not convinced that it is a great idea here. + In an array we have to loop round setting everything to + &PL_sv_undef, which means writing to memory, potentially lots + of it, whereas for the SV buffer case we don't touch the + "bonus" memory. So there there is no cost in telling the + world about it, whereas here we have to do work before we can + tell the world about it, and that work involves writing to + memory that might never be read. So, I feel, better to keep + the current lazy system of only writing to it if our caller + has a need for more space. NWC */ + newmax = Perl_safesysmalloc_size((void*)AvALLOC(av)) / + sizeof(const SV *) - 1; if (key <= newmax) goto resized; #endif newmax = key + AvMAX(av) / 5; resize: + MEM_WRAP_CHECK_1(newmax+1, SV*, oom_array_extend); #if defined(STRANGE_MALLOC) || defined(MYMALLOC) Renew(AvALLOC(av),newmax+1, SV*); #else - bytes = (newmax + 1) * sizeof(SV*); + bytes = (newmax + 1) * sizeof(const SV *); #define MALLOC_OVERHEAD 16 itmp = MALLOC_OVERHEAD; while ((MEM_SIZE)(itmp - MALLOC_OVERHEAD) < bytes) itmp += itmp; itmp -= MALLOC_OVERHEAD; - itmp /= sizeof(SV*); + itmp /= sizeof(const SV *); assert(itmp > newmax); newmax = itmp - 1; assert(newmax >= AvMAX(av)); - New(2,ary, newmax+1, SV*); + Newx(ary, newmax+1, SV*); Copy(AvALLOC(av), ary, AvMAX(av)+1, SV*); - if (AvMAX(av) > 64) - offer_nice_chunk(AvALLOC(av), (AvMAX(av)+1) * sizeof(SV*)); - else - Safefree(AvALLOC(av)); + Safefree(AvALLOC(av)); AvALLOC(av) = ary; #endif -#if defined(MYMALLOC) && !defined(LEAKTEST) +#ifdef Perl_safesysmalloc_size resized: #endif ary = AvALLOC(av) + AvMAX(av) + 1; @@ -147,7 +166,8 @@ Perl_av_extend(pTHX_ AV *av, I32 key) } else { newmax = key < 3 ? 3 : key; - New(2,AvALLOC(av), newmax+1, SV*); + MEM_WRAP_CHECK_1(newmax+1, SV*, oom_array_extend); + Newx(AvALLOC(av), newmax+1, SV*); ary = AvALLOC(av) + 1; tmp = newmax; AvALLOC(av)[0] = &PL_sv_undef; /* For the stacks */ @@ -157,7 +177,7 @@ Perl_av_extend(pTHX_ AV *av, I32 key) ary[--tmp] = &PL_sv_undef; } - SvPVX(av) = (char*)AvALLOC(av); + AvARRAY(av) = AvALLOC(av); AvMAX(av) = newmax; } } @@ -167,76 +187,81 @@ Perl_av_extend(pTHX_ AV *av, I32 key) =for apidoc av_fetch Returns the SV at the specified index in the array. The C is the -index. If C is set then the fetch will be part of a store. Check -that the return value is non-null before dereferencing it to a C. +index. If lval is true, you are guaranteed to get a real SV back (in case +it wasn't real before), which you can then modify. Check that the return +value is non-null before dereferencing it to a C. See L for more information on how to use this function on tied arrays. +The rough perl equivalent is C<$myarray[$idx]>. =cut */ SV** Perl_av_fetch(pTHX_ register AV *av, I32 key, I32 lval) { - SV *sv; + dVAR; - if (!av) - return 0; + PERL_ARGS_ASSERT_AV_FETCH; + assert(SvTYPE(av) == SVt_PVAV); if (SvRMAGICAL(av)) { - MAGIC *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; - } + const MAGIC * const tied_magic + = mg_find((const SV *)av, PERL_MAGIC_tied); + if (tied_magic || mg_find((const SV *)av, PERL_MAGIC_regdata)) { + 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(MUTABLE_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(); - mg_copy((SV*)av, sv, 0, key); - PL_av_fetch_sv = sv; - return &PL_av_fetch_sv; + sv_upgrade(sv, SVt_PVLV); + mg_copy(MUTABLE_SV(av), sv, 0, key); + if (!tied_magic) /* for regdata, force leavesub to make copies */ + SvTEMP_off(sv); + LvTYPE(sv) = 't'; + LvTARG(sv) = sv; /* fake (SV**) */ + return &(LvTARG(sv)); } } 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; } @@ -263,21 +288,27 @@ 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; + PERL_ARGS_ASSERT_AV_STORE; + assert(SvTYPE(av) == SVt_PVAV); + + /* S_regclass relies on being able to pass in a NULL sv + (unicode_alternate may be NULL). + */ + if (!val) val = &PL_sv_undef; if (SvRMAGICAL(av)) { - MAGIC *tied_magic = mg_find((SV*)av, PERL_MAGIC_tied); + const MAGIC * const tied_magic = mg_find((const SV *)av, PERL_MAGIC_tied); if (tied_magic) { /* Handle negative array indices 20020222 MJD */ if (key < 0) { - unsigned adjust_index = 1; - SV **negative_indices_glob = - hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *)av, + bool adjust_index = 1; + SV * const * const negative_indices_glob = + hv_fetch(SvSTASH(SvRV(SvTIED_obj(MUTABLE_SV(av), tied_magic))), NEGATIVE_INDICES_VAR, 16, 0); if (negative_indices_glob @@ -290,9 +321,9 @@ Perl_av_store(pTHX_ register AV *av, I32 key, SV *val) } } if (val != &PL_sv_undef) { - mg_copy((SV*)av, val, 0, key); + mg_copy(MUTABLE_SV(av), val, 0, key); } - return 0; + return NULL; } } @@ -300,11 +331,11 @@ 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)) - Perl_croak(aTHX_ PL_no_modify); + Perl_croak_no_modify(aTHX); if (!AvREAL(av) && AvREIFY(av)) av_reify(av); @@ -315,9 +346,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; } @@ -325,101 +356,66 @@ Perl_av_store(pTHX_ register AV *av, I32 key, SV *val) SvREFCNT_dec(ary[key]); ary[key] = val; if (SvSMAGICAL(av)) { + const MAGIC* const mg = SvMAGIC(av); if (val != &PL_sv_undef) { - MAGIC* mg = SvMAGIC(av); - sv_magic(val, (SV*)av, toLOWER(mg->mg_type), 0, key); + sv_magic(val, MUTABLE_SV(av), toLOWER(mg->mg_type), 0, key); } - mg_set((SV*)av); + if (PL_delaymagic && mg->mg_type == PERL_MAGIC_isa) + PL_delaymagic |= DM_ARRAY_ISA; + else + mg_set(MUTABLE_SV(av)); } return &ary[key]; } /* -=for apidoc newAV - -Creates a new AV. The reference count is set to 1. - -=cut -*/ - -AV * -Perl_newAV(pTHX) -{ - register AV *av; - - av = (AV*)NEWSV(3,0); - sv_upgrade((SV *)av, SVt_PVAV); - AvREAL_on(av); - AvALLOC(av) = 0; - SvPVX(av) = 0; - AvMAX(av) = AvFILLp(av) = -1; - return av; -} - -/* =for apidoc av_make Creates a new AV and populates it with a list of SVs. The SVs are copied into the array, so they may be freed after the call to av_make. The new AV will have a reference count of 1. +Perl equivalent: C + =cut */ AV * Perl_av_make(pTHX_ register I32 size, register SV **strp) { - register AV *av; - register I32 i; - register SV** ary; - - av = (AV*)NEWSV(8,0); - sv_upgrade((SV *) av,SVt_PVAV); - AvFLAGS(av) = AVf_REAL; - if (size) { /* `defined' was returning undef for size==0 anyway. */ - New(4,ary,size,SV*); + register AV * const av = MUTABLE_AV(newSV_type(SVt_PVAV)); + /* sv_upgrade does AvREAL_only() */ + PERL_ARGS_ASSERT_AV_MAKE; + assert(SvTYPE(av) == SVt_PVAV); + + if (size) { /* "defined" was returning undef for size==0 anyway. */ + register SV** ary; + register I32 i; + Newx(ary,size,SV*); AvALLOC(av) = ary; - SvPVX(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); - sv_setsv(ary[i], *strp); + + /* Don't let sv_setsv swipe, since our source array might + have multiple references to the same temp scalar (e.g. + from a list slice) */ + + ary[i] = newSV(0); + sv_setsv_flags(ary[i], *strp, + SV_GMAGIC|SV_DO_COW_SVSETSV|SV_NOSTEAL); 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); - New(4,ary,size+1,SV*); - AvALLOC(av) = ary; - Copy(strp,ary,size,SV*); - AvFLAGS(av) = AVf_REIFY; - SvPVX(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 Clears an array, making it empty. Does not free the memory used by the -array itself. +array itself. Perl equivalent: C<@myarray = ();>. =cut */ @@ -427,39 +423,48 @@ array itself. void Perl_av_clear(pTHX_ register AV *av) { - register I32 key; - SV** ary; + dVAR; + I32 extra; + + PERL_ARGS_ASSERT_AV_CLEAR; + assert(SvTYPE(av) == SVt_PVAV); #ifdef DEBUGGING - if (SvREFCNT(av) == 0 && ckWARN_d(WARN_DEBUGGING)) { - Perl_warner(aTHX_ packWARN(WARN_DEBUGGING), "Attempt to clear deleted array"); + if (SvREFCNT(av) == 0) { + Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING), "Attempt to clear deleted array"); } #endif - if (!av) - return; - /*SUPPRESS 560*/ if (SvREADONLY(av)) - Perl_croak(aTHX_ PL_no_modify); + Perl_croak_no_modify(aTHX); /* Give any tie a chance to cleanup first */ - if (SvRMAGICAL(av)) - mg_clear((SV*)av); + if (SvRMAGICAL(av)) { + const MAGIC* const mg = SvMAGIC(av); + if (PL_delaymagic && mg && mg->mg_type == PERL_MAGIC_isa) + PL_delaymagic |= DM_ARRAY_ISA; + else + mg_clear(MUTABLE_SV(av)); + } if (AvMAX(av) < 0) return; if (AvREAL(av)) { - ary = AvARRAY(av); - key = AvFILLp(av) + 1; - while (key) { - SvREFCNT_dec(ary[--key]); - ary[key] = &PL_sv_undef; + 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 array */ + ary[index] = &PL_sv_undef; + SvREFCNT_dec(sv); } } - if ((key = AvARRAY(av) - AvALLOC(av))) { - AvMAX(av) += key; - SvPVX(av) = (char*)AvALLOC(av); + extra = AvARRAY(av) - AvALLOC(av); + if (extra) { + AvMAX(av) += extra; + AvARRAY(av) = AvALLOC(av); } AvFILLp(av) = -1; @@ -476,36 +481,52 @@ Undefines the array. Frees the memory used by the array itself. void Perl_av_undef(pTHX_ register AV *av) { - register I32 key; - - if (!av) - return; - /*SUPPRESS 560*/ + PERL_ARGS_ASSERT_AV_UNDEF; + assert(SvTYPE(av) == SVt_PVAV); /* Give any tie a chance to cleanup first */ - if (SvTIED_mg((SV*)av, PERL_MAGIC_tied)) - av_fill(av, -1); /* mg_clear() ? */ + if (SvTIED_mg((const SV *)av, PERL_MAGIC_tied)) + av_fill(av, -1); if (AvREAL(av)) { - key = AvFILLp(av) + 1; + register I32 key = AvFILLp(av) + 1; while (key) SvREFCNT_dec(AvARRAY(av)[--key]); } + Safefree(AvALLOC(av)); - AvALLOC(av) = 0; - SvPVX(av) = 0; + AvALLOC(av) = NULL; + AvARRAY(av) = NULL; AvMAX(av) = AvFILLp(av) = -1; - if (AvARYLEN(av)) { - SvREFCNT_dec(AvARYLEN(av)); - AvARYLEN(av) = 0; - } + + if(SvRMAGICAL(av)) mg_clear(MUTABLE_SV(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) +{ + PERL_ARGS_ASSERT_AV_CREATE_AND_PUSH; + + if (!*avp) + *avp = newAV(); + av_push(*avp, val); } /* =for apidoc av_push Pushes an SV onto the end of the array. The array will grow automatically -to accommodate the addition. +to accommodate the addition. This takes ownership of one reference count. =cut */ @@ -513,24 +534,18 @@ to accommodate the addition. void Perl_av_push(pTHX_ register AV *av, SV *val) { + dVAR; MAGIC *mg; - if (!av) - return; + + PERL_ARGS_ASSERT_AV_PUSH; + assert(SvTYPE(av) == SVt_PVAV); + if (SvREADONLY(av)) - Perl_croak(aTHX_ PL_no_modify); - - if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) { - dSP; - PUSHSTACKi(PERLSI_MAGIC); - PUSHMARK(SP); - EXTEND(SP,2); - PUSHs(SvTIED_obj((SV*)av, mg)); - PUSHs(val); - PUTBACK; - ENTER; - call_method("PUSH", G_SCALAR|G_DISCARD); - LEAVE; - POPSTACK; + Perl_croak_no_modify(aTHX); + + if ((mg = SvTIED_mg((const SV *)av, PERL_MAGIC_tied))) { + Perl_magic_methcall(aTHX_ MUTABLE_SV(av), mg, "PUSH", G_DISCARD, 1, + val); return; } av_store(av,AvFILLp(av)+1,val); @@ -548,27 +563,19 @@ is empty. SV * Perl_av_pop(pTHX_ register AV *av) { + dVAR; SV *retval; MAGIC* mg; - if (!av) - return &PL_sv_undef; + PERL_ARGS_ASSERT_AV_POP; + assert(SvTYPE(av) == SVt_PVAV); + if (SvREADONLY(av)) - Perl_croak(aTHX_ PL_no_modify); - if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) { - dSP; - PUSHSTACKi(PERLSI_MAGIC); - PUSHMARK(SP); - XPUSHs(SvTIED_obj((SV*)av, mg)); - PUTBACK; - ENTER; - if (call_method("POP", G_SCALAR)) { - retval = newSVsv(*PL_stack_sp--); - } else { - retval = &PL_sv_undef; - } - LEAVE; - POPSTACK; + Perl_croak_no_modify(aTHX); + if ((mg = SvTIED_mg((const SV *)av, PERL_MAGIC_tied))) { + retval = Perl_magic_methcall(aTHX_ MUTABLE_SV(av), mg, "POP", 0, 0); + if (retval) + retval = newSVsv(retval); return retval; } if (AvFILL(av) < 0) @@ -576,11 +583,33 @@ Perl_av_pop(pTHX_ register AV *av) retval = AvARRAY(av)[AvFILLp(av)]; AvARRAY(av)[AvFILLp(av)--] = &PL_sv_undef; if (SvSMAGICAL(av)) - mg_set((SV*)av); + mg_set(MUTABLE_SV(av)); return retval; } /* + +=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) +{ + PERL_ARGS_ASSERT_AV_CREATE_AND_UNSHIFT_ONE; + + if (!*avp) + *avp = newAV(); + av_unshift(*avp, 1); + return av_store(*avp, 0, val); +} + +/* =for apidoc av_unshift Unshift the given number of C values onto the beginning of the @@ -593,30 +622,19 @@ must then use C to assign values to these new elements. void Perl_av_unshift(pTHX_ register AV *av, register I32 num) { + dVAR; register I32 i; - register SV **ary; MAGIC* mg; - I32 slide; - if (!av) - return; + PERL_ARGS_ASSERT_AV_UNSHIFT; + assert(SvTYPE(av) == SVt_PVAV); + if (SvREADONLY(av)) - Perl_croak(aTHX_ PL_no_modify); - - if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) { - dSP; - PUSHSTACKi(PERLSI_MAGIC); - PUSHMARK(SP); - EXTEND(SP,1+num); - PUSHs(SvTIED_obj((SV*)av, mg)); - while (num-- > 0) { - PUSHs(&PL_sv_undef); - } - PUTBACK; - ENTER; - call_method("UNSHIFT", G_SCALAR|G_DISCARD); - LEAVE; - POPSTACK; + Perl_croak_no_modify(aTHX); + + if ((mg = SvTIED_mg((const SV *)av, PERL_MAGIC_tied))) { + Perl_magic_methcall(aTHX_ MUTABLE_SV(av), mg, "UNSHIFT", + G_DISCARD | G_UNDEF_FILL, num); return; } @@ -632,12 +650,13 @@ Perl_av_unshift(pTHX_ register AV *av, register I32 num) AvMAX(av) += i; AvFILLp(av) += i; - SvPVX(av) = (char*)(AvARRAY(av) - i); + AvARRAY(av) = AvARRAY(av) - i; } if (num) { - i = AvFILLp(av); + register SV **ary; + const I32 i = AvFILLp(av); /* Create extra elements */ - slide = i > 0 ? i : 0; + const I32 slide = i > 0 ? i : 0; num += slide; av_extend(av, i + num); AvFILLp(av) += num; @@ -649,14 +668,15 @@ Perl_av_unshift(pTHX_ register AV *av, register I32 num) /* Make extra elements into a buffer */ AvMAX(av) -= slide; AvFILLp(av) -= slide; - SvPVX(av) = (char*)(AvARRAY(av) + slide); + AvARRAY(av) = AvARRAY(av) + slide; } } /* =for apidoc av_shift -Shifts an SV off the beginning of the array. +Shifts an SV off the beginning of the array. Returns C<&PL_sv_undef> if the +array is empty. =cut */ @@ -664,27 +684,19 @@ Shifts an SV off the beginning of the array. SV * Perl_av_shift(pTHX_ register AV *av) { + dVAR; SV *retval; MAGIC* mg; - if (!av) - return &PL_sv_undef; + PERL_ARGS_ASSERT_AV_SHIFT; + assert(SvTYPE(av) == SVt_PVAV); + if (SvREADONLY(av)) - Perl_croak(aTHX_ PL_no_modify); - if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) { - dSP; - PUSHSTACKi(PERLSI_MAGIC); - PUSHMARK(SP); - XPUSHs(SvTIED_obj((SV*)av, mg)); - PUTBACK; - ENTER; - if (call_method("SHIFT", G_SCALAR)) { - retval = newSVsv(*PL_stack_sp--); - } else { - retval = &PL_sv_undef; - } - LEAVE; - POPSTACK; + Perl_croak_no_modify(aTHX); + if ((mg = SvTIED_mg((const SV *)av, PERL_MAGIC_tied))) { + retval = Perl_magic_methcall(aTHX_ MUTABLE_SV(av), mg, "SHIFT", 0, 0); + if (retval) + retval = newSVsv(retval); return retval; } if (AvFILL(av) < 0) @@ -692,64 +704,69 @@ Perl_av_shift(pTHX_ register AV *av) retval = *AvARRAY(av); if (AvREAL(av)) *AvARRAY(av) = &PL_sv_undef; - SvPVX(av) = (char*)(AvARRAY(av) + 1); + AvARRAY(av) = AvARRAY(av) + 1; AvMAX(av)--; AvFILLp(av)--; if (SvSMAGICAL(av)) - mg_set((SV*)av); + mg_set(MUTABLE_SV(av)); return retval; } /* =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. Returns -1 if the array is empty. + +The Perl equivalent for this is C<$#myarray>. =cut */ I32 -Perl_av_len(pTHX_ register AV *av) +Perl_av_len(pTHX_ AV *av) { + PERL_ARGS_ASSERT_AV_LEN; + assert(SvTYPE(av) == SVt_PVAV); + 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 after +av_fill() returns. If the array was previously shorter, then the +additional elements appended are set to C. If the array +was longer, then the excess elements are freed. C is +the same as C. + =cut */ void Perl_av_fill(pTHX_ register AV *av, I32 fill) { + dVAR; MAGIC *mg; - if (!av) - Perl_croak(aTHX_ "panic: null array"); + + PERL_ARGS_ASSERT_AV_FILL; + assert(SvTYPE(av) == SVt_PVAV); + if (fill < 0) fill = -1; - if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) { - dSP; - ENTER; - SAVETMPS; - PUSHSTACKi(PERLSI_MAGIC); - PUSHMARK(SP); - EXTEND(SP,2); - PUSHs(SvTIED_obj((SV*)av, mg)); - PUSHs(sv_2mortal(newSViv(fill+1))); - PUTBACK; - call_method("STORESIZE", G_SCALAR|G_DISCARD); - POPSTACK; - FREETMPS; - LEAVE; + if ((mg = SvTIED_mg((const SV *)av, PERL_MAGIC_tied))) { + SV *arg1 = sv_newmortal(); + sv_setiv(arg1, (IV)(fill + 1)); + Perl_magic_methcall(aTHX_ MUTABLE_SV(av), mg, "STORESIZE", G_DISCARD, + 1, arg1); return; } if (fill <= AvMAX(av)) { I32 key = AvFILLp(av); - SV** ary = AvARRAY(av); + SV** const ary = AvARRAY(av); if (AvREAL(av)) { while (key > fill) { @@ -764,7 +781,7 @@ Perl_av_fill(pTHX_ register AV *av, I32 fill) AvFILLp(av) = fill; if (SvSMAGICAL(av)) - mg_set((SV*)av); + mg_set(MUTABLE_SV(av)); } else (void)av_store(av,fill,&PL_sv_undef); @@ -773,31 +790,37 @@ Perl_av_fill(pTHX_ register AV *av, I32 fill) /* =for apidoc av_delete -Deletes the element indexed by C from the array. Returns the -deleted element. C is currently ignored. +Deletes the element indexed by C from the array, makes the element mortal, +and returns it. If C equals C, the element is freed and null +is returned. Perl equivalent: C for the +non-C version and a void-context C for the +C version. =cut */ SV * Perl_av_delete(pTHX_ AV *av, I32 key, I32 flags) { + dVAR; SV *sv; - if (!av) - return Nullsv; + PERL_ARGS_ASSERT_AV_DELETE; + assert(SvTYPE(av) == SVt_PVAV); + if (SvREADONLY(av)) - Perl_croak(aTHX_ PL_no_modify); + Perl_croak_no_modify(aTHX); if (SvRMAGICAL(av)) { - MAGIC *tied_magic = mg_find((SV*)av, PERL_MAGIC_tied); - SV **svp; - if ((tied_magic || mg_find((SV*)av, PERL_MAGIC_regdata))) { + const MAGIC * const tied_magic + = mg_find((const SV *)av, PERL_MAGIC_tied); + if ((tied_magic || mg_find((const SV *)av, PERL_MAGIC_regdata))) { /* Handle negative array indices 20020222 MJD */ + SV **svp; if (key < 0) { unsigned adjust_index = 1; if (tied_magic) { - SV **negative_indices_glob = - hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *)av, + SV * const * const negative_indices_glob = + hv_fetch(SvSTASH(SvRV(SvTIED_obj(MUTABLE_SV(av), tied_magic))), NEGATIVE_INDICES_VAR, 16, 0); if (negative_indices_glob @@ -807,7 +830,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); @@ -818,7 +841,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; } } } @@ -826,12 +849,14 @@ 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); sv = AvARRAY(av)[key]; if (key == AvFILLp(av)) { AvARRAY(av)[key] = &PL_sv_undef; @@ -842,12 +867,14 @@ Perl_av_delete(pTHX_ AV *av, I32 key, I32 flags) else AvARRAY(av)[key] = &PL_sv_undef; if (SvSMAGICAL(av)) - mg_set((SV*)av); + mg_set(MUTABLE_SV(av)); } if (flags & G_DISCARD) { SvREFCNT_dec(sv); - sv = Nullsv; + sv = NULL; } + else if (AvREAL(av)) + sv = sv_2mortal(sv); return sv; } @@ -859,26 +886,31 @@ Returns true if the element indexed by C has been initialized. This relies on the fact that uninitialized array elements are set to C<&PL_sv_undef>. +Perl equivalent: C. + =cut */ bool Perl_av_exists(pTHX_ AV *av, I32 key) { - if (!av) - return FALSE; - + dVAR; + PERL_ARGS_ASSERT_AV_EXISTS; + assert(SvTYPE(av) == SVt_PVAV); if (SvRMAGICAL(av)) { - MAGIC *tied_magic = mg_find((SV*)av, PERL_MAGIC_tied); - if (tied_magic || mg_find((SV*)av, PERL_MAGIC_regdata)) { - SV *sv = sv_newmortal(); + const MAGIC * const tied_magic + = mg_find((const SV *)av, PERL_MAGIC_tied); + const MAGIC * const regdata_magic + = mg_find((const SV *)av, PERL_MAGIC_regdata); + if (tied_magic || regdata_magic) { + 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 = - hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *)av, + SV * const * const negative_indices_glob = + hv_fetch(SvSTASH(SvRV(SvTIED_obj(MUTABLE_SV(av), tied_magic))), NEGATIVE_INDICES_VAR, 16, 0); if (negative_indices_glob @@ -889,14 +921,23 @@ Perl_av_exists(pTHX_ AV *av, I32 key) key += AvFILL(av) + 1; if (key < 0) return FALSE; + else + return TRUE; } } - mg_copy((SV*)av, sv, 0, key); + if(key >= 0 && regdata_magic) { + if (key <= AvFILL(av)) + return TRUE; + else + return FALSE; + } + + mg_copy(MUTABLE_SV(av), sv, 0, key); mg = mg_find(sv, PERL_MAGIC_tiedelem); if (mg) { magic_existspack(sv, mg); - return (bool)SvTRUE(sv); + return cBOOL(SvTRUE(sv)); } } @@ -916,3 +957,63 @@ Perl_av_exists(pTHX_ AV *av, I32 key) else return FALSE; } + +static MAGIC * +S_get_aux_mg(pTHX_ AV *av) { + dVAR; + MAGIC *mg; + + PERL_ARGS_ASSERT_GET_AUX_MG; + assert(SvTYPE(av) == SVt_PVAV); + + mg = mg_find((const SV *)av, PERL_MAGIC_arylen_p); + + if (!mg) { + mg = sv_magicext(MUTABLE_SV(av), 0, PERL_MAGIC_arylen_p, + &PL_vtbl_arylen_p, 0, 0); + assert(mg); + /* sv_magicext won't set this for us because we pass in a NULL obj */ + mg->mg_flags |= MGf_REFCOUNTED; + } + return mg; +} + +SV ** +Perl_av_arylen_p(pTHX_ AV *av) { + MAGIC *const mg = get_aux_mg(av); + + PERL_ARGS_ASSERT_AV_ARYLEN_P; + assert(SvTYPE(av) == SVt_PVAV); + + return &(mg->mg_obj); +} + +IV * +Perl_av_iter_p(pTHX_ AV *av) { + MAGIC *const mg = get_aux_mg(av); + + PERL_ARGS_ASSERT_AV_ITER_P; + assert(SvTYPE(av) == SVt_PVAV); + +#if IVSIZE == I32SIZE + return (IV *)&(mg->mg_len); +#else + if (!mg->mg_ptr) { + IV *temp; + mg->mg_len = IVSIZE; + Newxz(temp, 1, IV); + mg->mg_ptr = (char *) temp; + } + return (IV *)mg->mg_ptr; +#endif +} + +/* + * Local variables: + * c-indentation-style: bsd + * c-basic-offset: 4 + * indent-tabs-mode: t + * End: + * + * ex: set ts=8 sts=4 sw=4 noet: + */