This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
export newRV_noinc on win32, deprecate AvFILL in favor of av_len()
[perl5.git] / av.c
diff --git a/av.c b/av.c
index 67f7880..5aac5b1 100644 (file)
--- a/av.c
+++ b/av.c
@@ -1,6 +1,6 @@
 /*    av.c
  *
- *    Copyright (c) 1991-1994, Larry Wall
+ *    Copyright (c) 1991-1997, 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.
 #include "EXTERN.h"
 #include "perl.h"
 
-static void    av_reify _((AV* av));
-
-static void
-av_reify(av)
-AV* av;
+void
+av_reify(AV *av)
 {
     I32 key;
     SV* sv;
-    
+
+    if (AvREAL(av))
+       return;
+#ifdef DEBUGGING
+    if (SvRMAGICAL(av) && mg_find((SV*)av,'P'))
+       warn("av_reify called on tied array");
+#endif
     key = AvMAX(av) + 1;
-    while (key > AvFILL(av) + 1)
+    while (key > AvFILLp(av) + 1)
        AvARRAY(av)[--key] = &sv_undef;
     while (key) {
        sv = AvARRAY(av)[--key];
        assert(sv);
-       if (sv != &sv_undef)
+       if (sv != &sv_undef) {
+           dTHR;
            (void)SvREFCNT_inc(sv);
+       }
     }
+    key = AvARRAY(av) - AvALLOC(av);
+    while (key)
+       AvALLOC(av)[--key] = &sv_undef;
     AvREAL_on(av);
 }
 
 void
-av_extend(av,key)
-AV *av;
-I32 key;
+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'))) {
+       dSP;
+       ENTER;
+       SAVETMPS;
+       PUSHSTACKi(PERLSI_MAGIC);
+       PUSHMARK(SP);
+       EXTEND(SP,2);
+       PUSHs(mg->mg_obj);
+       PUSHs(sv_2mortal(newSViv(key+1)));
+        PUTBACK;
+       perl_call_method("EXTEND", G_SCALAR|G_DISCARD);
+       POPSTACK;
+       FREETMPS;
+       LEAVE;
+       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);
            if (AvREAL(av)) {
@@ -68,9 +92,15 @@ I32 key;
                U32 bytes;
 #endif
 
+#ifdef MYMALLOC
+               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*);
@@ -84,14 +114,13 @@ I32 key;
                newmax = tmp - 1;
                New(2,ary, newmax+1, SV*);
                Copy(AvALLOC(av), ary, AvMAX(av)+1, SV*);
-               if (AvMAX(av) > 64 && !nice_chunk) {
-                   nice_chunk = (char*)AvALLOC(av);
-                   nice_chunk_size = (AvMAX(av) + 1) * sizeof(SV*);
-               }
+               if (AvMAX(av) > 64)
+                   offer_nice_chunk(AvALLOC(av), (AvMAX(av)+1) * sizeof(SV*));
                else
                    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()?) */
@@ -101,7 +130,7 @@ I32 key;
                }
            }
            else {
-               newmax = key < 4 ? 4 : key;
+               newmax = key < 3 ? 3 : key;
                New(2,AvALLOC(av), newmax+1, SV*);
                ary = AvALLOC(av) + 1;
                tmp = newmax;
@@ -119,31 +148,30 @@ I32 key;
 }
 
 SV**
