Skip to content
This repository
tree: de6a984c5e
Fetching contributors…

Cannot retrieve contributors at this time

file 690 lines (456 sloc) 14.925 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
/*
Copyright (C) 2001-2011, Parrot Foundation.

=head1 NAME

src/pmc/resizablestringarray.pmc - resizable array for strings only

=head1 DESCRIPTION

ResizableStringArray implements a resizeable array which stores Parrot strings
only. Any ints or floats assigned to elements of the array will first be
converted to String PMCs and then to native Parrot strings. PMCs assigned to
to elements of the array will be stringified by having their C<get_string>
method called.

=cut

*/

/* HEADERIZER HFILE: none */
/* HEADERIZER BEGIN: static */
/* HEADERIZER END: static */

pmclass ResizableStringArray extends FixedStringArray auto_attrs provides array {
    ATTR UINTVAL resize_threshold; /*max capacity before resizing */

/*

=head2 Functions

=over 4

=item C<void init_int(INTVAL size)>

Initializes the array.

=cut

*/

    VTABLE void init_int(INTVAL size) {
        SUPER(size);
        if (size)
            SET_ATTR_resize_threshold(INTERP, SELF, size);
    }


/*

=item C<STRING *get_string_keyed_int(INTVAL key)>

Returns the Parrot string value of the element at index C<key>.

=cut

*/

    VTABLE STRING *get_string_keyed_int(INTVAL key) {

        STRING **str_array;
        INTVAL size;
        GET_ATTR_size(INTERP, SELF, size);

        if (key < 0) {
            if (key < -size)
                Parrot_ex_throw_from_c_args(INTERP, NULL, EXCEPTION_OUT_OF_BOUNDS,
                    "ResizableStringArray: index out of bounds!");
            else
                key += size;
        }

        if (key >= size)
            return CONST_STRING(INTERP, "");

        GET_ATTR_str_array(INTERP, SELF, str_array);

        if (!str_array[key])
            str_array[key] = Parrot_str_new(INTERP, NULL, 0);

        return str_array[key];
    }

/*

=item C<void set_string_keyed_int(INTVAL key, STRING *value)>

Sets the Parrot string value of the element at index C<key> to C<value>.

=cut

*/

    VTABLE void set_string_keyed_int(INTVAL key, STRING *value) {

        STRING **str_array;
        INTVAL size;
        GET_ATTR_size(INTERP, SELF, size);

        if (key < 0) {
            if (key < -size)
                Parrot_ex_throw_from_c_args(INTERP, NULL, EXCEPTION_OUT_OF_BOUNDS,
                    "ResizableStringArray: index out of bounds!");
            else
                key += size;
        }

        if (key >= size)
            SELF.set_integer_native(key+1);

        GET_ATTR_str_array(INTERP, SELF, str_array);
        str_array[key] = value;
    }

/*

=item C<void push_string(STRING *value)>

Extends the array by adding an element of value C<*value> to the end of
the array.

=cut

*/

    VTABLE void push_string(STRING *value) {
        INTVAL next_idx;
        GET_ATTR_size(INTERP, SELF, next_idx);
        SELF.set_string_keyed_int(next_idx, value);
    }

/*

=item C<STRING *pop_string()>

Removes and returns the last element in the array.

=cut

*/

    VTABLE STRING *pop_string() {
        STRING *value;
        INTVAL size;
        GET_ATTR_size(INTERP, SELF, size);

        if (size == 0)
            Parrot_ex_throw_from_c_args(INTERP, NULL, EXCEPTION_OUT_OF_BOUNDS,
                    "ResizableStringArray: Can't pop from an empty array!");

        value = SELF.get_string_keyed_int(size - 1);
        SELF.set_integer_native(size - 1);
        return value;
    }

/*

=item C<PMC *pop_pmc()>

Removes and returns the last element in the array.

=cut

*/

    VTABLE PMC *pop_pmc() {
        STRING *strval = SELF.pop_string();
        PMC *value = Parrot_pmc_new(INTERP, enum_class_String);

        VTABLE_set_string_native(INTERP, value, strval);

        return value;
    }

/*

=item C<INTVAL pop_integer()>

Removes and returns the last element in the array.

=cut

*/

    VTABLE INTVAL pop_integer() {
        PMC * const pmcval = SELF.pop_pmc();
        return VTABLE_get_integer(INTERP, pmcval);
    }

/*

=item C<FLOATVAL pop_float()>

Removes and returns the last element in the array.

=cut

*/

    VTABLE FLOATVAL pop_float() {
        PMC * const pmcval = SELF.pop_pmc();
        return VTABLE_get_number(INTERP, pmcval);
    }

/*

=item C<void set_integer_native(INTVAL size)>

Resizes the array to C<size> elements.

=cut

*/

    VTABLE void set_integer_native(INTVAL new_size) {

        STRING **str_array;
        INTVAL resize_threshold;

        if (new_size < 0)
            Parrot_ex_throw_from_c_args(INTERP, NULL, EXCEPTION_OUT_OF_BOUNDS,
                    "ResizableStringArray: Can't resize!");

        GET_ATTR_str_array(INTERP, SELF, str_array);
        GET_ATTR_resize_threshold(INTERP, SELF, resize_threshold);
        if (!str_array) {
            /* empty - used fixed routine */
            if (new_size < 8) {
                SUPER(8);
                SET_ATTR_size(INTERP, SELF, new_size);
                SET_ATTR_resize_threshold(INTERP, SELF, 8);
            }
            else {
                SUPER(new_size);
                SET_ATTR_resize_threshold(INTERP, SELF, new_size);
            }
        }
        else if (new_size <= resize_threshold) {
            /* zero out anything that was previously allocated
             * if we're growing the array */
            INTVAL old_size;
            GET_ATTR_size(INTERP, SELF, old_size);
            if (new_size > old_size) {
                INTVAL i;
                for (i = old_size; i < new_size; ++i)
                    str_array[i] = NULL;
            }

            SET_ATTR_size(INTERP, SELF, new_size);
            /* we could shrink here if necessary */
            return;
        }
        else {
            INTVAL i = resize_threshold;
            INTVAL cur = i;

            if (cur < 8192)
                cur = (new_size < 2 * cur) ? (2 * cur) : new_size;
            else {
                cur = new_size + 4096;
                cur &= ~0xfff;
            }

            SET_ATTR_str_array(INTERP, SELF,
                    mem_gc_realloc_n_typed_zeroed(INTERP, str_array,
                            cur, resize_threshold, STRING*));
            GET_ATTR_str_array(INTERP, SELF, str_array);

            for (; i < cur; ++i)
                str_array[i] = NULL;

            SET_ATTR_size(INTERP, SELF, new_size);
            SET_ATTR_resize_threshold(INTERP, SELF, cur);
        }
    }

/*

=item C<PMC *clone()>

Creates and returns a copy of the array.

=cut

*/

    VTABLE PMC *clone() {
        PMC * const copy = SUPER();
        INTVAL size;
        GET_ATTR_size(INTERP, SELF, size);
        /* copy trimmed extra space */
        SET_ATTR_resize_threshold(INTERP, copy, size);
        return copy;
    }

/*

=item C<STRING *shift_string()>

Removes and returns an item from the start of the array.

=cut

*/

    VTABLE STRING *shift_string() {
        STRING *value;
        INTVAL size;
        GET_ATTR_size(INTERP, SELF, size);

        if (size == 0)
            Parrot_ex_throw_from_c_args(INTERP, NULL, EXCEPTION_OUT_OF_BOUNDS,
                    "ResizableStringArray: Can't shift from an empty array!");

        value = SELF.get_string_keyed_int(0);
        SELF.delete_keyed_int(0);
        return value;
    }

/*

=item C<INTVAL shift_integer()>

Removes and returns the first element in the array.

=cut

*/

    VTABLE INTVAL shift_integer() {
        PMC * const pmcval = SELF.shift_pmc();
        return VTABLE_get_integer(INTERP, pmcval);
    }

/*

=item C<FLOATVAL shift_float()>

Removes and returns the first element in the array.

=cut

*/

    VTABLE FLOATVAL shift_float() {
        PMC * const pmcval = SELF.shift_pmc();
        return VTABLE_get_number(INTERP, pmcval);
    }


/*

=item C<void push_pmc(PMC *value)>

Extends the array by adding an element of value C<*value> to the end of
the array.

=cut

*/

    VTABLE void push_pmc(PMC *value) {
        STRING * const strvalue = VTABLE_get_string(INTERP, value);
        SELF.push_string(strvalue);
    }

/*

=item C<void push_integer(INTVAL value)>

Extends the array by adding an element of value C<*value> to the end of
the array.

=cut

*/

    VTABLE void push_integer(INTVAL value) {
        PMC * const ret = Parrot_pmc_new(INTERP, enum_class_String);
        STRING *val;

        VTABLE_set_integer_native(INTERP, ret, value);
        val = VTABLE_get_string(INTERP, ret);
        SELF.push_string(val);
    }

/*

=item C<void push_float(FLOAT value)>

Extends the array by adding an element of value C<*value> to the end of
the array.

=cut

*/

    VTABLE void push_float(FLOATVAL value) {
        PMC * const ret = Parrot_pmc_new(INTERP, enum_class_String);
        STRING *val;

        VTABLE_set_number_native(INTERP, ret, value);
        val = VTABLE_get_string(INTERP, ret);
        SELF.push_string(val);
    }

/*

=item C<PMC *shift_pmc()>

Removes and returns a String PMC from the start of the array.

=cut

*/

    VTABLE PMC *shift_pmc() {
        UINTVAL size;
        PMC *ret;
        STRING *value;

        GET_ATTR_size(INTERP, SELF, size);

        if (size == 0)
            Parrot_ex_throw_from_c_args(INTERP, NULL, EXCEPTION_OUT_OF_BOUNDS,
                    "ResizableStringArray: Can't shift from an empty array!");

        value = SELF.get_string_keyed_int(0);
        ret = Parrot_pmc_new(INTERP, enum_class_String);

        VTABLE_set_string_native(INTERP, ret, value);
        SELF.delete_keyed_int(0);

        return ret;
    }

/*

=item C<void unshift_string(STRING *value)>

Extends the array by adding an element of value C<*value> to the start
of the array.

=cut

*/

    VTABLE void unshift_string(STRING *value) {
        STRING **str_array;
        UINTVAL size, i;

        GET_ATTR_size(INTERP, SELF, size);
        SELF.set_integer_native(size + 1);

        GET_ATTR_str_array(INTERP, SELF, str_array);
        for (i = size; i; --i)
            str_array[i] = str_array[i - 1];

        SELF.set_string_keyed_int(0, value);
    }


/*

=item C<void unshift_pmc(PMC *value)>

Extends the array by adding an element of value C<*value> to the front of
the array.

=cut

*/

    VTABLE void unshift_pmc(PMC *value) {
        STRING * const strvalue = VTABLE_get_string(INTERP, value);
        SELF.unshift_string(strvalue);
    }

/*

=item C<void unshift_integer(INTVAL value)>

Extends the array by adding an element of value C<*value> to the front of
the array.

=cut

*/

    VTABLE void unshift_integer(INTVAL value) {
        PMC * const ret = Parrot_pmc_new(INTERP, enum_class_String);
        STRING *val;

        VTABLE_set_integer_native(INTERP, ret, value);
        val = VTABLE_get_string(INTERP, ret);
        SELF.unshift_string(val);
    }

/*

=item C<void unshift_float(FLOAT value)>

Extends the array by adding an element of value C<*value> to the front of
the array.

=cut

*/

    VTABLE void unshift_float(FLOATVAL value) {
        PMC * const ret = Parrot_pmc_new(INTERP, enum_class_String);
        STRING *val;

        VTABLE_set_number_native(INTERP, ret, value);
        val = VTABLE_get_string(INTERP, ret);
        SELF.unshift_string(val);
    }

/*

=item C<void delete_keyed_int(INTVAL key)>

Converts C<key> to a PMC key and calls C<delete_keyed()> with it.

=cut

*/

    VTABLE void delete_keyed_int(INTVAL key) {
        STRING **str_array;
        UINTVAL size, i;

        GET_ATTR_str_array(INTERP, SELF, str_array);
        GET_ATTR_size(INTERP, SELF, size);

        for (i = key; i < size - 1; ++i)
            str_array[i] = str_array[i + 1];

        SELF.set_integer_native(size - 1);
    }

/*

=item C<void delete_keyed(PMC *key)>

Removes the element at C<*key>.

=cut

*/

    VTABLE void delete_keyed(PMC *key) {
        const INTVAL idx = VTABLE_get_integer(INTERP, key);
        STRING **str_array;
        UINTVAL size, i;

        GET_ATTR_str_array(INTERP, SELF, str_array);
        GET_ATTR_size(INTERP, SELF, size);

        for (i = idx; i < size - 1; ++i)
            str_array[i] = str_array[i + 1];

        SELF.set_integer_native(size - 1);
    }

/*

=item C<void splice(PMC *value, INTVAL offset, INTVAL count)>

Replaces C<count> elements starting at C<offset> with the elements in
C<value>.

Note that the C<value> PMC can be of any of the various array types.

Note that this implementation can be *VERY *inefficient as it manipulates
everything via the VTABLE api.

=cut

*/

    VTABLE void splice(PMC *value, INTVAL offset, INTVAL count) {

        INTVAL length, elems, shift, i;

        if (value->vtable->base_type != SELF->vtable->base_type &&
                value->vtable->base_type != enum_class_FixedStringArray)
            Parrot_ex_throw_from_c_args(INTERP, NULL, EXCEPTION_INVALID_OPERATION,
                    "ResizableStringArray: illegal type for splice!");

        length = VTABLE_elements(INTERP, SELF);
        elems = VTABLE_elements(INTERP, value);
        shift = elems - count;

        /* start from end? */
        if (offset < 0)
            offset += length;

        if (offset < 0)
            Parrot_ex_throw_from_c_args(INTERP, NULL, EXCEPTION_OUT_OF_BOUNDS,
                "illegal splice offset\n");

        /* shrink the array */
        if (shift < 0) {
            /* start at offset so we don't overwrite values we'll need */
            for (i = offset+count; i < length; ++i)
                VTABLE_set_pmc_keyed_int(INTERP, SELF, i + shift,
                    VTABLE_get_pmc_keyed_int(INTERP, SELF, i));

            SELF.set_integer_native(length + shift);
        }
        /* grow the array */
        else if (shift > 0) {
            SELF.set_integer_native(length + shift);

            /* move the existing values */
            /* start at length-1 so we don't overwrite values we'll need */
            for (i = length - 1; i >= offset; --i)
                VTABLE_set_pmc_keyed_int(INTERP, SELF, i + shift,
                    VTABLE_get_pmc_keyed_int(INTERP, SELF, i));
        }

        /* copy the new values */
        for (i = 0; i < elems; ++i)
            VTABLE_set_pmc_keyed_int(INTERP, SELF, i + offset,
                VTABLE_get_pmc_keyed_int(INTERP, value, i));
    }

/*

=item METHOD PMC* shift()

=item METHOD PMC* pop()

Method forms to remove and return a PMC from the beginning or
end of the array.

=cut

*/

    METHOD shift() {
        PMC * const value = SELF.shift_pmc();
        RETURN(PMC *value);
    }

    METHOD pop() {
        PMC * const value = SELF.pop_pmc();
        RETURN(PMC *value);
    }

/*

=item METHOD unshift(PMC* value)

=item METHOD push(PMC* value)

Method forms to add a PMC to the beginning or end of the array.

=cut

*/

    METHOD unshift(PMC* value) {
        SELF.unshift_pmc(value);
    }

    METHOD push(PMC* value) {
        SELF.push_pmc(value);
    }

}

/*

=back

=head1 SEE ALSO

F<docs/pdds/pdd17_basic_types.pod>.

=cut

*/

/*
 * Local variables:
 * c-file-style: "parrot"
 * End:
 * vim: expandtab shiftwidth=4 cinoptions='\:2=2' :
 */
Something went wrong with that request. Please try again.