This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
doc tweak suggested by M.J.T. Guy <mjtg@cus.cam.ac.uk>
[perl5.git] / av.c
diff --git a/av.c b/av.c
index 85bcf0c..1f0d94a 100644 (file)
--- a/av.c
+++ b/av.c
@@ -1,6 +1,6 @@
 /*    av.c
  *
- *    Copyright (c) 1991-1997, Larry Wall
+ *    Copyright (c) 1991-1999, Larry Wall
  *
  *    You may distribute under the terms of either the GNU General Public
  *    License or the Artistic License, as specified in the README file.
@@ -24,23 +24,24 @@ av_reify(AV *av)
     if (AvREAL(av))
        return;
 #ifdef DEBUGGING
-    if (SvRMAGICAL(av) && mg_find((SV*)av,'P'))
+    if (SvTIED_mg((SV*)av, 'P'))
        warn("av_reify called on tied array");
 #endif
     key = AvMAX(av) + 1;
     while (key > AvFILLp(av) + 1)
-       AvARRAY(av)[--key] = &sv_undef;
+       AvARRAY(av)[--key] = &PL_sv_undef;
     while (key) {
        sv = AvARRAY(av)[--key];
        assert(sv);
-       if (sv != &sv_undef) {
+       if (sv != &PL_sv_undef) {
            dTHR;
            (void)SvREFCNT_inc(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);
 }
 
@@ -49,18 +50,18 @@ av_extend(AV *av, I32 key)
 {
     dTHR;                      /* only necessary if we have to extend stack */
     MAGIC *mg;