-av_fetch(av,key,lval)
-register AV *av;
-I32 key;
-I32 lval;
+av_fetch(register AV *av, I32 key, I32 lval)
 {
     SV *sv;
 
     if (!av)
        return 0;
 
+    if (key < 0) {
+       key += AvFILL(av) + 1;
+       if (key < 0)
+           return 0;
+    }
+
     if (SvRMAGICAL(av)) {
        if (mg_find((SV*)av,'P')) {
+           dTHR;
            sv = sv_newmortal();
            mg_copy((SV*)av, sv, 0, key);
-           Sv = sv;
-           return &Sv;
+           av_fetch_sv = sv;
+           return &av_fetch_sv;
        }
     }
 
-    if (key < 0) {
-       key += AvFILL(av) + 1;
-       if (key < 0)
-           return 0;
-    }
-    else if (key > AvFILL(av)) {
+    if (key > AvFILLp(av)) {
        if (!lval)
            return 0;
        if (AvREALISH(av))
@@ -170,47 +198,50 @@ I32 lval;
 }
 
 SV**
-av_store(av,key,val)
-register AV *av;
-I32 key;
-SV *val;
+av_store(register AV *av, I32 key, SV *val)
 {
     SV** ary;
+    U32  fill;
+
 
     if (!av)
        return 0;
     if (!val)
        val = &sv_undef;
 
-    if (SvRMAGICAL(av)) {
-       if (mg_find((SV*)av,'P')) {
-           if (val != &sv_undef)
-               mg_copy((SV*)av, val, 0, key);
-           return 0;
-       }
-    }
-
     if (key < 0) {
        key += AvFILL(av) + 1;
        if (key < 0)
            return 0;
     }
+
     if (SvREADONLY(av) && key >= AvFILL(av))
        croak(no_modify);
-    if (key > AvMAX(av))
-       av_extend(av,key);
+
+    if (SvRMAGICAL(av)) {
+       if (mg_find((SV*)av,'P')) {
+           if (val != &sv_undef) {
+               mg_copy((SV*)av, val, 0, key);
+           }
+           return 0;
+       }
+    }
+
     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);
+               ary[++AvFILLp(av)] = &sv_undef;
+           while (AvFILLp(av) < key);
        }
-       AvFILL(av) = key;
+       AvFILLp(av) = key;
     }
     else if (AvREAL(av))
        SvREFCNT_dec(ary[key]);
@@ -226,7 +257,7 @@ SV *val;
 }
 
 AV *
-newAV()
+newAV(void)
 {
     register AV *av;
 
@@ -235,14 +266,12 @@ newAV()
     AvREAL_on(av);
     AvALLOC(av) = 0;
     SvPVX(av) = 0;
-    AvMAX(av) = AvFILL(av) = -1;
+    AvMAX(av) = AvFILLp(av) = -1;
     return av;
 }
 
 AV *
