2 ** array.c - Array class
4 ** See Copyright Notice in mruby.h
8 #include <mruby/array.h>
9 #include <mruby/class.h>
10 #include <mruby/string.h>
11 #include <mruby/range.h>
12 #include "value_array.h"
14 #define ARY_DEFAULT_LEN 4
15 #define ARY_SHRINK_RATIO 5 /* must be larger than 2 */
16 #define ARY_C_MAX_SIZE (SIZE_MAX / sizeof(mrb_value))
17 #define ARY_MAX_SIZE ((mrb_int)((ARY_C_MAX_SIZE < (size_t)MRB_INT_MAX) ? ARY_C_MAX_SIZE : MRB_INT_MAX-1))
20 ary_new_capa(mrb_state *mrb, mrb_int capa)
25 if (capa > ARY_MAX_SIZE) {
26 mrb_raise(mrb, E_ARGUMENT_ERROR, "array size too big");
28 blen = capa * sizeof(mrb_value);
30 a = (struct RArray*)mrb_obj_alloc(mrb, MRB_TT_ARRAY, mrb->array_class);
31 if (capa <= MRB_ARY_EMBED_LEN_MAX) {
32 ARY_SET_EMBED_LEN(a, 0);
35 a->as.heap.ptr = (mrb_value *)mrb_malloc(mrb, blen);
36 a->as.heap.aux.capa = capa;
44 mrb_ary_new_capa(mrb_state *mrb, mrb_int capa)
46 struct RArray *a = ary_new_capa(mrb, capa);
47 return mrb_obj_value(a);
51 mrb_ary_new(mrb_state *mrb)
53 return mrb_ary_new_capa(mrb, 0);
57 * to copy array, use this instead of memcpy because of portability
58 * * gcc on ARM may fail optimization of memcpy
59 * http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.faqs/ka3934.html
60 * * gcc on MIPS also fail
61 * http://gcc.gnu.org/bugzilla/show_bug.cgi?id=39755
62 * * memcpy doesn't exist on freestanding environment
64 * If you optimize for binary size, use memcpy instead of this at your own risk
65 * of above portability issue.
67 * see also http://togetter.com/li/462898
71 array_copy(mrb_value *dst, const mrb_value *src, mrb_int size)
75 for (i = 0; i < size; i++) {
81 ary_new_from_values(mrb_state *mrb, mrb_int size, const mrb_value *vals)
83 struct RArray *a = ary_new_capa(mrb, size);
85 array_copy(ARY_PTR(a), vals, size);
92 mrb_ary_new_from_values(mrb_state *mrb, mrb_int size, const mrb_value *vals)
94 struct RArray *a = ary_new_from_values(mrb, size, vals);
95 return mrb_obj_value(a);
99 mrb_assoc_new(mrb_state *mrb, mrb_value car, mrb_value cdr)
103 a = ary_new_capa(mrb, 2);
107 return mrb_obj_value(a);
111 ary_fill_with_nil(mrb_value *ptr, mrb_int size)
113 mrb_value nil = mrb_nil_value();
121 ary_modify_check(mrb_state *mrb, struct RArray *a)
123 if (MRB_FROZEN_P(a)) {
124 mrb_raise(mrb, E_FROZEN_ERROR, "can't modify frozen array");
129 ary_modify(mrb_state *mrb, struct RArray *a)
131 ary_modify_check(mrb, a);
133 if (ARY_SHARED_P(a)) {
134 mrb_shared_array *shared = a->as.heap.aux.shared;
136 if (shared->refcnt == 1 && a->as.heap.ptr == shared->ptr) {
137 a->as.heap.ptr = shared->ptr;
138 a->as.heap.aux.capa = a->as.heap.len;
139 mrb_free(mrb, shared);
146 len = a->as.heap.len * sizeof(mrb_value);
147 ptr = (mrb_value *)mrb_malloc(mrb, len);
149 array_copy(ptr, p, a->as.heap.len);
151 a->as.heap.ptr = ptr;
152 a->as.heap.aux.capa = a->as.heap.len;
153 mrb_ary_decref(mrb, shared);
155 ARY_UNSET_SHARED_FLAG(a);
160 mrb_ary_modify(mrb_state *mrb, struct RArray* a)
162 mrb_write_barrier(mrb, (struct RBasic*)a);
167 ary_make_shared(mrb_state *mrb, struct RArray *a)
169 if (!ARY_SHARED_P(a) && !ARY_EMBED_P(a)) {
170 mrb_shared_array *shared = (mrb_shared_array *)mrb_malloc(mrb, sizeof(mrb_shared_array));
171 mrb_value *ptr = a->as.heap.ptr;
172 mrb_int len = a->as.heap.len;
175 if (a->as.heap.aux.capa > len) {
176 a->as.heap.ptr = shared->ptr = (mrb_value *)mrb_realloc(mrb, ptr, sizeof(mrb_value)*len+1);
182 a->as.heap.aux.shared = shared;
183 ARY_SET_SHARED_FLAG(a);
188 ary_expand_capa(mrb_state *mrb, struct RArray *a, mrb_int len)
190 mrb_int capa = ARY_CAPA(a);
192 if (len > ARY_MAX_SIZE || len < 0) {
194 mrb_raise(mrb, E_ARGUMENT_ERROR, "array size too big");
197 if (capa < ARY_DEFAULT_LEN) {
198 capa = ARY_DEFAULT_LEN;
201 if (capa <= ARY_MAX_SIZE / 2) {
208 if (capa < len || capa > ARY_MAX_SIZE) {
212 if (ARY_EMBED_P(a)) {
213 mrb_value *ptr = ARY_EMBED_PTR(a);
214 mrb_int len = ARY_EMBED_LEN(a);
215 mrb_value *expanded_ptr = (mrb_value *)mrb_malloc(mrb, sizeof(mrb_value)*capa);
217 ARY_UNSET_EMBED_FLAG(a);
218 array_copy(expanded_ptr, ptr, len);
219 a->as.heap.len = len;
220 a->as.heap.aux.capa = capa;
221 a->as.heap.ptr = expanded_ptr;
223 else if (capa > a->as.heap.aux.capa) {
224 mrb_value *expanded_ptr = (mrb_value *)mrb_realloc(mrb, a->as.heap.ptr, sizeof(mrb_value)*capa);
226 a->as.heap.aux.capa = capa;
227 a->as.heap.ptr = expanded_ptr;
232 ary_shrink_capa(mrb_state *mrb, struct RArray *a)
237 if (ARY_EMBED_P(a)) return;
239 capa = a->as.heap.aux.capa;
240 if (capa < ARY_DEFAULT_LEN * 2) return;
241 if (capa <= a->as.heap.len * ARY_SHRINK_RATIO) return;
245 if (capa < ARY_DEFAULT_LEN) {
246 capa = ARY_DEFAULT_LEN;
249 } while (capa > a->as.heap.len * ARY_SHRINK_RATIO);
251 if (capa > a->as.heap.len && capa < a->as.heap.aux.capa) {
252 a->as.heap.aux.capa = capa;
253 a->as.heap.ptr = (mrb_value *)mrb_realloc(mrb, a->as.heap.ptr, sizeof(mrb_value)*capa);
258 mrb_ary_resize(mrb_state *mrb, mrb_value ary, mrb_int new_len)
261 struct RArray *a = mrb_ary_ptr(ary);
264 old_len = RARRAY_LEN(ary);
265 if (old_len != new_len) {
266 if (new_len < old_len) {
267 ary_shrink_capa(mrb, a);
270 ary_expand_capa(mrb, a, new_len);
271 ary_fill_with_nil(ARY_PTR(a) + old_len, new_len - old_len);
273 ARY_SET_LEN(a, new_len);
280 mrb_ary_s_create(mrb_state *mrb, mrb_value klass)
287 mrb_get_args(mrb, "*!", &vals, &len);
288 ary = mrb_ary_new_from_values(mrb, len, vals);
289 a = mrb_ary_ptr(ary);
290 a->c = mrb_class_ptr(klass);
295 static void ary_replace(mrb_state*, struct RArray*, struct RArray*);
298 ary_concat(mrb_state *mrb, struct RArray *a, struct RArray *a2)
302 if (ARY_LEN(a) == 0) {
303 ary_replace(mrb, a, a2);
306 if (ARY_LEN(a2) > ARY_MAX_SIZE - ARY_LEN(a)) {
307 mrb_raise(mrb, E_ARGUMENT_ERROR, "array size too big");
309 len = ARY_LEN(a) + ARY_LEN(a2);
312 if (ARY_CAPA(a) < len) {
313 ary_expand_capa(mrb, a, len);
315 array_copy(ARY_PTR(a)+ARY_LEN(a), ARY_PTR(a2), ARY_LEN(a2));
316 mrb_write_barrier(mrb, (struct RBasic*)a);
321 mrb_ary_concat(mrb_state *mrb, mrb_value self, mrb_value other)
323 struct RArray *a2 = mrb_ary_ptr(other);
325 ary_concat(mrb, mrb_ary_ptr(self), a2);
329 mrb_ary_concat_m(mrb_state *mrb, mrb_value self)
333 mrb_get_args(mrb, "A", &ary);
334 mrb_ary_concat(mrb, self, ary);
339 mrb_ary_plus(mrb_state *mrb, mrb_value self)
341 struct RArray *a1 = mrb_ary_ptr(self);
346 mrb_get_args(mrb, "a", &ptr, &blen);
347 if (ARY_MAX_SIZE - blen < ARY_LEN(a1)) {
348 mrb_raise(mrb, E_ARGUMENT_ERROR, "array size too big");
351 a2 = ary_new_capa(mrb, len1 + blen);
352 array_copy(ARY_PTR(a2), ARY_PTR(a1), len1);
353 array_copy(ARY_PTR(a2) + len1, ptr, blen);
354 ARY_SET_LEN(a2, len1+blen);
356 return mrb_obj_value(a2);
359 #define ARY_REPLACE_SHARED_MIN 20
362 ary_replace(mrb_state *mrb, struct RArray *a, struct RArray *b)
364 mrb_int len = ARY_LEN(b);
366 ary_modify_check(mrb, a);
368 if (ARY_SHARED_P(a)) {
369 mrb_ary_decref(mrb, a->as.heap.aux.shared);
370 a->as.heap.aux.capa = 0;
372 a->as.heap.ptr = NULL;
373 ARY_UNSET_SHARED_FLAG(a);
375 if (ARY_SHARED_P(b)) {
377 if (ARY_EMBED_P(a)) {
378 ARY_UNSET_EMBED_FLAG(a);
381 mrb_free(mrb, a->as.heap.ptr);
383 a->as.heap.ptr = b->as.heap.ptr;
384 a->as.heap.len = len;
385 a->as.heap.aux.shared = b->as.heap.aux.shared;
386 a->as.heap.aux.shared->refcnt++;
387 ARY_SET_SHARED_FLAG(a);
388 mrb_write_barrier(mrb, (struct RBasic*)a);
391 if (!MRB_FROZEN_P(b) && len > ARY_REPLACE_SHARED_MIN) {
392 ary_make_shared(mrb, b);
395 if (ARY_CAPA(a) < len)
396 ary_expand_capa(mrb, a, len);
397 array_copy(ARY_PTR(a), ARY_PTR(b), len);
398 mrb_write_barrier(mrb, (struct RBasic*)a);
403 mrb_ary_replace(mrb_state *mrb, mrb_value self, mrb_value other)
405 struct RArray *a1 = mrb_ary_ptr(self);
406 struct RArray *a2 = mrb_ary_ptr(other);
409 ary_replace(mrb, a1, a2);
414 mrb_ary_replace_m(mrb_state *mrb, mrb_value self)
418 mrb_get_args(mrb, "A", &other);
419 mrb_ary_replace(mrb, self, other);
425 mrb_ary_times(mrb_state *mrb, mrb_value self)
427 struct RArray *a1 = mrb_ary_ptr(self);
432 mrb_get_args(mrb, "i", ×);
434 mrb_raise(mrb, E_ARGUMENT_ERROR, "negative argument");
436 if (times == 0) return mrb_ary_new(mrb);
437 if (ARY_MAX_SIZE / times < ARY_LEN(a1)) {
438 mrb_raise(mrb, E_ARGUMENT_ERROR, "array size too big");
441 a2 = ary_new_capa(mrb, len1 * times);
442 ARY_SET_LEN(a2, len1 * times);
445 array_copy(ptr, ARY_PTR(a1), len1);
449 return mrb_obj_value(a2);
453 mrb_ary_reverse_bang(mrb_state *mrb, mrb_value self)
455 struct RArray *a = mrb_ary_ptr(self);
456 mrb_int len = ARY_LEN(a);
475 mrb_ary_reverse(mrb_state *mrb, mrb_value self)
477 struct RArray *a = mrb_ary_ptr(self), *b = ary_new_capa(mrb, ARY_LEN(a));
478 mrb_int len = ARY_LEN(a);
481 mrb_value *p1, *p2, *e;
485 p2 = ARY_PTR(b) + len - 1;
491 return mrb_obj_value(b);
495 mrb_ary_push(mrb_state *mrb, mrb_value ary, mrb_value elem)
497 struct RArray *a = mrb_ary_ptr(ary);
498 mrb_int len = ARY_LEN(a);
501 if (len == ARY_CAPA(a))
502 ary_expand_capa(mrb, a, len + 1);
503 ARY_PTR(a)[len] = elem;
504 ARY_SET_LEN(a, len+1);
505 mrb_field_write_barrier_value(mrb, (struct RBasic*)a, elem);
509 mrb_ary_push_m(mrb_state *mrb, mrb_value self)
512 mrb_int len, len2, alen;
515 mrb_get_args(mrb, "*!", &argv, &alen);
516 a = mrb_ary_ptr(self);
520 if (ARY_CAPA(a) < len2) {
521 ary_expand_capa(mrb, a, len2);
523 array_copy(ARY_PTR(a)+len, argv, alen);
524 ARY_SET_LEN(a, len2);
525 mrb_write_barrier(mrb, (struct RBasic*)a);
531 mrb_ary_pop(mrb_state *mrb, mrb_value ary)
533 struct RArray *a = mrb_ary_ptr(ary);
534 mrb_int len = ARY_LEN(a);
536 ary_modify_check(mrb, a);
537 if (len == 0) return mrb_nil_value();
538 ARY_SET_LEN(a, len-1);
539 return ARY_PTR(a)[len-1];
542 #define ARY_SHIFT_SHARED_MIN 10
545 mrb_ary_shift(mrb_state *mrb, mrb_value self)
547 struct RArray *a = mrb_ary_ptr(self);
548 mrb_int len = ARY_LEN(a);
551 ary_modify_check(mrb, a);
552 if (len == 0) return mrb_nil_value();
553 if (ARY_SHARED_P(a)) {
555 val = a->as.heap.ptr[0];
560 if (len > ARY_SHIFT_SHARED_MIN) {
561 ary_make_shared(mrb, a);
565 mrb_value *ptr = ARY_PTR(a);
573 ARY_SET_LEN(a, len-1);
581 p self #=> [0, 1, 2, 3] */
583 mrb_ary_unshift(mrb_state *mrb, mrb_value self, mrb_value item)
585 struct RArray *a = mrb_ary_ptr(self);
586 mrb_int len = ARY_LEN(a);
589 && a->as.heap.aux.shared->refcnt == 1 /* shared only referenced from this array */
590 && a->as.heap.ptr - a->as.heap.aux.shared->ptr >= 1) /* there's room for unshifted item */ {
592 a->as.heap.ptr[0] = item;
598 if (ARY_CAPA(a) < len + 1)
599 ary_expand_capa(mrb, a, len + 1);
601 value_move(ptr + 1, ptr, len);
604 ARY_SET_LEN(a, len+1);
605 mrb_field_write_barrier_value(mrb, (struct RBasic*)a, item);
611 mrb_ary_unshift_m(mrb_state *mrb, mrb_value self)
613 struct RArray *a = mrb_ary_ptr(self);
614 mrb_value *vals, *ptr;
617 mrb_get_args(mrb, "*!", &vals, &alen);
619 ary_modify_check(mrb, a);
623 if (alen > ARY_MAX_SIZE - len) {
624 mrb_raise(mrb, E_ARGUMENT_ERROR, "array size too big");
627 && a->as.heap.aux.shared->refcnt == 1 /* shared only referenced from this array */
628 && a->as.heap.ptr - a->as.heap.aux.shared->ptr >= alen) /* there's room for unshifted item */ {
629 ary_modify_check(mrb, a);
630 a->as.heap.ptr -= alen;
631 ptr = a->as.heap.ptr;
635 if (ARY_CAPA(a) < len + alen)
636 ary_expand_capa(mrb, a, len + alen);
638 value_move(ptr + alen, ptr, len);
640 array_copy(ptr, vals, alen);
641 ARY_SET_LEN(a, len+alen);
643 mrb_field_write_barrier_value(mrb, (struct RBasic*)a, vals[alen]);
650 mrb_ary_ref(mrb_state *mrb, mrb_value ary, mrb_int n)
652 struct RArray *a = mrb_ary_ptr(ary);
653 mrb_int len = ARY_LEN(a);
657 if (n < 0 || len <= n) return mrb_nil_value();
659 return ARY_PTR(a)[n];
663 mrb_ary_set(mrb_state *mrb, mrb_value ary, mrb_int n, mrb_value val)
665 struct RArray *a = mrb_ary_ptr(ary);
666 mrb_int len = ARY_LEN(a);
673 mrb_raisef(mrb, E_INDEX_ERROR, "index %S out of array", mrb_fixnum_value(n - len));
677 if (ARY_CAPA(a) <= n)
678 ary_expand_capa(mrb, a, n + 1);
679 ary_fill_with_nil(ARY_PTR(a) + len, n + 1 - len);
684 mrb_field_write_barrier_value(mrb, (struct RBasic*)a, val);
687 static struct RArray*
688 ary_dup(mrb_state *mrb, struct RArray *a)
690 return ary_new_from_values(mrb, ARY_LEN(a), ARY_PTR(a));
694 mrb_ary_splice(mrb_state *mrb, mrb_value ary, mrb_int head, mrb_int len, mrb_value rpl)
696 struct RArray *a = mrb_ary_ptr(ary);
697 mrb_int alen = ARY_LEN(a);
698 const mrb_value *argv;
705 if (len < 0) mrb_raisef(mrb, E_INDEX_ERROR, "negative length (%S)", mrb_fixnum_value(len));
711 mrb_raise(mrb, E_INDEX_ERROR, "index is out of array");
715 if (alen < len || alen < tail) {
720 if (mrb_array_p(rpl)) {
721 argc = RARRAY_LEN(rpl);
722 argv = RARRAY_PTR(rpl);
723 if (argv == ARY_PTR(a)) {
727 mrb_raise(mrb, E_ARGUMENT_ERROR, "too big recursive splice");
738 if (head > ARY_MAX_SIZE - argc) {
739 mrb_raisef(mrb, E_INDEX_ERROR, "index %S too big", mrb_fixnum_value(head));
742 if (len > ARY_CAPA(a)) {
743 ary_expand_capa(mrb, a, head + argc);
745 ary_fill_with_nil(ARY_PTR(a) + alen, head - alen);
747 array_copy(ARY_PTR(a) + head, argv, argc);
754 if (alen - len > ARY_MAX_SIZE - argc) {
755 mrb_raisef(mrb, E_INDEX_ERROR, "index %S too big", mrb_fixnum_value(alen + argc - len));
757 newlen = alen + argc - len;
758 if (newlen > ARY_CAPA(a)) {
759 ary_expand_capa(mrb, a, newlen);
763 mrb_value *ptr = ARY_PTR(a);
765 value_move(ptr + head + argc, ptr + tail, alen - tail);
766 ARY_SET_LEN(a, newlen);
769 value_move(ARY_PTR(a) + head, argv, argc);
772 mrb_write_barrier(mrb, (struct RBasic*)a);
777 mrb_ary_decref(mrb_state *mrb, mrb_shared_array *shared)
780 if (shared->refcnt == 0) {
781 mrb_free(mrb, shared->ptr);
782 mrb_free(mrb, shared);
787 ary_subseq(mrb_state *mrb, struct RArray *a, mrb_int beg, mrb_int len)
791 if (!ARY_SHARED_P(a) && len <= ARY_SHIFT_SHARED_MIN) {
792 return mrb_ary_new_from_values(mrb, len, ARY_PTR(a)+beg);
794 ary_make_shared(mrb, a);
795 b = (struct RArray*)mrb_obj_alloc(mrb, MRB_TT_ARRAY, mrb->array_class);
796 b->as.heap.ptr = a->as.heap.ptr + beg;
797 b->as.heap.len = len;
798 b->as.heap.aux.shared = a->as.heap.aux.shared;
799 b->as.heap.aux.shared->refcnt++;
800 ARY_SET_SHARED_FLAG(b);
802 return mrb_obj_value(b);
806 aget_index(mrb_state *mrb, mrb_value index)
808 if (mrb_fixnum_p(index)) {
809 return mrb_fixnum(index);
811 #ifndef MRB_WITHOUT_FLOAT
812 else if (mrb_float_p(index)) {
813 return (mrb_int)mrb_float(index);
820 mrb_get_args(mrb, "i*!", &i, &argv, &argc);
827 * ary[index] -> obj or nil
828 * ary[start, length] -> new_ary or nil
829 * ary[range] -> new_ary or nil
830 * ary.slice(index) -> obj or nil
831 * ary.slice(start, length) -> new_ary or nil
832 * ary.slice(range) -> new_ary or nil
834 * Element Reference --- Returns the element at +index+, or returns a
835 * subarray starting at the +start+ index and continuing for +length+
836 * elements, or returns a subarray specified by +range+ of indices.
838 * Negative indices count backward from the end of the array (-1 is the last
839 * element). For +start+ and +range+ cases the starting index is just before
840 * an element. Additionally, an empty array is returned when the starting
841 * index for an element range is at the end of the array.
843 * Returns +nil+ if the index (or starting index) are out of range.
845 * a = [ "a", "b", "c", "d", "e" ]
847 * a[1,2] => ["b", "c"]
848 * a[1..-2] => ["b", "c", "d"]
853 mrb_ary_aget(mrb_state *mrb, mrb_value self)
855 struct RArray *a = mrb_ary_ptr(self);
856 mrb_int i, len, alen;
859 if (mrb_get_args(mrb, "o|i", &index, &len) == 1) {
860 switch (mrb_type(index)) {
863 if (mrb_range_beg_len(mrb, index, &i, &len, ARY_LEN(a), TRUE) == 1) {
864 return ary_subseq(mrb, a, i, len);
867 return mrb_nil_value();
870 return mrb_ary_ref(mrb, self, mrb_fixnum(index));
872 return mrb_ary_ref(mrb, self, aget_index(mrb, index));
876 i = aget_index(mrb, index);
878 if (i < 0) i += alen;
879 if (i < 0 || alen < i) return mrb_nil_value();
880 if (len < 0) return mrb_nil_value();
881 if (alen == i) return mrb_ary_new(mrb);
882 if (len > alen - i) len = alen - i;
884 return ary_subseq(mrb, a, i, len);
889 * ary[index] = obj -> obj
890 * ary[start, length] = obj or other_ary or nil -> obj or other_ary or nil
891 * ary[range] = obj or other_ary or nil -> obj or other_ary or nil
893 * Element Assignment --- Sets the element at +index+, or replaces a subarray
894 * from the +start+ index for +length+ elements, or replaces a subarray
895 * specified by the +range+ of indices.
897 * If indices are greater than the current capacity of the array, the array
898 * grows automatically. Elements are inserted into the array at +start+ if
901 * Negative indices will count backward from the end of the array. For
902 * +start+ and +range+ cases the starting index is just before an element.
904 * An IndexError is raised if a negative index points past the beginning of
907 * See also Array#push, and Array#unshift.
910 * a[4] = "4"; #=> [nil, nil, nil, nil, "4"]
911 * a[0, 3] = [ 'a', 'b', 'c' ] #=> ["a", "b", "c", nil, "4"]
912 * a[1..2] = [ 1, 2 ] #=> ["a", 1, 2, nil, "4"]
913 * a[0, 2] = "?" #=> ["?", 2, nil, "4"]
914 * a[0..2] = "A" #=> ["A", "4"]
915 * a[-1] = "Z" #=> ["A", "Z"]
916 * a[1..-1] = nil #=> ["A", nil]
917 * a[1..-1] = [] #=> ["A"]
918 * a[0, 0] = [ 1, 2 ] #=> [1, 2, "A"]
919 * a[3, 0] = "B" #=> [1, 2, "A", "B"]
923 mrb_ary_aset(mrb_state *mrb, mrb_value self)
925 mrb_value v1, v2, v3;
928 mrb_ary_modify(mrb, mrb_ary_ptr(self));
929 if (mrb_get_args(mrb, "oo|o", &v1, &v2, &v3) == 2) {
931 switch (mrb_range_beg_len(mrb, v1, &i, &len, RARRAY_LEN(self), FALSE)) {
932 case 0: /* not range */
933 mrb_ary_set(mrb, self, aget_index(mrb, v1), v2);
936 mrb_ary_splice(mrb, self, i, len, v2);
938 case 2: /* out of range */
939 mrb_raisef(mrb, E_RANGE_ERROR, "%S out of range", v1);
946 mrb_ary_splice(mrb, self, aget_index(mrb, v1), aget_index(mrb, v2), v3);
951 mrb_ary_delete_at(mrb_state *mrb, mrb_value self)
953 struct RArray *a = mrb_ary_ptr(self);
959 mrb_get_args(mrb, "i", &index);
961 if (index < 0) index += alen;
962 if (index < 0 || alen <= index) return mrb_nil_value();
974 ARY_SET_LEN(a, alen-1);
976 ary_shrink_capa(mrb, a);
982 mrb_ary_first(mrb_state *mrb, mrb_value self)
984 struct RArray *a = mrb_ary_ptr(self);
987 if (mrb_get_argc(mrb) == 0) {
988 return (ARY_LEN(a) > 0)? ARY_PTR(a)[0]: mrb_nil_value();
990 mrb_get_args(mrb, "|i", &size);
992 mrb_raise(mrb, E_ARGUMENT_ERROR, "negative array size");
996 if (size > alen) size = alen;
997 if (ARY_SHARED_P(a)) {
998 return ary_subseq(mrb, a, 0, size);
1000 return mrb_ary_new_from_values(mrb, size, ARY_PTR(a));
1004 mrb_ary_last(mrb_state *mrb, mrb_value self)
1006 struct RArray *a = mrb_ary_ptr(self);
1007 mrb_int n, size, alen;
1009 n = mrb_get_args(mrb, "|i", &size);
1012 return (alen > 0) ? ARY_PTR(a)[alen - 1]: mrb_nil_value();
1016 mrb_raise(mrb, E_ARGUMENT_ERROR, "negative array size");
1018 if (size > alen) size = alen;
1019 if (ARY_SHARED_P(a) || size > ARY_DEFAULT_LEN) {
1020 return ary_subseq(mrb, a, alen - size, size);
1022 return mrb_ary_new_from_values(mrb, size, ARY_PTR(a) + alen - size);
1026 mrb_ary_index_m(mrb_state *mrb, mrb_value self)
1031 mrb_get_args(mrb, "o", &obj);
1032 for (i = 0; i < RARRAY_LEN(self); i++) {
1033 if (mrb_equal(mrb, RARRAY_PTR(self)[i], obj)) {
1034 return mrb_fixnum_value(i);
1037 return mrb_nil_value();
1041 mrb_ary_rindex_m(mrb_state *mrb, mrb_value self)
1046 mrb_get_args(mrb, "o", &obj);
1047 for (i = RARRAY_LEN(self) - 1; i >= 0; i--) {
1048 if (mrb_equal(mrb, RARRAY_PTR(self)[i], obj)) {
1049 return mrb_fixnum_value(i);
1051 if (i > (len = RARRAY_LEN(self))) {
1055 return mrb_nil_value();
1059 mrb_ary_splat(mrb_state *mrb, mrb_value v)
1063 if (mrb_array_p(v)) {
1067 if (!mrb_respond_to(mrb, v, mrb_intern_lit(mrb, "to_a"))) {
1068 return mrb_ary_new_from_values(mrb, 1, &v);
1071 a = mrb_funcall(mrb, v, "to_a", 0);
1073 return mrb_ary_new_from_values(mrb, 1, &v);
1075 mrb_ensure_array_type(mrb, a);
1080 mrb_ary_size(mrb_state *mrb, mrb_value self)
1082 struct RArray *a = mrb_ary_ptr(self);
1084 return mrb_fixnum_value(ARY_LEN(a));
1088 mrb_ary_clear(mrb_state *mrb, mrb_value self)
1090 struct RArray *a = mrb_ary_ptr(self);
1093 if (ARY_SHARED_P(a)) {
1094 mrb_ary_decref(mrb, a->as.heap.aux.shared);
1095 ARY_UNSET_SHARED_FLAG(a);
1097 else if (!ARY_EMBED_P(a)){
1098 mrb_free(mrb, a->as.heap.ptr);
1100 ARY_SET_EMBED_LEN(a, 0);
1106 mrb_ary_clear_m(mrb_state *mrb, mrb_value self)
1108 mrb_get_args(mrb, "");
1109 return mrb_ary_clear(mrb, self);
1113 mrb_ary_empty_p(mrb_state *mrb, mrb_value self)
1115 struct RArray *a = mrb_ary_ptr(self);
1117 return mrb_bool_value(ARY_LEN(a) == 0);
1121 mrb_ary_entry(mrb_value ary, mrb_int offset)
1124 offset += RARRAY_LEN(ary);
1126 if (offset < 0 || RARRAY_LEN(ary) <= offset) {
1127 return mrb_nil_value();
1129 return RARRAY_PTR(ary)[offset];
1133 join_ary(mrb_state *mrb, mrb_value ary, mrb_value sep, mrb_value list)
1136 mrb_value result, val, tmp;
1138 /* check recursive */
1139 for (i=0; i<RARRAY_LEN(list); i++) {
1140 if (mrb_obj_equal(mrb, ary, RARRAY_PTR(list)[i])) {
1141 mrb_raise(mrb, E_ARGUMENT_ERROR, "recursive array join");
1145 mrb_ary_push(mrb, list, ary);
1147 result = mrb_str_new_capa(mrb, 64);
1149 for (i=0; i<RARRAY_LEN(ary); i++) {
1150 if (i > 0 && !mrb_nil_p(sep)) {
1151 mrb_str_cat_str(mrb, result, sep);
1154 val = RARRAY_PTR(ary)[i];
1155 switch (mrb_type(val)) {
1158 val = join_ary(mrb, val, sep, list);
1163 mrb_str_cat_str(mrb, result, val);
1167 if (!mrb_immediate_p(val)) {
1168 tmp = mrb_check_string_type(mrb, val);
1169 if (!mrb_nil_p(tmp)) {
1173 tmp = mrb_check_array_type(mrb, val);
1174 if (!mrb_nil_p(tmp)) {
1179 val = mrb_obj_as_string(mrb, val);
1184 mrb_ary_pop(mrb, list);
1190 mrb_ary_join(mrb_state *mrb, mrb_value ary, mrb_value sep)
1192 if (!mrb_nil_p(sep)) {
1193 sep = mrb_obj_as_string(mrb, sep);
1195 return join_ary(mrb, ary, sep, mrb_ary_new(mrb));
1200 * ary.join(sep="") -> str
1202 * Returns a string created by converting each element of the array to
1203 * a string, separated by <i>sep</i>.
1205 * [ "a", "b", "c" ].join #=> "abc"
1206 * [ "a", "b", "c" ].join("-") #=> "a-b-c"
1210 mrb_ary_join_m(mrb_state *mrb, mrb_value ary)
1212 mrb_value sep = mrb_nil_value();
1214 mrb_get_args(mrb, "|S!", &sep);
1215 return mrb_ary_join(mrb, ary, sep);
1219 mrb_ary_eq(mrb_state *mrb, mrb_value ary1)
1223 mrb_get_args(mrb, "o", &ary2);
1224 if (mrb_obj_equal(mrb, ary1, ary2)) return mrb_true_value();
1225 if (!mrb_array_p(ary2)) {
1226 return mrb_false_value();
1228 if (RARRAY_LEN(ary1) != RARRAY_LEN(ary2)) return mrb_false_value();
1234 mrb_ary_cmp(mrb_state *mrb, mrb_value ary1)
1238 mrb_get_args(mrb, "o", &ary2);
1239 if (mrb_obj_equal(mrb, ary1, ary2)) return mrb_fixnum_value(0);
1240 if (!mrb_array_p(ary2)) {
1241 return mrb_nil_value();
1247 /* internal method to convert multi-value to single value */
1249 mrb_ary_svalue(mrb_state *mrb, mrb_value ary)
1251 mrb_get_args(mrb, "");
1252 switch (RARRAY_LEN(ary)) {
1254 return mrb_nil_value();
1256 return RARRAY_PTR(ary)[0];
1263 mrb_init_array(mrb_state *mrb)
1267 mrb->array_class = a = mrb_define_class(mrb, "Array", mrb->object_class); /* 15.2.12 */
1268 MRB_SET_INSTANCE_TT(a, MRB_TT_ARRAY);
1270 mrb_define_class_method(mrb, a, "[]", mrb_ary_s_create, MRB_ARGS_ANY()); /* 15.2.12.4.1 */
1272 mrb_define_method(mrb, a, "+", mrb_ary_plus, MRB_ARGS_REQ(1)); /* 15.2.12.5.1 */
1273 mrb_define_method(mrb, a, "*", mrb_ary_times, MRB_ARGS_REQ(1)); /* 15.2.12.5.2 */
1274 mrb_define_method(mrb, a, "<<", mrb_ary_push_m, MRB_ARGS_REQ(1)); /* 15.2.12.5.3 */
1275 mrb_define_method(mrb, a, "[]", mrb_ary_aget, MRB_ARGS_ANY()); /* 15.2.12.5.4 */
1276 mrb_define_method(mrb, a, "[]=", mrb_ary_aset, MRB_ARGS_ANY()); /* 15.2.12.5.5 */
1277 mrb_define_method(mrb, a, "clear", mrb_ary_clear_m, MRB_ARGS_NONE()); /* 15.2.12.5.6 */
1278 mrb_define_method(mrb, a, "concat", mrb_ary_concat_m, MRB_ARGS_REQ(1)); /* 15.2.12.5.8 */
1279 mrb_define_method(mrb, a, "delete_at", mrb_ary_delete_at, MRB_ARGS_REQ(1)); /* 15.2.12.5.9 */
1280 mrb_define_method(mrb, a, "empty?", mrb_ary_empty_p, MRB_ARGS_NONE()); /* 15.2.12.5.12 */
1281 mrb_define_method(mrb, a, "first", mrb_ary_first, MRB_ARGS_OPT(1)); /* 15.2.12.5.13 */
1282 mrb_define_method(mrb, a, "index", mrb_ary_index_m, MRB_ARGS_REQ(1)); /* 15.2.12.5.14 */
1283 mrb_define_method(mrb, a, "initialize_copy", mrb_ary_replace_m, MRB_ARGS_REQ(1)); /* 15.2.12.5.16 */
1284 mrb_define_method(mrb, a, "join", mrb_ary_join_m, MRB_ARGS_ANY()); /* 15.2.12.5.17 */
1285 mrb_define_method(mrb, a, "last", mrb_ary_last, MRB_ARGS_ANY()); /* 15.2.12.5.18 */
1286 mrb_define_method(mrb, a, "length", mrb_ary_size, MRB_ARGS_NONE()); /* 15.2.12.5.19 */
1287 mrb_define_method(mrb, a, "pop", mrb_ary_pop, MRB_ARGS_NONE()); /* 15.2.12.5.21 */
1288 mrb_define_method(mrb, a, "push", mrb_ary_push_m, MRB_ARGS_ANY()); /* 15.2.12.5.22 */
1289 mrb_define_method(mrb, a, "append", mrb_ary_push_m, MRB_ARGS_ANY());
1290 mrb_define_method(mrb, a, "replace", mrb_ary_replace_m, MRB_ARGS_REQ(1)); /* 15.2.12.5.23 */
1291 mrb_define_method(mrb, a, "reverse", mrb_ary_reverse, MRB_ARGS_NONE()); /* 15.2.12.5.24 */
1292 mrb_define_method(mrb, a, "reverse!", mrb_ary_reverse_bang, MRB_ARGS_NONE()); /* 15.2.12.5.25 */
1293 mrb_define_method(mrb, a, "rindex", mrb_ary_rindex_m, MRB_ARGS_REQ(1)); /* 15.2.12.5.26 */
1294 mrb_define_method(mrb, a, "shift", mrb_ary_shift, MRB_ARGS_NONE()); /* 15.2.12.5.27 */
1295 mrb_define_method(mrb, a, "size", mrb_ary_size, MRB_ARGS_NONE()); /* 15.2.12.5.28 */
1296 mrb_define_method(mrb, a, "slice", mrb_ary_aget, MRB_ARGS_ANY()); /* 15.2.12.5.29 */
1297 mrb_define_method(mrb, a, "unshift", mrb_ary_unshift_m, MRB_ARGS_ANY()); /* 15.2.12.5.30 */
1298 mrb_define_method(mrb, a, "prepend", mrb_ary_unshift_m, MRB_ARGS_ANY());
1300 mrb_define_method(mrb, a, "__ary_eq", mrb_ary_eq, MRB_ARGS_REQ(1));
1301 mrb_define_method(mrb, a, "__ary_cmp", mrb_ary_cmp, MRB_ARGS_REQ(1));
1302 mrb_define_method(mrb, a, "__ary_index", mrb_ary_index_m, MRB_ARGS_REQ(1)); /* kept for mruby-array-ext */
1303 mrb_define_method(mrb, a, "__svalue", mrb_ary_svalue, MRB_ARGS_NONE());