-    if (SvRMAGICAL(av) && (mg = mg_find((SV*)av,'P'))) {
+    if (mg = SvTIED_mg((SV*)av, 'P')) {
        dSP;
        ENTER;
        SAVETMPS;
-       PUSHSTACK(SI_MAGIC);
+       PUSHSTACKi(PERLSI_MAGIC);
        PUSHMARK(SP);
        EXTEND(SP,2);
-       PUSHs(mg->mg_obj);
+       PUSHs(SvTIED_obj((SV*)av, mg));
        PUSHs(sv_2mortal(newSViv(key+1)));
         PUTBACK;
        perl_call_method("EXTEND", G_SCALAR|G_DISCARD);
-       POPSTACK();
+       POPSTACK;
        FREETMPS;
        LEAVE;
        return;
@@ -78,7 +79,7 @@ av_extend(AV *av, I32 key)
            SvPVX(av) = (char*)AvALLOC(av);
            if (AvREAL(av)) {
                while (tmp)
-                   ary[--tmp] = &sv_undef;
+                   ary[--tmp] = &PL_sv_undef;
            }
            
            if (key > AvMAX(av) - 10) {
@@ -92,9 +93,15 @@ av_extend(AV *av, I32 key)
                U32 bytes;
 #endif
 
+#if defined(MYMALLOC) && !defined(PURIFY) && !defined(LEAKTEST)
+               newmax = malloced_size((void*)AvALLOC(av))/sizeof(SV*) - 1;
+
+               if (key <= newmax) 
+                   goto resized;
+#endif 
                newmax = key + AvMAX(av) / 5;
              resize:
-#ifdef STRANGE_MALLOC
+#if defined(STRANGE_MALLOC) || defined(MYMALLOC)
                Renew(AvALLOC(av),newmax+1, SV*);
 #else
                bytes = (newmax + 1) * sizeof(SV*);
@@ -114,24 +121,25 @@ av_extend(AV *av, I32 key)
                    Safefree(AvALLOC(av));
                AvALLOC(av) = ary;
 #endif
+             resized:
                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;
+               newmax = key < 3 ? 3 : key;
                New(2,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);
@@ -155,25 +163,22 @@ av_fetch(register AV *av, I32 key, I32 lval)
     }
 
     if (SvRMAGICAL(av)) {
-       if (mg_find((SV*)av,'P')) {
+       if (mg_find((SV*)av,'P') || mg_find((SV*)av,'D')) {
            dTHR;
            sv = sv_newmortal();
            mg_copy((SV*)av, sv, 0, key);
-           av_fetch_sv = sv;
-           return &av_fetch_sv;
+           PL_av_fetch_sv = sv;
+           return &PL_av_fetch_sv;
        }
     }
 
     if (key > AvFILLp(av)) {
        if (!lval)
            return 0;
-       if (AvREALISH(av))
-           sv = NEWSV(5,0);
-       else
-           sv = sv_newmortal();
+       sv = NEWSV(5,0);
        return av_store(av,key,sv);
     }
-    if (AvARRAY(av)[key] == &sv_undef) {
+    if (AvARRAY(av)[key] == &PL_sv_undef) {
     emptyness:
        if (lval) {
            sv = NEWSV(6,0);
@@ -184,7 +189,7 @@ av_fetch(register AV *av, I32 key, I32 lval)
     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 */
+       AvARRAY(av)[key] = &PL_sv_undef;        /* 1/2 reify */
        goto emptyness;
     }
     return &AvARRAY(av)[key];
@@ -200,7 +205,7 @@ av_store(register AV *av, I32 key, SV *val)
     if (!av)
        return 0;
     if (!val)
-       val = &sv_undef;
+       val = &PL_sv_undef;
 
     if (key < 0) {
        key += AvFILL(av) + 1;
@@ -209,11 +214,11 @@ av_store(register AV *av, I32 key, SV *val)
     }
 
     if (SvREADONLY(av) && key >= AvFILL(av))
-       croak(no_modify);
+       croak(PL_no_modify);
 
     if (SvRMAGICAL(av)) {
        if (mg_find((SV*)av,'P')) {
-           if (val != &sv_undef) {
+           if (val != &PL_sv_undef) {
                mg_copy((SV*)av, val, 0, key);
            }
            return 0;
@@ -228,10 +233,10 @@ av_store(register AV *av, I32 key, SV *val)
     if (AvFILLp(av) < key) {
        if (!AvREAL(av)) {
            dTHR;
-           if (av == curstack && key > stack_sp - stack_base)
-               stack_sp = stack_base + key;    /* XPUSH in disguise */
+           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)] = &sv_undef;
+               ary[++AvFILLp(av)] = &PL_sv_undef;
            while (AvFILLp(av) < key);
        }
        AvFILLp(av) = key;
@@ -240,7 +245,7 @@ av_store(register AV *av, I32 key, SV *val)
        SvREFCNT_dec(ary[key]);
     ary[key] = val;
     if (SvSMAGICAL(av)) {
-       if (val != &sv_undef) {
+       if (val != &PL_sv_undef) {
            MAGIC* mg = SvMAGIC(av);
            sv_magic(val, (SV*)av, toLOWER(mg->mg_type), 0, key);
        }
@@ -328,7 +333,7 @@ av_clear(register AV *av)
     /*SUPPRESS 560*/
 
     if (SvREADONLY(av))
-       croak(no_modify);
+       croak(PL_no_modify);
 
     /* Give any tie a chance to cleanup first */
     if (SvRMAGICAL(av))
@@ -342,7 +347,7 @@ av_clear(register AV *av)
        key = AvFILLp(av) + 1;
        while (key) {
            SvREFCNT_dec(ary[--key]);
-           ary[key] = &sv_undef;
+           ary[key] = &PL_sv_undef;
        }
     }
     if (key = AvARRAY(av) - AvALLOC(av)) {
@@ -363,7 +368,7 @@ av_undef(register AV *av)
     /*SUPPRESS 560*/
 
     /* Give any tie a chance to cleanup first */
-    if (SvRMAGICAL(av) && mg_find((SV*)av,'P')) 
+    if (SvTIED_mg((SV*)av, 'P')) 
        av_fill(av, -1);   /* mg_clear() ? */
 
     if (AvREAL(av)) {
@@ -388,20 +393,20 @@ av_push(register AV *av, SV *val)
     if (!av)
        return;
     if (SvREADONLY(av))
-       croak(no_modify);
+       croak(PL_no_modify);
 
-    if (SvRMAGICAL(av) && (mg = mg_find((SV*)av,'P'))) {
+    if (mg = SvTIED_mg((SV*)av, 'P')) {
        dSP;
-       PUSHSTACK(SI_MAGIC);
+       PUSHSTACKi(PERLSI_MAGIC);
        PUSHMARK(SP);
        EXTEND(SP,2);
-       PUSHs(mg->mg_obj);
+       PUSHs(SvTIED_obj((SV*)av, mg));
        PUSHs(val);
        PUTBACK;
        ENTER;
        perl_call_method("PUSH", G_SCALAR|G_DISCARD);
        LEAVE;
-       POPSTACK();
+       POPSTACK;
        return;
     }
     av_store(av,AvFILLp(av)+1,val);
@@ -414,27 +419,27 @@ av_pop(register AV *av)
     MAGIC* mg;
 
     if (!av || AvFILL(av) < 0)
-       return &sv_undef;
+       return &PL_sv_undef;
     if (SvREADONLY(av))
-       croak(no_modify);
-    if (SvRMAGICAL(av) && (mg = mg_find((SV*)av,'P'))) {
+       croak(PL_no_modify);
+    if (mg = SvTIED_mg((SV*)av, 'P')) {
        dSP;    
-       PUSHSTACK(SI_MAGIC);
+       PUSHSTACKi(PERLSI_MAGIC);
        PUSHMARK(SP);
-       XPUSHs(mg->mg_obj);
+       XPUSHs(SvTIED_obj((SV*)av, mg));
        PUTBACK;
        ENTER;
        if (perl_call_method("POP", G_SCALAR)) {
-           retval = newSVsv(*stack_sp--);    
+           retval = newSVsv(*PL_stack_sp--);    
        } else {    
-           retval = &sv_undef;
+           retval = &PL_sv_undef;
        }
        LEAVE;
-       POPSTACK();
+       POPSTACK;
        return retval;
     }
     retval = AvARRAY(av)[AvFILLp(av)];
-    AvARRAY(av)[AvFILLp(av)--] = &sv_undef;
+    AvARRAY(av)[AvFILLp(av)--] = &PL_sv_undef;
     if (SvSMAGICAL(av))
        mg_set((SV*)av);
     return retval;
@@ -450,22 +455,22 @@ av_unshift(register AV *av, register I32 num)
     if (!av || num <= 0)
        return;
     if (SvREADONLY(av))
-       croak(no_modify);
+       croak(PL_no_modify);
 
-    if (SvRMAGICAL(av) && (mg = mg_find((SV*)av,'P'))) {
+    if (mg = SvTIED_mg((SV*)av, 'P')) {
        dSP;
-       PUSHSTACK(SI_MAGIC);
+       PUSHSTACKi(PERLSI_MAGIC);
        PUSHMARK(SP);
        EXTEND(SP,1+num);
-       PUSHs(mg->mg_obj);
+       PUSHs(SvTIED_obj((SV*)av, mg));
        while (num-- > 0) {
-           PUSHs(&sv_undef);
+           PUSHs(&PL_sv_undef);
        }
        PUTBACK;
        ENTER;
        perl_call_method("UNSHIFT", G_SCALAR|G_DISCARD);
        LEAVE;
-       POPSTACK();
+       POPSTACK;
        return;
     }
 
@@ -488,7 +493,7 @@ av_unshift(register AV *av, register I32 num)
        ary = AvARRAY(av);
        Move(ary, ary + num, i + 1, SV*);
        do {
-           ary[--num] = &sv_undef;
+           ary[--num] = &PL_sv_undef;
        } while (num);
     }
 }
@@ -500,28 +505,28 @@ av_shift(register AV *av)
     MAGIC* mg;
 
     if (!av || AvFILL(av) < 0)
-       return &sv_undef;
+       return &PL_sv_undef;
     if (SvREADONLY(av))
-       croak(no_modify);
-    if (SvRMAGICAL(av) && (mg = mg_find((SV*)av,'P'))) {
+       croak(PL_no_modify);
+    if (mg = SvTIED_mg((SV*)av, 'P')) {
        dSP;
-       PUSHSTACK(SI_MAGIC);
+       PUSHSTACKi(PERLSI_MAGIC);
        PUSHMARK(SP);
-       XPUSHs(mg->mg_obj);
+       XPUSHs(SvTIED_obj((SV*)av, mg));
        PUTBACK;
        ENTER;
        if (perl_call_method("SHIFT", G_SCALAR)) {
-           retval = newSVsv(*stack_sp--);            
+           retval = newSVsv(*PL_stack_sp--);            
        } else {    
-           retval = &sv_undef;
+           retval = &PL_sv_undef;
        }     
        LEAVE;
-       POPSTACK();
+       POPSTACK;
        return retval;
     }
     retval = *AvARRAY(av);
     if (AvREAL(av))
-       *AvARRAY(av) = &sv_undef;
+       *AvARRAY(av) = &PL_sv_undef;
     SvPVX(av) = (char*)(AvARRAY(av) + 1);
     AvMAX(av)--;
     AvFILLp(av)--;
@@ -544,18 +549,18 @@ av_fill(register AV *av, I32 fill)
        croak("panic: null array");
     if (fill < 0)
        fill = -1;
-    if (SvRMAGICAL(av) && (mg = mg_find((SV*)av,'P'))) {
+    if (mg = SvTIED_mg((SV*)av, 'P')) {
        dSP;            
        ENTER;
        SAVETMPS;
-       PUSHSTACK(SI_MAGIC);
+       PUSHSTACKi(PERLSI_MAGIC);
        PUSHMARK(SP);
        EXTEND(SP,2);
-       PUSHs(mg->mg_obj);
+       PUSHs(SvTIED_obj((SV*)av, mg));
        PUSHs(sv_2mortal(newSViv(fill+1)));
        PUTBACK;
        perl_call_method("STORESIZE", G_SCALAR|G_DISCARD);
-       POPSTACK();
+       POPSTACK;
        FREETMPS;
        LEAVE;
        return;
@@ -567,12 +572,12 @@ av_fill(register AV *av, I32 fill)
        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;
        }
            
        AvFILLp(av) = fill;
@@ -580,17 +585,28 @@ av_fill(register AV *av, I32 fill)
            mg_set((SV*)av);
     }
     else
-       (void)av_store(av,fill,&sv_undef);
+       (void)av_store(av,fill,&PL_sv_undef);
+}
+
+
+/* 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.
+ */
+
+STATIC I32
+avhv_index_sv(SV* sv)
+{
+    I32 index = SvIV(sv);
+    if (index < 1)
+       croak("Bad index while coercing array into hash");
+    return index;    
 }
 
-  
 HV*
 avhv_keys(AV *av)
 {
-    SV **keysp;
-    HV *keys = Nullhv;
-
-    keysp = av_fetch(av, 0, FALSE);
+    SV **keysp = av_fetch(av, 0, FALSE);
     if (keysp) {
        SV *sv = *keysp;
        if (SvGMAGICAL(sv))
@@ -598,34 +614,11 @@ avhv_keys(AV *av)
        if (SvROK(sv)) {
            sv = SvRV(sv);
            if (SvTYPE(sv) == SVt_PVHV)
-               keys = (HV*)sv;
+               return (HV*)sv;
        }
     }
-    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);
-    }
-    return av_fetch(av, ind, lval);
+    croak("Can't coerce array into hash");
+    return Nullhv;
 }
 
 SV**
@@ -634,59 +627,11 @@ 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);
-    }
-    return av_fetch(av, ind, lval);
-}
-
-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);
-}
-
-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);
+    if (!he)
+        croak("No such array field");
+    return av_fetch(av, avhv_index_sv(HeVAL(he)), lval);
 }
 
 bool
@@ -696,76 +641,6 @@ avhv_exists_ent(AV *av, SV *keysv, U32 hash)
     return hv_exists_ent(keys, keysv, hash);
 }
 
-bool
-avhv_exists(AV *av, char *key, U32 klen)
-{
-    HV *keys = avhv_keys(av);
-    return hv_exists(keys, key, klen);
-}
-
-/* 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);
-    }
-    *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);
-    }
-    *svp = &sv_undef;
-    return sv;
-}
-
-I32
-avhv_iterinit(AV *av)
-{
-    HV *keys = avhv_keys(av);
-    return hv_iterinit(keys);
-}
-
 HE *
 avhv_iternext(AV *av)
 {
@@ -776,32 +651,6 @@ avhv_iternext(AV *av)
 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 *
-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);
+    SV *sv = hv_iterval(avhv_keys(av), entry);
+    return *av_fetch(av, avhv_index_sv(sv), TRUE);
 }