av.c

   1 /*    av.c
   2  *
   3  *    Copyright (c) 1991-1994, Larry Wall
   4  *
   5  *    You may distribute under the terms of either the GNU General Public
   6  *    License or the Artistic License, as specified in the README file.
   7  *
   8  */
   9
  10 /*
  11  * "...for the Entwives desired order, and plenty, and peace (by which they
  12  * meant that things should remain where they had set them)." --Treebeard
  13  */
  14
  15 #include "EXTERN.h"
  16 #include "perl.h"
  17
  18 static void     av_reify _((AV* av));
  19
  20 static void
  21 av_reify(av)
  22 AV* av;
  23 {
  24     I32 key;
  25     SV* sv;
  26
  27     key = AvMAX(av) + 1;
  28     while (key > AvFILL(av) + 1)
  29         AvARRAY(av)[--key] = &sv_undef;
  30     while (key) {
  31         sv = AvARRAY(av)[--key];
  32         assert(sv);
  33         if (sv != &sv_undef)
  34             (void)SvREFCNT_inc(sv);
  35     }
  36     AvREAL_on(av);
  37 }
  38
  39 void
  40 av_extend(av,key)
  41 AV *av;
  42 I32 key;
  43 {
  44     if (key > AvMAX(av)) {
  45         SV** ary;
  46         I32 tmp;
  47         I32 newmax;
  48
  49         if (AvALLOC(av) != AvARRAY(av)) {
  50             ary = AvALLOC(av) + AvFILL(av) + 1;
  51             tmp = AvARRAY(av) - AvALLOC(av);
  52             Move(AvARRAY(av), AvALLOC(av), AvFILL(av)+1, SV*);
  53             AvMAX(av) += tmp;
  54             SvPVX(av) = (char*)AvALLOC(av);
  55             if (AvREAL(av)) {
  56                 while (tmp)
  57                     ary[--tmp] = &sv_undef;
  58             }
  59
  60             if (key > AvMAX(av) - 10) {
  61                 newmax = key + AvMAX(av);
  62                 goto resize;
  63             }
  64         }
  65         else {
  66             if (AvALLOC(av)) {
  67 #ifndef STRANGE_MALLOC
  68                 U32 bytes;
  69 #endif
  70
  71                 newmax = key + AvMAX(av) / 5;
  72               resize:
  73 #ifdef STRANGE_MALLOC
  74                 Renew(AvALLOC(av),newmax+1, SV*);
  75 #else
  76                 bytes = (newmax + 1) * sizeof(SV*);
  77 #define MALLOC_OVERHEAD 16
  78                 tmp = MALLOC_OVERHEAD;
  79                 while (tmp - MALLOC_OVERHEAD < bytes)
  80                     tmp += tmp;
  81                 tmp -= MALLOC_OVERHEAD;
  82                 tmp /= sizeof(SV*);
  83                 assert(tmp > newmax);
  84                 newmax = tmp - 1;
  85                 New(2,ary, newmax+1, SV*);
  86                 Copy(AvALLOC(av), ary, AvMAX(av)+1, SV*);
  87                 if (AvMAX(av) > 64 && !nice_chunk) {
  88                     nice_chunk = (char*)AvALLOC(av);
  89                     nice_chunk_size = (AvMAX(av) + 1) * sizeof(SV*);
  90                 }
  91                 else
  92                     Safefree(AvALLOC(av));
  93                 AvALLOC(av) = ary;
  94 #endif
  95                 ary = AvALLOC(av) + AvMAX(av) + 1;
  96                 tmp = newmax - AvMAX(av);
  97                 if (av == curstack) {   /* Oops, grew stack (via av_store()?) */
  98                     stack_sp = AvALLOC(av) + (stack_sp - stack_base);
  99                     stack_base = AvALLOC(av);
 100                     stack_max = stack_base + newmax;
 101                 }
 102             }
 103             else {
 104                 newmax = key < 4 ? 4 : key;
 105                 New(2,AvALLOC(av), newmax+1, SV*);
 106                 ary = AvALLOC(av) + 1;
 107                 tmp = newmax;
 108                 AvALLOC(av)[0] = &sv_undef;     /* For the stacks */
 109             }
 110             if (AvREAL(av)) {
 111                 while (tmp)
 112                     ary[--tmp] = &sv_undef;
 113             }
 114
 115             SvPVX(av) = (char*)AvALLOC(av);
 116             AvMAX(av) = newmax;
 117         }
 118     }
 119 }
 120
 121 SV**
 122 av_fetch(av,key,lval)
 123 register AV *av;
 124 I32 key;
 125 I32 lval;
 126 {
 127     SV *sv;
 128
 129     if (!av)
 130         return 0;
 131
 132     if (SvRMAGICAL(av)) {
 133         if (mg_find((SV*)av,'P')) {
 134             sv = sv_newmortal();
 135             mg_copy((SV*)av, sv, 0, key);
 136             Sv = sv;
 137             return &Sv;
 138         }
 139     }
 140
 141     if (key < 0) {
 142         key += AvFILL(av) + 1;
 143         if (key < 0)
 144             return 0;
 145     }
 146     else if (key > AvFILL(av)) {
 147         if (!lval)
 148             return 0;
 149         if (AvREALISH(av))
 150             sv = NEWSV(5,0);
 151         else
 152             sv = sv_newmortal();
 153         return av_store(av,key,sv);
 154     }
 155     if (AvARRAY(av)[key] == &sv_undef) {
 156     emptyness:
 157         if (lval) {
 158             sv = NEWSV(6,0);
 159             return av_store(av,key,sv);
 160         }
 161         return 0;
 162     }
 163     else if (AvREIFY(av)
 164              && (!AvARRAY(av)[key]      /* eg. @_ could have freed elts */
 165                  || SvTYPE(AvARRAY(av)[key]) == SVTYPEMASK)) {
 166         AvARRAY(av)[key] = &sv_undef;   /* 1/2 reify */
 167         goto emptyness;
 168     }
 169     return &AvARRAY(av)[key];
 170 }
 171
 172 SV**
 173 av_store(av,key,val)
 174 register AV *av;
 175 I32 key;
 176 SV *val;
 177 {
 178     SV** ary;
 179
 180     if (!av)
 181         return 0;
 182     if (!val)
 183         val = &sv_undef;
 184
 185     if (SvRMAGICAL(av)) {
 186         if (mg_find((SV*)av,'P')) {
 187             if (val != &sv_undef)
 188                 mg_copy((SV*)av, val, 0, key);
 189             return 0;
 190         }
 191     }
 192
 193     if (key < 0) {
 194         key += AvFILL(av) + 1;
 195         if (key < 0)
 196             return 0;
 197     }
 198     if (SvREADONLY(av) && key >= AvFILL(av))
 199         croak(no_modify);
 200     if (key > AvMAX(av))
 201         av_extend(av,key);
 202     if (!AvREAL(av) && AvREIFY(av))
 203         av_reify(av);
 204     ary = AvARRAY(av);
 205     if (AvFILL(av) < key) {
 206         if (!AvREAL(av)) {
 207             if (av == curstack && key > stack_sp - stack_base)
 208                 stack_sp = stack_base + key;    /* XPUSH in disguise */
 209             do
 210                 ary[++AvFILL(av)] = &sv_undef;
 211             while (AvFILL(av) < key);
 212         }
 213         AvFILL(av) = key;
 214     }
 215     else if (AvREAL(av))
 216         SvREFCNT_dec(ary[key]);
 217     ary[key] = val;
 218     if (SvSMAGICAL(av)) {
 219         if (val != &sv_undef) {
 220             MAGIC* mg = SvMAGIC(av);
 221             sv_magic(val, (SV*)av, toLOWER(mg->mg_type), 0, key);
 222         }
 223         mg_set((SV*)av);
 224     }
 225     return &ary[key];
 226 }
 227
 228 AV *
 229 newAV()
 230 {
 231     register AV *av;
 232
 233     av = (AV*)NEWSV(3,0);
 234     sv_upgrade((SV *)av, SVt_PVAV);
 235     AvREAL_on(av);
 236     AvALLOC(av) = 0;
 237     SvPVX(av) = 0;
 238     AvMAX(av) = AvFILL(av) = -1;
 239     return av;
 240 }
 241
 242 AV *
 243 av_make(size,strp)
 244 register I32 size;
 245 register SV **strp;
 246 {
 247     register AV *av;
 248     register I32 i;
 249     register SV** ary;
 250
 251     av = (AV*)NEWSV(8,0);
 252     sv_upgrade((SV *) av,SVt_PVAV);
 253     New(4,ary,size+1,SV*);
 254     AvALLOC(av) = ary;
 255     AvFLAGS(av) = AVf_REAL;
 256     SvPVX(av) = (char*)ary;
 257     AvFILL(av) = size - 1;
 258     AvMAX(av) = size - 1;
 259     for (i = 0; i < size; i++) {
 260         assert (*strp);
 261         ary[i] = NEWSV(7,0);
 262         sv_setsv(ary[i], *strp);
 263         strp++;
 264     }
 265     return av;
 266 }
 267
 268 AV *
 269 av_fake(size,strp)
 270 register I32 size;
 271 register SV **strp;
 272 {
 273     register AV *av;
 274     register SV** ary;
 275
 276     av = (AV*)NEWSV(9,0);
 277     sv_upgrade((SV *)av, SVt_PVAV);
 278     New(4,ary,size+1,SV*);
 279     AvALLOC(av) = ary;
 280     Copy(strp,ary,size,SV*);
 281     AvFLAGS(av) = AVf_REIFY;
 282     SvPVX(av) = (char*)ary;
 283     AvFILL(av) = size - 1;
 284     AvMAX(av) = size - 1;
 285     while (size--) {
 286         assert (*strp);
 287         SvTEMP_off(*strp);
 288         strp++;
 289     }
 290     return av;
 291 }
 292
 293 void
 294 av_clear(av)
 295 register AV *av;
 296 {
 297     register I32 key;
 298     SV** ary;
 299
 300 #ifdef DEBUGGING
 301     if (SvREFCNT(av) <= 0) {
 302         warn("Attempt to clear deleted array");
 303     }
 304 #endif
 305     if (!av || AvMAX(av) < 0)
 306         return;
 307     /*SUPPRESS 560*/
 308
 309     if (AvREAL(av)) {
 310         ary = AvARRAY(av);
 311         key = AvFILL(av) + 1;
 312         while (key) {
 313             SvREFCNT_dec(ary[--key]);
 314             ary[key] = &sv_undef;
 315         }
 316     }
 317     if (key = AvARRAY(av) - AvALLOC(av)) {
 318         AvMAX(av) += key;
 319         SvPVX(av) = (char*)AvALLOC(av);
 320     }
 321     AvFILL(av) = -1;
 322 }
 323
 324 void
 325 av_undef(av)
 326 register AV *av;
 327 {
 328     register I32 key;
 329
 330     if (!av)
 331         return;
 332     /*SUPPRESS 560*/
 333     if (AvREAL(av)) {
 334         key = AvFILL(av) + 1;
 335         while (key)
 336             SvREFCNT_dec(AvARRAY(av)[--key]);
 337     }
 338     Safefree(AvALLOC(av));
 339     AvALLOC(av) = 0;
 340     SvPVX(av) = 0;
 341     AvMAX(av) = AvFILL(av) = -1;
 342     if (AvARYLEN(av)) {
 343         SvREFCNT_dec(AvARYLEN(av));
 344         AvARYLEN(av) = 0;
 345     }
 346 }
 347
 348 void
 349 av_push(av,val)
 350 register AV *av;
 351 SV *val;
 352 {
 353     if (!av)
 354         return;
 355     av_store(av,AvFILL(av)+1,val);
 356 }
 357
 358 SV *
 359 av_pop(av)
 360 register AV *av;
 361 {
 362     SV *retval;
 363
 364     if (!av || AvFILL(av) < 0)
 365         return &sv_undef;
 366     if (SvREADONLY(av))
 367         croak(no_modify);
 368     retval = AvARRAY(av)[AvFILL(av)];
 369     AvARRAY(av)[AvFILL(av)--] = &sv_undef;
 370     if (SvSMAGICAL(av))
 371         mg_set((SV*)av);
 372     return retval;
 373 }
 374
 375 void
 376 av_unshift(av,num)
 377 register AV *av;
 378 register I32 num;
 379 {
 380     register I32 i;
 381     register SV **sstr,**dstr;
 382
 383     if (!av || num <= 0)
 384         return;
 385     if (SvREADONLY(av))
 386         croak(no_modify);
 387     if (!AvREAL(av) && AvREIFY(av))
 388         av_reify(av);
 389     i = AvARRAY(av) - AvALLOC(av);
 390     if (i) {
 391         if (i > num)
 392             i = num;
 393         num -= i;
 394
 395         AvMAX(av) += i;
 396         AvFILL(av) += i;
 397         SvPVX(av) = (char*)(AvARRAY(av) - i);
 398     }
 399     if (num) {
 400         av_extend(av,AvFILL(av)+num);
 401         AvFILL(av) += num;
 402         dstr = AvARRAY(av) + AvFILL(av);
 403         sstr = dstr - num;
 404 #ifdef BUGGY_MSC5
 405  # pragma loop_opt(off) /* don't loop-optimize the following code */
 406 #endif /* BUGGY_MSC5 */
 407         for (i = AvFILL(av) - num; i >= 0; --i) {
 408             *dstr-- = *sstr--;
 409 #ifdef BUGGY_MSC5
 410  # pragma loop_opt()    /* loop-optimization back to command-line setting */
 411 #endif /* BUGGY_MSC5 */
 412         }
 413         while (num)
 414             AvARRAY(av)[--num] = &sv_undef;
 415     }
 416 }
 417
 418 SV *
 419 av_shift(av)
 420 register AV *av;
 421 {
 422     SV *retval;
 423
 424     if (!av || AvFILL(av) < 0)
 425         return &sv_undef;
 426     if (SvREADONLY(av))
 427         croak(no_modify);
 428     retval = *AvARRAY(av);
 429     if (AvREAL(av))
 430         *AvARRAY(av) = &sv_undef;
 431     SvPVX(av) = (char*)(AvARRAY(av) + 1);
 432     AvMAX(av)--;
 433     AvFILL(av)--;
 434     if (SvSMAGICAL(av))
 435         mg_set((SV*)av);
 436     return retval;
 437 }
 438
 439 I32
 440 av_len(av)
 441 register AV *av;
 442 {
 443     return AvFILL(av);
 444 }
 445
 446 void
 447 av_fill(av, fill)
 448 register AV *av;
 449 I32 fill;
 450 {
 451     if (!av)
 452         croak("panic: null array");
 453     if (fill < 0)
 454         fill = -1;
 455     if (fill <= AvMAX(av)) {
 456         I32 key = AvFILL(av);
 457         SV** ary = AvARRAY(av);
 458
 459         if (AvREAL(av)) {
 460             while (key > fill) {
 461                 SvREFCNT_dec(ary[key]);
 462                 ary[key--] = &sv_undef;
 463             }
 464         }
 465         else {
 466             while (key < fill)
 467                 ary[++key] = &sv_undef;
 468         }
 469
 470         AvFILL(av) = fill;
 471         if (SvSMAGICAL(av))
 472             mg_set((SV*)av);
 473     }
 474     else
 475         (void)av_store(av,fill,&sv_undef);
 476 }