-av_make(size,strp)
-register I32 size;
-register SV **strp;
+av_make(register I32 size, register SV **strp)
 {
     register AV *av;
     register I32 i;
@@ -250,25 +279,25 @@ register SV **strp;
 
     av = (AV*)NEWSV(8,0);
     sv_upgrade((SV *) av,SVt_PVAV);
-    New(4,ary,size+1,SV*);
-    AvALLOC(av) = ary;
     AvFLAGS(av) = AVf_REAL;
-    SvPVX(av) = (char*)ary;
-    AvFILL(av) = size - 1;
-    AvMAX(av) = size - 1;
-    for (i = 0; i < size; i++) {
-       assert (*strp);
-       ary[i] = NEWSV(7,0);
-       sv_setsv(ary[i], *strp);
-       strp++;
+    if (size) {                /* `defined' was returning undef for size==0 anyway. */
+       New(4,ary,size,SV*);
+       AvALLOC(av) = ary;
+       SvPVX(av) = (char*)ary;
+       AvFILLp(av) = size - 1;
+       AvMAX(av) = size - 1;
+       for (i = 0; i < size; i++) {
+           assert (*strp);
+           ary[i] = NEWSV(7,0);
+           sv_setsv(ary[i], *strp);
+           strp++;
+       }
     }
     return av;
 }
 
 AV *
-av_fake(size,strp)
-register I32 size;
-register SV **strp;
+av_fake(register I32 size, register SV **strp)
 {
     register AV *av;
     register SV** ary;
@@ -280,7 +309,7 @@ register SV **strp;
     Copy(strp,ary,size,SV*);
     AvFLAGS(av) = AVf_REIFY;
     SvPVX(av) = (char*)ary;
-    AvFILL(av) = size - 1;
+    AvFILLp(av) = size - 1;
     AvMAX(av) = size - 1;
     while (size--) {
        assert (*strp);
@@ -291,8 +320,7 @@ register SV **strp;
 }
 
 void
-av_clear(av)
-register AV *av;
+av_clear(register AV *av)
 {
     register I32 key;
     SV** ary;
@@ -302,13 +330,23 @@ register AV *av;
        warn("Attempt to clear deleted array");
     }
 #endif
-    if (!av || AvMAX(av) < 0)
+    if (!av)
        return;
     /*SUPPRESS 560*/
 
+    if (SvREADONLY(av))
+       croak(no_modify);
+
+    /* Give any tie a chance to cleanup first */
+    if (SvRMAGICAL(av))
+       mg_clear((SV*)av); 
+
+    if (AvMAX(av) < 0)
+       return;
+
     if (AvREAL(av)) {
        ary = AvARRAY(av);
-       key = AvFILL(av) + 1;
+       key = AvFILLp(av) + 1;
        while (key) {
            SvREFCNT_dec(ary[--key]);
            ary[key] = &sv_undef;
@@ -318,27 +356,32 @@ register AV *av;
        AvMAX(av) += key;
        SvPVX(av) = (char*)AvALLOC(av);
     }
-    AvFILL(av) = -1;
+    AvFILLp(av) = -1;
+
 }
 
 void
-av_undef(av)
-register AV *av;
+av_undef(register AV *av)
 {
     register I32 key;
 
     if (!av)
        return;
     /*SUPPRESS 560*/
+
+    /* Give any tie a chance to cleanup first */
+    if (SvRMAGICAL(av) && mg_find((SV*)av,'P')) 
+       av_fill(av, -1);   /* mg_clear() ? */
+
     if (AvREAL(av)) {
-       key = AvFILL(av) + 1;
+       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;
+    AvMAX(av) = AvFILLp(av) = -1;
     if (AvARYLEN(av)) {
        SvREFCNT_dec(AvARYLEN(av));
        AvARYLEN(av) = 0;
@@ -346,44 +389,93 @@ register AV *av;
 }
 
 void
-av_push(av,val)
-register AV *av;
-SV *val;
-{
+av_push(register AV *av, SV *val)
+{             
+    MAGIC *mg;
     if (!av)
        return;
-    av_store(av,AvFILL(av)+1,val);
+    if (SvREADONLY(av))
+       croak(no_modify);
+
+    if (SvRMAGICAL(av) && (mg = mg_find((SV*)av,'P'))) {
+       dSP;
+       PUSHSTACKi(PERLSI_MAGIC);
+       PUSHMARK(SP);
+       EXTEND(SP,2);
+       PUSHs(mg->mg_obj);
+       PUSHs(val);
+       PUTBACK;
+       ENTER;
+       perl_call_method("PUSH", G_SCALAR|G_DISCARD);
+       LEAVE;
+       POPSTACK;
+       return;
+    }
+    av_store(av,AvFILLp(av)+1,val);
 }
 
 SV *
-av_pop(av)
-register AV *av;
+av_pop(register AV *av)
 {
     SV *retval;
+    MAGIC* mg;
 
     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;
+    if (SvRMAGICAL(av) && (mg = mg_find((SV*)av,'P'))) {
+       dSP;    
+       PUSHSTACKi(PERLSI_MAGIC);
+       PUSHMARK(SP);
+       XPUSHs(mg->mg_obj);
+       PUTBACK;
+       ENTER;
+       if (perl_call_method("POP", G_SCALAR)) {
+           retval = newSVsv(*stack_sp--);    
+       } else {    
+           retval = &sv_undef;
+       }
+       LEAVE;
+       POPSTACK;
+       return retval;
+    }
+    retval = AvARRAY(av)[AvFILLp(av)];
+    AvARRAY(av)[AvFILLp(av)--] = &sv_undef;
     if (SvSMAGICAL(av))
        mg_set((SV*)av);
     return retval;
 }
 
 void
-av_unshift(av,num)
-register AV *av;
-register I32 num;
+av_unshift(register AV *av, register I32 num)
 {
     register I32 i;
-    register SV **sstr,**dstr;
+    register SV **ary;
+    MAGIC* mg;
 
     if (!av || num <= 0)
        return;
     if (SvREADONLY(av))
        croak(no_modify);
+
+    if (SvRMAGICAL(av) && (mg = mg_find((SV*)av,'P'))) {
+       dSP;
+       PUSHSTACKi(PERLSI_MAGIC);
+       PUSHMARK(SP);
+       EXTEND(SP,1+num);
+       PUSHs(mg->mg_obj);
+       while (num-- > 0) {
+           PUSHs(&sv_undef);
+       }
+       PUTBACK;
+       ENTER;
+       perl_call_method("UNSHIFT", G_SCALAR|G_DISCARD);
+       LEAVE;
+       POPSTACK;
+       return;
+    }
+
     if (!AvREAL(av) && AvREIFY(av))
        av_reify(av);
     i = AvARRAY(av) - AvALLOC(av);
@@ -393,67 +485,90 @@ register I32 num;
        num -= i;
     
        AvMAX(av) += i;
-       AvFILL(av) += i;
+       AvFILLp(av) += i;
        SvPVX(av) = (char*)(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;
+       i = AvFILLp(av);
+       av_extend(av, i + num);
+       AvFILLp(av) += num;
+       ary = AvARRAY(av);
+       Move(ary, ary + num, i + 1, SV*);
+       do {
+           ary[--num] = &sv_undef;
+       } while (num);
     }
 }
 
 SV *
-av_shift(av)
-register AV *av;
+av_shift(register AV *av)
 {
     SV *retval;
+    MAGIC* mg;
 
     if (!av || AvFILL(av) < 0)
        return &sv_undef;
     if (SvREADONLY(av))
        croak(no_modify);
+    if (SvRMAGICAL(av) && (mg = mg_find((SV*)av,'P'))) {
+       dSP;
+       PUSHSTACKi(PERLSI_MAGIC);
+       PUSHMARK(SP);
+       XPUSHs(mg->mg_obj);
+       PUTBACK;
+       ENTER;
+       if (perl_call_method("SHIFT", G_SCALAR)) {
+           retval = newSVsv(*stack_sp--);            
+       } else {    
+           retval = &sv_undef;
+       }     
+       LEAVE;
+       POPSTACK;
+       return retval;
+    }
     retval = *AvARRAY(av);
     if (AvREAL(av))
        *AvARRAY(av) = &sv_undef;
     SvPVX(av) = (char*)(AvARRAY(av) + 1);
     AvMAX(av)--;
-    AvFILL(av)--;
+    AvFILLp(av)--;
     if (SvSMAGICAL(av))
        mg_set((SV*)av);
     return retval;
 }
 
 I32
-av_len(av)
-register AV *av;
+av_len(register AV *av)
 {
     return AvFILL(av);
 }
 
 void
-av_fill(av, fill)
-register AV *av;
-I32 fill;
+av_fill(register AV *av, I32 fill)
 {
+    MAGIC *mg;
     if (!av)
        croak("panic: null array");
     if (fill < 0)
        fill = -1;
+    if (SvRMAGICAL(av) && (mg = mg_find((SV*)av,'P'))) {
+       dSP;            
+       ENTER;
+       SAVETMPS;
+       PUSHSTACKi(PERLSI_MAGIC);
+       PUSHMARK(SP);
+       EXTEND(SP,2);
+       PUSHs(mg->mg_obj);
+       PUSHs(sv_2mortal(newSViv(fill+1)));
+       PUTBACK;
+       perl_call_method("STORESIZE", G_SCALAR|G_DISCARD);
+       POPSTACK;
+       FREETMPS;
+       LEAVE;
+       return;
+    }
     if (fill <= AvMAX(av)) {
-       I32 key = AvFILL(av);
+       I32 key = AvFILLp(av);
        SV** ary = AvARRAY(av);
 
        if (AvREAL(av)) {
@@ -467,10 +582,77 @@ I32 fill;
                ary[++key] = &sv_undef;
        }
            
-       AvFILL(av) = fill;
+       AvFILLp(av) = fill;
        if (SvSMAGICAL(av))
            mg_set((SV*)av);
     }
     else
        (void)av_store(av,fill,&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 = 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;
+       }
+    }
+    croak("Can't coerce array into hash");
+    return Nullhv;
+}
+
+SV**
+avhv_fetch_ent(AV *av, SV *keysv, I32 lval, U32 hash)
+{
+    SV **indsvp;
+    HV *keys = avhv_keys(av);
+    HE *he;
+    
+    he = hv_fetch_ent(keys, keysv, FALSE, hash);
+    if (!he)
+        croak("No such array field");
+    return av_fetch(av, avhv_index_sv(HeVAL(he)), lval);
+}
+
+bool
+avhv_exists_ent(AV *av, SV *keysv, U32 hash)
+{
+    HV *keys = avhv_keys(av);
+    return hv_exists_ent(keys, keysv, hash);
+}
+
+HE *
+avhv_iternext(AV *av)
+{
+    HV *keys = avhv_keys(av);
+    return hv_iternext(keys);
+}
+
+SV *
+avhv_iterval(AV *av, register HE *entry)
+{
+    SV *sv = hv_iterval(avhv_keys(av), entry);
+    return *av_fetch(av, avhv_index_sv(sv), TRUE);
+}