X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/d627ae4ec1b0cdf09c0e99c4a5197c0c507bd235..48d0d1bec7d856a8eb6ad58b8ba8bfa25c36766d:/av.c diff --git a/av.c b/av.c index 1768442..776dafd 100644 --- a/av.c +++ b/av.c @@ -1,6 +1,7 @@ /* av.c * - * Copyright (c) 1991-1997, 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,373 +9,637 @@ */ /* - * "...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"] */ +/* +=head1 Array Manipulation Functions +*/ + #include "EXTERN.h" +#define PERL_IN_AV_C #include "perl.h" void -av_reify(AV *av) +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((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 > AvFILL(av) + 1) - AvARRAY(av)[--key] = &sv_undef; + 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 != &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) - AvALLOC(av)[--key] = &sv_undef; + AvALLOC(av)[--key] = &PL_sv_undef; + AvREIFY_off(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 -av_extend(AV *av, I32 key) +Perl_av_extend(pTHX_ AV *av, I32 key) { - dTHR; /* only necessary if we have to extend stack */ + dVAR; + MAGIC *mg; + + 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)) { SV** ary; I32 tmp; I32 newmax; if (AvALLOC(av) != AvARRAY(av)) { - ary = AvALLOC(av) + AvFILL(av) + 1; + ary = AvALLOC(av) + AvFILLp(av) + 1; tmp = AvARRAY(av) - AvALLOC(av); - Move(AvARRAY(av), AvALLOC(av), AvFILL(av)+1, SV*); + 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] = &sv_undef; + 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 - U32 bytes; +#if !defined(STRANGE_MALLOC) && !defined(MYMALLOC) + MEM_SIZE bytes; + IV itmp; #endif +#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: -#ifdef STRANGE_MALLOC + 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 - tmp = MALLOC_OVERHEAD; - while (tmp - MALLOC_OVERHEAD < bytes) - tmp += tmp; - tmp -= MALLOC_OVERHEAD; - tmp /= sizeof(SV*); - assert(tmp > newmax); - newmax = tmp - 1; - New(2,ary, newmax+1, SV*); + itmp = MALLOC_OVERHEAD; + while ((MEM_SIZE)(itmp - MALLOC_OVERHEAD) < bytes) + itmp += itmp; + itmp -= MALLOC_OVERHEAD; + itmp /= sizeof(const SV *); + assert(itmp > newmax); + newmax = itmp - 1; + assert(newmax >= AvMAX(av)); + 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 +#ifdef Perl_safesysmalloc_size + resized: +#endif ary = AvALLOC(av) + AvMAX(av) + 1; tmp = newmax - AvMAX(av); - if (av == curstack) { /* Oops, grew stack (via av_store()?) */ - stack_sp = AvALLOC(av) + (stack_sp - stack_base); - stack_base = AvALLOC(av); - stack_max = stack_base + newmax; + if (av == PL_curstack) { /* Oops, grew stack (via av_store()?) */ + PL_stack_sp = AvALLOC(av) + (PL_stack_sp - PL_stack_base); + PL_stack_base = AvALLOC(av); + PL_stack_max = PL_stack_base + newmax; } } else { - newmax = key < 4 ? 4 : key; - New(2,AvALLOC(av), newmax+1, SV*); + newmax = key < 3 ? 3 : key; + 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] = &sv_undef; /* For the stacks */ + AvALLOC(av)[0] = &PL_sv_undef; /* For the stacks */ } if (AvREAL(av)) { while (tmp) - ary[--tmp] = &sv_undef; + 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 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** -av_fetch(register AV *av, I32 key, I32 lval) +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)) { - if (mg_find((SV*)av,'P')) { - dTHR; - sv = sv_newmortal(); - mg_copy((SV*)av, sv, 0, key); - Sv = sv; - return &Sv; - } + 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 (adjust_index) { + key += AvFILL(av) + 1; + if (key < 0) + return NULL; + } + } + + sv = sv_newmortal(); + 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; } - else if (key > AvFILL(av)) { + + if (key > AvFILLp(av)) { if (!lval) - return 0; - if (AvREALISH(av)) - sv = NEWSV(5,0); - else - sv = sv_newmortal(); - return av_store(av,key,sv); + return NULL; + return av_store(av,key,newSV(0)); } - if (AvARRAY(av)[key] == &sv_undef) { + 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)) { - AvARRAY(av)[key] = &sv_undef; /* 1/2 reify */ + || 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** -av_store(register AV *av, I32 key, SV *val) +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 = &sv_undef; + val = &PL_sv_undef; if (SvRMAGICAL(av)) { - if (mg_find((SV*)av,'P')) { - if (val != &sv_undef) - mg_copy((SV*)av, val, 0, key); - return 0; - } + 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) { + 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 + && 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(MUTABLE_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)) - croak(no_modify); + Perl_croak_no_modify(aTHX); + if (!AvREAL(av) && AvREIFY(av)) av_reify(av); if (key > AvMAX(av)) av_extend(av,key); ary = AvARRAY(av); - if (AvFILL(av) < key) { + if (AvFILLp(av) < key) { if (!AvREAL(av)) { - dTHR; - if (av == curstack && key > stack_sp - stack_base) - stack_sp = stack_base + key; /* XPUSH in disguise */ - do - ary[++AvFILL(av)] = &sv_undef; - while (AvFILL(av) < key); + if (av == PL_curstack && key > PL_stack_sp - PL_stack_base) + PL_stack_sp = PL_stack_base + key; /* XPUSH in disguise */ + do { + ary[++AvFILLp(av)] = &PL_sv_undef; + } while (AvFILLp(av) < key); } - AvFILL(av) = key; + AvFILLp(av) = key; } else if (AvREAL(av)) SvREFCNT_dec(ary[key]); ary[key] = val; if (SvSMAGICAL(av)) { - if (val != &sv_undef) { - MAGIC* mg = SvMAGIC(av); - sv_magic(val, (SV*)av, toLOWER(mg->mg_type), 0, key); + const MAGIC* const mg = SvMAGIC(av); + if (val != &PL_sv_undef) { + 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]; } -AV * -newAV(void) -{ - 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) = AvFILL(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. + +Perl equivalent: C + +=cut +*/ AV * -av_make(register I32 size, register SV **strp) +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; - AvFILL(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 * -av_fake(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; - AvFILL(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. Perl equivalent: C<@myarray = ();>. + +=cut +*/ void -av_clear(register AV *av) +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) { - warn("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 || AvMAX(av) < 0) + + if (SvREADONLY(av)) + Perl_croak_no_modify(aTHX); + + /* Give any tie a chance to cleanup first */ + 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; - /*SUPPRESS 560*/ if (AvREAL(av)) { - ary = AvARRAY(av); - key = AvFILL(av) + 1; - while (key) { - SvREFCNT_dec(ary[--key]); - ary[key] = &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); } - AvFILL(av) = -1; + AvFILLp(av) = -1; - if (SvRMAGICAL(av)) - mg_clear((SV*)av); } +/* +=for apidoc av_undef + +Undefines the array. Frees the memory used by the array itself. + +=cut +*/ + void -av_undef(register AV *av) +Perl_av_undef(pTHX_ register AV *av) { - register I32 key; + PERL_ARGS_ASSERT_AV_UNDEF; + assert(SvTYPE(av) == SVt_PVAV); + + /* Give any tie a chance to cleanup first */ + if (SvTIED_mg((const SV *)av, PERL_MAGIC_tied)) + av_fill(av, -1); - if (!av) - return; - /*SUPPRESS 560*/ if (AvREAL(av)) { - key = AvFILL(av) + 1; + register I32 key = AvFILLp(av) + 1; while (key) SvREFCNT_dec(AvARRAY(av)[--key]); } + Safefree(AvALLOC(av)); - AvALLOC(av) = 0; - SvPVX(av) = 0; - AvMAX(av) = AvFILL(av) = -1; - if (AvARYLEN(av)) { - SvREFCNT_dec(AvARYLEN(av)); - AvARYLEN(av) = 0; - } + AvALLOC(av) = NULL; + AvARRAY(av) = NULL; + AvMAX(av) = AvFILLp(av) = -1; + + 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 -av_push(register AV *av, SV *val) +Perl_av_create_and_push(pTHX_ AV **const avp, SV *const val) { - if (!av) + 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. This takes ownership of one reference count. + +=cut +*/ + +void +Perl_av_push(pTHX_ register AV *av, SV *val) +{ + dVAR; + MAGIC *mg; + + PERL_ARGS_ASSERT_AV_PUSH; + assert(SvTYPE(av) == SVt_PVAV); + + if (SvREADONLY(av)) + 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,AvFILL(av)+1,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 * -av_pop(register AV *av) +Perl_av_pop(pTHX_ register AV *av) { + dVAR; SV *retval; + MAGIC* mg; + + PERL_ARGS_ASSERT_AV_POP; + assert(SvTYPE(av) == SVt_PVAV); - if (!av || AvFILL(av) < 0) - return &sv_undef; if (SvREADONLY(av)) - croak(no_modify); - retval = AvARRAY(av)[AvFILL(av)]; - AvARRAY(av)[AvFILL(av)--] = &sv_undef; + 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) + return &PL_sv_undef; + 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 +array. The array will grow automatically to accommodate the addition. You +must then use C to assign values to these new elements. + +=cut +*/ + void -av_unshift(register AV *av, register I32 num) +Perl_av_unshift(pTHX_ register AV *av, register I32 num) { + dVAR; register I32 i; - register SV **sstr,**dstr; + MAGIC* mg; + + PERL_ARGS_ASSERT_AV_UNSHIFT; + assert(SvTYPE(av) == SVt_PVAV); - if (!av || num <= 0) - return; if (SvREADONLY(av)) - croak(no_modify); + 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; + } + + if (num <= 0) + return; if (!AvREAL(av) && AvREIFY(av)) av_reify(av); i = AvARRAY(av) - AvALLOC(av); @@ -384,303 +649,371 @@ av_unshift(register AV *av, register I32 num) num -= i; AvMAX(av) += i; - AvFILL(av) += i; - SvPVX(av) = (char*)(AvARRAY(av) - i); + AvFILLp(av) += i; + AvARRAY(av) = AvARRAY(av) - i; } if (num) { - av_extend(av,AvFILL(av)+num); - AvFILL(av) += num; - dstr = AvARRAY(av) + AvFILL(av); - sstr = dstr - num; -#ifdef BUGGY_MSC5 - # pragma loop_opt(off) /* don't loop-optimize the following code */ -#endif /* BUGGY_MSC5 */ - for (i = AvFILL(av) - num; i >= 0; --i) { - *dstr-- = *sstr--; -#ifdef BUGGY_MSC5 - # pragma loop_opt() /* loop-optimization back to command-line setting */ -#endif /* BUGGY_MSC5 */ - } - while (num) - AvARRAY(av)[--num] = &sv_undef; + 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); + Move(ary, ary + num, i + 1, SV*); + 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 * -av_shift(register AV *av) +Perl_av_shift(pTHX_ register AV *av) { + dVAR; SV *retval; + MAGIC* mg; + + PERL_ARGS_ASSERT_AV_SHIFT; + assert(SvTYPE(av) == SVt_PVAV); - if (!av || AvFILL(av) < 0) - return &sv_undef; if (SvREADONLY(av)) - croak(no_modify); + 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) + return &PL_sv_undef; retval = *AvARRAY(av); if (AvREAL(av)) - *AvARRAY(av) = &sv_undef; - SvPVX(av) = (char*)(AvARRAY(av) + 1); + *AvARRAY(av) = &PL_sv_undef; + AvARRAY(av) = AvARRAY(av) + 1; AvMAX(av)--; - AvFILL(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. 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 -av_len(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 + +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 -av_fill(register AV *av, I32 fill) +Perl_av_fill(pTHX_ register AV *av, I32 fill) { - if (!av) - croak("panic: null array"); + dVAR; + MAGIC *mg; + + PERL_ARGS_ASSERT_AV_FILL; + assert(SvTYPE(av) == SVt_PVAV); + if (fill < 0) fill = -1; + 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 = AvFILL(av); - SV** ary = AvARRAY(av); + I32 key = AvFILLp(av); + SV** const ary = AvARRAY(av); if (AvREAL(av)) { while (key > fill) { SvREFCNT_dec(ary[key]); - ary[key--] = &sv_undef; + ary[key--] = &PL_sv_undef; } } else { while (key < fill) - ary[++key] = &sv_undef; + ary[++key] = &PL_sv_undef; } - AvFILL(av) = fill; + AvFILLp(av) = fill; if (SvSMAGICAL(av)) - mg_set((SV*)av); + mg_set(MUTABLE_SV(av)); } else - (void)av_store(av,fill,&sv_undef); + (void)av_store(av,fill,&PL_sv_undef); } - -HV* -avhv_keys(AV *av) +/* +=for apidoc av_delete + +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) { - SV **keysp; - HV *keys = Nullhv; - - 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) - keys = (HV*)sv; - } + dVAR; + SV *sv; + + PERL_ARGS_ASSERT_AV_DELETE; + assert(SvTYPE(av) == SVt_PVAV); + + if (SvREADONLY(av)) + Perl_croak_no_modify(aTHX); + + if (SvRMAGICAL(av)) { + 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 * 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 (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 (!keys) - croak("Can't coerce array into hash"); - return keys; -} -SV** -avhv_fetch(AV *av, char *key, U32 klen, I32 lval) -{ - SV **indsvp; - HV *keys = avhv_keys(av); - I32 ind; - - indsvp = hv_fetch(keys, key, klen, FALSE); - if (indsvp) { - ind = SvIV(*indsvp); - if (ind < 1) - croak("Bad index while coercing array into hash"); - } else { - if (!lval) - return 0; - - ind = AvFILL(av) + 1; - hv_store(keys, key, klen, newSViv(ind), 0); + if (key < 0) { + key += AvFILL(av) + 1; + if (key < 0) + return NULL; } - return av_fetch(av, ind, lval); -} -SV** -avhv_fetch_ent(AV *av, SV *keysv, I32 lval, U32 hash) -{ - SV **indsvp; - HV *keys = avhv_keys(av); - HE *he; - I32 ind; - - he = hv_fetch_ent(keys, keysv, FALSE, hash); - if (he) { - ind = SvIV(HeVAL(he)); - if (ind < 1) - croak("Bad index while coercing array into hash"); - } else { - if (!lval) - return 0; - - ind = AvFILL(av) + 1; - hv_store_ent(keys, keysv, newSViv(ind), 0); + if (key > AvFILLp(av)) + 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); + } + else + AvARRAY(av)[key] = &PL_sv_undef; + if (SvSMAGICAL(av)) + mg_set(MUTABLE_SV(av)); + } + if (flags & G_DISCARD) { + SvREFCNT_dec(sv); + sv = NULL; } - return av_fetch(av, ind, lval); + else if (AvREAL(av)) + sv = sv_2mortal(sv); + return sv; } -SV** -avhv_store(AV *av, char *key, U32 klen, SV *val, U32 hash) -{ - SV **indsvp; - HV *keys = avhv_keys(av); - I32 ind; - - indsvp = hv_fetch(keys, key, klen, FALSE); - if (indsvp) { - ind = SvIV(*indsvp); - if (ind < 1) - croak("Bad index while coercing array into hash"); - } else { - ind = AvFILL(av) + 1; - hv_store(keys, key, klen, newSViv(ind), hash); - } - return av_store(av, ind, val); -} +/* +=for apidoc av_exists -SV** -avhv_store_ent(AV *av, SV *keysv, SV *val, U32 hash) -{ - HV *keys = avhv_keys(av); - HE *he; - I32 ind; - - he = hv_fetch_ent(keys, keysv, FALSE, hash); - if (he) { - ind = SvIV(HeVAL(he)); - if (ind < 1) - croak("Bad index while coercing array into hash"); - } else { - ind = AvFILL(av) + 1; - hv_store_ent(keys, keysv, newSViv(ind), hash); - } - return av_store(av, ind, val); -} +Returns true if the element indexed by C has been initialized. -bool -avhv_exists_ent(AV *av, SV *keysv, U32 hash) -{ - HV *keys = avhv_keys(av); - return hv_exists_ent(keys, keysv, hash); -} +This relies on the fact that uninitialized array elements are set to +C<&PL_sv_undef>. + +Perl equivalent: C. +=cut +*/ bool -avhv_exists(AV *av, char *key, U32 klen) +Perl_av_exists(pTHX_ AV *av, I32 key) { - HV *keys = avhv_keys(av); - return hv_exists(keys, key, klen); -} + dVAR; + PERL_ARGS_ASSERT_AV_EXISTS; + assert(SvTYPE(av) == SVt_PVAV); -/* avhv_delete leaks. Caller can re-index and compress if so desired. */ -SV * -avhv_delete(AV *av, char *key, U32 klen, I32 flags) -{ - HV *keys = avhv_keys(av); - SV *sv; - SV **svp; - I32 ind; - - sv = hv_delete(keys, key, klen, 0); - if (!sv) - return Nullsv; - ind = SvIV(sv); - if (ind < 1) - croak("Bad index while coercing array into hash"); - svp = av_fetch(av, ind, FALSE); - if (!svp) - return Nullsv; - if (flags & G_DISCARD) { - sv = Nullsv; - SvREFCNT_dec(*svp); - } else { - sv = sv_2mortal(*svp); + if (SvRMAGICAL(av)) { + 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 * 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 (adjust_index) { + key += AvFILL(av) + 1; + if (key < 0) + return FALSE; + else + return TRUE; + } + } + + 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 cBOOL(SvTRUE(sv)); + } + + } } - *svp = &sv_undef; - return sv; -} -/* avhv_delete_ent leaks. Caller can re-index and compress if so desired. */ -SV * -avhv_delete_ent(AV *av, SV *keysv, I32 flags, U32 hash) -{ - HV *keys = avhv_keys(av); - SV *sv; - SV **svp; - I32 ind; - - sv = hv_delete_ent(keys, keysv, 0, hash); - if (!sv) - return Nullsv; - ind = SvIV(sv); - if (ind < 1) - croak("Bad index while coercing array into hash"); - svp = av_fetch(av, ind, FALSE); - if (!svp) - return Nullsv; - if (flags & G_DISCARD) { - sv = Nullsv; - SvREFCNT_dec(*svp); - } else { - sv = sv_2mortal(*svp); + if (key < 0) { + key += AvFILL(av) + 1; + if (key < 0) + return FALSE; } - *svp = &sv_undef; - return sv; -} -I32 -avhv_iterinit(AV *av) -{ - HV *keys = avhv_keys(av); - return hv_iterinit(keys); + if (key <= AvFILLp(av) && AvARRAY(av)[key] != &PL_sv_undef + && AvARRAY(av)[key]) + { + return TRUE; + } + else + return FALSE; } -HE * -avhv_iternext(AV *av) -{ - HV *keys = avhv_keys(av); - return hv_iternext(keys); +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 * -avhv_iterval(AV *av, register HE *entry) -{ - HV *keys = avhv_keys(av); - SV *sv; - I32 ind; - - sv = hv_iterval(keys, entry); - ind = SvIV(sv); - if (ind < 1) - croak("Bad index while coercing array into hash"); - return *av_fetch(av, ind, TRUE); +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); } -SV * -avhv_iternextsv(AV *av, char **key, I32 *retlen) -{ - HV *keys = avhv_keys(av); - HE *he; - SV *sv; - I32 ind; - - he = hv_iternext(keys); - if (!he) - return Nullsv; - *key = hv_iterkey(he, retlen); - sv = hv_iterval(keys, he); - ind = SvIV(sv); - if (ind < 1) - croak("Bad index while coercing array into hash"); - return *av_fetch(av, ind, TRUE); +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: + */