X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/8ea97a1e700347a7b6ed9267c8c34f286f94d5d6..e37e15afdcc8f08e993ebae0fd343b1a4fdf1e75:/av.c diff --git a/av.c b/av.c index af8296a..3d15d58 100644 --- a/av.c +++ b/av.c @@ -1,6 +1,7 @@ /* av.c * - * Copyright (c) 1991-1999, Larry Wall + * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, + * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 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. @@ -12,6 +13,10 @@ * 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" @@ -19,25 +24,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, 'P') && ckWARN_d(WARN_DEBUGGING)) - Perl_warner(aTHX_ WARN_DEBUGGING, "av_reify called on tied array"); + if (SvTIED_mg((SV*)av, PERL_MAGIC_tied) && ckWARN_d(WARN_DEBUGGING)) + Perl_warner(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) { - dTHR; - (void)SvREFCNT_inc(sv); - } + if (sv != &PL_sv_undef) + SvREFCNT_inc_simple_void_NN(sv); } key = AvARRAY(av) - AvALLOC(av); while (key) @@ -46,12 +52,26 @@ Perl_av_reify(pTHX_ AV *av) AvREAL_on(av); } +/* +=for apidoc av_extend + +Pre-extend an array. The C is the index to which the array should be +extended. + +=cut +*/ + void Perl_av_extend(pTHX_ AV *av, I32 key) { - dTHR; /* only necessary if we have to extend stack */ + dVAR; MAGIC *mg; - if (mg = SvTIED_mg((SV*)av, 'P')) { + + PERL_ARGS_ASSERT_AV_EXTEND; + assert(SvTYPE(av) == SVt_PVAV); + + mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied); + if (mg) { dSP; ENTER; SAVETMPS; @@ -59,7 +79,7 @@ Perl_av_extend(pTHX_ AV *av, I32 key) PUSHMARK(SP); EXTEND(SP,2); PUSHs(SvTIED_obj((SV*)av, mg)); - PUSHs(sv_2mortal(newSViv(key+1))); + mPUSHi(key + 1); PUTBACK; call_method("EXTEND", G_SCALAR|G_DISCARD); POPSTACK; @@ -77,46 +97,65 @@ 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)) { -#ifndef STRANGE_MALLOC +#if !defined(STRANGE_MALLOC) && !defined(MYMALLOC) MEM_SIZE bytes; IV itmp; #endif -#if defined(MYMALLOC) && !defined(PURIFY) && !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(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*); #define MALLOC_OVERHEAD 16 itmp = MALLOC_OVERHEAD; - while (itmp - MALLOC_OVERHEAD < bytes) + while ((MEM_SIZE)(itmp - MALLOC_OVERHEAD) < bytes) itmp += itmp; itmp -= MALLOC_OVERHEAD; itmp /= sizeof(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*)); @@ -124,7 +163,9 @@ Perl_av_extend(pTHX_ AV *av, I32 key) Safefree(AvALLOC(av)); AvALLOC(av) = ary; #endif +#ifdef Perl_safesysmalloc_size resized: +#endif ary = AvALLOC(av) + AvMAX(av) + 1; tmp = newmax - AvMAX(av); if (av == PL_curstack) { /* Oops, grew stack (via av_store()?) */ @@ -135,7 +176,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 */ @@ -145,89 +187,160 @@ 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; } } } +/* +=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. + +See L for +more information on how to use this function on tied arrays. + +=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)) { + const MAGIC * const tied_magic = mg_find((SV*)av, PERL_MAGIC_tied); + if (tied_magic || mg_find((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((SV *)av, tied_magic))), + NEGATIVE_INDICES_VAR, 16, 0); + + if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob))) + adjust_index = 0; + } + + if (adjust_index) { + key += AvFILL(av) + 1; + if (key < 0) + return NULL; + } + } + + sv = sv_newmortal(); + sv_upgrade(sv, SVt_PVLV); + mg_copy((SV*)av, sv, 0, key); + LvTYPE(sv) = 't'; + LvTARG(sv) = sv; /* fake (SV**) */ + return &(LvTARG(sv)); + } + } if (key < 0) { key += AvFILL(av) + 1; if (key < 0) - return 0; - } - - if (SvRMAGICAL(av)) { - if (mg_find((SV*)av,'P') || mg_find((SV*)av,'D')) { - dTHR; - sv = sv_newmortal(); - mg_copy((SV*)av, sv, 0, key); - PL_av_fetch_sv = sv; - return &PL_av_fetch_sv; - } + 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; } return &AvARRAY(av)[key]; } +/* +=for apidoc av_store + +Stores an SV in an array. The array index is specified as C. The +return value will be NULL if the operation failed or if the value did not +need to be actually stored within the array (as in the case of tied +arrays). Otherwise it can be dereferenced to get the original C. Note +that the caller is responsible for suitably incrementing the reference +count of C before the call, and decrementing it if the function +returned NULL. + +See L for +more information on how to use this function on tied arrays. + +=cut +*/ + SV** Perl_av_store(pTHX_ register AV *av, I32 key, SV *val) { + dVAR; SV** ary; - U32 fill; + 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 (!av) - return 0; if (!val) val = &PL_sv_undef; + if (SvRMAGICAL(av)) { + const MAGIC * const tied_magic = mg_find((SV*)av, PERL_MAGIC_tied); + if (tied_magic) { + /* Handle negative array indices 20020222 MJD */ + if (key < 0) { + 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); + if (negative_indices_glob + && SvTRUE(GvSV(*negative_indices_glob))) + adjust_index = 0; + if (adjust_index) { + key += AvFILL(av) + 1; + if (key < 0) + return 0; + } + } + if (val != &PL_sv_undef) { + mg_copy((SV*)av, val, 0, key); + } + return NULL; + } + } + + 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); - if (SvRMAGICAL(av)) { - if (mg_find((SV*)av,'P')) { - if (val != &PL_sv_undef) { - mg_copy((SV*)av, val, 0, key); - } - return 0; - } - } - if (!AvREAL(av) && AvREIFY(av)) av_reify(av); if (key > AvMAX(av)) @@ -235,12 +348,11 @@ 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 + do { ary[++AvFILLp(av)] = &PL_sv_undef; - while (AvFILLp(av) < key); + } while (AvFILLp(av) < key); } AvFILLp(av) = key; } @@ -248,48 +360,46 @@ 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); } - mg_set((SV*)av); + if (PL_delaymagic && mg->mg_type == PERL_MAGIC_isa) + PL_delaymagic |= DM_ARRAY; + else + mg_set((SV*)av); } return &ary[key]; } -AV * -Perl_newAV(pTHX) -{ - register AV *av; +/* +=for apidoc av_make - 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; -} +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. + +=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 = (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); + ary[i] = newSV(0); sv_setsv(ary[i], *strp); strp++; } @@ -297,108 +407,139 @@ 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); - 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. + +=cut +*/ 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_ WARN_DEBUGGING, "Attempt to clear deleted array"); + if (SvREFCNT(av) == 0 && ckWARN_d(WARN_DEBUGGING)) { + Perl_warner(aTHX_ packWARN(WARN_DEBUGGING), "Attempt to clear deleted array"); } #endif - if (!av) - return; - /*SUPPRESS 560*/ if (SvREADONLY(av)) Perl_croak(aTHX_ PL_no_modify); /* 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; + else + mg_clear((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; } +/* +=for apidoc av_undef + +Undefines the array. Frees the memory used by the array itself. + +=cut +*/ + 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, 'P')) - av_fill(av, -1); /* mg_clear() ? */ + if (SvTIED_mg((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((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. + +=cut +*/ + 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, 'P')) { + if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) { dSP; PUSHSTACKi(PERLSI_MAGIC); PUSHMARK(SP); @@ -415,17 +556,28 @@ Perl_av_push(pTHX_ register AV *av, SV *val) av_store(av,AvFILLp(av)+1,val); } +/* +=for apidoc av_pop + +Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array +is empty. + +=cut +*/ + SV * Perl_av_pop(pTHX_ register AV *av) { + dVAR; SV *retval; MAGIC* mg; - if (!av || AvFILL(av) < 0) - 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, 'P')) { + if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) { dSP; PUSHSTACKi(PERLSI_MAGIC); PUSHMARK(SP); @@ -441,6 +593,8 @@ Perl_av_pop(pTHX_ register AV *av) POPSTACK; return retval; } + if (AvFILL(av) < 0) + return &PL_sv_undef; retval = AvARRAY(av)[AvFILLp(av)]; AvARRAY(av)[AvFILLp(av)--] = &PL_sv_undef; if (SvSMAGICAL(av)) @@ -448,19 +602,52 @@ Perl_av_pop(pTHX_ register AV *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 +array. The array will grow automatically to accommodate the addition. You +must then use C to assign values to these new elements. + +=cut +*/ + void Perl_av_unshift(pTHX_ register AV *av, register I32 num) { + dVAR; register I32 i; - register SV **ary; MAGIC* mg; - if (!av || num <= 0) - 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, 'P')) { + if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) { dSP; PUSHSTACKi(PERLSI_MAGIC); PUSHMARK(SP); @@ -477,6 +664,8 @@ Perl_av_unshift(pTHX_ register AV *av, register I32 num) return; } + if (num <= 0) + return; if (!AvREAL(av) && AvREIFY(av)) av_reify(av); i = AvARRAY(av) - AvALLOC(av); @@ -487,10 +676,14 @@ 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 */ + const I32 slide = i > 0 ? i : 0; + num += slide; av_extend(av, i + num); AvFILLp(av) += num; ary = AvARRAY(av); @@ -498,20 +691,35 @@ 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; + AvARRAY(av) = AvARRAY(av) + slide; } } +/* +=for apidoc av_shift + +Shifts an SV off the beginning of the array. Returns C<&PL_sv_undef> if the +array is empty. + +=cut +*/ + SV * Perl_av_shift(pTHX_ register AV *av) { + dVAR; SV *retval; MAGIC* mg; - if (!av || AvFILL(av) < 0) - 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, 'P')) { + if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) { dSP; PUSHSTACKi(PERLSI_MAGIC); PUSHMARK(SP); @@ -527,10 +735,12 @@ Perl_av_shift(pTHX_ register AV *av) POPSTACK; return retval; } + if (AvFILL(av) < 0) + return &PL_sv_undef; 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)) @@ -538,21 +748,50 @@ Perl_av_shift(pTHX_ register AV *av) return retval; } +/* +=for apidoc av_len + +Returns the highest index in the array. The number of elements in the +array is C. Returns -1 if the array is empty. + +=cut +*/ + I32 -Perl_av_len(pTHX_ register AV *av) +Perl_av_len(pTHX_ register const AV *av) { + PERL_ARGS_ASSERT_AV_LEN; + assert(SvTYPE(av) == SVt_PVAV); + return AvFILL(av); } +/* +=for apidoc av_fill + +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, 'P')) { + if ((mg = SvTIED_mg((SV*)av, PERL_MAGIC_tied))) { dSP; ENTER; SAVETMPS; @@ -560,7 +799,7 @@ Perl_av_fill(pTHX_ register AV *av, I32 fill) PUSHMARK(SP); EXTEND(SP,2); PUSHs(SvTIED_obj((SV*)av, mg)); - PUSHs(sv_2mortal(newSViv(fill+1))); + mPUSHi(fill + 1); PUTBACK; call_method("STORESIZE", G_SCALAR|G_DISCARD); POPSTACK; @@ -570,7 +809,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) { @@ -591,39 +830,76 @@ 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 from the array. Returns the +deleted element. If C equals C, the element is freed +and null is returned. + +=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); + + 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))) { + /* Handle negative array indices 20020222 MJD */ + SV **svp; + if (key < 0) { + unsigned adjust_index = 1; + if (tied_magic) { + 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 (adjust_index) { + key += AvFILL(av) + 1; + if (key < 0) + return NULL; + } + } + svp = av_fetch(av, key, TRUE); + if (svp) { + sv = *svp; + mg_clear(sv); + if (mg_find(sv, PERL_MAGIC_tiedelem)) { + sv_unmagic(sv, PERL_MAGIC_tiedelem); /* No longer an element */ + return sv; + } + return NULL; + } + } + } + if (key < 0) { key += AvFILL(av) + 1; if (key < 0) - return Nullsv; - } - if (SvRMAGICAL(av)) { - SV **svp; - if ((mg_find((SV*)av,'P') || mg_find((SV*)av,'D')) - && (svp = av_fetch(av, key, TRUE))) - { - sv = *svp; - mg_clear(sv); - if (mg_find(sv, 'p')) { - sv_unmagic(sv, 'p'); /* No longer an element */ - return sv; - } - return Nullsv; /* element cannot be deleted */ - } + 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; do { AvFILLp(av)--; } while (--key >= 0 && AvARRAY(av)[key] == &PL_sv_undef); @@ -635,34 +911,70 @@ 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); return sv; } /* - * 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 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) { - if (!av) - return FALSE; + dVAR; + PERL_ARGS_ASSERT_AV_EXISTS; + assert(SvTYPE(av) == SVt_PVAV); + + 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 * const sv = sv_newmortal(); + MAGIC *mg; + /* Handle negative array indices 20020222 MJD */ + if (key < 0) { + unsigned adjust_index = 1; + if (tied_magic) { + 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 (adjust_index) { + key += AvFILL(av) + 1; + if (key < 0) + return FALSE; + } + } + + mg_copy((SV*)av, sv, 0, key); + mg = mg_find(sv, PERL_MAGIC_tiedelem); + if (mg) { + magic_existspack(sv, mg); + return (bool)SvTRUE(sv); + } + + } + } + if (key < 0) { key += AvFILL(av) + 1; if (key < 0) return FALSE; } - if (SvRMAGICAL(av)) { - if (mg_find((SV*)av,'P') || mg_find((SV*)av,'D')) { - SV *sv = sv_newmortal(); - mg_copy((SV*)av, sv, 0, key); - magic_existspack(sv, mg_find(sv, 'p')); - return SvTRUE(sv); - } - } + if (key <= AvFILLp(av) && AvARRAY(av)[key] != &PL_sv_undef && AvARRAY(av)[key]) { @@ -672,91 +984,62 @@ Perl_av_exists(pTHX_ AV *av, I32 key) return FALSE; } -/* AVHV: Support for treating arrays as if they were hashes. The - * first element of the array should be a hash reference that maps - * hash keys to array indices. - */ +MAGIC * +S_get_aux_mg(pTHX_ AV *av) { + dVAR; + MAGIC *mg; -STATIC I32 -S_avhv_index_sv(pTHX_ SV* sv) -{ - I32 index = SvIV(sv); - if (index < 1) - Perl_croak(aTHX_ "Bad index while coercing array into hash"); - return index; -} + PERL_ARGS_ASSERT_GET_AUX_MG; + assert(SvTYPE(av) == SVt_PVAV); -HV* -Perl_avhv_keys(pTHX_ AV *av) -{ - SV **keysp = av_fetch(av, 0, FALSE); - if (keysp) { - SV *sv = *keysp; - if (SvGMAGICAL(sv)) - mg_get(sv); - if (SvROK(sv)) { - sv = SvRV(sv); - if (SvTYPE(sv) == SVt_PVHV) - return (HV*)sv; - } + 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); + assert(mg); + /* sv_magicext won't set this for us because we pass in a NULL obj */ + mg->mg_flags |= MGf_REFCOUNTED; } - Perl_croak(aTHX_ "Can't coerce array into hash"); - return Nullhv; + return mg; } -SV** -Perl_avhv_fetch_ent(pTHX_ AV *av, SV *keysv, I32 lval, U32 hash) -{ - SV **indsvp; - HV *keys = avhv_keys(av); - HE *he; - STRLEN n_a; - - he = hv_fetch_ent(keys, keysv, FALSE, hash); - if (!he) - Perl_croak(aTHX_ "No such pseudo-hash field \"%s\"", SvPV(keysv,n_a)); - return av_fetch(av, avhv_index_sv(HeVAL(he)), lval); -} +SV ** +Perl_av_arylen_p(pTHX_ AV *av) { + MAGIC *const mg = get_aux_mg(av); -SV * -Perl_avhv_delete_ent(pTHX_ AV *av, SV *keysv, I32 flags, U32 hash) -{ - HV *keys = avhv_keys(av); - HE *he; - - he = hv_fetch_ent(keys, keysv, FALSE, hash); - if (!he || !SvOK(HeVAL(he))) - return Nullsv; - - return av_delete(av, avhv_index_sv(HeVAL(he)), flags); + PERL_ARGS_ASSERT_AV_ARYLEN_P; + assert(SvTYPE(av) == SVt_PVAV); + + return &(mg->mg_obj); } -/* Check for the existence of an element named by a given key. - * - */ -bool -Perl_avhv_exists_ent(pTHX_ AV *av, SV *keysv, U32 hash) -{ - HV *keys = avhv_keys(av); - HE *he; - - he = hv_fetch_ent(keys, keysv, FALSE, hash); - if (!he || !SvOK(HeVAL(he))) - return FALSE; +IV * +Perl_av_iter_p(pTHX_ AV *av) { + MAGIC *const mg = get_aux_mg(av); - return av_exists(av, avhv_index_sv(HeVAL(he))); -} + PERL_ARGS_ASSERT_AV_ITER_P; + assert(SvTYPE(av) == SVt_PVAV); -HE * -Perl_avhv_iternext(pTHX_ AV *av) -{ - HV *keys = avhv_keys(av); - return hv_iternext(keys); +#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 } -SV * -Perl_avhv_iterval(pTHX_ AV *av, register HE *entry) -{ - SV *sv = hv_iterval(avhv_keys(av), entry); - return *av_fetch(av, avhv_index_sv(sv), TRUE); -} +/* + * Local variables: + * c-indentation-style: bsd + * c-basic-offset: 4 + * indent-tabs-mode: t + * End: + * + * ex: set ts=8 sts=4 sw=4 noet: + */